AudioEffectDistortion

Adds a distortion audio effect to an Audio bus. Modify 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 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.

@GodotBaseClass

struct AudioEffectDistortion {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AudioEffectDistortion other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AudioEffectDistortion _new();

enum Mode;

enum Constants;

double getDrive();

double getKeepHfHz();

AudioEffectDistortion.Mode getMode();

double getPostGain();

double getPreGain();

void setDrive(double drive);

void setKeepHfHz(double keep_hf_hz);

void setMode(long mode);

void setPostGain(double post_gain);

void setPreGain(double pre_gain);

double drive [@property getter];

double drive [@property setter];

double keepHfHz [@property getter];

double keepHfHz [@property setter];

AudioEffectDistortion.Mode mode [@property getter];

long mode [@property setter];

double postGain [@property getter];

double postGain [@property setter];

double preGain [@property getter];

double preGain [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
Mode enum Mode

Functions

getDrive double getDrive()
getKeepHfHz double getKeepHfHz()
getMode AudioEffectDistortion.Mode getMode()
getPostGain double getPostGain()
getPreGain double getPreGain()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AudioEffectDistortion other)
opEquals bool opEquals(typeof(null) n)
setDrive void setDrive(double drive)
setKeepHfHz void setKeepHfHz(double keep_hf_hz)
setMode void setMode(long mode)
setPostGain void setPostGain(double post_gain)
setPreGain void setPreGain(double pre_gain)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

drive double drive [@property getter]
double drive [@property setter]: Distortion power. Value can range from 0 to 1.
keepHfHz double keepHfHz [@property getter]
double keepHfHz [@property setter]: 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 AudioEffectDistortion.Mode mode [@property getter]
long mode [@property setter]: Distortion type.
postGain double postGain [@property getter]
double postGain [@property setter]: Increases or decreases the volume after the effect. Value can range from -80 to 24.
preGain double preGain [@property getter]
double preGain [@property setter]: Increases or decreases the volume before the effect. Value can range from -60 to 60.

Static functions

_new AudioEffectDistortion _new(): Construct a new instance of AudioEffectDistortion. Note: use memnew!AudioEffectDistortion instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

AudioEffectDistortion

Members

Aliases

Enums

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

AudioEffectDistortion

From mixin baseCasts

From `mixin baseCasts`