Skip to main content

SwVideoLayerHandle

Struct SwVideoLayerHandle 

Source
pub struct SwVideoLayerHandle { /* private fields */ }
Expand description

Thread-safe runtime placement control for one compositor input. Retaining it does not keep the input or compositor alive.

Implementations§

Source§

impl SwVideoLayerHandle

Source

pub fn id(&self) -> VideoInputId

Returns the stable identity of this particular input registration.

Source

pub fn name(&self) -> Arc<str>

Returns the registration name, which may be reused by a newer input.

Source

pub fn layer(&self) -> Option<VideoLayer>

Returns the current layer settings, or None after this registration is removed.

Source

pub fn set_layer(&self, layer: VideoLayer) -> Result<(), SwVideoCompositorError>

Atomically replaces every layer setting.

Returns SwVideoCompositorError::SourceRemoved if this handle is stale.

Source

pub fn set_rect(&self, rect: VideoRect) -> Result<(), SwVideoCompositorError>

Replaces the destination rectangle while retaining the other layer settings.

Source

pub fn set_opacity(&self, opacity: f32) -> Result<(), SwVideoCompositorError>

Replaces the layer opacity after validating the 0.0..=1.0 range.

Source

pub fn set_z_index(&self, z_index: i32) -> Result<(), SwVideoCompositorError>

Changes the stacking order; larger values are drawn later.

Source

pub fn set_visible(&self, visible: bool) -> Result<(), SwVideoCompositorError>

Shows or hides the input without removing its registration.

Source

pub fn set_fit(&self, fit: VideoFit) -> Result<(), SwVideoCompositorError>

Changes how the input aspect ratio maps into its rectangle.

Source

pub fn set_source( &self, source: Option<VideoSourceRect>, ) -> Result<(), SwVideoCompositorError>

Draws only part of the input, or all of it again with None.

Not checked against the frame, which may not have arrived yet and may change size later — see VideoSourceRect. Only an empty region is refused here.

Trait Implementations§

Source§

impl Clone for SwVideoLayerHandle

Source§

fn clone(&self) -> SwVideoLayerHandle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more