Struct MultiPlaneImage 

#[non_exhaustive]
pub struct MultiPlaneImage { /* private fields */ }

A multi-plane image where each plane is an independent pixel buffer.

Combines a PlaneLayout (metadata describing plane count, semantics, subsampling, and relationship) with actual pixel buffers. Each buffer corresponds to one plane in the layout.

Examples

use zenpixels::{MultiPlaneImage, PlaneLayout, ChannelType, PixelBuffer, PixelDescriptor};

let layout = PlaneLayout::ycbcr_444(ChannelType::U8);
let y = PixelBuffer::new(1920, 1080, PixelDescriptor::GRAY8);
let cb = PixelBuffer::new(1920, 1080, PixelDescriptor::GRAY8);
let cr = PixelBuffer::new(1920, 1080, PixelDescriptor::GRAY8);

let img = MultiPlaneImage::new(layout, vec![y, cb, cr]);
assert_eq!(img.plane_count(), 3);
assert!(img.layout().is_ycbcr());

Implementations

impl MultiPlaneImage

pub fn new(layout: PlaneLayout, buffers: Vec<PixelBuffer>) -> MultiPlaneImage

Create a new multi-plane image from a layout and corresponding buffers.

Panics

Debug-asserts that the number of buffers matches the planar plane count.

pub fn with_origin(self, ctx: Arc<ColorContext>) -> MultiPlaneImage

Attach a color context.

pub fn layout(&self) -> &PlaneLayout

The layout describing this image’s plane organization.

pub fn plane_count(&self) -> usize

Number of planes.

pub fn buffer(&self, idx: usize) -> Option<&PixelBuffer>

Access a single buffer by index.

pub fn buffer_mut(&mut self, idx: usize) -> Option<&mut PixelBuffer>

Access a single buffer mutably by index.

pub fn buffers(&self) -> &[PixelBuffer]

Access all buffers.

pub fn buffers_mut(&mut self) -> &mut [PixelBuffer]

Access all buffers mutably.

pub fn origin(&self) -> Option<&Arc<ColorContext>>

The optional color context shared across all planes.