Enum PixelFormat

pub enum PixelFormat {
    Invalid,
    R8G8B8A8,
    R8G8B8X8,
    B8G8R8A8,
    B8G8R8X8,
    I420,
    M420,
    Nv12,
    Yuy2,
    Mjpeg,
    Yv12,
    B8G8R8,
    R5G6B5,
    R3G3B2,
    R2G2B2X2,
    L8,
    R8,
    R8G8,
    A2R10G10B10,
    A2B10G10R10,
    P010,
    R8G8B8,
    DoNotCare,
    // some variants omitted
}

Expresses the manner in which video pixels are encoded.

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

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

Variants

Invalid

R8G8B8A8

RGB only, 8 bits per each of R/G/B/A sample

If A is actually X (not set to meaningful values), that can be specified by settting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to false.

If A is known to be set to meaningful values, that can be specified by setting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to true.

Compatible with VK_FORMAT_R8G8B8A8_UNORM.

R8G8B8X8

RGB only, 8 bits per each of R/G/B/X sample

Compatible with VK_FORMAT_R8G8B8A8_UNORM, when treated as opaque.

Deprecated. Use R8G8B8A8 with [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] set to false instead.

B8G8R8A8

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

Compatible with VK_FORMAT_B8G8R8A8_UNORM.

If A is actually X (not set to meaningful values), that can be specified by settting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to false.

If A is known to be set to meaningful values, that can be specified by setting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to true.

In sysmem(1), this is BGRA32.

B8G8R8X8

32bpp BGRA, 1 plane. RGB only, 8 bits per each of B/G/R/X sample.

Compatible with VK_FORMAT_B8G8R8A8_UNORM, when treated as opaque.

Deprecated. Use B8G8R8A8 with [fuchsia.sysemm2/ImageFormatConstraints.is_alpha_present] set to false instead.

I420

YUV only, 8 bits per Y sample

Compatible with VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM.

M420

YUV only, 8 bits per Y sample

Not compatible with any vulkan format.

Nv12

YUV only, 8 bits per Y sample

Compatible with VK_FORMAT_G8_B8R8_2PLANE_420_UNORM.

Yuy2

YUV only, 8 bits per Y sample

Compatible with VK_FORMAT_G8B8G8R8_422_UNORM.

Mjpeg

This value is reserved, and not currently used.

Yv12

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.

B8G8R8

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

Compatible with VK_FORMAT_B8G8R8_UNORM.

In sysmem(1), this is BGR24.

R5G6B5

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

Compatible with VK_FORMAT_R5G6B5_UNORM_PACK16.

In sysmem(1), this is RGB565.

R3G3B2

8bpp RGB, 1 plane. 3 bits R, 3 bits G, 2 bits B

Not compatible with any vulkan format.

In sysmem(1), this is RGB332.

R2G2B2X2

8bpp RGB, 1 plane. 2 bits R, 2 bits G, 2 bits B

Not compatible with any vulkan format.

If X is actually X (not set to meaningful values), that can be specified by settting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to false.

If X is known to be set to meaningful values, that can be specified by setting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to true.

In sysmem(1), this is RGB2220.

L8

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

Compatible with VK_FORMAT_R8_UNORM.

Most clients will prefer to use R8 instead.

R8

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

Compatible with VK_FORMAT_R8_UNORM.

R8G8

16bpp RG, 1 plane. 8 bits R, 8 bits G.

Compatible with VK_FORMAT_R8G8_UNORM.

A2R10G10B10

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

If A is actually X (not set to meaningful values), that can be specified by settting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to false.

If A is known to be set to meaningful values, that can be specified by setting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to true.

Compatible with VK_FORMAT_A2R10G10B10_UNORM_PACK32.

A2B10G10R10

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

If A is actually X (not set to meaningful values), that can be specified by settting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to false.

If A is known to be set to meaningful values, that can be specified by setting [‘fuchsia.sysemm2.ImageFormatConstraints.is_alpha_present’] to true.

Compatible with VK_FORMAT_A2B10G10R10_UNORM_PACK32.

P010

YUV only, 16 bits per Y sample

This is like NV12 but with 16 bit samples that have the bottom 6 bits of each sample set to zero and/or ignored. The endianess of each 16 bit sample is host endian-ness (LE on LE system, BE on BE system). The CbCr plane has 16 bit Cb first, then 16 bit Cr, interleaved Cb Cr Cb Cr etc.

Compatible with VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16.

R8G8B8

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

Compatible with VK_FORMAT_R8G8B8_UNORM.

DoNotCare

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

Implementations

impl PixelFormat

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 PixelFormat

fn clone(&self) -> PixelFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormat

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

Formats the value using the given formatter.

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

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

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 PixelFormat

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 PixelFormat

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

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

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

type Owned = PixelFormat

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 PixelFormat

type Borrowed<'a> = PixelFormat

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 PixelFormat

impl Eq for PixelFormat

impl StructuralPartialEq for PixelFormat