Struct PixelFormat

pub struct PixelFormat(/* private fields */);

A FourCC code identifying a pixel format.

Implementations

impl PixelFormat

pub const NV12: Self

Planar YUV 4:2:0 standard pixel format.

All samples are 8 bits in size. The plane containing Y samples comes first, followed by a plane storing packed U and V samples (with U samples in the first byte and V samples in the second byte).

This format is widely supported by hardware codecs (and often the only supported format), so it should be supported by all software, and may be used as the default format.

pub const NV21: Self

Planar YUV 4:2:0 pixel format, with U and V swapped compared to NV12.

pub const YUY2: Self

Interleaved YUV 4:2:2, stored in memory as yyyyyyyy uuuuuuuu YYYYYYYY vvvvvvvv.

uuuuuuuu and vvvvvvvv are shared by 2 horizontally neighboring pixels.

Also known as YUYV.

pub const YUYV: Self

Identical to YUY2.

pub const UYVY: Self

Interleaved YUV 4:2:2, stored in memory as uuuuuuuu yyyyyyyy vvvvvvvv YYYYYYYY.

uuuuuuuu and vvvvvvvv are shared by 2 neighboring pixels.

pub const RGBA: Self

RGBA: Packed 8-bit RGBA, stored in memory as aaaaaaaa bbbbbbbb gggggggg rrrrrrrr.

pub const ARGB: Self

ARGB: Packed 8-bit RGBA, stored in memory as bbbbbbbb gggggggg rrrrrrrr aaaaaaaa.

pub const RGBX: Self

Packed 8-bit RGBX.

The X channel has unspecified values.

pub const BGRA: Self

Packed 8-bit BGRA.

pub const BGRX: Self

Packed 8-bit BGRX.

The X channel has unspecified values.

pub const fn from_bytes(fourcc: [u8; 4]) -> Self

pub const fn from_u32_le(fourcc: u32) -> Self

pub const fn to_bytes(self) -> [u8; 4]

pub const fn to_u32_le(self) -> u32

pub fn to_rtformat(self) -> Option<RTFormat>

Returns a surface RTFormat compatible with this PixelFormat.

Returns None when self is an unknown or unhandled PixelFormat.

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

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

Formats the value using the given formatter.

impl From<PixelFormat> for ImageFormat

fn from(value: PixelFormat) -> Self

Converts to this type from the input type.

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

impl Eq for PixelFormat

impl StructuralPartialEq for PixelFormat