Enum beryllium::PixelFormatEnum

#[repr(i32)]
pub enum PixelFormatEnum {
    Unknown,
    Index1lsb,
    Index1msb,
    Index4lsb,
    Index4msb,
    Index8,
    RGB332,
    RGB444,
    RGB555,
    BGR555,
    ARGB4444,
    RGBA4444,
    ABGR4444,
    BGRA4444,
    ARGB1555,
    RGBA5551,
    ABGR1555,
    BGRA5551,
    RGB565,
    BGR565,
    RGB24,
    BGR24,
    RGB888,
    RGBX8888,
    BGR888,
    BGRX8888,
    ARGB8888,
    RGBA8888,
    ABGR8888,
    BGRA8888,
    ARGB2101010,
    YV12,
    IYUV,
    YUY2,
    UYVY,
    YVYU,
    NV12,
    NV21,
    ExternalOES,
}

The various named pixel formats that SDL2 supports.

There's various checks you can perform on each pixel format.

Note that the "fourcc" formats, anything that gives true from the is_fourcc method, are industry specified special values, and do not follow SDL2's bit packing scheme. In other words, the output they produce for any of the other check methods is not to really be trusted.

Variants

UnknownIndex1lsbIndex1msbIndex4lsbIndex4msbIndex8RGB332RGB444RGB555BGR555ARGB4444RGBA4444ABGR4444BGRA4444ARGB1555RGBA5551ABGR1555BGRA5551RGB565BGR565RGB24BGR24RGB888RGBX8888BGR888BGRX8888ARGB8888RGBA8888ABGR8888BGRA8888ARGB2101010YV12

Planar mode: Y + V + U (3 planes)

IYUV

Planar mode: Y + U + V (3 planes)

YUY2

Packed mode: Y0+U0+Y1+V0 (1 plane)

UYVY

Packed mode: U0+Y0+V0+Y1 (1 plane)

YVYU

Packed mode: Y0+V0+Y1+U0 (1 plane)

NV12

Planar mode: Y + U/V interleaved (2 planes)

NV21

Planar mode: Y + V/U interleaved (2 planes)

ExternalOES

Android video texture format

Methods

impl PixelFormatEnum

pub const RGBA32: Self

Platform specific alias for RGBA

pub const ARGB32: Self

Platform specific alias for ARGB

pub const BGRA32: Self

Platform specific alias for BGRA

pub const ABGR32: Self

Platform specific alias for ABGR

impl PixelFormatEnum

pub fn pixel_type(self) -> PixelType

The type of the pixel format.

All unknown types convert to PixelType::Unknown, of course.

pub fn pixel_order(self) -> PixelOrder

Ordering of channel or bits in the pixel format.

Unknown values convert to one of the None variants.

pub fn pixel_layout(self) -> PixelLayout

Channel bits pattern of the pixel format.

Converts any possible unknown layout to PixelLayout::None.

pub fn bits_per_pixel(self) -> u32

Bits of color information per pixel.

pub fn bytes_per_pixel(self) -> u32

Bytes used per pixel.

Note: Formats with less than 8 bits per pixel give a result of 0 bytes per pixel. Weird and all, but that's how it is.

pub fn is_indexed(self) -> bool

Is this format an indexed format?

pub fn is_packed(self) -> bool

Is this format a packed format?

pub fn is_array(self) -> bool

Is this format a packed format?

pub fn is_alpha(self) -> bool

Is this format a format with an alpha channel?

pub fn is_fourcc(self) -> bool

Is this a four-character code format?

True for pixel formats representing unique formats, for example YUV formats.

Trait Implementations

impl From<i32> for PixelFormatEnum

fn from(pf: Type) -> Self

Performs the conversion.

impl PartialEq<PixelFormatEnum> for PixelFormatEnum

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for PixelFormatEnum

fn clone(&self) -> PixelFormatEnum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PixelFormatEnum

impl Copy for PixelFormatEnum

impl Debug for PixelFormatEnum

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

Formats the value using the given formatter.