Struct ParamF32Handle 

pub struct ParamF32Handle { /* private fields */ }

A handle to get and update the value of an auto-smoothed ParamF32 from a UI.

Implementations

impl ParamF32Handle

pub fn normalized(&self) -> f32

The normalized value in the range [0.0, 1.0].

pub fn value(&self) -> f32

The (un-normalized) value of this parameter.

Please note that this is calculated from the shared normalized value every time, so avoid calling this every frame if you can.

pub fn set_normalized(&self, normalized: f32)

Set the normalized value of this parameter in the range [0.0, 1.0].

Please note that this will NOT automatically notify the host of the value change if you are using this inside a plugin spec such as VST. It is intended for you use your own method for achieving this.

pub fn set_value(&self, value: f32)

Set the (un-normalized) value of this parameter.

Please note that this will NOT automatically notify the host of the value change if you are using this inside a plugin spec such as VST. It is intended for you use your own method for achieving this.

pub fn min(&self) -> f32

The minimum value of this parameter.

pub fn max(&self) -> f32

The maximum value of this parameter.

pub fn gradient(&self) -> Gradient

The Gradient mapping used when converting from the normalized value in the range [0.0, 1.0] to the desired value.

pub fn unit(&self) -> Unit

The Unit that signifies how the value displayed to the end user should differ from the actual value used in DSP.

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

Convert the given value to the corresponding normalized range [0.0, 1.0] of this parameter.

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

Convert the given normalized value in the range [0.0, 1.0] into the corresponding value of this parameter.

pub fn shared_normalized(&self) -> Arc<AtomicF32>

Get the shared normalized float value.

This can be useful to integrate with various plugin APIs.

Trait Implementations

impl Clone for ParamF32Handle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.