Enum ColorTransfer 

#[non_exhaustive]
pub enum ColorTransfer {
    Bt709,
    Bt2020_10,
    Bt2020_12,
    Hlg,
    Pq,
    Linear,
    Unknown,
}

Color transfer characteristic (opto-electronic transfer function).

The transfer characteristic defines how scene luminance maps to the signal level stored in the video bitstream. Different HDR and SDR standards use different curves.

Common Usage

• Bt709: Standard SDR video (HD television)
• Pq: HDR10 and Dolby Vision (SMPTE ST 2084 / Perceptual Quantizer)
• Hlg: Hybrid Log-Gamma — broadcast-compatible HDR (ARIB STD-B67)
• Bt2020_10 / Bt2020_12: BT.2020 SDR at 10/12-bit depth
• Linear: Linear light, no gamma applied

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bt709

ITU-R BT.709 transfer characteristic (standard SDR)

Bt2020_10

ITU-R BT.2020 for 10-bit content

Bt2020_12

ITU-R BT.2020 for 12-bit content

Hlg

Hybrid Log-Gamma (ARIB STD-B67) — broadcast HDR

Pq

Perceptual Quantizer / SMPTE ST 2084 — HDR10

Linear

Linear light transfer (no gamma)

Unknown

Transfer characteristic is not specified or unknown

Implementations

impl ColorTransfer

pub const fn name(&self) -> &'static str

Returns the name of the color transfer characteristic as a string.

Examples

use ff_format::color::ColorTransfer;

assert_eq!(ColorTransfer::Bt709.name(), "bt709");
assert_eq!(ColorTransfer::Hlg.name(), "hlg");
assert_eq!(ColorTransfer::Pq.name(), "pq");

pub const fn is_hdr(&self) -> bool

Returns true if this is an HDR transfer characteristic (Pq or Hlg).

Examples

use ff_format::color::ColorTransfer;

assert!(ColorTransfer::Pq.is_hdr());
assert!(ColorTransfer::Hlg.is_hdr());
assert!(!ColorTransfer::Bt709.is_hdr());

pub const fn is_hlg(&self) -> bool

Returns true if this is Hybrid Log-Gamma (HLG).

Examples

use ff_format::color::ColorTransfer;

assert!(ColorTransfer::Hlg.is_hlg());
assert!(!ColorTransfer::Pq.is_hlg());

pub const fn is_pq(&self) -> bool

Returns true if this is Perceptual Quantizer / SMPTE ST 2084 (PQ).

Examples

use ff_format::color::ColorTransfer;

assert!(ColorTransfer::Pq.is_pq());
assert!(!ColorTransfer::Hlg.is_pq());

pub const fn is_unknown(&self) -> bool

Returns true if the transfer characteristic is unknown.

Examples

use ff_format::color::ColorTransfer;

assert!(ColorTransfer::Unknown.is_unknown());
assert!(!ColorTransfer::Bt709.is_unknown());

Trait Implementations

impl Clone for ColorTransfer

fn clone(&self) -> ColorTransfer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorTransfer

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

Formats the value using the given formatter.

impl Default for ColorTransfer

fn default() -> ColorTransfer

Returns the “default value” for a type.

impl Display for ColorTransfer

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

Formats the value using the given formatter.

impl Hash for ColorTransfer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ColorTransfer

fn eq(&self, other: &ColorTransfer) -> 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 Copy for ColorTransfer

impl Eq for ColorTransfer

impl StructuralPartialEq for ColorTransfer