Enum ColorSpaceType

#[repr(u32)]
pub enum ColorSpaceType {
    Invalid = 0,
    Srgb = 1,
    Rec601Ntsc = 2,
    Rec601NtscFullRange = 3,
    Rec601Pal = 4,
    Rec601PalFullRange = 5,
    Rec709 = 6,
    Rec2020 = 7,
    Rec2100 = 8,
    PassThrough = 9,
    DoNotCare = 4_294_967_294,
}

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.

A given ColorSpaceType may permit usage with a PixelFormatType(s) that provides a bits-per-sample that’s compatible with the ColorSpaceType’s official spec. Not all spec-valid combinations are necessarily supported. See ImageFormatIsSupportedColorSpaceForPixelFormat() for the best-case degree of support, but a “true” from that function doesn’t guarantee that any given combination of participants will all support the desired combination of ColorSpaceType and PixelFormatType.

The sysmem service helps find a mutually supported combination and allocate suitable buffers.

A ColorSpaceType’s spec is not implicitly extended to support outside-the-standard bits-per-sample (R, G, B, or Y sample). For example, for 2020 and 2100, 8 bits-per-Y-sample is not supported (by sysmem), because 8 bits-per-Y-sample is not in the spec for 2020 or 2100. A sysmem participant that attempts to advertise support for a PixelFormat + ColorSpace that’s non-standard will cause sysmem to reject the combo and fail to allocate (intentionally, to strongly discourage specifying insufficiently-defined combos).

This type is deprecated for new code, but is still used by some camera code.

Variants

Invalid = 0

Not a valid color space type.

Srgb = 1

sRGB

Rec601Ntsc = 2

601 NTSC (“525 line”) YCbCr primaries, narrow

Rec601NtscFullRange = 3

601 NTSC (“525 line”) YCbCr primaries, wide

Rec601Pal = 4

601 PAL (“625 line”) YCbCr primaries, narrow

Rec601PalFullRange = 5

601 PAL (“625 line”) YCbCr primaries, wide

Rec709 = 6

709 YCbCr (not RGB)

Rec2020 = 7

2020 YCbCr (not RGB, not YcCbcCrc)

Rec2100 = 8

2100 YCbCr (not RGB, not ICtCp)

PassThrough = 9

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 = 4_294_967_294

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

Implementations

impl ColorSpaceType

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

pub const fn into_primitive(self) -> u32

pub fn is_unknown(&self) -> bool

👎Deprecated: Strict enums should not use is_unknown

Trait Implementations

impl Clone for ColorSpaceType

fn clone(&self) -> ColorSpaceType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorSpaceType

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

Formats the value using the given formatter.

impl<D> Decode<ColorSpaceType, D> for ColorSpaceType

where D: ResourceDialect,

fn new_empty() -> ColorSpaceType

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

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

impl<D> Encode<ColorSpaceType, D> for ColorSpaceType

where D: ResourceDialect,

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

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

impl Hash for ColorSpaceType

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

fn cmp(&self, other: &ColorSpaceType) -> 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 ColorSpaceType

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

fn partial_cmp(&self, other: &ColorSpaceType) -> 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 ColorSpaceType

type Owned = ColorSpaceType

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 ColorSpaceType

type Borrowed<'a> = ColorSpaceType

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: &<ColorSpaceType as TypeMarker>::Owned, ) -> <ColorSpaceType as ValueTypeMarker>::Borrowed<'_>

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

impl Copy for ColorSpaceType

impl Eq for ColorSpaceType

impl StructuralPartialEq for ColorSpaceType