Struct PixelFormat

pub struct PixelFormat { /* private fields */ }

Available on crate feature dep_sdl3 only.

A pixel format, i.e. a set of masks that define how to pack and unpack pixel data. This is used to convert between pixel data and surface data. It wraps an SDL_PixelFormat.

Implementations

impl PixelFormat

pub const unsafe fn raw(&self) -> SDL_PixelFormat

impl PixelFormat

pub const unsafe fn from_ll(raw: SDL_PixelFormat) -> PixelFormat

impl PixelFormat

pub unsafe fn unknown() -> PixelFormat

pub unsafe fn pixel_format_details(&self) -> *const SDL_PixelFormatDetails

pub fn from_masks(masks: PixelMasks) -> PixelFormat

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

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 PixelFormat

fn clone(&self) -> PixelFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl From<PixelFormat> for SDL_PixelFormat

fn from(pf: PixelFormat) -> SDL_PixelFormat

Converts to this type from the input type.

impl From<i64> for PixelFormat

fn from(format: i64) -> PixelFormat

Converts to this type from the input type.

impl Hash for PixelFormat

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<SDL_PixelFormat> for PixelFormat

type Error = Error

The type returned in the event of a conversion error.

fn try_from( format: SDL_PixelFormat, ) -> Result<PixelFormat, <PixelFormat as TryFrom<SDL_PixelFormat>>::Error>

Performs the conversion.

impl Copy for PixelFormat

impl Eq for PixelFormat

impl StructuralPartialEq for PixelFormat