Struct Frame 

pub struct Frame { /* private fields */ }

Immutable ref-counted frame handle.

Implementations

impl Frame

pub const fn format(&self) -> &FormatDescriptor

Returns frame format descriptor.

pub const fn width(&self) -> usize

Returns frame width.

pub const fn height(&self) -> usize

Returns frame height.

pub const fn metadata(&self) -> &Metadata

Returns frame metadata.

pub const fn actual_alignment(&self) -> usize

Returns actual alignment used for this frame allocation.

pub fn plane<T>(&self, index: usize) -> Result<Plane<T>, PixelFlowError>

where T: Sample,

Returns typed immutable plane view.

pub fn with_metadata(&self, metadata: Metadata) -> Frame

Creates frame clone that shares all plane buffers and replaces metadata.

pub fn shares_plane_storage(&self, other: &Frame, plane_index: usize) -> bool

Returns true when both frames share same backing storage for a plane index.

pub fn shares_plane_storage_at( &self, plane_index: usize, other: &Frame, other_plane_index: usize, ) -> bool

Returns true when selected planes share the same backing storage.

pub fn view( &self, left: usize, top: usize, width: usize, height: usize, ) -> Result<Frame, PixelFlowError>

Creates zero-copy crop-like view over parent plane storage.

pub fn single_plane_view( &self, plane_index: usize, format: FormatDescriptor, ) -> Result<Frame, PixelFlowError>

Creates a zero-copy frame containing one source plane as plane 0 of format.

pub fn from_plane_sources( format: FormatDescriptor, width: usize, height: usize, sources: &[(&Frame, usize)], metadata: Metadata, ) -> Result<Frame, PixelFlowError>

Creates a zero-copy frame from existing plane storage.

pub unsafe fn raw_plane(&self, index: usize) -> Result<RawPlane, PixelFlowError>

Returns raw pointer and stride view for expert Rust and ABI adapters.

Safety

Caller must honor plane bounds from height and stride_bytes, and must interpret sample values using returned sample_type. Pointer remains valid only while frame storage remains alive through this frame or another shared owner.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.