8Synth  2.0
Procedural 8-bit SFX creator.
Synth8.Envelope Class Reference

A simple attack-decay-sustain-release (ADSR) envelope. Use it to give form/attenuate your audios. More...

Inheritance diagram for Synth8.Envelope:
Synth8.SynthClipNode Synth8.IPlottable

Public Member Functions

override void Init ()
 Called when initializing the node. More...
 
override void Randomize ()
 Called when randomizing the node's parameters. More...
 
override float GetSample ()
 The node's main method. This return is used to pass values to other nodes. More...
 
override void OnSetTime (float length, float time)
 
override void OnUpdateTime (float length, float deltaTime, float time)
 Called when updating the position in time of the audio being rendered. More...
 

Public Attributes

SynthParameter attackTime = new SynthParameter( 0.01f )
 The attack time of the envelope. More...
 
SynthParameter decayTime = new SynthParameter( 0.01f )
 The decay time of the envelope. More...
 
SynthParameter sustainTime = new SynthParameter( 0.0f )
 The sustain time of the envelope. More...
 
SynthParameter releaseTime = new SynthParameter( 0.4f )
 The release time of the envelope. More...
 
SynthParameter punch = new SynthParameter( 1.0f )
 How much punch the signal gets when reaching the peak of the attack. More...
 
SynthParameter sustain = new SynthParameter( 0.7f )
 At which level the signal stays after the decay. More...
 
SynthClipNode input
 The input node which signal will be enveloped. More...
 
- Public Attributes inherited from Synth8.SynthClipNode
int x
 The node's x position in the graph. More...
 
int y
 The node's y position in the graph. More...
 

Detailed Description

A simple attack-decay-sustain-release (ADSR) envelope. Use it to give form/attenuate your audios.

Member Function Documentation

override float Synth8.Envelope.GetSample ( )
virtual

The node's main method. This return is used to pass values to other nodes.

Returns

Reimplemented from Synth8.SynthClipNode.

override void Synth8.Envelope.Init ( )
virtual

Called when initializing the node.

Reimplemented from Synth8.SynthClipNode.

override void Synth8.Envelope.OnUpdateTime ( float  length,
float  deltaTime,
float  time 
)
virtual

Called when updating the position in time of the audio being rendered.

Parameters
length
deltaTime
time

Reimplemented from Synth8.SynthClipNode.

override void Synth8.Envelope.Randomize ( )
virtual

Called when randomizing the node's parameters.

Reimplemented from Synth8.SynthClipNode.

Member Data Documentation

SynthParameter Synth8.Envelope.attackTime = new SynthParameter( 0.01f )

The attack time of the envelope.

SynthParameter Synth8.Envelope.decayTime = new SynthParameter( 0.01f )

The decay time of the envelope.

SynthClipNode Synth8.Envelope.input

The input node which signal will be enveloped.

SynthParameter Synth8.Envelope.punch = new SynthParameter( 1.0f )

How much punch the signal gets when reaching the peak of the attack.

SynthParameter Synth8.Envelope.releaseTime = new SynthParameter( 0.4f )

The release time of the envelope.

SynthParameter Synth8.Envelope.sustain = new SynthParameter( 0.7f )

At which level the signal stays after the decay.

SynthParameter Synth8.Envelope.sustainTime = new SynthParameter( 0.0f )

The sustain time of the envelope.


The documentation for this class was generated from the following file: