rhi: Add a note to generateMips docs

Change-Id: Ib07eef8944367948338075832452fdae6df6078a
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
This commit is contained in:
Laszlo Agocs 2020-10-01 10:17:56 +02:00
parent 0b7aef08dc
commit 9b35a16c64

View File

@ -4991,6 +4991,13 @@ void QRhiResourceUpdateBatch::readBackTexture(const QRhiReadbackDescription &rb,
\note The texture must be created with QRhiTexture::MipMapped and
QRhiTexture::UsedWithGenerateMips.
\warning QRhi cannot guarantee that mipmaps can be generated for all
supported texture formats. For example, QRhiTexture::RGBA32F is not a \c
filterable format in OpenGL ES 3.0 and Metal on iOS, and therefore the
mipmap generation request may fail. RGBA8 and RGBA16F are typically
filterable, so it is recommended to use these formats when mipmap generation
is desired.
*/
void QRhiResourceUpdateBatch::generateMips(QRhiTexture *tex)
{