Struct Frame 

pub struct Frame<'a> { /* private fields */ }

A borrowed, writable pixel buffer for exactly one frame.

Obtained from Surface::acquire and released by dropping it, after which the same surface must be told what changed via Surface::present.

stride is in pixels, not bytes, and may exceed size.width: DRM framebuffers are pitch-aligned (64 bytes on vc4, more elsewhere) and fbdev has its own line_length. Never assume stride == width — index rows through Frame::row_mut or Frame::rows_mut.

Implementations

impl<'a> Frame<'a>

pub fn new( pixels: &'a mut [u32], size: Size, stride: u32, format: PixelFormat, age: BufferAge, ) -> Result<Self, SurfaceError>

Wraps a backend buffer.

Returns SurfaceError::BufferTooSmall unless stride >= size.width and pixels covers stride * (height - 1) + width words.

pub const fn size(&self) -> Size

Visible extent in physical pixels.

pub const fn stride(&self) -> u32

Distance between the starts of consecutive rows, in pixels.

pub const fn format(&self) -> PixelFormat

Word layout of the buffer.

pub const fn age(&self) -> BufferAge

How stale these contents are. Feed to crate::DamageTracker::resolve.

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

Full backing slice, including any inter-row padding.

pub fn pixels_mut(&mut self) -> &mut [u32]

Full backing slice, including any inter-row padding.

pub fn row(&self, y: u32) -> Option<&[u32]>

One row, trimmed to the visible width. Returns None past the bottom edge.

pub fn row_mut(&mut self, y: u32) -> Option<&mut [u32]>

One row, trimmed to the visible width. Returns None past the bottom edge.

pub fn rows_mut(&mut self) -> impl Iterator<Item = &mut [u32]>

Every visible row, top to bottom, each trimmed to the visible width.

Trait Implementations

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.