Struct knyst::envelope::EnvelopeGen

pub struct EnvelopeGen {
    pub start_value: Sample,
    pub playing: bool,
    /* private fields */
}

An envelope Gen. Must be started by calling EnvelopeGen::start since that will initialise it based on the settings of its segments. If you want to use it offline, it can be turned into an iterator by calling EnvelopeGen::iter_mut.

Fields

start_value: Sample

playing: bool

Implementations

impl EnvelopeGen

pub fn adsr( attack_time: Sample, decay_time: Sample, sustain_level: Sample, release_time: Sample ) -> Self

Convenience method for an ADSR envelope

pub fn sustain(self, sustain: SustainMode) -> Self

Set the SustainMode

pub fn stop_action(self, stop_action: StopAction) -> Self

Set the StopAction

pub fn set_points(&mut self, points: Vec<(Sample, Sample)>)

Set the points of the envelope. Points are in the format (next_leve, time_to_reach_that_level_in_seconds)

pub fn curves(self, curves: Vec<Curve>) -> Self

If the curves are differently many from the points, fill with Curve::Linear for the later segments.

pub fn set_curve(&mut self, curve: Curve, index: usize)

Set a specific segment curve

pub fn get_point(&mut self, index: usize) -> (Sample, Sample)

pub fn playing(&self) -> bool

Returns if the envelope is playing

pub fn update_from_envelope(&mut self, other: &EnvelopeGen)

Updates the values of the this Envelope to match those of the other Envelope if it can be done without allocation. The Envelopes are assumed to match.

pub fn start(&mut self)

Initialises the envelope based on the start_value and the first point

pub fn restart_from_current(&mut self)

Initialises the envelope based on the current value and the first point

pub fn release(&mut self)

Releases the envelope if it is sustaining or immediately fades out if it is not.

pub fn fade_out(&mut self)

Immediately fade the output to 0.0. This is called if EnvelopeGen::release is called on a non sustaining and non looping envelope.

pub fn set_value(&mut self, value: Sample, index: usize)

Change the value of a specific point.

pub fn set_duration(&mut self, duration: Sample, index: usize)

Set the duration of a segment in seconds (the duration to reach the value with the same index). Will not affect the currently playing segment.

pub fn next_sample(&mut self) -> Sample

Get the next sample of the envelope

pub fn iter_mut(&mut self) -> EnvelopeIterator<'_>

Evaluate Self as an iterator. Evaluating the envelope means changing the state which is why it is mut.

impl EnvelopeGen

pub fn new( start_value: Sample, points: Vec<(Sample, Sample)>, sustain: SustainMode, stop_action: StopAction ) -> Self

Create a new Envelope. points are in the format (level, duration) where the duration is given in seconds, and later converted to samples internally.

pub fn process( &mut self, release: &[Trig], restart: &[Trig], amplitude: &mut [Sample] ) -> GenState

Process block

impl EnvelopeGen

pub fn upload(self) -> Handle<EnvelopeGenHandle>

Upload the Gen to the currently selected Graph and return a handle

Trait Implementations

impl Clone for EnvelopeGen

fn clone(&self) -> EnvelopeGen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeGen

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

Formats the value using the given formatter.

impl Gen for EnvelopeGen

fn process( &mut self, ctx: GenContext<'_, '_>, resources: &mut Resources ) -> GenState

The input and output buffers are both indexed using [in/out_index][sample_index].

fn num_inputs(&self) -> usize

The number of inputs this Gen takes. Determines how big the input buffer is.

fn num_outputs(&self) -> usize

The number of outputs this Gen produces. Determines how big the output buffer is.

fn input_desc(&self, input: usize) -> &'static str

Return a label for a given input channel index. This sets the label in the Connection API.

fn output_desc(&self, output: usize) -> &'static str

Return a label for a given output channel index. This sets the label in the Connection API.

fn init(&mut self, block_size: usize, sample_rate: Sample, node_id: NodeId)

Initialize buffers etc. Default: noop

fn name(&self) -> &'static str

A name identifying this Gen.