Version: 2021.1
LanguageEnglish
  • C#

HDROutputSettings.RequestHDRModeChange

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void RequestHDRModeChange(bool enabled);

Parameters

enabled Indicates whether HDR should be enabled.

Description

Use this function to request a change in the HDR Output Mode and in the value of HDROutputSettings.active.

When calling this function, Unity automatically sets the HDROutputSettings.HDRModeChangeRequested property to true until the HDR Output Mode change completes.

This functionality could be used to implement an in application menu allowing users to swap in or our of HDR display mode.

Some platforms cannot swap in or out of HDR display mode at runtime. See SystemInfo.hdrDisplaySupportFlags for more information.

Accessing this member results in an exception if HDR is not available on the display. Use HDROutputSettings.available for the display to check that HDR is available.