Module |
|
Header |
/Engine/Source/Runtime/SignalProcessing/Public/DSP/Osc.h |
Include |
#include "DSP/Osc.h" |
class IOscBase
Oscillator base class.
Name | Description | ||
---|---|---|---|
|
float |
BaseFreq |
The base frequency of the oscillator. |
|
bChanged |
||
|
bIsPlaying |
Whether or not the oscillator is on or off. |
|
|
bIsSync |
||
|
float |
ExternalGainMod |
Linear gain modulation of the oscillator (used in amplitude modulation) |
|
float |
Freq |
The final frequency of the oscillator after computing all factors contributing to frequency. |
|
FreqData |
Holds all frequency data. |
|
|
float |
Gain |
Linear gain of the oscillator. |
|
ModAddDest |
||
|
ModFrequencyDest |
||
|
ModGainDest |
||
|
ModMatrix |
Modulation matrix to use for this oscillator. |
|
|
ModPulseWidthDest |
||
|
ModScaleDest |
||
|
float |
Nyquist |
Maximum frequency allowed. |
|
float |
Phase |
The current phase of oscillator (between 0.0 and 1.0) |
|
float |
PhaseInc |
How much to increment the phase each update. |
|
float |
PulseWidth |
The final pulse width. |
|
float |
PulseWidthBase |
Pulse width used in square LFOs. |
|
float |
PulseWidthMod |
Pulse width modulator factor. |
|
float |
SampleRate |
Sample rate of the oscillator. |
|
IOscBase * |
SlaveOsc |
Ptr to a slave oscillator that can be triggered to 0 phase if it is synced. |
|
VoiceId |
The voice ID that this oscillator belongs to. |
Name | Description | |
---|---|---|
|
IOscBase() |
Name | Description | |
---|---|---|
|
~IOscBase() |
Name | Description | ||
---|---|---|---|
|
float |
Generate ( |
Generates the next sample of audio, optionally passes out the auxillary output (supported in some oscillators) |
|
float |
GetFrequency() |
Returns the frequency of the oscillator. |
|
float |
GetGain() |
Returns the frequency of the oscillator. |
|
FPatchDestin... |
GetModDestAdd() |
|
|
FPatchDestin... |
GetModDestFrequency() |
Return patch destinations for various modulatable parameters. |
|
FPatchDestin... |
GetModDestGain() |
|
|
FPatchDestin... |
GetModDestPulseWidth() |
|
|
FPatchDestin... |
GetModDestScale() |
|
|
float |
GetPhase() |
Returns the current phase of the oscillator. |
|
float |
GetQuadPhase() |
Returns the quadrature phase, wrapped. |
|
Init ( |
Initializes the oscillator. |
|
|
IsPlaying() |
Returns whether or not this oscillator is playing. |
|
|
IsSync() |
Returns if this oscillator should be synced to a master oscillator. |
|
|
Reset() |
Resets the oscillator. |
|
|
ResetPhase() |
Resets the phase of this oscillator to 0.0. |
|
|
SetCents ( |
||
|
SetDetune ( |
||
|
SetFreqScale ( |
||
|
SetFrequency ( |
Sets the base frequency of the oscillator. |
|
|
SetFrequencyMod ( |
Sets a frequency modulation value. |
|
|
SetGain ( |
Sets the gain of the oscillator. |
|
|
SetGainMod ( |
Sets the gain modulator of the oscillator. |
|
|
SetNote ( |
Sets the base frequency of the oscillator from the midi. |
|
|
SetOctave ( |
||
|
SetPitchBend ( |
||
|
SetPulseWidth ( |
Sets the LFO pulse width for square-wave type oscillators. |
|
|
SetSampleRate ( |
||
|
SetSemitones ( |
||
|
SetSlaveOsc ( |
Sets the input oscillator as the slave of this oscillator. |
|
|
SetSync ( |
Sets whether or not this oscillator should be synced to a master oscillator. Master oscillator needs to have set this oscillator as its slave. |
|
|
Start() |
Starts the oscillator. |
|
|
Stop() |
Stops the oscillator. |
|
|
Update() |
Updates oscillator state. |
|
|
UpdatePhase() |
Updates the phase based on the phase increment. |
|
|
WrapPhase() |
Returns true if there was a phase wrap this update. |