@@ -7,6 +7,9 @@ HDR output is a feature that enables presentation of High Dynamic Range (HDR) vi
77HDR-capable screens. HDR **output ** is not to be confused with the internal HDR rendering that is
88used by Godot for both Standard Dynamic Range (SDR) output and HDR output modes.
99
10+ HDR output is supported on iOS, Linux (Wayland), macOS, visionOS, and Windows. It is not supported
11+ on Android, Linux (X11), or web.
12+
1013Enabling HDR output in your project
1114-----------------------------------
1215
@@ -190,6 +193,8 @@ demonstrates this:
190193 # Godot unless stated otherwise.
191194 return linear_color.linear_to_srgb()
192195
196+ The `HDR output demo project <https://github.com/godotengine/godot-demo-projects/tree/master/misc/hdr_output >`__
197+ includes more advanced versions of this script and examples of how this approach can be used in your project.
193198
194199Using Tonemapping
195200^^^^^^^^^^^^^^^^^
@@ -285,17 +290,30 @@ This value is typically around 100 to 300 nits and is always represented by an
285290:ref: `output max linear value<class_Window_method_get_output_max_linear_value> ` of exactly ``1.0 ``.
286291This value may also be referred to as "paper white" or the "SDR white level".
287292
293+ .. note ::
294+
295+ When using an external screen on Windows, the *SDR content brightness * HDR display setting
296+ directly controls the reference luminance value and is the primary way to adjust the brightness
297+ of the Windows desktop and Godot. When using a built-in HDR screen on Windows, changing *HDR
298+ content brightness * also directly controls the reference luminance, but has no effect on the
299+ brightness of the Windows desktop or Godot because a separate brightness implementation negates
300+ any effect of changes to the reference luminance.
301+
288302Maximum luminance
289303^^^^^^^^^^^^^^^^^
290304
291305The maximum luminance is a property of an HDR screen. This value may be anywhere from 250 to 2,000
292- nits or beyond.
306+ nits or beyond. It is common for external screens to report a maximum luminance value that is higher
307+ than the physical capabilities of the screen that results in visible tonemapping applied by the screen.
308+ Some desktop or laptop operating systems provide a way to calibrate the maximum luminance value that
309+ is used for each external screen.
310+
311+ .. note ::
293312
294- Although this value is a property of the screen hardware and is expected to not change, some
295- devices dynamically adapt this value to work within the constraints of the platform. For example,
296- the reported maximum luminance of Windows laptops with built-in HDR screens will change as the
297- user adjusts their laptop screen brightness while the reported reference luminance remains
298- constant.
313+ When using a built-in screen on Windows, the reported maximum luminance will change as the user
314+ adjusts their laptop screen brightness while the reported reference luminance remains constant.
315+ This behavior is opposite from using an external display on Windows and adjusting the *SDR content
316+ brightness * HDR display setting and also opposite of other platforms.
299317
300318Output max linear value in practice
301319^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
0 commit comments