summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectReverb.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AudioEffectReverb.xml')
-rw-r--r--doc/classes/AudioEffectReverb.xml34
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml
index 8c9652eee2..a0664e727f 100644
--- a/doc/classes/AudioEffectReverb.xml
+++ b/doc/classes/AudioEffectReverb.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.2">
<brief_description>
- Adds a Reverb audio effect to an Audio bus.
+ Adds a reverberation audio effect to an Audio bus.
Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
</brief_description>
<description>
@@ -12,29 +12,29 @@
<methods>
</methods>
<members>
- <member name="damping" type="float" setter="set_damping" getter="get_damping">
- Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code].
+ <member name="damping" type="float" setter="set_damping" getter="get_damping" default="0.5">
+ Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.
</member>
- <member name="dry" type="float" setter="set_dry" getter="get_dry">
- Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code].
+ <member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
+ Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.
</member>
- <member name="hipass" type="float" setter="set_hpf" getter="get_hpf">
- High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: [code]0[/code].
+ <member name="hipass" type="float" setter="set_hpf" getter="get_hpf" default="0.0">
+ High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.
</member>
- <member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback">
- Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code].
+ <member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback" default="0.4">
+ Output percent of predelay. Value can range from 0 to 1.
</member>
- <member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec">
- Time between the original signal and the early reflections of the reverb signal. Default value: [code]150ms[/code].
+ <member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec" default="150.0">
+ Time between the original signal and the early reflections of the reverb signal, in milliseconds.
</member>
- <member name="room_size" type="float" setter="set_room_size" getter="get_room_size">
- Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code].
+ <member name="room_size" type="float" setter="set_room_size" getter="get_room_size" default="0.8">
+ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.
</member>
- <member name="spread" type="float" setter="set_spread" getter="get_spread">
- Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: [code]1[/code].
+ <member name="spread" type="float" setter="set_spread" getter="get_spread" default="1.0">
+ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.
</member>
- <member name="wet" type="float" setter="set_wet" getter="get_wet">
- Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: [code]0.5[/code].
+ <member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
+ Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.
</member>
</members>
<constants>