Enum PixelFormatType

#[repr(u32)]
pub enum PixelFormatType {
    Invalid = 0,
    R8G8B8A8 = 1,
    Bgra32 = 101,
    I420 = 102,
    M420 = 103,
    Nv12 = 104,
    Yuy2 = 105,
    Mjpeg = 106,
    Yv12 = 107,
    Bgr24 = 108,
    Rgb565 = 109,
    Rgb332 = 110,
    Rgb2220 = 111,
    L8 = 112,
    R8 = 113,
    R8G8 = 114,
    A2R10G10B10 = 115,
    A2B10G10R10 = 116,
    DoNotCare = 4_294_967_294,
}

The ordering of the channels in the format name reflects how the actual layout of the channel.

Each of these values is opinionated re. the color spaces that can be contained within (in contrast with Vulkan).

This should be kept in sync with fuchsia.sysmem2.PixelFormatType.

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

Variants

Invalid = 0

R8G8B8A8 = 1

RGB only, 8 bits per each of R/G/B/A sample Compatible with VK_FORMAT_R8G8B8A8_UNORM.

Bgra32 = 101

32bpp BGRA, 1 plane. RGB only, 8 bits per each of B/G/R/A sample. Compatible with VK_FORMAT_B8G8R8A8_UNORM.

I420 = 102

YUV only, 8 bits per Y sample Compatible with VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM.

M420 = 103

YUV only, 8 bits per Y sample Not compatible with any vulkan format.

Nv12 = 104

YUV only, 8 bits per Y sample Compatible with VK_FORMAT_G8_B8R8_2PLANE_420_UNORM.

Yuy2 = 105

YUV only, 8 bits per Y sample Compatible with VK_FORMAT_G8B8G8R8_422_UNORM.

Mjpeg = 106

Yv12 = 107

YUV only, 8 bits per Y sample Compatible with VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM. The U plane may be located in either the B or R plane for the image (and likewise for the V plane); the ordering may be determined by looking at the members of VkBufferCollectionPropertiesFUCHSIA.samplerYcbcrConversionComponents.

Bgr24 = 108

24bpp BGR, 1 plane. RGB only, 8 bits per each of B/G/R sample Compatible with VK_FORMAT_B8G8R8_UNORM.

Rgb565 = 109

16bpp RGB, 1 plane. 5 bits R, 6 bits G, 5 bits B Compatible with VK_FORMAT_R5G6B5_UNORM_PACK16.

Rgb332 = 110

8bpp RGB, 1 plane. 3 bits R, 3 bits G, 2 bits B Not compatible with any vulkan format.

Rgb2220 = 111

8bpp RGB, 1 plane. 2 bits R, 2 bits G, 2 bits B Not compatible with any vulkan format.

L8 = 112

8bpp, Luminance-only (red, green and blue have identical values.) Compatible with VK_FORMAT_R8_UNORM.

R8 = 113

8bpp, Red-only (Green and Blue are to be interpreted as 0). Compatible with VK_FORMAT_R8_UNORM.

R8G8 = 114

16bpp RG, 1 plane. 8 bits R, 8 bits G. Compatible with VK_FORMAT_R8G8_UNORM.

A2R10G10B10 = 115

32bpp RGBA, 1 plane. 2 bits A, 10 bits R/G/B. Compatible with VK_FORMAT_A2R10G10B10_UNORM_PACK32.

A2B10G10R10 = 116

32bpp BGRA, 1 plane. 2 bits A, 10 bits R/G/B. Compatible with VK_FORMAT_A2B10G10R10_UNORM_PACK32.

DoNotCare = 4_294_967_294

The sysmem client is explicitly indicating that the sysmem client does not care which pixel format is chosen / used. When setting this value, the sysmem client must not set format_modifier_value.

Implementations

impl PixelFormatType

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

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 PixelFormatType

fn clone(&self) -> PixelFormatType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormatType

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

Formats the value using the given formatter.

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

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<PixelFormatType, D> for PixelFormatType

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 PixelFormatType

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 PixelFormatType

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

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

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

type Owned = PixelFormatType

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 PixelFormatType

type Borrowed<'a> = PixelFormatType

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 PixelFormatType

impl Eq for PixelFormatType

impl StructuralPartialEq for PixelFormatType