SDL_PixelFormat

sdl3_sys::pixels

Struct SDL_PixelFormat 

Source 
#[repr(transparent)]
pub struct SDL_PixelFormat(pub c_int);
Expand description

Pixel format.

SDL’s pixel formats have the following naming convention:

  • Names with a list of components and a single bit count, such as RGB24 and ABGR32, define a platform-independent encoding into bytes in the order specified. For example, in RGB24 data, each pixel is encoded in 3 bytes (red, green, blue) in that order, and in ABGR32 data, each pixel is encoded in 4 bytes (alpha, blue, green, red) in that order. Use these names if the property of a format that is important to you is the order of the bytes in memory or on disk.
  • Names with a bit count per component, such as ARGB8888 and XRGB1555, are “packed” into an appropriately-sized integer in the platform’s native endianness. For example, ARGB8888 is a sequence of 32-bit integers; in each integer, the most significant bits are alpha, and the least significant bits are blue. On a little-endian CPU such as x86, the least significant bits of each integer are arranged first in memory, but on a big-endian CPU such as s390x, the most significant bits are arranged first. Use these names if the property of a format that is important to you is the meaning of each bit position within a native-endianness integer.
  • In indexed formats such as INDEX4LSB, each pixel is represented by encoding an index into the palette into the indicated number of bits, with multiple pixels packed into each byte if appropriate. In LSB formats, the first (leftmost) pixel is stored in the least-significant bits of the byte; in MSB formats, it’s stored in the most-significant bits. INDEX8 does not need LSB/MSB variants, because each pixel exactly fills one byte.

The 32-bit byte-array encodings such as RGBA32 are aliases for the appropriate 8888 encoding for the current platform. For example, RGBA32 is an alias for ABGR8888 on little-endian CPUs like x86, or an alias for RGBA8888 on big-endian CPUs.

§Availability

This enum is available since SDL 3.2.0.

§Known values (sdl3-sys)

