Struct PixmapRef

pub struct PixmapRef<'a> { /* private fields */ }

A container that references premultiplied RGBA pixels.

Can be created from Pixmap or from a user provided data.

The data is not aligned, therefore width == stride.

Implementations

impl<'a> PixmapRef<'a>

pub fn from_bytes(data: &'a [u8], width: u32, height: u32) -> Option<Self>

Creates a new PixmapRef from bytes.

The size must be at least size.width() * size.height() * BYTES_PER_PIXEL. Zero size in an error. Width is limited by i32::MAX/4.

The data is assumed to have premultiplied RGBA pixels (byteorder: RGBA).

pub fn to_owned(&self) -> Pixmap

Creates a new Pixmap from the current data.

Clones the underlying data.

pub fn width(&self) -> u32

Returns pixmap’s width.

pub fn height(&self) -> u32

Returns pixmap’s height.

pub fn data(&self) -> &'a [u8]

Returns the internal data.

Byteorder: RGBA

pub fn pixel(&self, x: u32, y: u32) -> Option<PremultipliedColorU8>

Returns a pixel color.

Returns None when position is out of bounds.

pub fn pixels(&self) -> &'a [PremultipliedColorU8]

Returns a slice of pixels.

pub fn clone_rect(&self, rect: IntRect) -> Option<Pixmap>

Returns a copy of the pixmap that intersects the rect.

Returns None when Pixmap’s rect doesn’t contain rect.

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

Encodes pixmap into a PNG data.

pub fn save_png<P: AsRef<Path>>(&self, path: P) -> Result<(), EncodingError>

Saves pixmap as a PNG file.

Trait Implementations

impl<'a> Clone for PixmapRef<'a>

fn clone(&self) -> PixmapRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixmapRef<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq for PixmapRef<'a>

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

impl<'a> Copy for PixmapRef<'a>

impl<'a> StructuralPartialEq for PixmapRef<'a>