Struct tiny_skia::PixmapRef

source ·
pub struct PixmapRef<'a> { /* private fields */ }
Expand description

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§

source§

impl<'a> PixmapRef<'a>

source

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).

source

pub fn to_owned(&self) -> Pixmap

Creates a new Pixmap from the current data.

Clones the underlying data.

source

pub fn width(&self) -> u32

Returns pixmap’s width.

source

pub fn height(&self) -> u32

Returns pixmap’s height.

source

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

Returns the internal data.

Byteorder: RGBA

source

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

Returns a pixel color.

Returns None when position is out of bounds.

source

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

Returns a slice of pixels.

source

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.

source

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

Encodes pixmap into a PNG data.

source

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

Saves pixmap as a PNG file.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PixmapRef<'_>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn eq(&self, other: &PixmapRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for PixmapRef<'a>

§

impl<'a> Send for PixmapRef<'a>

§

impl<'a> Sync for PixmapRef<'a>

§

impl<'a> Unpin for PixmapRef<'a>

§

impl<'a> UnwindSafe for PixmapRef<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.