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:`AudioEffectBandLimitFilter<class_AudioEffectBandLimitFilter>`, :ref:`AudioEffectBandPassFilter<class_AudioEffectBandPassFilter>`, :ref:`AudioEffectHighPassFilter<class_AudioEffectHighPassFilter>`, :ref:`AudioEffectHighShelfFilter<class_AudioEffectHighShelfFilter>`, :ref:`AudioEffectLowPassFilter<class_AudioEffectLowPassFilter>`, :ref:`AudioEffectLowShelfFilter<class_AudioEffectLowShelfFilter>`, :ref:`AudioEffectNotchFilter<class_AudioEffectNotchFilter>`

**Category:** Core

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

Adds a filter to the Audio Bus.

Properties
----------

+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_property_db>`               |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`gain<class_AudioEffectFilter_property_gain>`           |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`resonance<class_AudioEffectFilter_property_resonance>` |
+--------------------------------------------------+--------------------------------------------------------------+

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

.. _enum_AudioEffectFilter_FilterDB:

.. _class_AudioEffectFilter_constant_FILTER_6DB:

.. _class_AudioEffectFilter_constant_FILTER_12DB:

.. _class_AudioEffectFilter_constant_FILTER_18DB:

.. _class_AudioEffectFilter_constant_FILTER_24DB:

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_property_cutoff_hz>` to pass.

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

.. _class_AudioEffectFilter_property_cutoff_hz:

- :ref:`float<class_float>` **cutoff_hz**

+----------+-------------------+
| *Setter* | set_cutoff(value) |
+----------+-------------------+
| *Getter* | get_cutoff()      |
+----------+-------------------+

Threshold frequency for the filter.

.. _class_AudioEffectFilter_property_db:

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

+----------+---------------+
| *Setter* | set_db(value) |
+----------+---------------+
| *Getter* | get_db()      |
+----------+---------------+

.. _class_AudioEffectFilter_property_gain:

- :ref:`float<class_float>` **gain**

+----------+-----------------+
| *Setter* | set_gain(value) |
+----------+-----------------+
| *Getter* | get_gain()      |
+----------+-----------------+

Gain amount of the frequencies after the filter.

.. _class_AudioEffectFilter_property_resonance:

- :ref:`float<class_float>` **resonance**

+----------+----------------------+
| *Setter* | set_resonance(value) |
+----------+----------------------+
| *Getter* | get_resonance()      |
+----------+----------------------+

Amount of boost in the overtones near the cutoff frequency.