Provides access to HDR display settings and information.
displays | The list of currently connected displays with possible HDR availability. |
main | The HDROutputSettings for the main display. |
active | Describes whether HDR output is currently active on the display. It is true if this is the case, and @@false@ otherwise. |
automaticHDRTonemapping | Describes whether Unity performs HDR tonemapping automatically. |
available | Describes whether HDR is currently available on your primary display and that you have HDR enabled in your Unity Project. It is true if this is the case, and false otherwise. |
displayColorGamut | The ColorGamut used to output to the active HDR display. |
format | The RenderTextureFormat of the display buffer for the active HDR display. |
graphicsFormat | The GraphicsFormat of the display buffer for the active HDR display. |
HDRModeChangeRequested | Describes whether the user has requested to change the HDR Output Mode. It is true if this is the case, and false otherwise. |
maxFullFrameToneMapLuminance | Maximum input luminance at which gradation is preserved even when the entire screen is bright. |
maxToneMapLuminance | Maximum input luminance at which gradation is preserved when 10% of the screen is bright. |
minToneMapLuminance | Minimum input luminance at which gradation is identifiable. |
paperWhiteNits | The base luminance of a white paper surface in nits or candela per square meter (cd/m2). |
RequestHDRModeChange | Use this function to request a change in the HDR Output Mode and in the value of HDROutputSettings.active. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.