Struct oscen::operators::Modulator

pub struct Modulator { /* fields omitted */ }

A Modulator is designed to be the input to the hz field of a carrier wave. It takes control of the carriers frequency and modulates it's base hz by adding mod_idx * mod_hz * output of modulator wave.

Implementations

impl Modulator

pub fn new(wave: Tag) -> Self

pub fn wave<T: Into<In>>(&mut self, arg: T) -> &mut Self

pub fn base_hz<T: Into<In>>(&mut self, arg: T) -> &mut Self

pub fn mod_hz<T: Into<In>>(&mut self, arg: T) -> &mut Self

pub fn mod_idx<T: Into<In>>(&mut self, arg: T) -> &mut Self

Trait Implementations

impl Builder for Modulator

fn build(&mut self) -> Self where
    Self: Sized + Clone, 

fn wrap(&mut self) -> ArcMutex<Self> where
    Self: Sized + Clone, 

fn rack(&mut self, rack: &mut Rack) -> ArcMutex<Self> where
    Self: Signal + Send + Sized + Clone, 

fn rack_pre(&mut self, rack: &mut Rack) -> ArcMutex<Self> where
    Self: Signal + Send + Sized + Clone, 

impl Clone for Modulator

fn clone(&self) -> Modulator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Modulator

impl<'_> Index<&'_ str> for Modulator

type Output = In

The returned type after indexing.

fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'_> IndexMut<&'_ str> for Modulator

fn index_mut(&mut self, index: &str) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Signal for Modulator

fn as_any_mut(&mut self) -> &mut dyn Any

This method has the same trivial implementation for all implentors of the trait. We need it to downcast trait objects to their underlying type.

fn tag(&self) -> Tag

Synth modules must have a tag (name) to serve as their key in the rack.

fn signal(&mut self, rack: &Rack, _sample_rate: Real) -> Real

Responsible for updating the phase and returning the next signal value, i.e. amplitude.