Skip to main content

ActiveEffect

Struct ActiveEffect 

Source
pub struct ActiveEffect<'a> { /* private fields */ }
Expand description

One effect invocation at one timestamp: timeline time for a timeline transition, composition time for a composition step.

Implementations§

Source§

impl<'a> ActiveEffect<'a>

Source

pub const fn new(effect: &'a ClipEffect, time: MediaTime) -> Self

The invocation effect sampled at time.

Source

pub fn id(&self) -> &'a str

Stable effect definition identifier.

Source

pub const fn version(&self) -> u32

Exact effect definition version.

Source

pub fn params(&self) -> impl Iterator<Item = (&'a str, EffectParamValue)> + 'a

Every authored parameter, sampled at this timestamp, by name. Parameters the invocation leaves out take their definition defaults.

Source

pub fn param(&self, name: &str) -> Option<EffectParamValue>

One parameter sampled at this timestamp, if the invocation sets it.

Source

pub fn resources( &self, ) -> impl Iterator<Item = (&'a str, &'a EffectResourceId)> + 'a

Named external resources matched against the effect definition.

Source

pub const fn authored(&self) -> &'a ClipEffect

The authored invocation, with its parameters unevaluated.

Trait Implementations§

Source§

impl<'a> Clone for ActiveEffect<'a>

Source§

fn clone(&self) -> Self

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
Source§

impl<'a> Copy for ActiveEffect<'a>

Source§

impl<'a> Debug for ActiveEffect<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> PartialEq for ActiveEffect<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for ActiveEffect<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ActiveEffect<'a>

§

impl<'a> RefUnwindSafe for ActiveEffect<'a>

§

impl<'a> Send for ActiveEffect<'a>

§

impl<'a> Sync for ActiveEffect<'a>

§

impl<'a> Unpin for ActiveEffect<'a>

§

impl<'a> UnsafeUnpin for ActiveEffect<'a>

§

impl<'a> UnwindSafe for ActiveEffect<'a>

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<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, 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> 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.