godot-docs/classes/class_audioeffectfilter.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectFilter.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioEffectFilter:

AudioEffectFilter
=================

**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`AudioEffectHighPassFilter<class_AudioEffectHighPassFilter>`, :ref:`AudioEffectBandLimitFilter<class_AudioEffectBandLimitFilter>`, :ref:`AudioEffectLowShelfFilter<class_AudioEffectLowShelfFilter>`, :ref:`AudioEffectHighShelfFilter<class_AudioEffectHighShelfFilter>`, :ref:`AudioEffectBandPassFilter<class_AudioEffectBandPassFilter>`, :ref:`AudioEffectNotchFilter<class_AudioEffectNotchFilter>`, :ref:`AudioEffectLowPassFilter<class_AudioEffectLowPassFilter>`
**Category:** Core

Brief Description
-----------------

Adds a filter to the Audio Bus.

Enumerations
------------

  .. _enum_AudioEffectFilter_FilterDB:

enum **FilterDB**

- **FILTER_6DB** = **0**
- **FILTER_12DB** = **1**
- **FILTER_18DB** = **2**
- **FILTER_24DB** = **3**


Description
-----------

Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_cutoff_hz>` to pass.

Property Descriptions
---------------------

  .. _class_AudioEffectFilter_cutoff_hz:

- :ref:`float<class_float>` **cutoff_hz** - Threshold frequency for the filter.

  .. _class_AudioEffectFilter_db:

- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db**

  .. _class_AudioEffectFilter_gain:

- :ref:`float<class_float>` **gain** - Gain amount of the frequencies after the filter.

  .. _class_AudioEffectFilter_resonance:

- :ref:`float<class_float>` **resonance** - Amount of boost in the overtones near the cutoff frequency.