Struct Generator

Source
pub struct Generator {
    pub sample: Sample,
    pub volume: f32,
    /* private fields */
}
Expand description

Sound effect generator

Generates sound effect data according to a Sample into a buffer. The data can be generated in multiple chunks, as the generator maintains its state from one call to generate to the next.

Fields§

§sample: Sample

Generator settings

§volume: f32

Sound effect volume. Default is 0.2.

Implementations§

Source§

impl Generator

Source

pub fn new(s: Sample) -> Generator

Constructs a new Generator based on the provided Sample

Source

pub fn generate(&mut self, buffer: &mut [f32])

Fills buffer with sound effect data. Subsequent calls continue where the last left off. Call reset first to start generating from the beginning.

Source

pub fn reset(&mut self)

Resets the generator to the beginning of the sound effect.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.