Struct Mask

pub struct Mask {
    data: Arc<[u8]>,
    width: u16,
    height: u16,
}

A mask.

Fields

data: Arc<[u8]>

width: u16

height: u16

Implementations

impl Mask

pub fn new_alpha(pixmap: &Pixmap) -> Mask

Create a new alpha mask from the pixmap.

pub fn new_luminance(pixmap: &Pixmap) -> Mask

Create a new luminance mask from the pixmap.

pub fn width(&self) -> u16

Return the width of the mask.

pub fn height(&self) -> u16

Return the height of the mask.

pub fn sample(&self, x: u16, y: u16) -> u8

Sample the value at a specific location.

This function might panic or yield a wrong result if the location is out-of-bounds.

Trait Implementations

impl Clone for Mask

fn clone(&self) -> Mask

Returns a duplicate 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<(), Error>

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 Eq for Mask

impl StructuralPartialEq for Mask