Associated constantGlobal constantDescription
UNKNOWNSDL_PIXELFORMAT_UNKNOWN
INDEX1LSBSDL_PIXELFORMAT_INDEX1LSB
INDEX1MSBSDL_PIXELFORMAT_INDEX1MSB
INDEX2LSBSDL_PIXELFORMAT_INDEX2LSB
INDEX2MSBSDL_PIXELFORMAT_INDEX2MSB
INDEX4LSBSDL_PIXELFORMAT_INDEX4LSB
INDEX4MSBSDL_PIXELFORMAT_INDEX4MSB
INDEX8SDL_PIXELFORMAT_INDEX8
RGB332SDL_PIXELFORMAT_RGB332
XRGB4444SDL_PIXELFORMAT_XRGB4444
XBGR4444SDL_PIXELFORMAT_XBGR4444
XRGB1555SDL_PIXELFORMAT_XRGB1555
XBGR1555SDL_PIXELFORMAT_XBGR1555
ARGB4444SDL_PIXELFORMAT_ARGB4444
RGBA4444SDL_PIXELFORMAT_RGBA4444
ABGR4444SDL_PIXELFORMAT_ABGR4444
BGRA4444SDL_PIXELFORMAT_BGRA4444
ARGB1555SDL_PIXELFORMAT_ARGB1555
RGBA5551SDL_PIXELFORMAT_RGBA5551
ABGR1555SDL_PIXELFORMAT_ABGR1555
BGRA5551SDL_PIXELFORMAT_BGRA5551
RGB565SDL_PIXELFORMAT_RGB565
BGR565SDL_PIXELFORMAT_BGR565
RGB24SDL_PIXELFORMAT_RGB24
BGR24SDL_PIXELFORMAT_BGR24
XRGB8888SDL_PIXELFORMAT_XRGB8888
RGBX8888SDL_PIXELFORMAT_RGBX8888
XBGR8888SDL_PIXELFORMAT_XBGR8888
BGRX8888SDL_PIXELFORMAT_BGRX8888
ARGB8888SDL_PIXELFORMAT_ARGB8888
RGBA8888SDL_PIXELFORMAT_RGBA8888
ABGR8888SDL_PIXELFORMAT_ABGR8888
BGRA8888SDL_PIXELFORMAT_BGRA8888
XRGB2101010SDL_PIXELFORMAT_XRGB2101010
XBGR2101010SDL_PIXELFORMAT_XBGR2101010
ARGB2101010SDL_PIXELFORMAT_ARGB2101010
ABGR2101010SDL_PIXELFORMAT_ABGR2101010
RGB48SDL_PIXELFORMAT_RGB48
BGR48SDL_PIXELFORMAT_BGR48
RGBA64SDL_PIXELFORMAT_RGBA64
ARGB64SDL_PIXELFORMAT_ARGB64
BGRA64SDL_PIXELFORMAT_BGRA64
ABGR64SDL_PIXELFORMAT_ABGR64
RGB48_FLOATSDL_PIXELFORMAT_RGB48_FLOAT
BGR48_FLOATSDL_PIXELFORMAT_BGR48_FLOAT
RGBA64_FLOATSDL_PIXELFORMAT_RGBA64_FLOAT
ARGB64_FLOATSDL_PIXELFORMAT_ARGB64_FLOAT
BGRA64_FLOATSDL_PIXELFORMAT_BGRA64_FLOAT
ABGR64_FLOATSDL_PIXELFORMAT_ABGR64_FLOAT
RGB96_FLOATSDL_PIXELFORMAT_RGB96_FLOAT
BGR96_FLOATSDL_PIXELFORMAT_BGR96_FLOAT
RGBA128_FLOATSDL_PIXELFORMAT_RGBA128_FLOAT
ARGB128_FLOATSDL_PIXELFORMAT_ARGB128_FLOAT
BGRA128_FLOATSDL_PIXELFORMAT_BGRA128_FLOAT
ABGR128_FLOATSDL_PIXELFORMAT_ABGR128_FLOAT
YV12SDL_PIXELFORMAT_YV12Planar mode: Y + V + U (3 planes)
IYUVSDL_PIXELFORMAT_IYUVPlanar mode: Y + U + V (3 planes)
YUY2SDL_PIXELFORMAT_YUY2Packed mode: Y0+U0+Y1+V0 (1 plane)
UYVYSDL_PIXELFORMAT_UYVYPacked mode: U0+Y0+V0+Y1 (1 plane)
YVYUSDL_PIXELFORMAT_YVYUPacked mode: Y0+V0+Y1+U0 (1 plane)
NV12SDL_PIXELFORMAT_NV12Planar mode: Y + U/V interleaved (2 planes)
NV21SDL_PIXELFORMAT_NV21Planar mode: Y + V/U interleaved (2 planes)
P010SDL_PIXELFORMAT_P010Planar mode: Y + U/V interleaved (2 planes)
EXTERNAL_OESSDL_PIXELFORMAT_EXTERNAL_OESAndroid video texture format
MJPGSDL_PIXELFORMAT_MJPGMotion JPEG
RGBA32SDL_PIXELFORMAT_RGBA32(target dependent)
ARGB32SDL_PIXELFORMAT_ARGB32(target dependent)
BGRA32SDL_PIXELFORMAT_BGRA32(target dependent)
ABGR32SDL_PIXELFORMAT_ABGR32(target dependent)
RGBX32SDL_PIXELFORMAT_RGBX32(target dependent)
XRGB32SDL_PIXELFORMAT_XRGB32(target dependent)
BGRX32SDL_PIXELFORMAT_BGRX32(target dependent)
XBGR32SDL_PIXELFORMAT_XBGR32(target dependent)

Tuple Fields§

§0: c_int

Implementations§

Source§

impl SDL_PixelFormat

Source

pub const UNKNOWN: Self

Source

pub const INDEX1LSB: Self

Source

pub const INDEX1MSB: Self

Source

pub const INDEX2LSB: Self

Source

pub const INDEX2MSB: Self

Source

pub const INDEX4LSB: Self

Source

pub const INDEX4MSB: Self

Source

pub const INDEX8: Self

Source

pub const RGB332: Self

Source

pub const XRGB4444: Self

Source

pub const XBGR4444: Self

Source

pub const XRGB1555: Self

Source

pub const XBGR1555: Self

Source

pub const ARGB4444: Self

Source

pub const RGBA4444: Self

Source

pub const ABGR4444: Self

Source

pub const BGRA4444: Self

Source

pub const ARGB1555: Self

Source

pub const RGBA5551: Self

Source

pub const ABGR1555: Self

Source

