From bc83fb11a174b57e8fed2d87ca787366635e3470 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tor=20Arne=20Vestb=C3=B8?= <tor.arne.vestbo@qt.io>
Date: Fri, 4 Oct 2024 09:56:32 +0200
Subject: [PATCH] Document how to create a QColorTransform via QColorSpace

Change-Id: If651a4f17f52ff784bc0832440f41fb30cd29371
Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
(cherry picked from commit 5effd7ad53997a5a1edcba09457036971cbdcd54)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 src/gui/painting/qcolortransform.cpp | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/gui/painting/qcolortransform.cpp b/src/gui/painting/qcolortransform.cpp
index 42315986b7a..90665e84ff6 100644
--- a/src/gui/painting/qcolortransform.cpp
+++ b/src/gui/painting/qcolortransform.cpp
@@ -84,6 +84,14 @@ void QColorTransformPrivate::updateLutsOut() const
     It can be applied on color and pixels to convert them from one color space to
     another.
 
+    To create a QColorTransform, use QColorSpace::transformationToColorSpace():
+
+    \code
+    QColorSpace sourceColorSpace(QColorSpace::SRgb);
+    QColorSpace targetColorSpace(QColorSpace::DisplayP3);
+    QColorTransform srgbToP3Transform = sourceColorSpace.transformationToColorSpace(targetColorSpace);
+    \endcode
+
     Setting up a QColorTransform takes some preprocessing, so keeping around
     QColorTransforms that you need often is recommended, instead of generating
     them on the fly.