W3cubDocs

/Godot 3.1

AudioEffectFilter

Inherits: AudioEffect < Resource < Reference < Object

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

Category: Core

Brief Description

Adds a filter to the Audio Bus.

Properties

float cutoff_hz
FilterDB db
float gain
float resonance

Enumerations

enum FilterDB:

  • FILTER_6DB = 0
  • FILTER_12DB = 1
  • FILTER_18DB = 2
  • FILTER_24DB = 3

Description

Allows frequencies other than the cutoff_hz to pass.

Property Descriptions

float cutoff_hz

Setter set_cutoff(value)
Getter get_cutoff()

Threshold frequency for the filter.

FilterDB db

Setter set_db(value)
Getter get_db()

float gain

Setter set_gain(value)
Getter get_gain()

Gain amount of the frequencies after the filter.

float resonance

Setter set_resonance(value)
Getter get_resonance()

Amount of boost in the overtones near the cutoff frequency.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_audioeffectfilter.html