Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

RequestHDRModeChange(bool)

Use this function to request a change in the HDR Output Mode and in the value of HDROutputSettings.active.
Read time 1 minuteLast updated 7 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public void RequestHDRModeChange(bool enabled)

Parameters

enabled

bool
Indicates whether HDR should be enabled.

Remarks

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.