Files
godot-docs/classes/class_audioeffectphaser.rst
2017-09-23 11:01:36 +02:00

97 lines
4.8 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectPhaser.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioEffectPhaser:
AudioEffectPhaser
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth<class_AudioEffectPhaser_get_depth>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback<class_AudioEffectPhaser_get_feedback>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range_max_hz<class_AudioEffectPhaser_get_range_max_hz>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range_min_hz<class_AudioEffectPhaser_get_range_min_hz>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rate_hz<class_AudioEffectPhaser_get_rate_hz>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth<class_AudioEffectPhaser_set_depth>` **(** :ref:`float<class_float>` depth **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback<class_AudioEffectPhaser_set_feedback>` **(** :ref:`float<class_float>` fbk **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range_max_hz<class_AudioEffectPhaser_set_range_max_hz>` **(** :ref:`float<class_float>` hz **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range_min_hz<class_AudioEffectPhaser_set_range_min_hz>` **(** :ref:`float<class_float>` hz **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rate_hz<class_AudioEffectPhaser_set_rate_hz>` **(** :ref:`float<class_float>` hz **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **depth**
- :ref:`float<class_float>` **feedback**
- :ref:`float<class_float>` **range_max_hz**
- :ref:`float<class_float>` **range_min_hz**
- :ref:`float<class_float>` **rate_hz**
Member Function Description
---------------------------
.. _class_AudioEffectPhaser_get_depth:
- :ref:`float<class_float>` **get_depth** **(** **)** const
.. _class_AudioEffectPhaser_get_feedback:
- :ref:`float<class_float>` **get_feedback** **(** **)** const
.. _class_AudioEffectPhaser_get_range_max_hz:
- :ref:`float<class_float>` **get_range_max_hz** **(** **)** const
.. _class_AudioEffectPhaser_get_range_min_hz:
- :ref:`float<class_float>` **get_range_min_hz** **(** **)** const
.. _class_AudioEffectPhaser_get_rate_hz:
- :ref:`float<class_float>` **get_rate_hz** **(** **)** const
.. _class_AudioEffectPhaser_set_depth:
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
.. _class_AudioEffectPhaser_set_feedback:
- void **set_feedback** **(** :ref:`float<class_float>` fbk **)**
.. _class_AudioEffectPhaser_set_range_max_hz:
- void **set_range_max_hz** **(** :ref:`float<class_float>` hz **)**
.. _class_AudioEffectPhaser_set_range_min_hz:
- void **set_range_min_hz** **(** :ref:`float<class_float>` hz **)**
.. _class_AudioEffectPhaser_set_rate_hz:
- void **set_rate_hz** **(** :ref:`float<class_float>` hz **)**