pub const BGRA5551: Self

Source

pub const RGB565: Self

Source

pub const BGR565: Self

Source

pub const RGB24: Self

Source

pub const BGR24: Self

Source

pub const XRGB8888: Self

Source

pub const RGBX8888: Self

Source

pub const XBGR8888: Self

Source

pub const BGRX8888: Self

Source

pub const ARGB8888: Self

Source

pub const RGBA8888: Self

Source

pub const ABGR8888: Self

Source

pub const BGRA8888: Self

Source

pub const XRGB2101010: Self

Source

pub const XBGR2101010: Self

Source

pub const ARGB2101010: Self

Source

pub const ABGR2101010: Self

Source

pub const RGB48: Self

Source

pub const BGR48: Self

Source

pub const RGBA64: Self

Source

pub const ARGB64: Self

Source

pub const BGRA64: Self

Source

pub const ABGR64: Self

Source

pub const RGB48_FLOAT: Self

Source

pub const BGR48_FLOAT: Self

Source

pub const RGBA64_FLOAT: Self

Source

pub const ARGB64_FLOAT: Self

Source

pub const BGRA64_FLOAT: Self

Source

pub const ABGR64_FLOAT: Self

Source

pub const RGB96_FLOAT: Self

Source

pub const BGR96_FLOAT: Self

Source

pub const RGBA128_FLOAT: Self

Source

pub const ARGB128_FLOAT: Self

Source

pub const BGRA128_FLOAT: Self

Source

pub const ABGR128_FLOAT: Self

Source

pub const YV12: Self

Planar mode: Y + V + U (3 planes)

Source

pub const IYUV: Self

Planar mode: Y + U + V (3 planes)

Source

pub const YUY2: Self

Packed mode: Y0+U0+Y1+V0 (1 plane)

Source

pub const UYVY: Self

Packed mode: U0+Y0+V0+Y1 (1 plane)

Source

pub const YVYU: Self

Packed mode: Y0+V0+Y1+U0 (1 plane)

Source

pub const NV12: Self

Planar mode: Y + U/V interleaved (2 planes)

Source

pub const NV21: Self

Planar mode: Y + V/U interleaved (2 planes)

Source

pub const P010: Self

Planar mode: Y + U/V interleaved (2 planes)

Source

pub const EXTERNAL_OES: Self

Android video texture format

Source

pub const MJPG: Self

Motion JPEG

Source

pub const RGBA32: Self = SDL_PIXELFORMAT_ABGR8888

Source

pub const ARGB32: Self = SDL_PIXELFORMAT_BGRA8888

Source

pub const BGRA32: Self = SDL_PIXELFORMAT_ARGB8888

Source

pub const ABGR32: Self = SDL_PIXELFORMAT_RGBA8888

Source

pub const RGBX32: Self = SDL_PIXELFORMAT_XBGR8888

Source

pub const XRGB32: Self = SDL_PIXELFORMAT_BGRX8888

Source

pub const BGRX32: Self = SDL_PIXELFORMAT_XRGB8888

Source

pub const XBGR32: Self = SDL_PIXELFORMAT_RGBX8888

Trait Implementations§

Source§

impl Clone for SDL_PixelFormat

Source§

fn clone(&self) -> SDL_PixelFormat

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SDL_PixelFormat

Available on crate feature debug-impls only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SDL_PixelFormat

Source§

fn default() -> SDL_PixelFormat

Returns the “default value” for a type. Read more
Source§

impl From<SDL_PixelFormat> for c_int

Source§

fn from(value: SDL_PixelFormat) -> Self

Converts to this type from the input type.
Source§

impl GroupMetadata for SDL_PixelFormat

Available on crate feature metadata only.
Source§

const GROUP_METADATA: &'static Group

Metadata for this group
Source§

impl Hash for SDL_PixelFormat

Source§

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

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

impl Ord for SDL_PixelFormat

Source§

fn cmp(&self, other: &SDL_PixelFormat) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq<SDL_PixelFormat> for c_int

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<i32> for SDL_PixelFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq for SDL_PixelFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for SDL_PixelFormat

Source§

fn partial_cmp(&self, other: &SDL_PixelFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for SDL_PixelFormat

Source§

impl Eq for SDL_PixelFormat

Source§

impl StructuralPartialEq for SDL_PixelFormat

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.