Struct bae_rs::sounds::simple_sound::SimpleSound

pub struct SimpleSound { /* fields omitted */ }

Type implementing the ablitiy to run multiple a single Generator by a given list of Modifiers operated in series. This allows for simple and fast processing of the structure's elements while still allowing for a wide range of complex sounds.

Methods

impl SimpleSound

pub fn new(
    input_gain: MathT,
    output_gain: MathT,
    generator: BasicBlockRc
) -> Self

Constructs a new SimpleSound object. The new object is initialized with an empty Vec of Modifiers. Add Modifiers with add_modifier or extend_modifiers.

pub fn add_modifier<M>(&mut self, m: BasicBlockRc) where
    M: 'static + Clone, 

Adds a single modifier to the internal Vec of Modifiers.

pub fn extend_modifiers(&mut self, m_list: Vec<BasicBlockRc>)

Extends the internal Vec of Modifiers with the given Vec.

pub fn get_input_gain(&self) -> MathT

Returns the linear gain applied to the input during processing.

pub fn get_output_gain(&self) -> MathT

Returns the linear gain applied to the output during processing.

pub fn set_input_gain(&mut self, g: MathT)

Sets the input linear gain that is applied during processing.

pub fn set_output_gain(&mut self, g: MathT)

Sets the output linear gain that is applied during processing.

Trait Implementations

impl Clone for SimpleSound

fn clone(&self) -> SimpleSound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Sound for SimpleSound

fn toggle_pause(&mut self)

Toggles the pause state of the sound. If the sound is paused, the internal structures aren't process during a call to [process], instead only [Default::default()] is returned.

fn is_paused(&self) -> bool

Returns the pause state of the sound.

fn toggle_mute(&mut self)

Toggels the mute state of the sound. If the sound is muted, the internal structures are still processed during a call to [process], but [Default::default()] is returned.

fn is_muted(&self) -> bool

Returns the mute state of the sound.

fn register(&mut self, id: usize)

Sets itself as registered with the given ID.

fn unregister(&mut self)

Sets itself as unregistered and clears the saved ID.

fn process(&mut self, input: SampleT) -> SampleT

Processes the sound and its internal structures, returning the resulting audio sample.

fn get_id(&self) -> Option<usize>

Returns the ID given to the [Sound] during registration with a [Channel]. If the [Sound] is unregistered, it will return None.