Struct piet_common::ImageBuf

pub struct ImageBuf { /* private fields */ }

An in-memory pixel buffer.

Contains raw bytes, dimensions, and image format (ImageFormat).

Implementations

impl ImageBuf

pub fn empty() -> ImageBuf

Create an empty image buffer.

pub fn from_raw(
    pixels: impl Into<Arc<[u8]>>,
    format: ImageFormat,
    width: usize,
    height: usize
) -> ImageBuf

Creates a new image buffer from an array of bytes.

format specifies the pixel format of the pixel data, which must have length width * height * format.bytes_per_pixel().

Panics

Panics if the pixel data has the wrong length.

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

Returns the raw pixel data of this image buffer.

pub fn raw_pixels_shared(&self) -> Arc<[u8]>

Returns a shared reference to the raw pixel data of this image buffer.

pub fn format(&self) -> ImageFormat

Returns the format of the raw pixel data.

pub fn width(&self) -> usize

The width, in pixels, of this image.

pub fn height(&self) -> usize

The height, in pixels, of this image.

pub fn size(&self) -> Size

The size of this image, in pixels.

pub fn pixel_colors(&self) -> impl Iterator<Item = impl Iterator<Item = Color>>

Returns an iterator over the pixels in this image.

The return value is an iterator over “rows”, where each “row” is an iterator over the color of the pixels in that row.

pub fn to_image<Ctx>(&self, ctx: &mut Ctx) -> <Ctx as RenderContext>::Imagewhere
    Ctx: RenderContext,

Converts this buffer an image that is optimized for drawing into a RenderContext.

pub fn ptr_eq(&self, other: &ImageBuf) -> bool

Returns true if the two ImageBufs refer to the same memory location.

Trait Implementations

impl Clone for ImageBuf

fn clone(&self) -> ImageBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageBuf

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

Formats the value using the given formatter.

impl Default for ImageBuf

fn default() -> ImageBuf

Returns the “default value” for a type.