1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rhi: Adjust some HDR-related docs and notes

Browse Source 
Change-Id: I3b5709358fc572ad2214527b19d027c93a0af745
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
(cherry picked from commit 5328fdd8baa813c4a170501c2fad740dc2d0b433)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Laszlo Agocs 2023-06-21 09:57:42 +02:00 committed by Qt Cherry-pick Bot
parent 6f956279f8
commit 266be57eed
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/gui/rhi/qrhi.cpp
View File

@ -6885,6 +6885,14 @@ QRhiResource::Type QRhiGraphicsPipeline::resourceType() const
\enum QRhiSwapChain::Format \enum QRhiSwapChain::Format
Describes the swapchain format. The default format is SDR. Describes the swapchain format. The default format is SDR.
This enum is used with
\l{QRhiSwapChain::isFormatSupported()}{isFormatSupported()} to check
upfront if creating the swapchain with the given format is supported by the
platform and the window's associated screen, and with
\l{QRhiSwapChain::setFormat()}{setFormat()}
to set the requested format in the swapchain before calling
\l{QRhiSwapChain::createOrResize()}{createOrResize()} for the first time.
\value SDR 8-bit RGBA or BGRA, depending on the backend and platform. With \value SDR 8-bit RGBA or BGRA, depending on the backend and platform. With
OpenGL ES in particular, it could happen that the platform provides less OpenGL ES in particular, it could happen that the platform provides less
than 8 bits (e.g. due to EGL and the QSurfaceFormat choosing a 565 or 444 than 8 bits (e.g. due to EGL and the QSurfaceFormat choosing a 565 or 444
@ -6993,6 +7001,21 @@ QRhiResource::Type QRhiSwapChain::resourceType() const
time. If the result is true for a HDR format, then creating the swapchain time. If the result is true for a HDR format, then creating the swapchain
with that format is expected to succeed as long as the window is not moved with that format is expected to succeed as long as the window is not moved
to another screen in the meantime. to another screen in the meantime.
The main use of this function is to call it before the first
createOrResize() after the window is already set. This allow the QRhi
backends to perform platform or windowing system specific queries to
determine if the window (and the screen it is on) is capable of true HDR
output with the specified format.
When the format is reported as supported, call setFormat() to set the
requested format and call createOrResize(). Be aware of the consequences
however: successfully requesting a HDR format will involve having to deal
with a different color space, possibly doing white level correction for
non-HDR-aware content, adjusting tonemapping methods, adjusting offscreen
render target settings, etc.
\sa setFormat()
*/ */
/*! /*!
@ -7111,6 +7134,15 @@ QRhiRenderTarget *QRhiSwapChain::currentFrameRenderTarget(StereoTargetBuffer tar
/*! /*!
\fn void QRhiSwapChain::setFormat(Format f) \fn void QRhiSwapChain::setFormat(Format f)
Sets the format \a f. Sets the format \a f.
Avoid setting formats that are reported as unsupported from
isFormatSupported(). Note that support for a given format may depend on the
screen the swapchain's associated window is opened on. On some platforms,
such as Windows and macOS, for HDR output to work it is necessary to have
HDR output enabled in the display settings.
See isFormatSupported(), \l QRhiSwapChainHdrInfo, and \l Format for more
information on high dynamic range output.
*/ */
/*! /*!