Struct PixelFormat

Source
pub struct PixelFormat(/* private fields */);
Expand description

A FourCC code identifying a pixel format.

Implementations§

Source§

impl PixelFormat

Source

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.

Source

pub const NV21: Self

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

Source

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.

Source

pub const YUYV: Self

Identical to YUY2.

Source

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.

Source

pub const RGBA: Self

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

Source

pub const ARGB: Self

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

Source

pub const RGBX: Self

Packed 8-bit RGBX.

The X channel has unspecified values.

Source

pub const BGRA: Self

Packed 8-bit BGRA.

Source

pub const BGRX: Self

Packed 8-bit BGRX.

The X channel has unspecified values.

Source

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

Source

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

Source

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

Source

pub const fn to_u32_le(self) -> u32

Source

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§

Source§

impl Clone for PixelFormat

Source§

fn clone(&self) -> PixelFormat

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PixelFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for PixelFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<PixelFormat> for ImageFormat

Source§

fn from(value: PixelFormat) -> Self

Converts to this type from the input type.
Source§

impl Hash for PixelFormat

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PixelFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PixelFormat

Source§

impl Eq for PixelFormat

Source§

impl StructuralPartialEq for PixelFormat

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.