Outdated documentation

This documentation page refers to Godot 4.3, and may be outdated or incorrect.
Additionally, this engine version is no longer supported.

Check this page in the stable branch for the latest additions and corrections.

AudioEffectFilter

Inherits: AudioEffect < Resource < RefCounted < Object

Inherited By: AudioEffectBandLimitFilter, AudioEffectBandPassFilter, AudioEffectHighPassFilter, AudioEffectHighShelfFilter, AudioEffectLowPassFilter, AudioEffectLowShelfFilter, AudioEffectNotchFilter

Adds a filter to the audio bus.

Description

Allows frequencies other than the cutoff_hz to pass.

Tutorials

• Audio buses

Properties

float	cutoff_hz	2000.0
FilterDB	db	0
float	gain	1.0
float	resonance	0.5

---

Enumerations

enum FilterDB: 🔗

FilterDB FILTER_6DB = 0

There is currently no description for this enum. Please help us by contributing one!

FilterDB FILTER_12DB = 1

There is currently no description for this enum. Please help us by contributing one!

FilterDB FILTER_18DB = 2

There is currently no description for this enum. Please help us by contributing one!

FilterDB FILTER_24DB = 3

There is currently no description for this enum. Please help us by contributing one!

---

Property Descriptions

float cutoff_hz = 2000.0 🔗

• void set_cutoff(value: float)

• float get_cutoff()

Threshold frequency for the filter, in Hz.

---

FilterDB db = 0 🔗

• void set_db(value: FilterDB)

• FilterDB get_db()

There is currently no description for this property. Please help us by contributing one!

---

float gain = 1.0 🔗

• void set_gain(value: float)

• float get_gain()

Gain amount of the frequencies after the filter.

---

float resonance = 0.5 🔗

• void set_resonance(value: float)

• float get_resonance()

Amount of boost in the frequency range near the cutoff frequency.

---

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.