Struct iced_audio::OctaveParam

pub struct OctaveParam { /* 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.

Methods

impl OctaveParam

pub fn new(id: u32, 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

Trait Implementations

impl Clone for OctaveParam

fn clone(&self) -> OctaveParam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OctaveParam

impl Debug for OctaveParam

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

Formats the value using the given formatter.

impl Param for OctaveParam

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<OctaveParam> for OctaveParam

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

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

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

This method tests for !=.

impl StructuralPartialEq for OctaveParam