Enum ColorSpace

pub enum ColorSpace {
    Invalid,
    Srgb,
    Rec601Ntsc,
    Rec601NtscFullRange,
    Rec601Pal,
    Rec601PalFullRange,
    Rec709,
    Rec2020,
    Rec2100,
    Passthrough,
    DoNotCare,
    // some variants omitted
}

Expresses the color space used to interpret video pixel values.

This list has a separate entry for each variant of a color space standard.

For this reason, should we ever add support for the RGB variant of 709, for example, we’d add a separate entry to this list for that variant. Similarly for the RGB variants of 2020 or 2100. Similarly for the YcCbcCrc variant of 2020. Similarly for the ICtCp variant of 2100.

See ImageFormatIsSupportedColorSpaceForPixelFormat() for whether a combination of PixelFormat and ColorSpace is potentially supported.

Generally, a ColorSpace is not supported for any PixelFormat whose bits-per-sample isn’t compatible with the color space’s spec, nor for any PixelFormat which is a mismatch in terms of RGB vs. YUV.

The “limited range” in comments below refers to where black and white are defined to be (and simimlar for chroma), but should not be interpreted as guaranteeing that there won’t be values outside the nominal “limited range”. In other words, “limited range” doesn’t necessarily mean there won’t be any values below black or above white, or outside the “limited” chroma range. For “full range”, black is 0 and white is the max possible/permitted numeric value (and similar for chroma).

Variants

Invalid

Not a valid color space type.

Srgb

sRGB, gamma transfer function and full range, per spec

Rec601Ntsc

601 NTSC (“525 line”) YCbCr primaries, limited range

Rec601NtscFullRange

601 NTSC (“525 line”) YCbCr primaries, full range

Rec601Pal

601 PAL (“625 line”) YCbCr primaries, limited range

Rec601PalFullRange

601 PAL (“625 line”) YCbCr primaries, full range

Rec709

709 YCbCr (not RGB), limited range

Rec2020

2020 YCbCr (not RGB, not YcCbcCrc), 10 or 12 bit according to PixelFormat, with primaries, limited range (not full range), transfer function (“gamma”), etc all per spec, wide color gamut SDR

Rec2100

2100 YCbCr (not RGB, not ICtCp), 10 or 12 bit according to PixelFormat, BT.2020 primaries (same wide color gamut as REC2020), limited range (not full range), PQ (aka SMPTE ST 2084) HDR transfer function (not HLG, not SDR “gamma” used by REC2020 and REC709), wide color gamut HDR

Passthrough

Either the pixel format doesn’t represent a color, or it’s in an application-specific colorspace that isn’t describable by another entry in this enum.

DoNotCare

A client is explicitly indicating that the client does not care which color space is chosen / used.

Implementations

impl ColorSpace

pub fn from_primitive(prim: u32) -> Option<Self>

pub fn from_primitive_allow_unknown(prim: u32) -> Self

pub fn unknown() -> Self

pub const fn into_primitive(self) -> u32

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Clone for ColorSpace

fn clone(&self) -> ColorSpace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorSpace

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<ColorSpace, D> for ColorSpace

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl<D: ResourceDialect> Encode<ColorSpace, D> for ColorSpace

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Hash for ColorSpace

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 Ord for ColorSpace

fn cmp(&self, other: &ColorSpace) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ColorSpace

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

fn partial_cmp(&self, other: &ColorSpace) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for ColorSpace

type Owned = ColorSpace

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for ColorSpace

type Borrowed<'a> = ColorSpace

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for ColorSpace

impl Eq for ColorSpace

impl StructuralPartialEq for ColorSpace