Struct OutputLayer 

pub struct OutputLayer {
    pub video_source_id: String,
    pub bounds: Rect,
    pub fit: Fit,
    pub z_index: i32,
    pub opacity: f32,
    pub visible: bool,
}

A single layer in an output, referencing a source with position and styling.

Stacked by z-index, 0 on top: an output is drawn from its highest z-index down to 0, and layers with the same z-index stack in the order they were added, the later one on top. Each layer independently specifies where and how large its source appears.

Coordinates

Position and size are in output space, where (0, 0) is the top-left corner of the output texture, regardless of where the output is placed on a monitor.

Fields

video_source_id: String

Persistent ID of the video source to render (references VideoSource).

bounds: Rect

Position and size of this layer within the output, in output coordinates.

fit: Fit

How the source’s picture sits inside bounds when the shapes differ. Fit::Contain by default: the whole picture, letterboxed.

z_index: i32

Stacking order: 0 is topmost, higher values are further back.

opacity: f32

Layer opacity: 0.0 (transparent) to 1.0 (opaque).

visible: bool

Whether this layer is visible. Hidden layers are skipped during rendering.

Implementations

impl OutputLayer

pub fn new(video_source_id: impl Into<String>, bounds: Rect) -> Self

Create a new layer referencing a video source.

pub fn with_fit(self, fit: Fit) -> Self

Set how the picture sits inside the bounds.

pub fn with_z_index(self, z_index: i32) -> Self

Set the stacking order (z-index).

pub fn with_opacity(self, opacity: f32) -> Self

Set the opacity (0.0 to 1.0).

pub fn with_visible(self, visible: bool) -> Self

Set visibility.

Trait Implementations

impl Clone for OutputLayer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputLayer

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

Formats the value using the given formatter.