[][src]Crate sfxr

Reimplementation of DrPetter's "sfxr" sound effect generator.

This crate provides tools for creating quick placeholder sound effects. The effects are primarily intended to be used in quickly made games.

Sound effects are first defined as Sample values, which has many fields for tuning the properties of the resulting sound. A simple base Sample can be created with Sample::new, but other constructors for various purposes are provided for quick random Samples.

Next, a Generator is constructed to handle filling a sound buffer with data.

Examples

Generating a smooth sine wave into a buffer

let mut sample = Sample::new();
sample.wave_type = WaveType::Sine;
let generator = Generator::new(sample);
let buffer = [0.0; 44_100];
generator.generate(&mut buffer);

Generating a random explosion effect

let sample = Sample::explosion();
let generator = Generator::new(sample);
let buffer = [0.0; 44_100];
generator.generate(&mut buffer);

Structs

Generator

Sound effect generator

Sample

Defines a sound effect configuration for a Generator

Enums

WaveType