Enum PixelFormat 

#[non_exhaustive]
pub enum PixelFormat {
    Gray8,
    Gray16,
    GrayA8,
    Rgb8,
    Rgba8,
    Rgb16,
    Rgba16,
    RgbF32,
    RgbaF32,
}

An interleaved pixel format: a ChannelLayout over a SampleKind.

The v1 set is exactly the formats listed in SPEC §Pixel formats. Samples are interleaved (RGBRGB…, not planar) and, for U16, stored in native endianness in memory — codecs convert at their own boundary.

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.

Gray8

8-bit grayscale.

Gray16

16-bit grayscale.

GrayA8

8-bit grayscale with alpha.

Rgb8

8-bit RGB.

Rgba8

8-bit RGBA.

Rgb16

16-bit RGB.

Rgba16

16-bit RGBA.

RgbF32

32-bit float RGB.

RgbaF32

32-bit float RGBA.

Implementations

impl PixelFormat

pub const ALL: &'static [PixelFormat]

Every pixel format supported in v1.

pub const fn layout(self) -> ChannelLayout

The channel layout of this format.

pub const fn from_parts( layout: ChannelLayout, kind: SampleKind, ) -> Option<PixelFormat>

The format with layout channels of kind samples, if v1 has one (there is no grey float, nor 16-bit grey with alpha).

pub const fn sample_kind(self) -> SampleKind

The sample type of this format.

pub const fn channels(self) -> usize

Number of channels per pixel.

pub const fn has_alpha(self) -> bool

Whether this format carries an alpha channel.

pub const fn bytes_per_pixel(self) -> usize

Size of one pixel in bytes.

This is exact: v1 formats are byte-aligned and interleaved, so there is no sub-byte packing to account for.

pub const fn as_str(self) -> &'static str

A short, stable, lowercase name for this format.

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

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<(), Error>

Formats the value using the given formatter.

impl Display for PixelFormat

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

Formats the value using the given formatter.

impl Eq for PixelFormat

impl Hash for PixelFormat

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

where __H: Hasher,

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PixelFormat