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

Implementations

impl PixelFormatEnum

pub const RGBA32: PixelFormatEnum = PixelFormatEnum::ABGR8888

pub const ARGB32: PixelFormatEnum = PixelFormatEnum::BGRA8888

pub const BGRA32: PixelFormatEnum = PixelFormatEnum::ARGB8888

pub const ABGR32: PixelFormatEnum = PixelFormatEnum::RGBA8888

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

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

Formats the value using the given formatter.

impl From<PixelFormat> for PixelFormatEnum

fn from(pf: PixelFormat) -> PixelFormatEnum

Converts to this type from the input type.

impl FromPrimitive for PixelFormatEnum

fn from_i64(n: i64) -> Option<PixelFormatEnum>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<PixelFormatEnum>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<u32> for PixelFormatEnum

fn into(self) -> uint32_t

Converts this type into the (usually inferred) input type.

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 ==.

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 PixelFormatEnum

impl Eq for PixelFormatEnum

impl StructuralEq for PixelFormatEnum

impl StructuralPartialEq for PixelFormatEnum