Struct bae_rs::sounds::standard_block::StandardBlock

pub struct StandardBlock { /* fields omitted */ }

Struct used for generalizing the structure of and abstracting the Sound struct. This allows us to create complex sounds as a graph of StandardBlocks, where each block can be a Modifier, Generator, or both, and there output of the StandardBlock is defined as some user-definable combination of the Generator and Modifier output. See Sound documentation for more info.

Internally, the Generator, Modifier, and Inter are stored wrapped within an Rc (note: may become Arc depending on future needs of the library). This means that when you clone a StandardBlock, the internal objects are not cloned. Rather, their reference count is incremented, and the wrapped objects stay where they are.

Methods

impl StandardBlock

pub fn new<T, U>(g: T, m: U, i: Inter) -> Self where
    T: 'static + Generator,
    U: 'static + Modifier, 

Creates a new StandardBlock from the given Generator, Modifier, and Inter.

Parameters

• g - The Generator for the StandardBlock.
• m - The Modifier for the StandardBlock.
• i - The interactor (typically a closure) that defines the combination of gs and ms samples when StandardBlock::process() is called.

pub fn from_generator<T>(g: T) -> Self where
    T: 'static + Generator, 

Creates a new block from the given Generator. For the StandardBlock, Empty is used for the m, and the return value of StandardBlock::generator_passthrough is used for i.

Parameters

• g - The Generator for the StandardBlock.

pub fn from_modifier<U>(m: U) -> Self where
    U: 'static + Modifier, 

Creates a new block from the given Modifier. For the StandardBlock, Empty is used for g, and the return value of StandardBlock::modifier_passthrough is used for i.

Parametrs

• m - The Modifier for the StandardBlock.

pub fn default_interactor() -> Inter

Creates the default interactor which simply multiplies the two passed samples together.

pub fn generator_passthrough() -> Inter

Creates a passthrough interactor which passes the Generator sample through.

pub fn modifier_passthrough() -> Inter

Creates a passthrough interactor which passes the Modifier sample through.

pub fn get_g(&self) -> &GeneratorRc

Returns a reference to the Rc-wrapped Generator.

pub fn get_m(&self) -> &ModifierRc

Returns a reference to the Rc-wrapped Modifier.

pub fn get_g_mut(&mut self) -> &mut GeneratorRc

Returns a mutable reference to the Rc-wrapped Generator.

pub fn get_m_mut(&mut self) -> &mut ModifierRc

Returns a mutable reference to the Rc-wrapped Modifier.

Trait Implementations

impl Block for StandardBlock

fn prime_input(&mut self, x: SampleT)

Increments the internal input sample by the given sample.

fn process(&mut self) -> SampleT

Process the [Block]. Individually processes the stored [Generator] and [Modifier] objects which are both combined using the [Inter] and returned.