Enum PixelFormat

pub enum PixelFormat {
    I420,
    I422,
    I444,
    I010,
    I012,
    I210,
    I212,
    I410,
    I412,
    NV12,
    YUYV,
    RGBA,
    BGRA,
    RGB,
    BGR,
}

Supported pixel formats

Variants

I420

Y, U and V planes, 4:2:0 sub sampling, 8 bits per sample

I422

Y, U and V planes, 4:2:2 sub sampling, 8 bits per sample

I444

Y, U and V planes, 4:4:4 sub sampling, 8 bits per sample

I010

Y, U, and V planes, 4:2:0 sub sampling, 10 bits per sample

I012

Y, U, and V planes, 4:2:0 sub sampling, 12 bits per sample

I210

Y, U, and V planes, 4:2:2 sub sampling, 10 bits per sample

I212

Y, U, and V planes, 4:2:2 sub sampling, 10 bits per sample

I410

Y, U, and V planes, 4:4:4 sub sampling, 10 bits per sample

I412

Y, U, and V planes, 4:4:4 sub sampling, 12 bits per sample

NV12

Y and interleaved UV planes, 4:2:0 sub sampling

YUYV

Single YUYV, 4:2:2 sub sampling

RGBA

Single RGBA interleaved plane

BGRA

Single BGRA interleaved plane

RGB

Single RGB interleaved plane

BGR

Single BGR interleaved plane

Implementations

impl PixelFormat

pub fn buffer_size(self, width: usize, height: usize) -> usize

Calculate the required buffer size given the PixelFormat self and image dimensions (in pixel width, height).

The size is the amount of primitives (u8, u16) so when allocating size this must be accounted for.

pub fn packed_strides(self, width: usize) -> Vec<usize>

Calculate the strides of an image in a packed buffer

pub fn bounds_check<'a>( self, planes: impl Iterator<Item = (&'a [u8], usize)>, width: usize, height: usize, ) -> Result<(), BoundsCheckError>

Check if the given planes+strides are valid for dimensions

pub fn bits_per_component(&self) -> usize

pub fn variants() -> impl IntoIterator<Item = Self>

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

impl Eq for PixelFormat

impl StructuralPartialEq for PixelFormat