pub struct ParamId {
    name: &'static str,
    node: NodeId,
    idx: u8,
}
Expand description

Refers to an input paramter or atom of a specific Node referred to by a NodeId.

To obtain a ParamId you use one of these:

To obtain an input and output index for a port use:

 use hexodsp::*;
 let freq_param = NodeId::Sin(2).inp_param("freq").unwrap();

 assert!(!freq_param.is_atom());

 // Access the UI min/max and fine/coarse step values of this paramter:
 assert_eq!(freq_param.param_min_max().unwrap(), ((-1.0, 0.5647131), (20.0, 100.0)));

 // Access the default value:
 assert_eq!(freq_param.as_atom_def().f(), 0.0);

 // Normalize a value (convert frequency to the 0.0 to 1.0 range)
 assert_eq!(freq_param.norm(220.0), -0.1);

 // Denormalize a value (convert 0.0 to 1.0 range to frequency)
 assert_eq!(freq_param.denorm(-0.1), 220.0);

Fields

name: &'static strnode: NodeIdidx: u8

Implementations

Returns true if the ParamId has been associated with the atoms of a Node, and not the paramters. Even if the Atom is a param().

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Compare self to key and return true if they are equal.

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.