Enum ColorPrimaries 

#[non_exhaustive]
#[repr(u8)]
pub enum ColorPrimaries {
    Bt709 = 1,
    Bt2020 = 9,
    DisplayP3 = 12,
    AdobeRgb = 13,
    Unknown = 255,
}

Color primaries (CIE xy chromaticities of R, G, B) and white point.

Each variant is a complete “named recipe” — primaries and white point are an inseparable pair (following CICP convention). Use from_cicp() / to_cicp() for CICP mapping. Discriminant values are internal.

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

BT.709 / sRGB (CICP 1). White point: D65.

Bt2020 = 9

BT.2020 / BT.2100 (CICP 9). Wide gamut for HDR. White point: D65.

DisplayP3 = 12

Display P3 (CICP 12, SMPTE EG 432-1). Apple ecosystem. Same RGB primaries as DCI-P3, white point: D65.

AdobeRgb = 13

Adobe RGB (1998). Wide gamut. White point: D65.

Unknown = 255

Primaries not known.

Implementations

impl ColorPrimaries

pub const WHITE_D65: (f32, f32)

D65 white point (BT.709, BT.2020, Display P3, Adobe RGB).

pub const fn chromaticity(self) -> Option<((f32, f32), (f32, f32), (f32, f32))>

CIE 1931 xy chromaticity coordinates of the RGB primaries.

Returns ((rx, ry), (gx, gy), (bx, by)) or None for Unknown. These are the canonical coordinates from the relevant standards (ITU-R BT.709, BT.2020, SMPTE EG 432-1, etc.).

pub const fn from_cicp(code: u8) -> Option<ColorPrimaries>

Map a CICP color_primaries code to a ColorPrimaries.

pub const fn to_cicp(self) -> Option<u8>

Convert to the CICP color_primaries code.

pub const fn white_point(self) -> (f32, f32)

CIE 1931 xy chromaticity of this color space’s white point.

pub const fn gamut_matrix_to(self, dst: ColorPrimaries) -> Option<[[f32; 3]; 3]>

Compute the 3×3 linear RGB gamut conversion matrix from self to dst.

Bradford chromatic adaptation is applied automatically when white points differ (e.g., DCI-P3 D50 → sRGB D65). Returns None for Unknown primaries. Identity conversions (same primaries) return the identity matrix.

The matrix operates in linear light — apply EOTF before, OETF after.

let m = ColorPrimaries::DisplayP3.gamut_matrix_to(ColorPrimaries::Bt709).unwrap();
// White maps to white
let r = m[0][0] + m[0][1] + m[0][2];
assert!((r - 1.0).abs() < 1e-4);

pub const fn contains(self, other: ColorPrimaries) -> bool

Whether self fully contains the gamut of other.

Returns false when white points differ (cross-adapted containment is not defined without a chromatic adaptation transform). D65 hierarchy: BT.2020 > Display P3 > Adobe RGB ≈ BT.709.

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 ColorPrimariesExt for ColorPrimaries

fn to_xyz_matrix(&self) -> Option<&'static GamutMatrix>

Linear RGB → CIE XYZ (D65 white point).

fn from_xyz_matrix(&self) -> Option<&'static GamutMatrix>

CIE XYZ (D65 white point) → linear RGB.

impl Debug for ColorPrimaries

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

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<(), Error>

Formats the value using the given formatter.

impl Hash for ColorPrimaries

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

where __H: Hasher,

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 Copy for ColorPrimaries

impl Eq for ColorPrimaries

impl StructuralPartialEq for ColorPrimaries