Struct LiveImageSource 

pub struct LiveImageSource { /* private fields */ }

A raster that producer threads rewrite and any number of windows show.

The first Send type in Teksilo that feeds the renderer: Send + Sync, Clone is an Arc clone, and equality is identity. Producers write through a LiveImageWriter; widgets show it with LiveImage, or with Canvas::draw_live_image in a widget of one’s own.

It holds one frame, latest wins. A commit that lands before a window has shown the one before is merged into what that window uploads next, so a producer faster than the display costs one upload per displayed frame. Pixels never pass through paint() or an event: each window’s renderer pulls what it lacks from the source, under its lock.

Implementations

impl LiveImageSource

pub const MAX_DIMENSION: u32 = 16_384

The largest side a source accepts. Each renderer also checks its device’s own limit, and draws nothing for a larger source.

pub const MAX_BYTES: usize

The largest frame a source accepts: 1 GiB, MAX_DIMENSION² × 4, so only a side can be too large. A renderer uploads a frame larger than its staging budget over several frames, showing the previous picture until the new one is complete.

pub fn new(format: LivePixelFormat) -> LiveImageSource

A source with no label, no size hint and no writer: Disconnected.

pub fn builder(format: LivePixelFormat) -> LiveImageSourceBuilder

pub fn writer(&self) -> LiveImageWriter

Join the current writer session. The first writer of a session moves Disconnected to Waiting. Use it for threads that cooperate on one stream; a stream that restarts takes writer_exclusive.

Panics

When this thread holds a write transaction on the source.

pub fn writer_exclusive(&self) -> LiveImageWriter

Start a new writer session: revoke every existing writer, free the pixels, set Waiting, and return the session’s first writer. A revoked writer’s calls return [LiveImageError::Revoked] without touching anything, so a task left over from an old stream cannot write into the new one. Waits for an open transaction to end.

Panics

When this thread holds a write transaction on the source.

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

The size layout uses while no buffer exists, shared by every clone.

Panics

When this thread holds a write transaction on the source.

pub fn id(&self) -> LiveImageId

Process-unique; keys each renderer’s texture cache.

pub fn label(&self) -> Option<&str>

Fixed at construction.

pub fn format(&self) -> LivePixelFormat

pub fn status(&self) -> LiveImageStatus

Lock-free.

pub fn size(&self) -> Option<(u32, u32)>

The buffer’s size, else the size hint. Lock-free, and may be ahead of what widgets laid out.

pub fn generation(&self) -> u64

Lock-free and monotonic: +1 per commit that published.

pub fn displayed_generation(&self) -> u64

The highest generation a window has presented. A producer that wants backpressure compares it with generation.

pub fn is_observed(&self) -> bool

Whether at least one widget showing the source was in its window’s last render, whatever the status: a placeholder counts.

pub fn is_displayed(&self) -> bool

Whether at least one widget drew the source unpaused in its window’s last render, in a window not known to be hidden. A producer can throttle while it is false. Takes the consumer-list lock briefly. On Wayland a minimised window still counts: its compositor stops its frames, but no window state says so.

pub fn stats(&self) -> LiveImageSourceStats

Counters read from atomics; never takes a lock.

pub fn ptr_eq(&self, other: &LiveImageSource) -> bool

Whether self and other are the same source.

Trait Implementations

impl Clone for LiveImageSource

fn clone(&self) -> LiveImageSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LiveImageSource

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

Atomics only, so it never waits on a producer: LiveImageSource(#3 "vm-screen" Bgrx8 720x1280 Live gen 5021).

impl Eq for LiveImageSource

impl Hash for LiveImageSource

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LiveImageSource

fn eq(&self, other: &LiveImageSource) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.