UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Audio::FLFO Class Reference

#include <LFO.h>

+ Inheritance diagram for Audio::FLFO:

Public Member Functions

SIGNALPROCESSING_API FLFO ()
 
virtual SIGNALPROCESSING_API ~FLFO ()
 
virtual SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InVoiceId=0, FModulationMatrix *InMatrix=nullptr, const int32 ModMatrixStage=1) override
 
virtual SIGNALPROCESSING_API void Start () override
 
virtual SIGNALPROCESSING_API void Stop () override
 
virtual SIGNALPROCESSING_API void Reset () override
 
virtual SIGNALPROCESSING_API float Generate (float *QuadPhaseOutput=nullptr) override
 
SIGNALPROCESSING_API void SetBipolar (const bool bInBipolar)
 
SIGNALPROCESSING_API void SetType (const ELFO::Type InLFOType)
 
SIGNALPROCESSING_API ELFO::Type GetType () const
 
SIGNALPROCESSING_API void SetMode (const ELFOMode::Type InLFOMode)
 
SIGNALPROCESSING_API ELFOMode::Type GetMode () const
 
SIGNALPROCESSING_API void SetPhaseOffset (const float InOffset)
 
SIGNALPROCESSING_API void SetExponentialFactor (const float InExpFactor)
 
SIGNALPROCESSING_API FPatchSource GetModSourceNormalPhase () const
 
SIGNALPROCESSING_API FPatchSource GetModSourceQuadPhase () const
 
- Public Member Functions inherited from Audio::IOscBase
SIGNALPROCESSING_API IOscBase ()
 
SIGNALPROCESSING_API IOscBase (const IOscBase &)
 
virtual SIGNALPROCESSING_API ~IOscBase ()
 
virtual SIGNALPROCESSING_API void Update ()
 
void SetGain (const float InGain)
 
void SetGainMod (const float InGainMod)
 
SIGNALPROCESSING_API void SetFrequency (const float InFreqBase)
 
SIGNALPROCESSING_API void SetFrequencyMod (const float InFreqMod)
 
SIGNALPROCESSING_API void SetNote (const float InNote)
 
float GetFrequency () const
 
float GetGain () const
 
SIGNALPROCESSING_API void SetCents (const float InCents)
 
SIGNALPROCESSING_API void SetOctave (const float InOctave)
 
SIGNALPROCESSING_API void SetSampleRate (const float InSampleRate)
 
SIGNALPROCESSING_API void SetSemitones (const float InSemiTone)
 
SIGNALPROCESSING_API void SetDetune (const float InDetune)
 
SIGNALPROCESSING_API void SetPitchBend (const float InPitchBend)
 
SIGNALPROCESSING_API void SetFreqScale (const float InFreqScale)
 
SIGNALPROCESSING_API void SetPulseWidth (const float InPulseWidth)
 
bool IsPlaying () const
 
bool IsSync () const
 
void SetSync (const bool bInSync)
 
SIGNALPROCESSING_API void SetSlaveOsc (IOscBase *InSlaveOsc)
 
SIGNALPROCESSING_API void SetFollowerOsc (IOscBase *InFollowerOsc)
 
FPatchDestination GetModDestFrequency () const
 
FPatchDestination GetModDestPulseWidth () const
 
FPatchDestination GetModDestGain () const
 
FPatchDestination GetModDestAdd () const
 
FPatchDestination GetModDestScale () const
 

Protected Member Functions

SIGNALPROCESSING_API float ComputeLFO (float InputPhase, float *OutQuad=nullptr)
 
SIGNALPROCESSING_API float GetInitPhase () const
 
virtual SIGNALPROCESSING_API void ResetPhase () override
 
- Protected Member Functions inherited from Audio::IOscBase
void UpdatePhase ()
 
bool WrapPhase ()
 
float GetPhase () const
 
float GetQuadPhase () const
 

Protected Attributes

ELFO::Type LFOType
 
ELFOMode::Type LFOMode
 
float ExponentialFactor
 
uint32 RSHCounter
 
float RSHValue
 
float ModScale
 
float ModAdd
 
float LastOutput
 
float LoopCount
 
float QuadLastOutput
 
float PhaseOffset
 
bool bBipolar
 
FPatchSource ModNormalPhase
 
FPatchSource ModQuadPhase
 
