Skip to main content

ColorPolicy

Enum ColorPolicy 

Source
pub enum ColorPolicy {
    TonemapToSdr,
    Passthrough,
    Hdr10,
    Hlg,
}
Expand description

Output color policy — the gamut (which colors are representable) and the transfer curve (SDR vs HDR), plus whether to tonemap an HDR source down. This is the color half of the decision; bit depth is the separate BitDepth half (though the HDR variants here imply 10-bit on their own).

The decode pump never tonemaps on its own — this policy decides.

Glossary (the jargon these variants use):

  • BT.709 — the standard HD / SDR color gamut. What the vast majority of video uses; “SDR” output means BT.709.
  • BT.2020 — the wide gamut used by HDR: more saturated, deeper colors.
  • PQ (SMPTE ST 2084) — the HDR10 transfer curve (absolute brightness, up to 10,000 nits).
  • HLG (ARIB STD-B67) — the broadcast-friendly HDR transfer curve (relative brightness; degrades gracefully on SDR screens).
  • tonemap — squeeze an HDR signal’s brightness/gamut down into SDR so it looks right on ordinary (BT.709, 8-bit) screens.

Variants§

§

TonemapToSdr

SDR out. Tonemap HDR (PQ / HLG) sources down to 8-bit BT.709 SDR; SDR sources pass through unchanged. The default — maximally web-compatible. (Convenience builder: OutputSpec::web_sdr.)

§

Passthrough

Verbatim. Keep the source’s gamut, transfer, and bit depth as-is — no tonemap, no re-signaling. An HDR source stays HDR (needs a 10-bit encoder); an SDR source stays SDR. (Builder: OutputSpec::passthrough.)

§

Hdr10

HDR10 out. Force BT.2020 gamut + PQ transfer, 10-bit. Sets 10-bit on its own, so you do not also need BitDepth::TenBit. (Builder: OutputSpec::hdr10.)

§

Hlg

HLG out. Force BT.2020 gamut + HLG transfer, 10-bit. Implies 10-bit. (Builder: OutputSpec::hlg.)

Implementations§

Source§

impl ColorPolicy

Source

pub fn tonemaps(self) -> bool

Whether the decode pump tonemaps HDR→SDR under this policy.

Source

pub fn is_hdr(self) -> bool

Whether this policy signals HDR (PQ/HLG) in the output bitstream.

Trait Implementations§

Source§

impl Clone for ColorPolicy

Source§

fn clone(&self) -> ColorPolicy

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 ColorPolicy

Source§

impl Debug for ColorPolicy

Source§

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

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

impl Default for ColorPolicy

Source§

fn default() -> ColorPolicy

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

impl Eq for ColorPolicy

Source§

impl PartialEq for ColorPolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for ColorPolicy

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<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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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