Enum PixelFormat 

#[non_exhaustive]
pub enum PixelFormat {
    I420,
    I422,
    I444,
    Nv12,
    P010,
    Rgba8,
    Bgra8,
}

How the samples are laid out.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

I420

Planar Y, U, V with chroma at half width and half height. What almost every consumer video decodes to.

I422

Planar, chroma at half width and full height.

I444

Planar, chroma at full resolution.

Nv12

Y plane then interleaved UV, half width and half height. What the hardware decoders hand back.

P010

NV12 at 10 bits, each sample in the top bits of a 16-bit word.

Rgba8

Packed 8-bit RGBA. Still images, and anything already converted.

Bgra8

Packed 8-bit BGRA, which is what several platform surfaces want.

Implementations

impl PixelFormat

pub fn plane_count(self) -> usize

How many separately-addressed planes there are.

pub fn bit_depth(self) -> u32

Bits per sample, per component.

pub fn bytes_per_sample(self) -> usize

Bytes each sample occupies, which is not the same as its bit depth: a 10-bit sample is stored in two bytes.

pub fn is_yuv(self) -> bool

Whether the planes are luma and chroma rather than colour.

pub fn chroma_shift(self) -> (u32, u32)

How far chroma is subsampled, as right-shifts of the luma dimensions.

(1, 1) for 4:2:0 — half width, half height. (0, 0) for anything with full-resolution colour.

pub fn plane_dimensions( self, plane: usize, width: u32, height: u32, ) -> Option<(u32, u32)>

The size of one plane in samples, for a picture of this size.

Chroma dimensions round up: a 1921-pixel-wide 4:2:0 picture has 961 chroma columns, not 960, and rounding down loses the last one.

pub fn samples_per_pixel(self, plane: usize) -> usize

Samples per pixel within one plane: 4 for packed RGBA, 2 for NV12’s interleaved chroma, 1 for a planar plane.

pub fn tight_stride(self, plane: usize, width: u32) -> usize

The tightest stride for a plane — no padding at all.

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PixelFormat

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Eq for PixelFormat

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 PartialEq for PixelFormat

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PixelFormat