Enum SharedImageBuffer

#[repr(C)]
pub enum SharedImageBuffer {
    RGB8(SharedPixelBuffer<Rgb8Pixel>),
    RGBA8(SharedPixelBuffer<Rgba8Pixel>),
    RGBA8Premultiplied(SharedPixelBuffer<Rgba8Pixel>),
}

SharedImageBuffer is a container for images that are stored in CPU accessible memory.

The SharedImageBuffer’s variants represent the different common formats for encoding images in pixels. TODO: Make this non_exhaustive before making the type public!

Variants

RGB8(SharedPixelBuffer<Rgb8Pixel>)

This variant holds the data for an image where each pixel has three color channels (red, green, and blue) and each channel is encoded as unsigned byte.

RGBA8(SharedPixelBuffer<Rgba8Pixel>)

This variant holds the data for an image where each pixel has four color channels (red, green, blue and alpha) and each channel is encoded as unsigned byte.

RGBA8Premultiplied(SharedPixelBuffer<Rgba8Pixel>)

This variant holds the data for an image where each pixel has four color channels (red, green, blue and alpha) and each channel is encoded as unsigned byte. In contrast to Self::RGBA8, this variant assumes that the alpha channel is also already multiplied to each red, green and blue component of each pixel. Only construct this format if you know that your pixels are encoded this way. It is more efficient for rendering.

Implementations

impl SharedImageBuffer

pub fn width(&self) -> u32

Returns the width of the image in pixels.

pub fn height(&self) -> u32

Returns the height of the image in pixels.

pub fn size(&self) -> IntSize

Returns the size of the image in pixels.

Trait Implementations

impl Clone for SharedImageBuffer

fn clone(&self) -> SharedImageBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedImageBuffer

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

Formats the value using the given formatter.

impl PartialEq for SharedImageBuffer

fn eq(&self, other: &Self) -> 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.