Enum nih_plug_iced::widgets::ParamMessage

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

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

impl Clone for ParamMessage

fn clone(&self) -> ParamMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamMessage

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

Formats the value using the given formatter.

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

fn width(&self) -> Length

Returns the width of the [Widget].

fn height(&self) -> Length

Returns the height of the [Widget].

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

Returns the Node of the [Widget].

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

Draws the [Widget] using the associated Renderer.

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

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

Returns the current [mouse::Interaction] of the [Widget].

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

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

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

fn width(&self) -> Length

Returns the width of the [Widget].

fn height(&self) -> Length

Returns the height of the [Widget].

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

Returns the Node of the [Widget].

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

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

Returns the current [mouse::Interaction] of the [Widget].

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.

impl Copy for ParamMessage