- Protected Attributes inherited from Audio::IOscBase
int32 VoiceId
 
float SampleRate
 
float Nyquist
 
float Freq
 
float BaseFreq
 
FOscFrequencyMod FreqData
 
float Gain
 
float ExternalGainMod
 
float Phase
 
float PhaseInc
 
float PulseWidthBase
 
float PulseWidthMod
 
float PulseWidth
 
FModulationMatrix * ModMatrix
 
FPatchDestination ModFrequencyDest
 
FPatchDestination ModPulseWidthDest
 
FPatchDestination ModGainDest
 
FPatchDestination ModScaleDest
 
FPatchDestination ModAddDest
 
IOscBase * FollowerOsc
 
bool bIsPlaying
 
bool bChanged
 
bool bIsSync
 

Constructor & Destructor Documentation

◆ FLFO()

Audio::FLFO::FLFO ( )

◆ ~FLFO()

Audio::FLFO::~FLFO ( )
virtualdefault

Member Function Documentation

◆ ComputeLFO()

float Audio::FLFO::ComputeLFO ( float  InputPhase,
float *  OutQuad = nullptr 
)
protected

◆ Generate()

float Audio::FLFO::Generate ( float *  QuadPhaseOutput = nullptr)
overridevirtual

Implements Audio::IOscBase.

◆ GetInitPhase()

SIGNALPROCESSING_API float Audio::FLFO::GetInitPhase ( ) const
protected

◆ GetMode()

ELFOMode::Type Audio::FLFO::GetMode ( ) const

◆ GetModSourceNormalPhase()

FPatchSource Audio::FLFO::GetModSourceNormalPhase ( ) const

◆ GetModSourceQuadPhase()

FPatchSource Audio::FLFO::GetModSourceQuadPhase ( ) const

◆ GetType()

ELFO::Type Audio::FLFO::GetType ( ) const

◆ Init()

void Audio::FLFO::Init ( const float  InSampleRate,
const int32  InVoiceId = 0,
FModulationMatrix *  InMatrix = nullptr,
const int32  ModMatrixStage = 1 
)
overridevirtual

Reimplemented from Audio::IOscBase.

◆ Reset()

void Audio::FLFO::Reset ( )
overridevirtual

Reimplemented from Audio::IOscBase.

◆ ResetPhase()

void Audio::FLFO::ResetPhase ( )
overrideprotectedvirtual

Reimplemented from Audio::IOscBase.

◆ SetBipolar()

void Audio::FLFO::SetBipolar ( const bool  bInBipolar)

◆ SetExponentialFactor()

void Audio::FLFO::SetExponentialFactor ( const float  InExpFactor)

◆ SetMode()

void Audio::FLFO::SetMode ( const ELFOMode::Type  InLFOMode)

◆ SetPhaseOffset()

void Audio::FLFO::SetPhaseOffset ( const float  InOffset)

◆ SetType()

void Audio::FLFO::SetType ( const ELFO::Type  InLFOType)

◆ Start()

void Audio::FLFO::Start ( )
overridevirtual

Implements Audio::IOscBase.

◆ Stop()

void Audio::FLFO::Stop ( )
overridevirtual

Implements Audio::IOscBase.

Member Data Documentation

◆ bBipolar

bool Audio::FLFO::bBipolar
protected

◆ ExponentialFactor

float Audio::FLFO::ExponentialFactor
protected

◆ LastOutput

float Audio::FLFO::LastOutput
protected

◆ LFOMode

ELFOMode::Type Audio::FLFO::LFOMode
protected

◆ LFOType

ELFO::Type Audio::FLFO::LFOType
protected

◆ LoopCount

float Audio::FLFO::LoopCount
protected

◆ ModAdd

float Audio::FLFO::ModAdd
protected

◆ ModNormalPhase

FPatchSource Audio::FLFO::ModNormalPhase
protected

◆ ModQuadPhase

FPatchSource Audio::FLFO::ModQuadPhase
protected

◆ ModScale

float Audio::FLFO::ModScale
protected

◆ PhaseOffset

float Audio::FLFO::PhaseOffset
protected

◆ QuadLastOutput

float Audio::FLFO::QuadLastOutput
protected

◆ RSHCounter

uint32 Audio::FLFO::RSHCounter
protected

◆ RSHValue

float Audio::FLFO::RSHValue
protected
The documentation for this class was generated from the following files: