Struct ColorInfo 

#[non_exhaustive]
pub struct ColorInfo {
    pub range: ColorRange,
    pub primaries: u8,
    pub transfer: u8,
    pub matrix: u8,
}

The H.273 colour description of a picture: nominal range plus the ColourPrimaries / TransferCharacteristics / MatrixCoefficients code points (one byte each on the wire).

Filled from the item’s colr nclx on decode; when a file carries none (or only an ICC colr) the MIAF §7.3.6.4 default applies — BT.709 primaries (1), sRGB transfer (13), BT.601 matrix (6), full range — which is also Default here.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

range: ColorRange

Nominal sample range.

primaries: u8

H.273 §8.1 ColourPrimaries (1 = BT.709, 9 = BT.2020, 12 = Display P3, 2 = unspecified).

transfer: u8

H.273 §8.2 TransferCharacteristics (13 = sRGB, 16 = PQ, 18 = HLG, 2 = unspecified).

matrix: u8

H.273 §8.3 MatrixCoefficients (0 = identity / RGB, 1 = BT.709, 6 = BT.601, 9 = BT.2020 NCL, 2 = unspecified).

Implementations

impl ColorInfo

pub const fn new( range: ColorRange, primaries: u8, transfer: u8, matrix: u8, ) -> Self

Every field as a positional argument, in declaration order.

pub const fn miaf_default() -> Self

The MIAF §7.3.6.4 default for an item without CICP: BT.709 primaries, sRGB transfer, BT.601 matrix, full range.

pub const fn identity_full_range() -> Self

The description the RGB constructors use: BT.709 primaries, sRGB transfer, the identity matrix (planes are G, B, R), full range.

pub fn from_colr(colr: Option<&Colr>) -> Self

The effective colour of an item from its colr (MIAF §7.3.6.4): the nclx code points as signalled, else Self::miaf_default. Code points past 255 read as unspecified (2).

pub fn to_colr(&self) -> Colr

The colr nclx property carrying this description.

pub fn is_identity_matrix(&self) -> bool

true for MatrixCoefficients == 0: the planes are G, B, R.

pub fn with_range(self, range: ColorRange) -> Self

Setter: replace range.

pub fn with_primaries(self, primaries: u8) -> Self

Setter: replace primaries.

pub fn with_transfer(self, transfer: u8) -> Self

Setter: replace transfer.

pub fn with_matrix(self, matrix: u8) -> Self

Setter: replace matrix.

Trait Implementations

impl Clone for ColorInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ColorInfo

impl Debug for ColorInfo

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

Formats the value using the given formatter.

impl Default for ColorInfo

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ColorInfo

impl From<ColorSignal> for ColorInfo

fn from(s: ColorSignal) -> Self

Converts to this type from the input type.

impl PartialEq for ColorInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColorInfo