Enum rich_sdl2_rust::color::pixel::kind::PixelFormatKind

#[non_exhaustive]
pub enum PixelFormatKind {
    Unknown,
    Bitmap {
        ty: BitmapPixelType,
        order: BitmapPixelOrder,
    },
    Packed {
        ty: PackedPixelType,
        order: PackedPixelOrder,
        layout: PackedPixelLayout,
    },
    Array {
        ty: ArrayPixelType,
        order: ArrayPixelOrder,
    },
    FourCode([u8; 4]),
}

A kind of pixel format.

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.

Unknown

A format not supported by SDL2.

Bitmap

Fields

ty: BitmapPixelType

The type of the bitmap.

order: BitmapPixelOrder

The type of the bitmap.

An indexed bitmap format with a palette.

Packed

Fields

ty: PackedPixelType

The type of the pack.

order: PackedPixelOrder

The order of the pack.

layout: PackedPixelLayout

The layout of the pack.

A packed pixel format.

Array

Fields

ty: ArrayPixelType

The type of the array.

order: ArrayPixelOrder

The order of the array.

A pixel array format.

FourCode([u8; 4])

A special format such as YUV in FourCC code.

Implementations

impl PixelFormatKind

pub fn from_bpp_mask(_: BppMask) -> Self

Constructs from BppMask.

pub fn to_bpp_mask(&self) -> Option<BppMask>

Converts to BppMask, if able to do.

pub fn name(&self) -> &'static str

Returns the name for the pixel format, or empty string if does not exist.

Trait Implementations

impl Clone for PixelFormatKind

fn clone(&self) -> PixelFormatKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormatKind

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

Formats the value using the given formatter.

impl Hash for PixelFormatKind

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 PixelFormatKind

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PixelFormatKind

impl Eq for PixelFormatKind

impl StructuralPartialEq for PixelFormatKind