Enum ColorPrimaries 

#[non_exhaustive]
pub enum ColorPrimaries {
    Bt709,
    Bt470bg,
    Smpte170m,
    Smpte240m,
    Film,
    DciP3,
    DisplayP3,
    Bt2020,
    Unknown,
}

Color primaries defining the color gamut (the range of colors that can be represented).

Different standards define different primary colors (red, green, blue points) which determine the overall range of colors that can be displayed.

Common Usage

• BT.709: HD content, same as sRGB primaries
• BT.470BG / SMPTE-170M: SD content (PAL/SECAM / NTSC)
• DCI-P3 / Display P3: digital cinema and wide-gamut displays
• BT.2020: Wide color gamut for UHD/HDR

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 primaries (same as sRGB, most common)

Bt470bg

ITU-R BT.470BG primaries (PAL/SECAM SD video)

Smpte170m

SMPTE 170M primaries (NTSC SD video)

Smpte240m

SMPTE 240M primaries (legacy HD)

Film

Generic film primaries (Illuminant C)

DciP3

DCI-P3 primaries (SMPTE RP 431-2, digital cinema)

DisplayP3

Display P3 primaries (SMPTE EG 432-1, wide-gamut displays)

Bt2020

ITU-R BT.2020 primaries (wide color gamut for UHD/HDR)

Unknown

Color primaries are not specified or unknown

Implementations

impl ColorPrimaries

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

Returns the name of the color primaries as a human-readable string.

Examples

use ff_format::color::ColorPrimaries;

assert_eq!(ColorPrimaries::Bt709.name(), "bt709");
assert_eq!(ColorPrimaries::Bt2020.name(), "bt2020");

pub const fn is_wide_gamut(&self) -> bool

Returns true if this uses a wide color gamut (BT.2020, DCI-P3, or Display P3).

Examples

use ff_format::color::ColorPrimaries;

assert!(ColorPrimaries::Bt2020.is_wide_gamut());
assert!(ColorPrimaries::DciP3.is_wide_gamut());
assert!(!ColorPrimaries::Bt709.is_wide_gamut());

pub const fn is_unknown(&self) -> bool

Returns true if the color primaries are unknown.

Examples

use ff_format::color::ColorPrimaries;

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

Trait Implementations

impl Clone for ColorPrimaries

fn clone(&self) -> ColorPrimaries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ColorPrimaries

impl Debug for ColorPrimaries

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

Formats the value using the given formatter.

impl Default for ColorPrimaries

fn default() -> ColorPrimaries

Returns the “default value” for a type.

impl Display for ColorPrimaries

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

Formats the value using the given formatter.

impl Eq for ColorPrimaries

impl Hash for ColorPrimaries

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 ColorPrimaries

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