Struct ImageFormat2

pub struct ImageFormat2 {
    pub pixel_format: PixelFormat,
    pub coded_width: u32,
    pub coded_height: u32,
    pub bytes_per_row: u32,
    pub display_width: u32,
    pub display_height: u32,
    pub layers: u32,
    pub color_space: ColorSpace,
    pub has_pixel_aspect_ratio: bool,
    pub pixel_aspect_ratio_width: u32,
    pub pixel_aspect_ratio_height: u32,
}

Describes how an image is represented.

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

Fields

pixel_format: PixelFormat

Pixel format.

coded_width: u32

Row width in pixels that exist in the buffer. Must be >= display_width. Can be < the width implied by stride_bytes.

coded_height: u32

Number of rows. Must be >= display_height.

bytes_per_row: u32

Stride in bytes of plane 0. Planes beyond plane 0 (if any, depending on pixel_format) have a known fixed relationship with plane 0’s stride. For Intel tiled textures, the stride is for the linearized version of the texture.

display_width: u32

Row width in pixels that are to be displayed. This can be <= coded_width. Any cropping occurs on the right of the image (not left).

display_height: u32

Number of rows to be displayed. This can be <= coded_height, with any cropping on the bottom (not top).

layers: u32

Number of layers within a multi-layered image.

color_space: ColorSpace

Color space.

has_pixel_aspect_ratio: bool

The pixel_aspect_ratio_width : pixel_aspect_ratio_height is the pixel aspect ratio (AKA sample aspect ratio aka SAR) for the luma (AKA Y) samples. A pixel_aspect_ratio of 1:1 mean square pixels. A pixel_aspect_ratio of 2:1 would mean pixels that are displayed twice as wide as they are tall. Codec implementation should ensure these two values are relatively prime by reducing the fraction (dividing both by GCF) if necessary.

When has_pixel_aspect_ratio == false, the pixel_aspect_ratio is unknown. A default of 1:1 can be appropriate in some cases, but as always, a consumer may determine the actual pixel_aspect_ratio by OOB means.

pixel_aspect_ratio_width: u32

pixel_aspect_ratio_height: u32

Trait Implementations

impl Clone for ImageFormat2

fn clone(&self) -> ImageFormat2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageFormat2

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

Formats the value using the given formatter.

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

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<ImageFormat2, D> for &ImageFormat2

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<D: ResourceDialect, T0: Encode<PixelFormat, D>, T1: Encode<u32, D>, T2: Encode<u32, D>, T3: Encode<u32, D>, T4: Encode<u32, D>, T5: Encode<u32, D>, T6: Encode<u32, D>, T7: Encode<ColorSpace, D>, T8: Encode<bool, D>, T9: Encode<u32, D>, T10: Encode<u32, D>> Encode<ImageFormat2, D> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

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 ImageFormat2

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 ImageFormat2

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

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

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

type Owned = ImageFormat2

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 ImageFormat2

type Borrowed<'a> = &'a ImageFormat2

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 ImageFormat2

impl Eq for ImageFormat2

impl Persistable for ImageFormat2

impl StructuralPartialEq for ImageFormat2