Struct tiny_skia::Pixmap

pub struct Pixmap { /* private fields */ }

A container that owns premultiplied RGBA pixels.

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

Implementations

impl Pixmap

pub fn new(width: u32, height: u32) -> Option<Self>

Allocates a new pixmap.

A pixmap is filled with transparent black by default, aka (0, 0, 0, 0).

Zero size in an error.

Pixmap’s width is limited by i32::MAX/4.

pub fn from_vec(data: Vec<u8>, size: IntSize) -> Option<Self>

Creates a new pixmap by taking ownership over an image buffer (premultiplied RGBA pixels).

The size needs to match the data provided.

Pixmap’s width is limited by i32::MAX/4.

pub fn decode_png(data: &[u8]) -> Result<Self, DecodingError>

Decodes a PNG data into a Pixmap.

Only 8-bit images are supported. Index PNGs are not supported.

pub fn load_png<P: AsRef<Path>>(path: P) -> Result<Self, DecodingError>

Loads a PNG file into a Pixmap.

Only 8-bit images are supported. Index PNGs are not supported.

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.

pub fn as_ref(&self) -> PixmapRef<'_>

Returns a container that references Pixmap’s data.

pub fn as_mut(&mut self) -> PixmapMut<'_>

Returns a container that references Pixmap’s data.

pub fn width(&self) -> u32

Returns pixmap’s width.

pub fn height(&self) -> u32

Returns pixmap’s height.

pub fn fill(&mut self, color: Color)

Fills the entire pixmap with a specified color.

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

Returns the internal data.

Byteorder: RGBA

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

Returns the mutable 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_mut(&mut self) -> &mut [PremultipliedColorU8]

Returns a mutable slice of pixels.

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

Returns a slice of pixels.

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

Consumes the internal data.

Byteorder: RGBA

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.

impl Pixmap

pub fn fill_rect(
    &mut self,
    rect: Rect,
    paint: &Paint<'_>,
    transform: Transform,
    clip_mask: Option<&ClipMask>
) -> Option<()>

Draws a filled rectangle onto the pixmap.

See PixmapMut::fill_rect for details.

pub fn fill_path(
    &mut self,
    path: &Path,
    paint: &Paint<'_>,
    fill_rule: FillRule,
    transform: Transform,
    clip_mask: Option<&ClipMask>
) -> Option<()>

Draws a filled path onto the pixmap.

See PixmapMut::fill_path for details.

pub fn stroke_path(
    &mut self,
    path: &Path,
    paint: &Paint<'_>,
    stroke: &Stroke,
    transform: Transform,
    clip_mask: Option<&ClipMask>
) -> Option<()>

Strokes a path.

See PixmapMut::stroke_path for details.

pub fn draw_pixmap(
    &mut self,
    x: i32,
    y: i32,
    pixmap: PixmapRef<'_>,
    paint: &PixmapPaint,
    transform: Transform,
    clip_mask: Option<&ClipMask>
) -> Option<()>

Draws a Pixmap on top of the current Pixmap.

See PixmapMut::draw_pixmap for details.

Trait Implementations

impl Clone for Pixmap

fn clone(&self) -> Pixmap

Returns a copy of the value.

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

impl PartialEq<Pixmap> for Pixmap

fn eq(&self, other: &Pixmap) -> bool

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

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

impl StructuralPartialEq for Pixmap