summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectDistortion.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AudioEffectDistortion.xml')
-rw-r--r--doc/classes/AudioEffectDistortion.xml24
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml
index cf02a8fb6d..0ee7d73f88 100644
--- a/doc/classes/AudioEffectDistortion.xml
+++ b/doc/classes/AudioEffectDistortion.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.2">
<brief_description>
- Adds a Distortion audio effect to an Audio bus.
+ Adds a distortion audio effect to an Audio bus.
Modify the sound to make it dirty.
</brief_description>
<description>
- Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape.
+ Modify the sound and make it dirty. Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.
By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.
</description>
<tutorials>
@@ -13,20 +13,20 @@
<methods>
</methods>
<members>
- <member name="drive" type="float" setter="set_drive" getter="get_drive">
- Distortion power. Value can range from 0 to 1. Default value: [code]0[/code].
+ <member name="drive" type="float" setter="set_drive" getter="get_drive" default="0.0">
+ Distortion power. Value can range from 0 to 1.
</member>
- <member name="keep_hf_hz" type="float" setter="set_keep_hf_hz" getter="get_keep_hf_hz">
- High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: [code]16000[/code].
+ <member name="keep_hf_hz" type="float" setter="set_keep_hf_hz" getter="get_keep_hf_hz" default="16000.0">
+ High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
</member>
- <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="AudioEffectDistortion.Mode">
- Distortion type. Default value: [constant MODE_CLIP].
+ <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="AudioEffectDistortion.Mode" default="0">
+ Distortion type.
</member>
- <member name="post_gain" type="float" setter="set_post_gain" getter="get_post_gain">
- Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: [code]0[/code].
+ <member name="post_gain" type="float" setter="set_post_gain" getter="get_post_gain" default="0.0">
+ Increases or decreases the volume after the effect. Value can range from -80 to 24.
</member>
- <member name="pre_gain" type="float" setter="set_pre_gain" getter="get_pre_gain">
- Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: [code]0[/code].
+ <member name="pre_gain" type="float" setter="set_pre_gain" getter="get_pre_gain" default="0.0">
+ Increases or decreases the volume before the effect. Value can range from -60 to 60.
</member>
</members>
<constants>