Enum hexodsp::dsp::NodeId

pub enum NodeId {
    Nop,
    Amp(u8),
    Mix3(u8),
    Mux9(u8),
    SMap(u8),
    Map(u8),
    Quant(u8),
    CQnt(u8),
    TSeq(u8),
    Code(u8),
    Rust1x1(u8),
    Sampl(u8),
    Sin(u8),
    BOsc(u8),
    VOsc(u8),
    BowStri(u8),
    MidiP(u8),
    MidiCC(u8),
    ExtA(u8),
    ExtB(u8),
    ExtC(u8),
    ExtD(u8),
    ExtE(u8),
    ExtF(u8),
    Inp(u8),
    Out(u8),
    FbWr(u8),
    FbRd(u8),
    Scope(u8),
    Ad(u8),
    Adsr(u8),
    TsLFO(u8),
    RndWk(u8),
    Delay(u8),
    AllP(u8),
    Comb(u8),
    Noise(u8),
    FormFM(u8),
    SFilter(u8),
    FVaFilt(u8),
    BiqFilt(u8),
    PVerb(u8),
    Test(u8),
}

This enum is a collection of all implemented modules (aka nodes) that are implemented. The associated u8 index is the so called instance of the corresponding Node type.

This is the primary way in this library to refer to a specific node in the node graph that is managed by crate::NodeConfigurator and executed by crate::NodeExecutor.

To see how to actually use this, refer to the documentation of crate::Cell, where you will find an example.

Variants

Nop

Amp(u8)

Mix3(u8)

Mux9(u8)

SMap(u8)

Map(u8)

Quant(u8)

CQnt(u8)

TSeq(u8)

Code(u8)

Rust1x1(u8)

Sampl(u8)

Sin(u8)

BOsc(u8)

VOsc(u8)

BowStri(u8)

MidiP(u8)

MidiCC(u8)

ExtA(u8)

ExtB(u8)

ExtC(u8)

ExtD(u8)

ExtE(u8)

ExtF(u8)

Inp(u8)

Out(u8)

FbWr(u8)

FbRd(u8)

Scope(u8)

Ad(u8)

Adsr(u8)

TsLFO(u8)

RndWk(u8)

Delay(u8)

AllP(u8)

Comb(u8)

Noise(u8)

FormFM(u8)

SFilter(u8)

FVaFilt(u8)

BiqFilt(u8)

PVerb(u8)

Test(u8)

Implementations

impl NodeId

pub fn to_instance(&self, instance: usize) -> NodeId

pub fn graph_fun(&self) -> Option<GraphFun>

pub fn eq_variant(&self, other: &NodeId) -> bool

pub fn from_node_info(ni: &NodeInfo) -> NodeId

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

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

pub fn from_str(name: &str) -> Self

pub fn ui_type(&self) -> UIType

pub fn ui_category(&self) -> UICategory

pub fn init_phase(&self) -> f32

Consistently initialize the phase for oscillators. This does some fixed phase offset for the first 3 instances, which is usually relied on by the automated tests.

pub fn atom_param_by_idx(&self, idx: usize) -> Option<ParamId>

This maps the atom index of the node to the absolute ParamId in the GUI (and in the crate::matrix::Matrix). The Atom/Param duality is a bit weird because they share the same ID namespace for the UI. But in the actual backend, they are split. So the actual splitting happens in the crate::matrix::Matrix.

pub fn inp_param_by_idx(&self, idx: usize) -> Option<ParamId>

pub fn param_by_idx(&self, idx: usize) -> Option<ParamId>

pub fn inp_param(&self, name: &str) -> Option<ParamId>

pub fn inp(&self, name: &str) -> Option<u8>

pub fn inp_name_by_idx(&self, idx: u8) -> Option<&'static str>

pub fn out_name_by_idx(&self, idx: u8) -> Option<&'static str>

pub fn out(&self, name: &str) -> Option<u8>

pub fn instance(&self) -> usize

Trait Implementations

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Display for NodeId

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

Formats the value using the given formatter.

impl Hash for NodeId

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 NodeId

fn cmp(&self, other: &NodeId) -> 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<NodeId> for NodeId

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

fn partial_cmp(&self, other: &NodeId) -> 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 NodeId

impl Eq for NodeId

impl StructuralEq for NodeId

impl StructuralPartialEq for NodeId