mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
197 lines
6.9 KiB
ReStructuredText
197 lines
6.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectFilter.xml.
|
|
|
|
.. _class_AudioEffectFilter:
|
|
|
|
AudioEffectFilter
|
|
=================
|
|
|
|
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :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>`
|
|
|
|
Adds a filter to the audio bus.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` to pass.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`Audio buses <../tutorials/audio/audio_buses>`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` | ``2000.0`` |
|
|
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
|
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_property_db>` | ``0`` |
|
|
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectFilter_property_gain>` | ``1.0`` |
|
|
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`resonance<class_AudioEffectFilter_property_resonance>` | ``0.5`` |
|
|
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_AudioEffectFilter_FilterDB:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **FilterDB**: :ref:`🔗<enum_AudioEffectFilter_FilterDB>`
|
|
|
|
.. _class_AudioEffectFilter_constant_FILTER_6DB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_6DB** = ``0``
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
|
|
|
|
.. _class_AudioEffectFilter_constant_FILTER_12DB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_12DB** = ``1``
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
|
|
|
|
.. _class_AudioEffectFilter_constant_FILTER_18DB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_18DB** = ``2``
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
|
|
|
|
.. _class_AudioEffectFilter_constant_FILTER_24DB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_24DB** = ``3``
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AudioEffectFilter_property_cutoff_hz:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **cutoff_hz** = ``2000.0`` :ref:`🔗<class_AudioEffectFilter_property_cutoff_hz>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_cutoff**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_cutoff**\ (\ )
|
|
|
|
Threshold frequency for the filter, in Hz.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectFilter_property_db:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db** = ``0`` :ref:`🔗<class_AudioEffectFilter_property_db>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_db**\ (\ value\: :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>`\ )
|
|
- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **get_db**\ (\ )
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectFilter_property_gain:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **gain** = ``1.0`` :ref:`🔗<class_AudioEffectFilter_property_gain>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_gain**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_gain**\ (\ )
|
|
|
|
Gain amount of the frequencies after the filter.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectFilter_property_resonance:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **resonance** = ``0.5`` :ref:`🔗<class_AudioEffectFilter_property_resonance>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_resonance**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_resonance**\ (\ )
|
|
|
|
Amount of boost in the frequency range near the cutoff frequency.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|