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

UnknownIndex1LSBIndex1MSBIndex4LSBIndex4MSBIndex8RGB332RGB444RGB555BGR555ARGB4444RGBA4444ABGR4444BGRA4444ARGB1555RGBA5551ABGR1555BGRA5551RGB565BGR565RGB24BGR24RGB888RGBX8888BGR888BGRX8888ARGB8888RGBA8888ABGR8888BGRA8888ARGB2101010YV12IYUVYUY2UYVYYVYU

Methods

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

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

fn eq(&self, __arg_0: &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 !=.

impl Hash for PixelFormatEnum

fn hash<__H: Hasher>(&self, __arg_0: &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 Debug for PixelFormatEnum

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

Formats the value using the given formatter.

impl Into<SDL_PixelFormatEnum> for PixelFormatEnum

fn into(self) -> SDL_PixelFormatEnum

Performs the conversion.

impl From<PixelFormat> for PixelFormatEnum

fn from(pf: PixelFormat) -> PixelFormatEnum

Performs the conversion.

impl FromPrimitive for PixelFormatEnum

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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