Struct Pixmap

pub struct Pixmap {
    width: u16,
    height: u16,
    buf: Vec<PremulRgba8>,
}

A pixmap of premultiplied RGBA8 values backed by u8.

Fields

width: u16

Width of the pixmap in pixels.

height: u16

Height of the pixmap in pixels.

buf: Vec<PremulRgba8>

Buffer of the pixmap in RGBA8 format.

Implementations

impl Pixmap

pub fn new(width: u16, height: u16) -> Self

Create a new pixmap with the given width and height in pixels.

pub fn from_parts(data: Vec<PremulRgba8>, width: u16, height: u16) -> Self

Create a new pixmap with the given premultiplied RGBA8 data.

The data vector must be of length width * height exactly.

The pixels are in row-major order.

Panics

Panics if the data vector is not of length width * height.

pub fn resize(&mut self, width: u16, height: u16)

Resizes the pixmap container to the given width and height; this does not resize the contained image.

If the pixmap buffer has to grow to fit the new size, those pixels are set to transparent black. If the pixmap buffer is larger than required, the buffer is truncated and its reserved capacity is unchanged.

pub fn shrink_to_fit(&mut self)

Shrink the capacity of the pixmap buffer to fit the pixmap’s current size.

pub fn capacity(&self) -> usize

The reserved capacity (in pixels) of this pixmap.

When calling Pixmap::resize with a width * height smaller than this value, the pixmap does not need to reallocate.

pub fn width(&self) -> u16

Return the width of the pixmap.

pub fn height(&self) -> u16

Return the height of the pixmap.

pub fn multiply_alpha(&mut self, alpha: u8)

Apply an alpha value to the whole pixmap.

pub fn from_png(data: impl Read) -> Result<Self, DecodingError>

Create a pixmap from a PNG file.

pub fn into_png(self) -> Result<Vec<u8>, EncodingError>

Return the current content of the pixmap as a PNG.

pub fn data(&self) -> &[PremulRgba8]

Returns a reference to the underlying data as premultiplied RGBA8.

The pixels are in row-major order.

pub fn data_mut(&mut self) -> &mut [PremulRgba8]

Returns a mutable reference to the underlying data as premultiplied RGBA8.

The pixels are in row-major order.

pub fn data_as_u8_slice(&self) -> &[u8]

Returns a reference to the underlying data as premultiplied RGBA8.

The pixels are in row-major order. Each pixel consists of four bytes in the order [r, g, b, a].

pub fn data_as_u8_slice_mut(&mut self) -> &mut [u8]

Returns a mutable reference to the underlying data as premultiplied RGBA8.

The pixels are in row-major order. Each pixel consists of four bytes in the order [r, g, b, a].

pub fn sample(&self, x: u16, y: u16) -> PremulRgba8

Sample a pixel from the pixmap.

The pixel data is premultiplied RGBA8.

pub fn sample_idx(&self, idx: u32) -> PremulRgba8

Sample a pixel from a custom-calculated index. This index should be calculated assuming that the data is stored in row-major order.

pub fn take(self) -> Vec<PremulRgba8>

Consume the pixmap, returning the data as the underlying Vec of premultiplied RGBA8.

The pixels are in row-major order.

pub fn take_unpremultiplied(self) -> Vec<Rgba8>

Consume the pixmap, returning the data as (unpremultiplied) RGBA8.

Not fast, but useful for saving to PNG etc.

The pixels are in row-major order.

Trait Implementations

impl Clone for Pixmap

fn clone(&self) -> Pixmap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pixmap

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

Formats the value using the given formatter.