Skip to main content

SurfaceDisplay

Struct SurfaceDisplay 

Source
pub struct SurfaceDisplay {
    pub known: bool,
    pub hdr: bool,
    pub headroom: f32,
    pub potential_headroom: f32,
    pub output_headroom: f32,
    pub sdr_white_nits: Option<f32>,
    pub peak_nits: Option<f32>,
    pub full_frame_nits: Option<f32>,
    pub refresh_hz: Option<f32>,
    pub variable_refresh: Option<bool>,
    pub refresh_period: Option<Duration>,
    pub last_vblank: Option<u64>,
}
Expand description

A display, in a surface’s unit: 1.0 is SDR (paper) white, as in macOS EDR and as Windows composes SDR content, so scRGB is this scaled by Self::sdr_white_nits / 80.

Fields§

§known: bool

Whether the platform reported it: not on Linux, and not before the window first drew.

§hdr: bool

The display is in HDR: Windows’ HDR (PQ) mode, or a macOS screen with EDR headroom.

§headroom: f32

The brightest value it shows now; 1.0 on an SDR display. On macOS it follows the brightness.

§potential_headroom: f32

The brightest it can show (macOS at full brightness); headroom on Windows.

§output_headroom: f32

The brightest value a surface’s frame reaches the display with: headroom where the window can draw HDR (Windows, macOS), else 1.0, where frames are clamped.

§sdr_white_nits: Option<f32>

SDR white in nits: Windows in HDR mode (its SDR content brightness setting).

§peak_nits: Option<f32>

The display’s peak and full-frame luminance in nits, where Windows knows them.

§full_frame_nits: Option<f32>§refresh_hz: Option<f32>

The refresh rate in Hz: Windows’ current mode, the screen’s maximum on macOS.

§variable_refresh: Option<bool>

Whether the screen refreshes at a variable rate (macOS: ProMotion, Adaptive-Sync).

§refresh_period: Option<Duration>

The display’s nominal refresh period: the compositor’s on Windows, else from refresh_hz.

§last_vblank: Option<u64>

When its last vblank was, in monotonic_ns’s clock, as info() was called. Off Windows it is extrapolated from the last frame shown, so it is known once one was.

Implementations§

Source§

impl SurfaceDisplay

Source

pub fn nits(&self, value: f32) -> Option<f32>

A surface value in nits, where the SDR white level is known.

Trait Implementations§

Source§

impl Clone for SurfaceDisplay

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SurfaceDisplay

Source§

impl Debug for SurfaceDisplay

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SurfaceDisplay

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SurfaceDisplay

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SurfaceDisplay

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more