rhi: Add a note to sampler docs about mipmaps

Fixes: QTBUG-115521
Pick-to: 6.6
Change-Id: I774cdc4d1b9e09624a9b5f9969eae5085b40a6c0
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
This commit is contained in:
Laszlo Agocs 2023-07-26 16:14:28 +02:00
parent 84f8d4961d
commit 803e5f0ff7

View File

@ -10221,6 +10221,14 @@ QRhiTexture *QRhi::newTextureArray(QRhiTexture::Format format,
minification filter \a minFilter, mipmapping mode \a mipmapMode, and the
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()
*/
QRhiSampler *QRhi::newSampler(QRhiSampler::Filter magFilter,