Struct beryllium::PixelFormat

#[repr(transparent)]
pub struct PixelFormat<'sdl> { /* fields omitted */ }

A handle to the information about a particular pixel layout.

This type works similar to the Palette type, where many images can share a single PixelFormat value and changes to the PixelFormat will show up in all places. Thankfully, the only changes you can make to a PixelFormat is changing the palette used.

Every PixelFormat is either "paletted" or not. If the PixelFormat is paletted then allocating the format value also allocates a Palette of the appropriate length. That length is either 32 (4 bits per pixel index values) or 256 (8 bits per pixel index values). Formats with a bits per pixel values of more than 8 don't use a palette.

Methods

impl<'_> PixelFormat<'_>

pub fn get_rgb(&self, pixel: u32) -> Color

Gets the RGB Color components of a pixel value in this format.

• The alpha channel is always given as 0xFF

pub fn get_rgba(&self, pixel: u32) -> Color

Gets the RGBA Color components of a pixel value in this format.

• The alpha channel is always given as 0xFF if the format has no alpha channel.

pub fn map_rgb(&self, color: Color) -> u32

Maps a Color value into an RGB pixel value in this format.

• If the format is paletted the closest index is returned.
• If the format supports alpha it will be a fully opaque pixel.
• The pixel format data is always in the lowest bits, so you can safely downcast pixel values to u16 and u8 as appropriate.

pub fn map_rgba(&self, color: Color) -> u32

Maps a Color value into an RGBA pixel value in this format.

• If the format is paletted the closest index is returned.
• If the format has no alpha channel or is paletted then the input alpha value is simply ignored.
• The pixel format data is always in the lowest bits, so you can safely downcast pixel values to u16 and u8 as appropriate.

pub fn set_palette(&mut self, palette: &Palette) -> Result<(), String>

Reassigns the Palette for this PixelFormat

pub fn format(&self) -> PixelFormatEnum

The enum value of this pixel format.

pub fn palette(&self) -> Option<&Palette>

Obtains the palette of this format, if any.

pub fn bits_per_pixel(&self) -> u8

Significant bits in a pixel value: probably 8, 15, 16, 24, or 32.

pub fn bytes_per_pixel(&self) -> u8

The bytes required to hold a pixel value: probably 1, 2, 3, or 4.

pub fn r_mask(&self) -> u32

Mask for the location of the red component within a pixel value.

pub fn g_mask(&self) -> u32

Mask for the location of the green component within a pixel value.

pub fn b_mask(&self) -> u32

Mask for the location of the blue component within a pixel value.

pub fn a_mask(&self) -> u32

Mask for the location of the alpha component within a pixel value.

Trait Implementations

impl<'_> Drop for PixelFormat<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'sdl> Debug for PixelFormat<'sdl>

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

Formats the value using the given formatter.