Struct rich_sdl2_rust::color::pixel::PixelFormat

pub struct PixelFormat { /* private fields */ }

A pixel format.

Implementations

impl PixelFormat

pub fn new(kind: PixelFormatKind) -> Result<Self>

Constructs a pixel format from PixelFormatKind.

Errors

Returns Err if failed to allocate the memory for the format, or construct the format.

pub fn kind(&self) -> PixelFormatKind

Returns the kind of the format.

pub fn bits_per_pixel(&self) -> u8

Returns the bits per pixel of the format.

pub fn bytes_per_pixel(&self) -> u8

Returns the bytes per pixel of the format.

pub fn property(&self) -> PixelFormatProperty

Returns the property of the format.

pub fn pixel_by_rgb(&self, _: Rgb) -> Pixel

Converts Rgb into Pixel.

pub fn pixel_by_rgba(&self, _: Rgba) -> Pixel

Converts Rgba into Pixel.

pub fn rgb_from_pixel(&self, _: Pixel) -> Rgb

Converts Pixel into Rgb.

pub fn rgba_from_pixel(&self, _: Pixel) -> Rgba

Converts Pixel into Rgba.

pub fn set_palette(&self, palette: &Palette)

Overwrites the palette with a new Palette.

Trait Implementations

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Drop for PixelFormat

fn drop(&mut self)

Executes the destructor for this type.