From c5a3cabce0f9fd615a77772002d6e1b5ca121919 Mon Sep 17 00:00:00 2001
From: Laszlo Agocs <laszlo.agocs@qt.io>
Date: Mon, 13 Sep 2021 15:43:16 +0200
Subject: [PATCH] rhi: Note in the docs that texture copies expect a matching
 format
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Pick-to: 6.2
Change-Id: I0a1fb042ec2a3983ffbd146ff9bdc9af20134fa5
Reviewed-by: Christian Strømme <christian.stromme@qt.io>
---
 src/gui/rhi/qrhi.cpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/gui/rhi/qrhi.cpp b/src/gui/rhi/qrhi.cpp
index 7c1e3811b1..e924841375 100644
--- a/src/gui/rhi/qrhi.cpp
+++ b/src/gui/rhi/qrhi.cpp
@@ -5312,6 +5312,11 @@ void QRhiResourceUpdateBatch::uploadTexture(QRhiTexture *tex, const QImage &imag
 
    \note The source texture \a src must be created with
    QRhiTexture::UsedAsTransferSource.
+
+   \note The format of the textures must match. With most graphics
+   APIs the data is copied as-is without any format conversions. If
+   \a dst and \a src are created with different formats, unspecified
+   issues may arise.
  */
 void QRhiResourceUpdateBatch::copyTexture(QRhiTexture *dst, QRhiTexture *src, const QRhiTextureCopyDescription &desc)
 {