Struct Frame 

pub struct Frame { /* private fields */ }

Rendered frame containing pixel data.

The pixel buffer is reference-counted (Arc) so that cloning a frame — e.g. returning a cached static frame for a new timestamp — is O(1) and shares the pixels. Mutating accessors use copy-on-write, so an exclusively-owned frame is still mutated in place.

Implementations

impl Frame

pub fn new(buffer: Vec<u8>, width: u32, height: u32, timestamp: u32) -> Self

Create a new frame with the given buffer

pub fn from_rgba(buffer: Vec<u8>, width: u32, height: u32) -> Self

Create a frame from RGBA data

pub fn with_format( buffer: Vec<u8>, width: u32, height: u32, timestamp: u32, format: PixelFormat, ) -> Self

Create a new frame with specific pixel format

pub fn empty(width: u32, height: u32, timestamp: u32) -> Self

Create an empty frame (transparent)

pub fn with_timestamp(&self, timestamp: u32) -> Self

Clone this frame sharing its pixel buffer (O(1)) but with a new timestamp. Used to serve a cached static frame for the current time without copying.

pub fn data(&self) -> &[u8]

Get frame buffer data

pub fn pixels(&self) -> &[u8]

Get frame pixels (alias for data())

pub fn data_mut(&mut self) -> &mut [u8]

Get mutable frame buffer data (copy-on-write if the buffer is shared)

pub fn into_buffer(self) -> Vec<u8>

Take ownership of the buffer (clones only if the buffer is still shared)

pub fn width(&self) -> u32

Get frame width

pub fn height(&self) -> u32

Get frame height

pub fn timestamp(&self) -> u32

Get frame timestamp in centiseconds

pub fn format(&self) -> PixelFormat

Get pixel format

pub fn bytes_per_pixel(&self) -> usize

Get bytes per pixel

pub fn stride(&self) -> usize

Get stride (bytes per row)

pub fn to_rgba(self) -> Self

Convert to RGBA format if not already

pub fn is_empty(&self) -> bool

Check if frame is empty (all transparent)

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.