Struct LiveImageWriter 

pub struct LiveImageWriter { /* private fields */ }

A producer’s handle on a LiveImageSource. Send + Sync; clones share one session token, and the source frees its pixels and becomes Disconnected when the session’s last token drops.

Writes happen in transactions: lock, any number of writes, then commit. One commit is one generation however many writes it holds. The helpers (write_frame, swap_frame, write_rect, resize, clear) each run one transaction of their own.

A writer waits only while a renderer copies bytes out of the buffer, a fraction of a millisecond for a 1080p frame.

Implementations

impl LiveImageWriter

pub fn lock(&self) -> Result<LiveImageWriteGuard<'_>, LiveImageError>

Start a write transaction. Only commit publishes it.

Errors

[LiveImageError::Revoked] once a newer session started.

Panics

When this thread already holds a transaction on the source.

pub fn try_lock(&self) -> Result<LiveImageWriteGuard<'_>, LiveImageError>

As lock, without waiting: [LiveImageError::WouldBlock] while another transaction or a renderer holds the lock, this thread’s own transaction included.

pub fn write_frame( &self, width: u32, height: u32, src: &[u8], src_stride: usize, ) -> Result<u64, LiveImageError>

Replace the whole frame, resizing if needed, and commit: one copy of src, whose rows are src_stride bytes apart. Returns the new generation.

pub fn swap_frame( &self, width: u32, height: u32, stride: usize, pixels: Vec<u8>, ) -> Result<Vec<u8>, RejectedFrame>

Install pixels as the frame without copying it, commit, and return the previous buffer for reuse: empty on the first call and after the pixels were freed. Its rows are stride bytes apart, at least width × 4. The previous buffer holds older content, which the producer must rewrite in full before its next swap.

Errors

A [RejectedFrame] carrying the error and pixels, untouched.

pub fn write_rect( &self, rect: PixelRect, src: &[u8], src_stride: usize, ) -> Result<u64, LiveImageError>

Copy one rect from src, whose row 0 is the rect’s top row and whose rows are src_stride bytes apart, and commit.

pub fn resize(&self, width: u32, height: u32) -> Result<u64, LiveImageError>

Resize, zero-filled, and commit. A no-op at the current size. The status is kept: a resize while Waiting stays Waiting.

pub fn clear(&self) -> Result<(), LiveImageError>

Free the pixels and return to Waiting; their size becomes the size hint. Every window frees its texture at its next render.

pub fn is_observed(&self) -> bool

As LiveImageSource::is_observed.

pub fn is_displayed(&self) -> bool

As LiveImageSource::is_displayed.

pub fn source(&self) -> LiveImageSource

pub fn stats(&self) -> LiveImageSourceStats

Trait Implementations

impl Clone for LiveImageWriter

fn clone(&self) -> LiveImageWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LiveImageWriter

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

Formats the value using the given formatter.