Enum sdl2::pixels::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,
}

Variants

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

Methods

impl PixelFormatEnum

pub const RGBA32: PixelFormatEnum

pub const ARGB32: PixelFormatEnum

pub const BGRA32: PixelFormatEnum

pub const ABGR32: PixelFormatEnum

impl PixelFormatEnum

pub fn from_masks(masks: PixelMasks) -> PixelFormatEnum

pub fn into_masks(self) -> Result<PixelMasks, String>

pub fn byte_size_from_pitch_and_height(
    self,
    pitch: usize,
    height: usize
) -> usize

Calculates the total byte size of an image buffer, given its pitch and height.

pub fn byte_size_of_pixels(self, num_of_pixels: usize) -> usize

pub fn byte_size_per_pixel(self) -> usize

pub fn supports_alpha(self) -> bool

Trait Implementations

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 Copy for PixelFormatEnum

impl Debug for PixelFormatEnum

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

Formats the value using the given formatter.

impl Eq for PixelFormatEnum

impl From<PixelFormat> for PixelFormatEnum

fn from(pf: PixelFormat) -> PixelFormatEnum

Performs the conversion.

impl Hash for PixelFormatEnum

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, 

Feeds a slice of this type into the given [Hasher].

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 StructuralEq for PixelFormatEnum

impl StructuralPartialEq for PixelFormatEnum

impl TryFrom<PixelFormatEnum> for PixelFormat

type Error = String

The type returned in the event of a conversion error.

fn try_from(pfe: PixelFormatEnum) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for PixelFormatEnum

type Error = ()

The type returned in the event of a conversion error.

fn try_from(n: u32) -> Result<Self, Self::Error>

Performs the conversion.