Struct Frame 

pub struct Frame { /* private fields */ }

A single captured frame in BGRA8 layout, row-major, stride = width * 4.

Implementations

impl Frame

pub fn new( width: u32, height: u32, data: Vec<u8>, ) -> Result<Frame, CaptureError>

pub fn solid(width: u32, height: u32, bgra: [u8; 4]) -> Frame

A frame filled with one BGRA color. Handy for tests and fakes.

Panics

Panics if width * height * 4 overflows the allocator’s capacity limits.

pub fn from_fn( width: u32, height: u32, f: impl FnMut(u32, u32) -> [u8; 4], ) -> Frame

Build a frame by evaluating f(x, y) -> BGRA for every pixel. Handy for synthetic test imagery and demos.

Panics

Panics if width * height * 4 overflows the allocator’s capacity limits (same policy as Frame::solid).

pub fn width(&self) -> u32

pub fn height(&self) -> u32

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

pub fn timestamp(&self) -> SystemTime

pub fn view(&self, rect: PxRect) -> Result<FrameView<'_>, CaptureError>

Borrow a rectangular view. Errors if rect exceeds the frame bounds.

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.

impl Debug for Frame

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

Formats the value using the given formatter.