Struct hexodsp::dsp::ParamId

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

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:

• NodeId::atom_param_by_idx
• NodeId::inp_param_by_idx
• NodeId::param_by_idx
• NodeId::inp_param

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

• NodeId::inp
• NodeId::out

 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 str

node: NodeId

idx: u8

Implementations

impl ParamId

pub fn none() -> Self

pub fn node_id(&self) -> NodeId

pub fn inp(&self) -> u8

pub fn name(&self) -> &'static str

pub fn is_atom(&self) -> bool

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().

pub fn atom_ui(&self) -> Option<&'static str>

pub fn param_steps(&self) -> Option<(f32, f32)>

pub fn param_min_max(&self) -> Option<((f32, f32), (f32, f32))>

pub fn format(&self, f: &mut dyn Write, v: f32) -> Option<Result<()>>

pub fn setting_min_max(&self) -> Option<(i64, i64)>

pub fn as_atom_def(&self) -> SAtom

pub fn norm_def(&self) -> f32

pub fn round(&self, v: f32, coarse: bool) -> f32

pub fn norm(&self, v: f32) -> f32

pub fn denorm(&self, v: f32) -> f32

Trait Implementations

impl Clone for ParamId

fn clone(&self) -> ParamId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamId

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

Formats the value using the given formatter.

impl Hash for ParamId

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,

Feeds a slice of this type into the given Hasher.

impl Ord for ParamId

fn cmp(&self, other: &ParamId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ParamId> for ParamId

fn eq(&self, other: &ParamId) -> 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 PartialOrd<ParamId> for ParamId

fn partial_cmp(&self, other: &ParamId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ParamId

impl Eq for ParamId

impl StructuralEq for ParamId

impl StructuralPartialEq for ParamId