1. Epic GamesDeveloper
  3. FLFO

FLFO

Low frequency oscillator.

API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP

Inheritance Hierarchy

References

   
Module SignalProcessing
Header /Engine/Source/Runtime/SignalProcessing/Public/DSP/LFO.h
Include #include "DSP/LFO.h"

Syntax

class FLFO : public Audio::IOscBase

Remarks

Low frequency oscillator.

Variables

  Type Name Description
Protected variable bool bBipolar  
Protected variable float ExponentialFactor  
Protected variable float LastOutput  
Protected variable ELFOMode::Type LFOMode  
Protected variable ELFO::Type LFOType  
Protected variable float LoopCount  
Protected variable float ModAdd  
Protected variable FPatchSource ModNormalPhase  
Protected variable FPatchSource ModQuadPhase  
Protected variable float ModScale  
Protected variable float PhaseOffset  
Protected variable float QuadLastOutput  
Protected variable uint32 RSHCounter  
Protected variable float RSHValue  

Constructors

  Type Name Description
Public function  

FLFO ()

  

Destructors

  Type Name Description
Public function Virtual  

~FLFO ()

  

Functions

  Type Name Description
Protected function float

ComputeLFO ( float InputPhase,
float* OutQuad
)

  
Protected function Const float 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).
Public function Const ELFOMode::Type

GetMode ()

 Returns current mode of LFO.
Public function Const FPatchSource Returns mod source's normal phase patch source.
Public function Const FPatchSource Returns mod source's quad phase patch source.
Public function Const ELFO::Type

GetType ()

 Returns current waveform type of LFO generator.
Public function void

SetBipolar ( const bool bInBipolar
)

 Set whether or not LFO outputs in bipolar domain or unipolar (false) domain. Defaults to bipolar.
Public function void

SetExponentialFactor ( const float InExpFactor
)

 Sets the exponential factor of LFO if type is "exponential". Clamped to positive, non-zero values.
Public function void

SetMode ( const ELFOMode::Type InLFOMode
)

 Sets mode of LFO (Looping or one-shot. Free not supported)
Public function void

SetPhaseOffset ( const float InOffset
)

 Sets a phase offset for the LFO. Clamped to positive values only.
Public function void

SetType ( const ELFO::Type InLFOType
)

 Set the waveform type of LFO generator.

Overridden from IOscBase

  Type Name Description
Public function Virtual float

Generate ( float* AuxOutput
)

 Generates the next sample of audio, optionally passes out the auxillary output (supported in some oscillators)
Public function Virtual void

Init ( const float InSampleRate,
const int32 InVoiceId,
FModulationMatrix* InMatrix,
const int32 ModMatrixStage
)

 Initializes the oscillator.
Public function Virtual void

Reset ()

 Resets the oscillator.
Protected function Virtual void Resets generator to initial phase.
Public function Virtual void

Start ()

 Starts the oscillator.
Public function Virtual void

Stop ()

 Stops the oscillator.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page