Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Envelope class generates ADSR style envelope.
| Name | FEnvelope |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/Envelope.h |
| Include Path | #include "DSP/Envelope.h" |
Syntax
class FEnvelope
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEnvelope() |
DSP/Envelope.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FEnvelope() |
DSP/Envelope.h |
Structs
| Name | Remarks |
|---|---|
| FEnvData |
Enums
Public
| Name | Remarks |
|---|---|
| EEnvelopeState | States for the envelope state machine. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float Generate
(
float* BiasedOutput |
Generate the next output value of the envelope. | DSP/Envelope.h | |
const FPatchSource GetModSourceBiasEnv() |
DSP/Envelope.h | ||
const FPatchSource GetModSourceEnv() |
Get the envelope's patch nodes. | DSP/Envelope.h | |
virtual EEnvelopeState GetState() |
DSP/Envelope.h | ||
void Init
(
const float InSampleRate, |
Initialize the envelope with the given sample rate. | DSP/Envelope.h | |
virtual bool IsDone() |
Queries if the envelope has finished. | DSP/Envelope.h | |
bool IsRetrigger() |
DSP/Envelope.h | ||
virtual void Kill() |
Kills the envelope (will cause discontinuity) | DSP/Envelope.h | |
virtual void Reset() |
Resets the envelope. | DSP/Envelope.h | |
virtual void SetAttackTime
(
const float InAttackTimeMsec |
Sets the envelope attack time in msec. | DSP/Envelope.h | |
virtual void SetBiasDepth
(
const float InDepth |
Sets the depth of the bias output. | DSP/Envelope.h | |
virtual void SetBiasInvert
(
const bool bInBiasInvert |
Inverts the value of the biased envelope output. | DSP/Envelope.h | |
virtual void SetDecayTime
(
const float InDecayTimeMsec |
Sets the envelope decay time in msec. | DSP/Envelope.h | |
virtual void SetDepth
(
const float InDepth |
Sets the envelope depth. | DSP/Envelope.h | |
virtual void SetInvert
(
const bool bInInvert |
Inverts the value of envelope output. | DSP/Envelope.h | |
void SetLegato
(
const bool bInLegatoMode |
Sets whether the envelope is in legato mode. Legato mode doesn't restart the envelope if it's already playing. | DSP/Envelope.h | |
virtual void SetReleaseTime
(
const float InReleaseTimeMsec |
Sets the envelope release time in msec. | DSP/Envelope.h | |
void SetRetrigger
(
const bool bInRetrigger |
Sets whether or not the envelope is zero'd when reset. | DSP/Envelope.h | |
void SetSimulateAnalog
(
const bool bInSimulatingAnalog |
Sets the envelope mode. | DSP/Envelope.h | |
virtual void SetSustainGain
(
const float InSustainGain |
Sets the envelope sustain gain in linear gain values. | DSP/Envelope.h | |
virtual void Shutdown() |
Puts envelope into shutdown mode, which is a much faster cutoff than release, but avoids pops. | DSP/Envelope.h | |
virtual void Start() |
Start the envelope, puts envelope in attack state. | DSP/Envelope.h | |
virtual void StartLegato () |
DSP/Envelope.h | ||
virtual void StartLegato
(
const float InNewDepth |
For truly legato envelope logic, we need to know the new sustain gain (if its being changed). | DSP/Envelope.h | |
virtual void Stop() |
Stop the envelope, puts in the release state. Can optionally force to off state. | DSP/Envelope.h | |
virtual void Update() |
Update the state of the envelope. | DSP/Envelope.h |