AudioEffectFilter
Inherits: AudioEffect < Resource < Reference < 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
Properties
float | cutoff_hz | 2000.0 |
FilterDB | db | 0 |
float | gain | 1.0 |
float | resonance | 0.5 |
Enumerations
enum FilterDB:
- FILTER_6DB = 0
- FILTER_12DB = 1
- FILTER_18DB = 2
- FILTER_24DB = 3
Property Descriptions
float cutoff_hz
Default | 2000.0 |
Setter | set_cutoff(value) |
Getter | get_cutoff() |
Threshold frequency for the filter, in Hz.
FilterDB db
Default | 0 |
Setter | set_db(value) |
Getter | get_db() |
float gain
Default | 1.0 |
Setter | set_gain(value) |
Getter | get_gain() |
Gain amount of the frequencies after the filter.
float resonance
Default | 0.5 |
Setter | set_resonance(value) |
Getter | get_resonance() |
Amount of boost in the frequency range near the cutoff frequency.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_audioeffectfilter.html