| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- .. 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 Functions
- ----------------
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_cutoff<class_AudioEffectFilter_get_cutoff>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_db<class_AudioEffectFilter_get_db>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectFilter_get_gain>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_resonance<class_AudioEffectFilter_get_resonance>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_cutoff<class_AudioEffectFilter_set_cutoff>` **(** :ref:`float<class_float>` freq **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_db<class_AudioEffectFilter_set_db>` **(** :ref:`int<class_int>` amount **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_gain<class_AudioEffectFilter_set_gain>` **(** :ref:`float<class_float>` amount **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_resonance<class_AudioEffectFilter_set_resonance>` **(** :ref:`float<class_float>` amount **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------+
- 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.
- Member Function Description
- ---------------------------
- .. _class_AudioEffectFilter_get_cutoff:
- - :ref:`float<class_float>` **get_cutoff** **(** **)** const
- .. _class_AudioEffectFilter_get_db:
- - :ref:`int<class_int>` **get_db** **(** **)** const
- .. _class_AudioEffectFilter_get_gain:
- - :ref:`float<class_float>` **get_gain** **(** **)** const
- .. _class_AudioEffectFilter_get_resonance:
- - :ref:`float<class_float>` **get_resonance** **(** **)** const
- .. _class_AudioEffectFilter_set_cutoff:
- - void **set_cutoff** **(** :ref:`float<class_float>` freq **)**
- .. _class_AudioEffectFilter_set_db:
- - void **set_db** **(** :ref:`int<class_int>` amount **)**
- .. _class_AudioEffectFilter_set_gain:
- - void **set_gain** **(** :ref:`float<class_float>` amount **)**
- .. _class_AudioEffectFilter_set_resonance:
- - void **set_resonance** **(** :ref:`float<class_float>` amount **)**
|
