rhi: Add a note to sampler docs about mipmaps

Fixes: QTBUG-115521
Change-Id: I774cdc4d1b9e09624a9b5f9969eae5085b40a6c0
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
(cherry picked from commit 803e5f0ff771944c8d5350b28940860d6b54a394)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Laszlo Agocs 2023-07-26 16:14:28 +02:00 committed by Qt Cherry-pick Bot
parent 4f75b1cdb7
commit 6909fb0019

View File

@ -10048,6 +10048,14 @@ QRhiTexture *QRhi::newTextureArray(QRhiTexture::Format format,
minification filter \a minFilter, mipmapping mode \a mipmapMode, and the minification filter \a minFilter, mipmapping mode \a mipmapMode, and the
addressing (wrap) modes \a addressU, \a addressV, and \a addressW. addressing (wrap) modes \a addressU, \a addressV, and \a addressW.
\note Setting \a mipmapMode to a value other than \c None implies that
images for all relevant mip levels will be provided either via
\l{QRhiResourceUpdateBatch::uploadTexture()}{texture uploads} or by calling
\l{QRhiResourceUpdateBatch::generateMips()}{generateMips()} on the texture
that is used with this sampler. Attempting to use the sampler with a
texture that has no data for all relevant mip levels will lead to rendering
errors, with the exact behavior dependent on the underlying graphics API.
\sa QRhiResource::destroy() \sa QRhiResource::destroy()
*/ */
QRhiSampler *QRhi::newSampler(QRhiSampler::Filter magFilter, QRhiSampler *QRhi::newSampler(QRhiSampler::Filter magFilter,