Struct synth_utils::adsr::Adsr

source ·
pub struct Adsr { /* private fields */ }
Expand description

An ADSR envelope generator is represented here

Implementations§

source§

impl Adsr

source

pub fn new(sample_rate_hz: f32) -> Self

Adrs::new(sr) is a new ADSR with sample rate sr

source

pub fn tick(&mut self)

adsr.tick() advances the ADSR by 1 tick, must be called at the sample rate

source

pub fn gate_on(&mut self)

adsr.gate_on() sends a gate-on message to the ADSR, triggering an ATTACK phase if it’s not already in ATTACK

Attack phases may be re-triggered by sending a new gate-on message during any phase.

source

pub fn gate_off(&mut self)

adsr.gate_off() sends a gate-off message to the ADSR, triggering a RELEASE phase unless it’s already RELEASED

source

pub fn value(&self) -> f32

adsr.value() is the current value of the ADSR in [0.0, 1.0]

source

pub fn set_input(&mut self, input: Input)

adsr.set_input(i) sets the given ADSR input

Examples

// set attack time to 30 milliseconds
adsr.set_input(adsr::Input::Attack(0.03_f32.into()));

// set decay time to 100 milliseconds
adsr.set_input(adsr::Input::Decay(0.1_f32.into()));

// set sustain level to 3/4 way up
adsr.set_input(adsr::Input::Sustain(0.75_f32.into()));

// set release time to 150 milliseconds
adsr.set_input(adsr::Input::Release(0.15_f32.into()));

Auto Trait Implementations§

§

impl RefUnwindSafe for Adsr

§

impl Send for Adsr

§

impl Sync for Adsr

§

impl Unpin for Adsr

§

impl UnwindSafe for Adsr

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.