UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FOsc Class Reference

#include <Osc.h>

+ Inheritance diagram for Audio::FOsc:

Public Member Functions

SIGNALPROCESSING_API FOsc ()
 
virtual SIGNALPROCESSING_API ~FOsc ()
 
virtual SIGNALPROCESSING_API void Start () override
 
virtual SIGNALPROCESSING_API void Stop () override
 
virtual SIGNALPROCESSING_API void Reset () override
 
virtual SIGNALPROCESSING_API void Update () override
 
virtual SIGNALPROCESSING_API float Generate (float *AuxOutput=nullptr) override
 
void SetType (const EOsc::Type InType)
 
EOsc::Type GetType () const
 
- Public Member Functions inherited from Audio::IOscBase
SIGNALPROCESSING_API IOscBase ()
 
SIGNALPROCESSING_API IOscBase (const IOscBase &)
 
virtual SIGNALPROCESSING_API ~IOscBase ()
 
virtual SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InVoiceId=0, FModulationMatrix *InMatrix=nullptr, const int32 ModMatrixStage=1)
 
virtual SIGNALPROCESSING_API void ResetPhase ()
 
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 PolySmooth (const float InPhase, const float InPhaseInc)
 
- Protected Member Functions inherited from Audio::IOscBase
void UpdatePhase ()
 
bool WrapPhase ()
 
float GetPhase () const
 
float GetQuadPhase () const
 

Protected Attributes

float TriangleSign
 
float DPW_z1
 
FExponentialEase PulseWidthLerped
 
EOsc::Type OscType
 
FWhiteNoise Noise
 
- 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
 
FModulationMatrixModMatrix
 
FPatchDestination ModFrequencyDest
 
FPatchDestination ModPulseWidthDest
 
FPatchDestination ModGainDest
 
FPatchDestination ModScaleDest
 
FPatchDestination ModAddDest
 
IOscBaseFollowerOsc
 
bool bIsPlaying
 
bool bChanged
 
bool bIsSync
 

Constructor & Destructor Documentation

◆ FOsc()

Audio::FOsc::FOsc ( )

◆ ~FOsc()

Audio::FOsc::~FOsc ( )
virtual

Member Function Documentation

◆ Generate()

float Audio::FOsc::Generate ( float AuxOutput = nullptr)
overridevirtual

Implements Audio::IOscBase.

◆ GetType()

EOsc::Type Audio::FOsc::GetType ( ) const
inline

◆ PolySmooth()

float Audio::FOsc::PolySmooth ( const float  InPhase,
const float  InPhaseInc 
)
protected

◆ Reset()

void Audio::FOsc::Reset ( )
overridevirtual

Reimplemented from Audio::IOscBase.

◆ SetType()

void Audio::FOsc::SetType ( const EOsc::Type  InType)
inline

◆ Start()

void Audio::FOsc::Start ( )
overridevirtual

Implements Audio::IOscBase.

◆ Stop()

void Audio::FOsc::Stop ( )
overridevirtual

Implements Audio::IOscBase.

◆ Update()

void Audio::FOsc::Update ( )
overridevirtual

Reimplemented from Audio::IOscBase.

Member Data Documentation

◆ DPW_z1

float Audio::FOsc::DPW_z1
protected

◆ Noise

FWhiteNoise Audio::FOsc::Noise
protected

◆ OscType

EOsc::Type Audio::FOsc::OscType
protected

◆ PulseWidthLerped

FExponentialEase Audio::FOsc::PulseWidthLerped
protected

◆ TriangleSign

float Audio::FOsc::TriangleSign
protected

The documentation for this class was generated from the following files: