AudioEffectDistortion

Refreshing Cache...

Inherits: AudioEffect < Resource < Reference < Object

Adds a distortion audio effect to an Audio bus.

Modify the sound to make it dirty.

Description

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.

Enumerations

enum Mode:

  • MODE_CLIP = 0 — Digital distortion effect which cuts off peaks at the top and bottom of the waveform.
  • MODE_ATAN = 1
  • MODE_LOFI = 2 — Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices.
  • MODE_OVERDRIVE = 3 — Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers.
  • MODE_WAVESHAPE = 4 — Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.

Property Descriptions

Default0.0
Setterset_drive(value)
Getterget_drive()

Distortion power. Value can range from 0 to 1.


Default16000.0
Setterset_keep_hf_hz(value)
Getterget_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.


Default0
Setterset_mode(value)
Getterget_mode()

Distortion type.


Default0.0
Setterset_post_gain(value)
Getterget_post_gain()

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


Default0.0
Setterset_pre_gain(value)
Getterget_pre_gain()

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

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:29:20. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.