Struct PlaneMask 

pub struct PlaneMask { /* private fields */ }

Bitmask selecting which planes to process in a multi-plane operation.

Supports up to 8 planes. Operations that only affect certain channels (e.g., luma sharpening) use this to skip untouched planes.

Examples

use zenpixels::PlaneMask;

let mask = PlaneMask::LUMA.union(PlaneMask::ALPHA);
assert!(mask.includes(0));  // luma
assert!(!mask.includes(1)); // chroma Cb
assert!(mask.includes(3));  // alpha
assert_eq!(mask.count(), 2);

Implementations

impl PlaneMask

pub const ALL: PlaneMask

All planes (bits 0–7).

pub const NONE: PlaneMask

No planes.

pub const LUMA: PlaneMask

Plane 0 only (luma / lightness / red / gray).

pub const CHROMA: PlaneMask

Planes 1 and 2 (chroma Cb + Cr, or Oklab a + b).

pub const ALPHA: PlaneMask

Plane 3 (alpha).

pub const fn single(idx: usize) -> PlaneMask

Mask for a single plane by index (0–7).

pub const fn includes(&self, idx: usize) -> bool

Whether the plane at idx is included in this mask.

pub const fn union(self, other: PlaneMask) -> PlaneMask

Union of two masks.

pub const fn intersection(self, other: PlaneMask) -> PlaneMask

Intersection of two masks.

pub const fn count(&self) -> u32

Number of planes selected.

pub const fn is_empty(&self) -> bool

Whether no planes are selected.

pub const fn bits(&self) -> u8

The raw bitmask value.

pub const fn from_bits(bits: u8) -> PlaneMask

Construct from a raw bitmask value.

Trait Implementations

impl Clone for PlaneMask

fn clone(&self) -> PlaneMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PlaneMask

impl Debug for PlaneMask

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

Formats the value using the given formatter.

impl Display for PlaneMask

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

Formats the value using the given formatter.

impl Eq for PlaneMask

impl Hash for PlaneMask

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PlaneMask

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlaneMask