Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Bit crushing effect https://en.wikipedia.org/wiki/Bitcrusher
| Name | FBitCrusher |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/BitCrusher.h |
| Include Path | #include "DSP/BitCrusher.h" |
Syntax
class FBitCrusher
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBitCrusher() |
Constructor. | DSP/BitCrusher.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FBitCrusher() |
Destructor. | DSP/BitCrusher.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BitDelta | float | DSP/BitCrusher.h | ||
| BitDepth | float | DSP/BitCrusher.h | ||
| LastOutput | float | Used to sample+hold the last output. | DSP/BitCrusher.h | |
| NumChannels | int32 | DSP/BitCrusher.h | ||
| Phase | float | The current phase of the bit crusher. | DSP/BitCrusher.h | |
| PhaseDelta | float | The amount of phase to increment each sample. | DSP/BitCrusher.h | |
| ReciprocalBitDelta | float | DSP/BitCrusher.h | ||
| SampleRate | float | I.e. 8 bit, etc. But can be float! | DSP/BitCrusher.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Init
(
const float InSampleRate, |
Initialize the equalizer. | DSP/BitCrusher.h | |
void ProcessAudio
(
const float* InBuffer, |
DSP/BitCrusher.h | ||
void ProcessAudioFrame
(
const float* InFrame, |
Processes audio. | DSP/BitCrusher.h | |
void SetBitDepthCrush
(
const float InBitDepth |
The amount to reduce the bit depth of the audio stream. | DSP/BitCrusher.h | |
void SetSampleRateCrush
(
const float InFrequency |
The amount to reduce the sample rate of the audio stream. | DSP/BitCrusher.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float GetMaxBitDepth() |
Returns the maximum value given bit depths will be clamped to. | DSP/BitCrusher.h |