godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-27 08:32:15 +01:00
parent 33f109ea70
commit 5bf33731b6
303 changed files with 2187 additions and 18408 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
classes/class_audioeffectlimiter.rst
View File

@@ -16,27 +16,6 @@ Brief Description
Adds a soft clip Limiter audio effect to an Audio bus.
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ceiling_db<class_AudioEffectLimiter_get_ceiling_db>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_soft_clip_db<class_AudioEffectLimiter_get_soft_clip_db>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_soft_clip_ratio<class_AudioEffectLimiter_get_soft_clip_ratio>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_threshold_db<class_AudioEffectLimiter_get_threshold_db>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ceiling_db<class_AudioEffectLimiter_set_ceiling_db>` **(** :ref:`float<class_float>` ceiling **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_soft_clip_db<class_AudioEffectLimiter_set_soft_clip_db>` **(** :ref:`float<class_float>` soft_clip **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_soft_clip_ratio<class_AudioEffectLimiter_set_soft_clip_ratio>` **(** :ref:`float<class_float>` soft_clip **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_threshold_db<class_AudioEffectLimiter_set_threshold_db>` **(** :ref:`float<class_float>` threshold **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -64,39 +43,3 @@ A limiter is similar to a compressor, but it’s less flexible and designed to d
Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.
Member Function Description
---------------------------
.. _class_AudioEffectLimiter_get_ceiling_db:
- :ref:`float<class_float>` **get_ceiling_db** **(** **)** const
.. _class_AudioEffectLimiter_get_soft_clip_db:
- :ref:`float<class_float>` **get_soft_clip_db** **(** **)** const
.. _class_AudioEffectLimiter_get_soft_clip_ratio:
- :ref:`float<class_float>` **get_soft_clip_ratio** **(** **)** const
.. _class_AudioEffectLimiter_get_threshold_db:
- :ref:`float<class_float>` **get_threshold_db** **(** **)** const
.. _class_AudioEffectLimiter_set_ceiling_db:
- void **set_ceiling_db** **(** :ref:`float<class_float>` ceiling **)**
.. _class_AudioEffectLimiter_set_soft_clip_db:
- void **set_soft_clip_db** **(** :ref:`float<class_float>` soft_clip **)**
.. _class_AudioEffectLimiter_set_soft_clip_ratio:
- void **set_soft_clip_ratio** **(** :ref:`float<class_float>` soft_clip **)**
.. _class_AudioEffectLimiter_set_threshold_db:
- void **set_threshold_db** **(** :ref:`float<class_float>` threshold **)**