Skip to main content

ParameterRange

Struct ParameterRange 

Source
pub struct ParameterRange {
    pub min: f32,
    pub max: f32,
    pub default: f32,
    pub scale: ParameterScale,
}
Expand description

Parameter range with scaling for automation and plugin parameters.

Stores the valid range and default value, and provides conversion between normalized (0.0-1.0) and real parameter values.

Fields§

§min: f32§max: f32§default: f32§scale: ParameterScale

Implementations§

Source§

impl ParameterRange

Source

pub fn new(min: f32, max: f32, default: f32, scale: ParameterScale) -> Self

Source

pub fn linear(min: f32, max: f32, default: f32) -> Self

Source

pub fn logarithmic(min: f32, max: f32, default: f32) -> Self

Create a logarithmic parameter range (for frequencies, gains).

§Panics

Panics in debug mode if min <= 0.

Source

pub fn exponential(min: f32, max: f32, default: f32, curve: f32) -> Self

curve shape factor: values > 1.0 give more resolution at low end.

Source

pub fn toggle(off_value: f32, on_value: f32, default_on: bool) -> Self

Source

pub fn integer(min: i32, max: i32, default: i32) -> Self

Source

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

Source

pub fn denormalize(&self, normalized: f32) -> f32

Source

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

Source

pub fn default_normalized(&self) -> f32

Source

pub fn contains(&self, value: f32) -> bool

Source

pub fn span(&self) -> f32

Source

pub fn db_to_linear(db: f32) -> f32

Source

pub fn linear_to_db(linear: f32) -> f32

Returns -inf for amplitude <= 0.

Trait Implementations§

Source§

impl Clone for ParameterRange

Source§

fn clone(&self) -> ParameterRange

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParameterRange

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ParameterRange

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.