Struct FrameConsumer 

#[repr(C)]
pub struct FrameConsumer {
    pub id: u32,
    pub width: u32,
    pub height: u32,
}

One CONSUMER of a capture source’s frames: a requested output size.

A camera or a screen share has many consumers of the same captured frame at once — the on-screen preview tile (sized by layout), a remote participant who asked for 500x200, a recorder at full size. The device captures ONCE, at the smallest size that covers every consumer (azul_layout::image_scale::covering_size), and every consumer gets its own resample of that one frame (azul_layout::image_scale::fan_out): the camera never captures more than the largest consumer needs, and nothing is ever sent bigger than the consumer asked for. Registered on a capture widget with CameraWidget::with_consumer / ScreenCaptureWidget::with_consumer; each cut frame is handed to the widget’s on_consumer_frame hook as a ConsumerFrame.

id is caller-chosen and handed back with every cut frame so one hook can serve many consumers (“client Bob” = 7, “the recorder” = 8). Id 0 (FrameConsumer::PREVIEW_ID) is reserved for the widget’s own on-screen tile, whose size follows layout.

Fields

id: u32

Caller-chosen id, handed back with every cut frame. 0 is the preview.

width: u32

Requested output width in px (0 = invalid, the consumer is skipped).

height: u32

Requested output height in px (0 = invalid, the consumer is skipped).

Implementations

impl FrameConsumer

pub const PREVIEW_ID: u32 = 0

The id of the widget’s own on-screen preview: its size follows the laid-out node (device pixels), never the caller.

pub const fn new(id: u32, width: u32, height: u32) -> Self

A consumer id that wants width x height frames.

pub const fn is_valid(&self) -> bool

false for a zero-sized request (skipped by the fan-out) or the reserved preview id.

Trait Implementations

impl Clone for FrameConsumer

fn clone(&self) -> FrameConsumer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameConsumer

impl Debug for FrameConsumer

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

Formats the value using the given formatter.

impl Default for FrameConsumer

fn default() -> FrameConsumer

Returns the “default value” for a type.

impl Eq for FrameConsumer

impl FromIterator<FrameConsumer> for FrameConsumerVec

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = FrameConsumer>,

Creates a value from an iterator.

impl Hash for FrameConsumer

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

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 Ord for FrameConsumer

fn cmp(&self, other: &FrameConsumer) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FrameConsumer

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FrameConsumer

fn partial_cmp(&self, other: &FrameConsumer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for FrameConsumer