Struct DisplayHeadroom 

pub struct DisplayHeadroom {
    pub current: Option<f32>,
    pub potential: Option<f32>,
    pub reference: Option<f32>,
}

Relative EDR headroom (Apple): unitless multipliers over current SDR white, where 1.0 means no headroom. Moves with brightness, ambient light, battery, and which display the window is on. Apple exposes no absolute-nit equivalent, so this is separate from DisplayLuminance and can’t be converted to nits.

Populated only on macOS; None on iOS, tvOS, and visionOS.

Fields

current: Option<f32>

Headroom available right now (maximumExtendedDynamicRangeColorComponentValue / iOS UIScreen.currentEDRHeadroom). 1.0 means no headroom at this instant, even on an HDR-capable panel.

potential: Option<f32>

Headroom the display could reach under ideal conditions (maximumPotentialExtendedDynamicRangeColorComponentValue / UIScreen.potentialEDRHeadroom).

reference: Option<f32>

Headroom for reference-white content (maximumReferenceExtendedDynamicRangeColorComponentValue). None if unreported.

Trait Implementations

impl Clone for DisplayHeadroom

fn clone(&self) -> DisplayHeadroom

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisplayHeadroom

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for DisplayHeadroom

fn default() -> DisplayHeadroom

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DisplayHeadroom

fn deserialize<__D>( __deserializer: __D, ) -> Result<DisplayHeadroom, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DisplayHeadroom

fn eq(&self, other: &DisplayHeadroom) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DisplayHeadroom

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DisplayHeadroom

impl StructuralPartialEq for DisplayHeadroom