Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Low frequency oscillator.
| Name | FLFO |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/LFO.h |
| Include Path | #include "DSP/LFO.h" |
Syntax
class FLFO : public Audio::IOscBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLFO() |
DSP/LFO.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FLFO() |
DSP/LFO.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ELFOMode::Type GetMode() |
Returns current mode of LFO. | DSP/LFO.h | |
FPatchSource GetModSourceNormalPhase() |
Returns mod source's normal phase patch source. | DSP/LFO.h | |
FPatchSource GetModSourceQuadPhase() |
Returns mod source's quad phase patch source. | DSP/LFO.h | |
ELFO::Type GetType() |
Returns current waveform type of LFO generator. | DSP/LFO.h | |
void SetBipolar
(
const bool bInBipolar |
Set whether or not LFO outputs in bipolar domain or unipolar (false) domain. Defaults to bipolar. | DSP/LFO.h | |
void SetExponentialFactor
(
const float InExpFactor |
Sets the exponential factor of LFO if type is "exponential". Clamped to positive, non-zero values. | DSP/LFO.h | |
void SetMode
(
const ELFOMode::Type InLFOMode |
Sets mode of LFO (Looping or one-shot. Free not supported) | DSP/LFO.h | |
void SetPhaseOffset
(
const float InOffset |
Sets a phase offset for the LFO. Clamped to positive values only. | DSP/LFO.h | |
void SetType
(
const ELFO::Type InLFOType |
Set the waveform type of LFO generator. | DSP/LFO.h |
Overridden from IOscBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float Generate
(
float* AuxOutput |
Generates the next sample of audio, optionally passes out the auxillary output (supported in some oscillators) | DSP/LFO.h | |
virtual void Init
(
const float InSampleRate, |
Initializes the oscillator. | DSP/LFO.h | |
virtual void Reset() |
Resets the oscillator. | DSP/LFO.h | |
virtual void Start() |
Starts the oscillator. | DSP/LFO.h | |
virtual void Stop() |
Stops the oscillator. | DSP/LFO.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float ComputeLFO
(
float InputPhase, |
DSP/LFO.h | ||
float GetInitPhase() |
Returns initial phase, which differs between generators ensuring certain LFO shapes start on rising edge from zero- crossing by default (assuming user's provided phase offset is 0). | DSP/LFO.h |
Overridden from IOscBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ResetPhase() |
Resets generator to initial phase. | DSP/LFO.h |