Struct AudioEffectDistortion
Adds a distortion audio effect to an Audio bus.
Modify the sound to make it dirty.
struct AudioEffectDistortion
;
Modify the sound and make it dirty. Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.
By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.
Properties
| Name | Type | Description |
drive[get, set]
|
double | Distortion power. Value can range from 0 to 1.
|
keepHfHz[get, set]
|
double | High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
|
mode[get, set]
|
AudioEffectDistortion.Mode | Distortion type.
|
postGain[get, set]
|
double | Increases or decreases the volume after the effect. Value can range from -80 to 24.
|
preGain[get, set]
|
double | Increases or decreases the volume before the effect. Value can range from -60 to 60.
|