Struct sfxr::Generator

pub struct Generator {
    pub sample: Sample,
    pub volume: f32,
    // some fields omitted
}

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.

Methods

impl Generator

pub fn new(s: Sample) -> Generator

Constructs a new Generator based on the provided Sample

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.

pub fn reset(&mut self)

Resets the generator to the beginning of the sound effect.