Window.DesiredHdrHeadroom Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get the desired amount of HDR headroom as set by #setDesiredHdrHeadroom(float) -or- Sets the desired about of HDR headroom to be used when rendering as a ratio of
targetHdrPeakBrightnessInNits / targetSdrWhitePointInNits.
public virtual float DesiredHdrHeadroom { [Android.Runtime.Register("getDesiredHdrHeadroom", "()F", "GetGetDesiredHdrHeadroomHandler", ApiSince=35)] get; [Android.Runtime.Register("setDesiredHdrHeadroom", "(F)V", "GetSetDesiredHdrHeadroom_FHandler", ApiSince=35)] set; }[<get: Android.Runtime.Register("getDesiredHdrHeadroom", "()F", "GetGetDesiredHdrHeadroomHandler", ApiSince=35)>]
[<set: Android.Runtime.Register("setDesiredHdrHeadroom", "(F)V", "GetSetDesiredHdrHeadroom_FHandler", ApiSince=35)>]
member this.DesiredHdrHeadroom : single with get, setProperty Value
The amount of HDR headroom set, or 0 for automatic/default behavior.
- Attributes
Remarks
Property getter documentation:
Get the desired amount of HDR headroom as set by #setDesiredHdrHeadroom(float)
Java documentation for android.view.Window.getDesiredHdrHeadroom().
Property setter documentation:
Sets the desired about of HDR headroom to be used when rendering as a ratio of targetHdrPeakBrightnessInNits / targetSdrWhitePointInNits. Only applies when #setColorMode(int) is ActivityInfo#COLOR_MODE_HDR
By default the system will choose an amount of HDR headroom that is appropriate for the underlying device capabilities & bit-depth of the panel. However, for some types of content this can end up being more headroom than necessary or desired. An example would be a messaging app or gallery thumbnail view where some amount of HDR pop is desired without overly influencing the perceived brightness of the majority SDR content. This can also be used to animate in/out of an HDR range for smoother transitions.
Note: The actual amount of HDR headroom that will be given is subject to a variety of factors such as ambient conditions, display capabilities, or bit-depth limitations. See Display#getHdrSdrRatio() for more information as well as how to query the current value.
Java documentation for android.view.Window.setDesiredHdrHeadroom(float).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.