Struct nih_plug_iced::widgets::peak_meter::PeakMeter

pub struct PeakMeter<'a, Message> { /* private fields */ }

A simple horizontal peak meter.

TODO: There are currently no styling options at all TODO: Vertical peak meter, this is just a proof of concept to fit the gain GUI example.

Implementations

impl<'a, Message> PeakMeter<'a, Message>

pub fn new(state: &'a mut State, value_db: f32) -> Self

Creates a new PeakMeter using the current measurement in decibel. This measurement can already have some form of smoothing applied to it. This peak slider widget can draw the last hold value for you.

pub fn hold_time(self, time: Duration) -> Self

Keep showing the peak value for a certain amount of time.

pub fn width(self, width: Length) -> Self

Sets the width of the PeakMeter.

pub fn height(self, height: Length) -> Self

Sets the height of the PeakMeter.

pub fn text_size(self, size: u16) -> Self

Sets the text size of the PeakMeter’s ticks bar.

pub fn font(self, font: Font) -> Self

Sets the font of the PeakMeter’s ticks bar.

Trait Implementations

impl<'a, Message> From<PeakMeter<'a, Message>> for Element<'a, Message>where Message: 'a + Clone,

fn from(widget: PeakMeter<'a, Message>) -> Self

Converts to this type from the input type.

impl<'a, Message> Widget<Message, Renderer<Backend>> for PeakMeter<'a, Message>where Message: Clone,

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<'_, Message> ) -> 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.