From 178fe26cb312d0885b4d173d2924243a2b8f80e4 Mon Sep 17 00:00:00 2001
From: Artem Dyomin <artem.dyomin@qt.io>
Date: Tue, 6 Feb 2024 14:25:03 +0100
Subject: [PATCH] Improve description of
 QRhiTextureSubresourceUploadDescription::setImage
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The format of QImage is not considered upon texture loading,
it should be documented.

Pick-to: 6.6 6.5
Change-Id: I795c8a82a71ecdba5407f7e4ce940f7d538ff924
Reviewed-by: Jøger Hansegård <joger.hansegard@qt.io>
Reviewed-by: Artem Dyomin <artem.dyomin@qt.io>
(cherry picked from commit f2957e463362b307c1cc736365c4640c9befbdd0)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 src/gui/rhi/qrhi.cpp | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/gui/rhi/qrhi.cpp b/src/gui/rhi/qrhi.cpp
index 415297b29b0..3a97d0d7100 100644
--- a/src/gui/rhi/qrhi.cpp
+++ b/src/gui/rhi/qrhi.cpp
@@ -2750,6 +2750,7 @@ QRhiTextureSubresourceUploadDescription::QRhiTextureSubresourceUploadDescription
     \fn void QRhiTextureSubresourceUploadDescription::setImage(const QImage &image)
 
     Sets \a image.
+    Upon textures loading, the image data will be read as is, with no formats conversions.
 
     \note image() and data() cannot be both set at the same time.
  */