Table of Contents

Class AudioEffectDistortion

Adds a distortion audio effect to an Audio bus.

Modifies the sound to make it distorted.

Inheritance
AudioEffectDistortion

Remarks

Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.

By distorting the waveform the frequency content changes, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.

See Also

Audio buses

Properties

drive

Distortion power. Value can range from 0 to 1.

var drive : float = 0.0

Property Value

float

Remarks

keep_hf_hz

High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.

var keep_hf_hz : float = 16000.0

Property Value

float

Remarks

  • void set_keep_hf_hz(float value)
  • float get_keep_hf_hz

mode

Distortion type.

var mode : int = 0

Property Value

int

Remarks

  • void set_mode(int value)
  • int get_mode

post_gain

Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24.

var post_gain : float = 0.0

Property Value

float

Remarks

  • void set_post_gain(float value)
  • float get_post_gain

pre_gain

Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60.

var pre_gain : float = 0.0

Property Value

float

Remarks

  • void set_pre_gain(float value)
  • float get_pre_gain