Inheritance #

AudioEffectDistortion #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

Adds a distortion audio effect to an Audio bus.

Modifies the sound to make it distorted.

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.

Members #

var drive: float = 0.0#

Distortion power. Value can range from 0 to 1.

var keep_hf_hz: float = 16000.0#

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 mode = MODE_CLIP#

Distortion type.

var post_gain: float = 0.0#

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

var pre_gain: float = 0.0#

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

Methods #

Annotations #

Constants #

const MODE_CLIP = 0 enum Mode#

Digital distortion effect which cuts off peaks at the top and bottom of the waveform.

const MODE_ATAN = 1 enum Mode#

const MODE_LOFI = 2 enum Mode#

Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices.

const MODE_OVERDRIVE = 3 enum Mode#

Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. The drive property has no effect in this mode.

const MODE_WAVESHAPE = 4 enum Mode#

Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.

Constructors #

Enums #

Mode#

Operators #

Signals #

Theme Items #

Tutorials #