Struct iced_audio::core::param::OctaveParam

pub struct OctaveParam<ID: Debug + Copy + Clone> { /* fields omitted */ }

A Param that defines a continuous logarithmic range of f32 frequency values, with each octave in the 10 octave spectrum spaced evenly.

Smaller frequencies will increment slower per slider movement than larger ones.

It stores a unique identifier of user supplied type ID. This can be an enum, u32, i32, String, etc. Each parameter must have a unique ID value!

Implementations

impl<ID: Debug + Copy + Clone> OctaveParam<ID>

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

Creates a new OctaveParam

Arguments

• id - an identifier for the parameter (must be unique!)
• min - the minimum of the range in Hz (inclusive), will be constrained to 20.0 Hz <= min <= 20480.0 Hz
• max - the maximum of the range in Hz (inclusive), will be constrained to 20.0 Hz <= max <= 20480.0 Hz
• value - the initial value of the parameter in Hz (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 in Hz (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

pub fn value_to_normal(&self, value: f32) -> Normal

Returns the corresponding Normal from the supplied frequency value

pub fn normal_to_value(&self, normal: Normal) -> f32

Returns the corresponding frequency value from the supplied Normal

Trait Implementations

impl<ID: Clone + Debug + Copy> Clone for OctaveParam<ID>

fn clone(&self) -> OctaveParam<ID>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ID: Copy + Debug + Clone> Copy for OctaveParam<ID>

impl<ID: Debug + Copy + Clone> Debug for OctaveParam<ID>

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

Formats the value using the given formatter.

impl<ID: Debug + Copy + Clone> Param for OctaveParam<ID>

type ID = ID

A unique identifier of user supplied type ID. This can be an enum, u32, i32, String, etc. Each parameter must have a unique ID value!

fn id(&self) -> ID

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]