| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AudioEffectDistortion.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AudioEffectDistortion:
- AudioEffectDistortion
- =====================
- **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_drive<class_AudioEffectDistortion_get_drive>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_keep_hf_hz<class_AudioEffectDistortion_get_keep_hf_hz>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_mode<class_AudioEffectDistortion_get_mode>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_post_gain<class_AudioEffectDistortion_get_post_gain>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_pre_gain<class_AudioEffectDistortion_get_pre_gain>` **(** **)** const |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_drive<class_AudioEffectDistortion_set_drive>` **(** :ref:`float<class_float>` drive **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_keep_hf_hz<class_AudioEffectDistortion_set_keep_hf_hz>` **(** :ref:`float<class_float>` keep_hf_hz **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_mode<class_AudioEffectDistortion_set_mode>` **(** :ref:`int<class_int>` mode **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_post_gain<class_AudioEffectDistortion_set_post_gain>` **(** :ref:`float<class_float>` post_gain **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_pre_gain<class_AudioEffectDistortion_set_pre_gain>` **(** :ref:`float<class_float>` pre_gain **)** |
- +----------------------------+----------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`float<class_float>` **drive**
- - :ref:`float<class_float>` **keep_hf_hz**
- - :ref:`int<class_int>` **mode**
- - :ref:`float<class_float>` **post_gain**
- - :ref:`float<class_float>` **pre_gain**
- Numeric Constants
- -----------------
- - **MODE_CLIP** = **0**
- - **MODE_ATAN** = **1**
- - **MODE_LOFI** = **2**
- - **MODE_OVERDRIVE** = **3**
- - **MODE_WAVESHAPE** = **4**
- Member Function Description
- ---------------------------
- .. _class_AudioEffectDistortion_get_drive:
- - :ref:`float<class_float>` **get_drive** **(** **)** const
- .. _class_AudioEffectDistortion_get_keep_hf_hz:
- - :ref:`float<class_float>` **get_keep_hf_hz** **(** **)** const
- .. _class_AudioEffectDistortion_get_mode:
- - :ref:`int<class_int>` **get_mode** **(** **)** const
- .. _class_AudioEffectDistortion_get_post_gain:
- - :ref:`float<class_float>` **get_post_gain** **(** **)** const
- .. _class_AudioEffectDistortion_get_pre_gain:
- - :ref:`float<class_float>` **get_pre_gain** **(** **)** const
- .. _class_AudioEffectDistortion_set_drive:
- - void **set_drive** **(** :ref:`float<class_float>` drive **)**
- .. _class_AudioEffectDistortion_set_keep_hf_hz:
- - void **set_keep_hf_hz** **(** :ref:`float<class_float>` keep_hf_hz **)**
- .. _class_AudioEffectDistortion_set_mode:
- - void **set_mode** **(** :ref:`int<class_int>` mode **)**
- .. _class_AudioEffectDistortion_set_post_gain:
- - void **set_post_gain** **(** :ref:`float<class_float>` post_gain **)**
- .. _class_AudioEffectDistortion_set_pre_gain:
- - void **set_pre_gain** **(** :ref:`float<class_float>` pre_gain **)**
|
