Struct Effect 

pub struct Effect {

    pub waveform: Waveform,
    pub frequency: f64,
    pub slide: f64,
    pub slide_change: f64,
    pub vibrato_depth: f64,
    pub vibrato_speed: f64,
    pub attack: f64,
    pub sustain: f64,
    pub punch: f64,
    pub decay: f64,
    pub duty_sweep: f64,
    pub low_pass: f64,
    pub low_pass_sweep: f64,
    pub high_pass: f64,
    pub high_pass_sweep: f64,
    pub arpeggio: f64,
    pub arpeggio_time: f64,
    pub repeat: f64,
    pub volume: f64,
}

The parameters of a sound effect. See the module documentation for their units, ranges and meaning.

Fields

waveform: Waveform

frequency: f64

slide: f64

slide_change: f64

vibrato_depth: f64

vibrato_speed: f64

attack: f64

sustain: f64

punch: f64

decay: f64

duty_sweep: f64

low_pass: f64

low_pass_sweep: f64

high_pass: f64

high_pass_sweep: f64

arpeggio: f64

arpeggio_time: f64

repeat: f64

volume: f64

Implementations

impl Effect

pub fn preset(kind: Preset, seed: u64) -> Self

Draws an effect of the given kind from a seed. The same kind and seed always give the same parameters, rounded to three decimals so the text stays short.

pub fn parse(text: &str) -> Result<Self, ParseError>

Parses the text form described in the module documentation.

pub fn duration(&self) -> f64

attack + sustain + decay, in seconds.

pub fn validate(&self) -> Result<()>

Checks every parameter’s range and the duration.

pub fn render(&self, sample_rate: u32) -> Result<Audio>

Renders with band-limited oscillators.

pub fn render_with(&self, sample_rate: u32, aliasing: Aliasing) -> Result<Audio>

Renders the effect into mono audio.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Effect

fn default() -> Self

Returns the “default value” for a type.

impl Display for Effect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Writes one key=value per line: the waveform, the frequency, the envelope and the volume, then every other parameter that differs from its default.

impl FromStr for Effect

type Err = Error

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for Effect

fn eq(&self, other: &Effect) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Effect