pub enum ParamMessage {
    BeginSetParameter(ParamPtr),
    SetParameterNormalized(ParamPtr, f32),
    EndSetParameter(ParamPtr),
}
Expand description

A message to update a parameter value. Since NIH-plug manages the parameters, interacting with parameter values with iced works a little different from updating any other state. This main IcedEditor should have a Message variant containing this ParamMessage. When it receives one of those messages, it can pass it through to self.handle_param_message().

Variants§

§

BeginSetParameter(ParamPtr)

Begin an automation gesture for a parameter.

§

SetParameterNormalized(ParamPtr, f32)

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

§

EndSetParameter(ParamPtr)

End an automation gesture for a parameter.

Trait Implementations§

source§

impl Clone for ParamMessage

source§

fn clone(&self) -> ParamMessage

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ParamMessage

source§

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

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

impl<'a, W> Widget<ParamMessage, Renderer<Backend>> for GenericUi<'a, W>where W: ParamWidget,

source§

fn width(&self) -> Length

Returns the width of the [Widget].
source§

fn height(&self) -> Length

Returns the height of the [Widget].
source§

fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node

Returns the Node of the [Widget]. Read more
source§

fn draw( &self, renderer: &mut Renderer, style: &Style, layout: Layout<'_>, cursor_position: Point, viewport: &Rectangle )

Draws the [Widget] using the associated Renderer.
source§

fn on_event( &mut self, event: Event, layout: Layout<'_>, cursor_position: Point, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, ParamMessage> ) -> Status

Processes a runtime [Event]. Read more
§

fn mouse_interaction( &self, _layout: Layout<'_>, _cursor_position: Point, _viewport: &Rectangle<f32>, _renderer: &Renderer ) -> Interaction

Returns the current [mouse::Interaction] of the [Widget]. Read more
§

fn overlay( &mut self, _layout: Layout<'_>, _renderer: &Renderer ) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the [Widget], if there is any.
source§

impl<'a, P: Param> Widget<ParamMessage, Renderer<Backend>> for ParamSlider<'a, P>

source§

fn width(&self) -> Length

Returns the width of the [Widget].
source§

fn height(&self) -> Length

Returns the height of the [Widget].
source§

fn layout(&self, _renderer: &Renderer, limits: &Limits) -> Node

Returns the Node of the [Widget]. Read more
source§

fn on_event( &mut self, event: Event, layout: Layout<'_>, cursor_position: Point, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, ParamMessage> ) -> Status

Processes a runtime [Event]. Read more
source§

fn mouse_interaction( &self, layout: Layout<'_>, cursor_position: Point, _viewport: &Rectangle, _renderer: &Renderer ) -> Interaction

Returns the current [mouse::Interaction] of the [Widget]. Read more
source§

fn draw( &self, renderer: &mut Renderer, style: &Style, layout: Layout<'_>, cursor_position: Point, _viewport: &Rectangle )

Draws the [Widget] using the associated Renderer.
§

fn overlay( &mut self, _layout: Layout<'_>, _renderer: &Renderer ) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the [Widget], if there is any.
source§

impl Copy for ParamMessage

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

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
§

impl<T, U> ToSample<U> for Twhere U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

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

§

fn vzip(self) -> V

§

impl<T> Any for Twhere T: Any,

§

impl<T> CloneAny for Twhere T: Any + Clone,

§

impl<S, T> Duplex<S> for Twhere T: FromSample<S> + ToSample<S>,

§

impl<T> MaybeSend for Twhere T: Send,