Struct Mask

pub struct Mask { /* private fields */ }

A mask.

During drawing over Pixmap, mask’s black (0) “pixels” would block rendering and white (255) will allow it. Anything in between is used for gradual masking and anti-aliasing.

Unlike Skia, we’re using just a simple 8bit alpha mask. It’s way slower, but easier to implement.

Implementations

impl Mask

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

Creates a new mask by taking ownership over a mask buffer.

The size needs to match the data provided.

pub fn from_pixmap(pixmap: PixmapRef<'_>, mask_type: MaskType) -> Self

Creates a new mask from a PixmapRef.

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

Creates a new mask by taking ownership over a mask buffer.

The size needs to match the data provided.

pub fn width(&self) -> u32

Returns mask’s width.

pub fn height(&self) -> u32

Returns mask’s height.

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

Returns the internal data.

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

Returns the mutable internal data.

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

Loads a PNG file into a Mask.

Only grayscale images are supported.

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

Loads a PNG file into a Mask.

Only grayscale images are supported.

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

Encodes mask into a PNG data.

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

Saves mask as a PNG file.

pub fn fill_path( &mut self, path: &Path, fill_rule: FillRule, anti_alias: bool, transform: Transform, )

Draws a filled path onto the mask.

In terms of RGB (no alpha) image, draws a white path on top of black mask.

Doesn’t reset the existing mask content and draws the path on top of existing data.

If the above behavior is undesired, Mask::clear() should be called first.

This method is intended to be used for simple cases. For more complex masks prefer Mask::from_pixmap().

pub fn intersect_path( &mut self, path: &Path, fill_rule: FillRule, anti_alias: bool, transform: Transform, )

Intersects the provided path with the current clipping path.

A temporary mask with the same size as the current one will be created.

pub fn invert(&mut self)

Inverts the mask.

pub fn clear(&mut self)

Clears the mask.

Zero-fills the internal data buffer.

Trait Implementations

impl Clone for Mask

fn clone(&self) -> Mask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mask

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

Formats the value using the given formatter.

impl PartialEq for Mask

fn eq(&self, other: &Mask) -> 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 StructuralPartialEq for Mask