Struct FrameLease 

pub struct FrameLease { /* private fields */ }

Frame container holding one or more planes plus metadata.

Example

use styx_core::prelude::*;

let pool = BufferPool::with_capacity(1, 256);
let res = Resolution::new(4, 4).unwrap();
let fmt = MediaFormat::new(FourCc::new(*b"RG24"), res, ColorSpace::Srgb);
let layout = plane_layout_from_dims(res.width, res.height, 3);
let meta = FrameMeta::new(fmt, 0);
let frame = FrameLease::single_plane(meta, pool.lease(), layout.len, layout.stride);
assert_eq!(frame.planes().len(), 1);

Implementations

impl FrameLease

pub fn single_plane( meta: FrameMeta, buffer: BufferLease, len: usize, stride: usize, ) -> FrameLease

Construct a single-plane frame using the provided buffer.

pub unsafe fn single_plane_uninit( meta: FrameMeta, buffer: BufferLease, len: usize, stride: usize, ) -> FrameLease

Construct a single-plane frame assuming the caller will fully initialize the buffer.

Safety

The caller must write every byte of the buffer before the frame is read.

pub fn multi_plane( meta: FrameMeta, buffers: SmallVec<[BufferLease; 3]>, layouts: SmallVec<[PlaneLayout; 3]>, ) -> FrameLease

Construct a multi-plane frame from a list of buffers and layouts.

pub fn from_external( meta: FrameMeta, layouts: SmallVec<[PlaneLayout; 3]>, backing: Arc<dyn ExternalBacking>, ) -> FrameLease

Construct a frame from an external backing (zero-copy).

pub fn meta(&self) -> &FrameMeta

Metadata describing this frame.

pub fn is_external(&self) -> bool

Returns true when the frame data is backed by an external zero-copy mapping (e.g. DMA / mmap).

In this case the frame does not own CPU buffers, so consumers that need an owned Vec<u8> must copy.

pub fn planes(&self) -> SmallVec<[Plane<'_>; 3]>

Iterate planes as borrowed slices (zero-copy).

pub fn planes_mut(&mut self) -> SmallVec<[PlaneMut<'_>; 3]>

Iterate mutable planes for in-place writes.

pub fn layouts(&self) -> SmallVec<[PlaneLayout; 3]>

Return a copy of plane layouts.

pub fn plane_strides(&self) -> SmallVec<[usize; 3]>

Return strides for each plane.

pub fn into_parts( self, ) -> (FrameMeta, SmallVec<[PlaneLayout; 3]>, SmallVec<[Vec<u8>; 3]>)

Convert into owned buffers and metadata.