mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
54 lines
1.7 KiB
ReStructuredText
54 lines
1.7 KiB
ReStructuredText
.. 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.
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_AudioEffectFilter_cutoff_hz:
|
|
|
|
- :ref:`float<class_float>` **cutoff_hz** - Threshold frequency for the filter.
|
|
|
|
.. _class_AudioEffectFilter_db:
|
|
|
|
- :ref:`int<class_int>` **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.
|
|
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **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.
|
|
|