Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
A clock-sync-able LFO with a morphing waveform.
| Name | FMorphingLFO |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/Modulators/MorphingLfo.h |
| Include Path | #include "HarmonixDsp/Modulators/MorphingLfo.h" |
Syntax
class FMorphingLFO
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMorphingLFO
(
float InSampleRate |
HarmonixDsp/Modulators/MorphingLfo.h |
Structs
| Name | Remarks |
|---|---|
| FMusicTimingInfo | Contains the information necessary to do music clock sync. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Frequency | Parameters::TParameter< float > | If LfoSyncType is TempoSync, the unit is cycles per quarter note. Otherwise, it's Hz. | HarmonixDsp/Modulators/MorphingLfo.h | |
| Invert | Parameters::TParameter< bool > | If set, the output will be inverted. | HarmonixDsp/Modulators/MorphingLfo.h | |
| Shape | Parameters::TParameter< float > | Determines the shape of the output 0.0-1.0 morphs from square to triangle, 1.0-2.0 morphs from triangle to sawtooth. | HarmonixDsp/Modulators/MorphingLfo.h | |
| SyncType | Parameters::TParameter< ETimeSyncOption > | Determines how the frequency parameter behaves. | HarmonixDsp/Modulators/MorphingLfo.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastFrequency | float | HarmonixDsp/Modulators/MorphingLfo.h | ||
| Phase | float | HarmonixDsp/Modulators/MorphingLfo.h | ||
| SampleRate | float | HarmonixDsp/Modulators/MorphingLfo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Advance
(
const int32 DeltaFrames, |
Advance and output the last value. | HarmonixDsp/Modulators/MorphingLfo.h | |
void Advance
(
float* OutputBuffer, |
Advance and output a buffer of LFO values. | HarmonixDsp/Modulators/MorphingLfo.h | |
float GetSampleRate() |
HarmonixDsp/Modulators/MorphingLfo.h | ||
void Reset
(
float InSampleRate |
Reset the LFO to its initial state. | HarmonixDsp/Modulators/MorphingLfo.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float GetClockSyncedPhase
(
const float CyclesPerQuarter, |
HarmonixDsp/Modulators/MorphingLfo.h | ||
static float GetFrequencyHz
(
const ETimeSyncOption SyncType, |
HarmonixDsp/Modulators/MorphingLfo.h | ||
static float GetValue
(
const float Shape, |
Get the LFO value for a given shape and phase. | HarmonixDsp/Modulators/MorphingLfo.h |