Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
This low-frequency oscillator (LFO) class is considered low-frequency because it doesn't do anything about aliasing, which is audible if the frequency is in the audible range. infrasonic frequencies are the target for this implementation.
| Name | FLfo |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/Modulators/Lfo.h |
| Include Path | #include "HarmonixDsp/Modulators/Lfo.h" |
Syntax
struct FLfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLfo() |
HarmonixDsp/Modulators/Lfo.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FWaveShapeFunction | float(*) | Input is [0,1], returns [0,1] | HarmonixDsp/Modulators/Lfo.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CyclesPerSample | double | HarmonixDsp/Modulators/Lfo.h | ||
| Mode | ELfoMode | HarmonixDsp/Modulators/Lfo.h | ||
| Phase | double | HarmonixDsp/Modulators/Lfo.h | ||
| Range | TInterval< float > | HarmonixDsp/Modulators/Lfo.h | ||
| SecondsPerSample | float | HarmonixDsp/Modulators/Lfo.h | ||
| Settings | const FLfoSettings * | Patch-level settings used as long as these settings are not overridden by and ADSR. | HarmonixDsp/Modulators/Lfo.h | |
| TempoWhenCalculated | float | HarmonixDsp/Modulators/Lfo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Advance
(
uint32 InNumSamples |
Advances the phase of the oscillator | HarmonixDsp/Modulators/Lfo.h | |
double GetPhase() |
HarmonixDsp/Modulators/Lfo.h | ||
TInterval< float > GetRange() |
HarmonixDsp/Modulators/Lfo.h | ||
const FLfoSettings * GetSettings() |
HarmonixDsp/Modulators/Lfo.h | ||
float GetValue() |
HarmonixDsp/Modulators/Lfo.h | ||
void Prepare
(
float InSampleRate |
HarmonixDsp/Modulators/Lfo.h | ||
void Retrigger() |
Sets phase to the initial phase indicated by the user setting (and possibly by the shape) | HarmonixDsp/Modulators/Lfo.h | |
void SetPhase
(
double InPhase |
HarmonixDsp/Modulators/Lfo.h | ||
| HarmonixDsp/Modulators/Lfo.h | |||
void UseSettings
(
const FLfoSettings* InSettings |
HarmonixDsp/Modulators/Lfo.h |