Enum nih_plug::params::internals::ParamPtr

pub enum ParamPtr {
    FloatParam(*const FloatParam),
    IntParam(*const IntParam),
    BoolParam(*const BoolParam),
    EnumParam(*const EnumParamInner),
}

Internal pointers to parameters. This is an implementation detail used by the wrappers for type erasure.

Variants

FloatParam(*const FloatParam)

IntParam(*const IntParam)

BoolParam(*const BoolParam)

EnumParam(*const EnumParamInner)

Since we can’t encode the actual enum here, this inner parameter struct contains all of the relevant information from the enum so it can be type erased.

Implementations

impl ParamPtr

pub unsafe fn name(&self) -> &str

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn unit(&self) -> &'static str

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn poly_modulation_id(&self) -> Option<u32>

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn modulated_normalized_value(&self) -> f32

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn unmodulated_normalized_value(&self) -> f32

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn default_normalized_value(&self) -> f32

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn step_count(&self) -> Option<usize>

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn previous_normalized_step(&self, from: f32, finer: bool) -> f32

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn next_normalized_step(&self, from: f32, finer: bool) -> f32

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn normalized_value_to_string( &self, normalized: f32, include_unit: bool ) -> String

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn string_to_normalized_value(&self, string: &str) -> Option<f32>

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn flags(&self) -> ParamFlags

Calls the corresponding method on the underlying Param object.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn modulated_plain_value(&self) -> f32

Get the parameter’s plain, unnormalized value, converted to a float. Useful in conjunction with preview_plain() to compare a snapped discrete value to a parameter’s current snapped value without having to do a back and forth conversion using normalized values.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn unmodulated_plain_value(&self) -> f32

Get the parameter’s plain, unnormalized value, converted to a float, before any monophonic host modulation has been applied. This is useful for handling modulated parameters for CLAP plugins in Bitwig in a way where the actual parameter does not move in the GUI while the parameter is being modulated. You can also use this to show the difference between the unmodulated value and the current value. Useful in conjunction with preview_plain() to compare a snapped discrete value to a parameter’s current snapped value without having to do a back and forth conversion using normalized values.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn default_plain_value(&self) -> f32

Get the parameter’s default value as a plain, unnormalized value, converted to a float.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

pub unsafe fn preview_normalized(&self, plain: f32) -> f32

Get the normalized value for a plain, unnormalized value, as a float. Used as part of the wrappers.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

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

Get the plain, unnormalized value for a normalized value, as a float. Used as part of the wrappers.

Safety

Calling this function is only safe as long as the object this ParamPtr was created for is still alive.

Trait Implementations

impl Clone for ParamPtr

fn clone(&self) -> ParamPtr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamPtr

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

Formats the value using the given formatter.

impl Hash for ParamPtr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<ParamPtr> for ParamPtr

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ParamPtr

impl Eq for ParamPtr

impl Send for ParamPtr

impl StructuralEq for ParamPtr

impl StructuralPartialEq for ParamPtr

impl Sync for ParamPtr