Struct iced_audio::FloatParam

pub struct FloatParam { /* fields omitted */ }

A Param that defines a continuous linear range of f32 values

Methods

impl FloatParam

pub fn new(id: u32, min: f32, max: f32, value: f32, default_value: f32) -> Self

Creates a new FloatParam

Arguments

• id - an identifier for the parameter (must be unique!)
• min - the minimum of the range (inclusive)
• max - the maximum of the range (inclusive)
• value - the initial value of the parameter (if value falls outside the range given by min and max, then min or max will be used instead)
• default_value - the default value of the parameter (if default_value falls outside the range given by min and max, then min or max will be used instead)

Panics

This will panic if max <= min

pub fn set_from_value(&mut self, value: f32)

Sets the parameter's value to value

If value falls outside the range given by min and max from FloatParam::new(), then min or max will be used instead.

Value to Normal calculactions will not be recalculated if the value has not changed.

pub fn set_from_normal(&mut self, normal: Normal)

Sets the parameter's value from a Normal

Normal to value calculactions will not be recalculated if the Normal has not changed.

pub fn value(&self) -> f32

Returns the parameter's value

pub fn default_value(&self) -> f32

Returns the parameter's default value

Trait Implementations

impl Clone for FloatParam

fn clone(&self) -> FloatParam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FloatParam

impl Debug for FloatParam

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

Formats the value using the given formatter.

impl Param for FloatParam

fn id(&self) -> u32

returns the unique identifier of the parameter

fn normal(&self) -> Normal

returns the value of the parameter represented as a [Normal]

fn default_normal(&self) -> Normal

returns the default value of the parameter represented as a [Normal]

impl PartialEq<FloatParam> for FloatParam

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for FloatParam