Table of Contents

Class AudioEffectDistortion

Namespace
Godot
Assembly
GodotSharp.dll

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.

public class AudioEffectDistortion : AudioEffect, IDisposable
Inheritance
AudioEffectDistortion
Implements
Inherited Members

Constructors

AudioEffectDistortion() 

public AudioEffectDistortion()

Properties

Drive

Distortion power. Value can range from 0 to 1.

public float Drive { get; set; }

Property Value

float

KeepHfHz

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

public float KeepHfHz { get; set; }

Property Value

float

Mode

Distortion type.

public AudioEffectDistortion.ModeEnum Mode { get; set; }

Property Value

AudioEffectDistortion.ModeEnum

PostGain

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

public float PostGain { get; set; }

Property Value

float

PreGain

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

public float PreGain { get; set; }

Property Value

float

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page