Enum PlaneLayout 

#[non_exhaustive]
pub enum PlaneLayout {
    Interleaved {
        channels: u8,
    },
    Planar {
        planes: Vec<PlaneDescriptor>,
        relationship: PlaneRelationship,
    },
}

Complete layout of a multi-plane image.

Separates the metadata (how many planes, what they represent, their subsampling) from any pixel buffers. Every consumer that needs to know about planar organization works with PlaneLayout; only code that allocates or reads pixels needs actual buffers.

Examples

use zenpixels::{PlaneLayout, ChannelType, PlaneSemantic};

let layout = PlaneLayout::ycbcr_420(ChannelType::U8);
assert!(layout.is_planar());
assert!(layout.is_ycbcr());
assert!(layout.has_subsampling());
assert_eq!(layout.plane_count(), 3);

// Check plane semantics
let planes = layout.planes();
assert_eq!(planes[0].semantic, PlaneSemantic::Luma);
assert_eq!(planes[1].semantic, PlaneSemantic::ChromaCb);
assert!(!planes[0].is_subsampled());
assert!(planes[1].is_subsampled());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Interleaved

Interleaved pixel data (channels packed per-pixel).

Fields

channels: u8

Number of channels per pixel (e.g., 3 for RGB, 4 for RGBA).

Planar

Planar pixel data (one buffer per plane).

Fields

planes: Vec<PlaneDescriptor>

Descriptor for each plane.

relationship: PlaneRelationship

How the planes relate to each other.

Implementations

impl PlaneLayout

pub fn ycbcr_444(ct: ChannelType) -> PlaneLayout

YCbCr 4:4:4 (no subsampling).

pub fn ycbcr_444_matrix(ct: ChannelType, matrix: YuvMatrix) -> PlaneLayout

YCbCr 4:4:4 with a specific matrix.

pub fn ycbcr_422(ct: ChannelType) -> PlaneLayout

YCbCr 4:2:2 (horizontal half chroma).

pub fn ycbcr_420(ct: ChannelType) -> PlaneLayout

YCbCr 4:2:0 (half chroma in both axes).

pub fn rgb(ct: ChannelType) -> PlaneLayout

Planar RGB (3 independent planes, no subsampling).

pub fn rgba(ct: ChannelType) -> PlaneLayout

Planar RGBA (4 independent planes, no subsampling).

pub fn oklab(ct: ChannelType) -> PlaneLayout

Oklab (L/a/b, 3 planes, no subsampling).

pub fn oklab_alpha(ct: ChannelType) -> PlaneLayout

Oklab with alpha (L/a/b/A, 4 planes, no subsampling).

pub fn gray(ct: ChannelType) -> PlaneLayout

Grayscale (single plane, no subsampling).

pub fn plane_count(&self) -> usize

Number of planes (or interleaved channels).

pub fn planes(&self) -> &[PlaneDescriptor]

Plane descriptors. Empty slice for interleaved layout.

pub fn luma_plane_index(&self) -> Option<usize>

Index of the luma/lightness plane, if any.

pub fn has_subsampling(&self) -> bool

Whether any plane is subsampled.

pub fn is_ycbcr(&self) -> bool

Whether this is a YCbCr layout.

pub fn is_oklab(&self) -> bool

Whether this is an Oklab layout.

pub fn is_planar(&self) -> bool

Whether this layout is planar (not interleaved).

pub fn relationship(&self) -> Option<PlaneRelationship>

The plane relationship, if planar.

pub fn max_v_subsample(&self) -> u8

Maximum vertical subsampling factor across all planes.

Returns 1 for interleaved or non-subsampled layouts.

pub fn max_h_subsample(&self) -> u8

Maximum horizontal subsampling factor across all planes.

Returns 1 for interleaved or non-subsampled layouts.

pub fn mask_where(&self, f: impl Fn(PlaneSemantic) -> bool) -> PlaneMask

Build a PlaneMask from a predicate on plane semantics.

Returns PlaneMask::NONE for interleaved layouts.

pub fn luma_mask(&self) -> PlaneMask

Mask of luminance-like planes (Luma, Gray, OklabL).

pub fn chroma_mask(&self) -> PlaneMask

Mask of chroma planes (Cb, Cr, OklabA, OklabB).

pub fn alpha_mask(&self) -> PlaneMask

Mask of alpha planes.

Trait Implementations

impl Clone for PlaneLayout

fn clone(&self) -> PlaneLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlaneLayout

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

Formats the value using the given formatter.

impl Display for PlaneLayout

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

Formats the value using the given formatter.

impl Eq for PlaneLayout

impl PartialEq for PlaneLayout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlaneLayout