Struct Lfo

pub struct Lfo { /* private fields */ }

A Low Frequency Oscillator is represented here

Implementations

impl Lfo

pub fn new(sample_rate_hz: f32) -> Self

Lfo::new(sr) is a new LFO with sample rate sr

pub fn tick(&mut self)

lfo.tick() advances the LFO by 1 tick, must be called at the sample rate

pub fn set_frequency(&mut self, freq: f32)

lfo.set_frequency(f) sets the frequency of the LFO to f

pub fn reset(&mut self)

lfo.reset() sets the oscillator into the start position`

pub fn set_phase(&mut self, phase: f32)

lfo.set_phase() sets the oscillator into a certain phase. A complete cycle (2pi radians) is represented with the 0.0-1.0 interval. Any negative or positive input is accepted and will be normalized to the 0.0-1.0 range internally.

pub fn get(&self, waveshape: Waveshape) -> f32

lfo.get(ws) is the current value of the given waveshape in [-1.0, +1.0]

Trait Implementations

impl Clone for Lfo

fn clone(&self) -> Lfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lfo

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

Formats the value using the given formatter.

impl PartialEq for Lfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Lfo

impl StructuralPartialEq for Lfo