Enum sdl2::pixels::PixelFormatEnum

source · [−]

#[repr(i32)]
pub enum PixelFormatEnum {
Show 36 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,
}

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

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for PixelFormatEnum

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

Formats the value using the given formatter. Read more

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. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

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

1.0.0 · source

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

This method tests for !=.

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.

impl Copy for PixelFormatEnum

impl Eq for PixelFormatEnum

impl StructuralEq for PixelFormatEnum

impl StructuralPartialEq for PixelFormatEnum

Auto Trait Implementations

impl RefUnwindSafe for PixelFormatEnum

impl Send for PixelFormatEnum

impl Sync for PixelFormatEnum

impl Unpin for PixelFormatEnum

impl UnwindSafe for PixelFormatEnum

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.