Enum nih_plug_vizia::widgets::ParamEvent

pub enum ParamEvent<'a, P: Param> {
    BeginSetParameter(&'a P),
    SetParameter(&'a P, P::Plain),
    SetParameterNormalized(&'a P, f32),
    EndSetParameter(&'a P),
}

An event that updates a parameter’s value. Since NIH-plug manages the parameters, interacting with parameter values with VIZIA works a little different from updating any other state. These events are automatically handled by nih_plug_vizia.

Call the upcast() method to be able to emit this event through an [EventContext][EventContext].

Variants

BeginSetParameter(&'a P)

Begin an automation gesture for a parameter.

SetParameter(&'a P, P::Plain)

Set a parameter to a new normalized value. This needs to be surrounded by a matching BeginSetParameter and EndSetParameter.

SetParameterNormalized(&'a P, f32)

Set a parameter to a new normalized value. This needs to be surrounded by a matching BeginSetParameter and EndSetParameter.

EndSetParameter(&'a P)

End an automation gesture for a parameter.

Implementations

impl<P: Param> ParamEvent<'_, P>

pub fn upcast(self) -> RawParamEvent

Convert this event into a type erased version of itself that can be emitted through [EventContext::emit()][EventContext::emit()].

TODO: Think of a better, clearer term for this

Trait Implementations

impl<'a, P: Clone + Param> Clone for ParamEvent<'a, P>where P::Plain: Clone,

fn clone(&self) -> ParamEvent<'a, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, P: Debug + Param> Debug for ParamEvent<'a, P>where P::Plain: Debug,

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

Formats the value using the given formatter.

impl<P: Param> From<ParamEvent<'_, P>> for RawParamEvent

fn from(event: ParamEvent<'_, P>) -> Self

Converts to this type from the input type.

impl<'a, P: Copy + Param> Copy for ParamEvent<'a, P>where P::Plain: Copy,