godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve AudioEffectDistortion and AudioEffectFilter documentation 

(cherry picked from commit 959f2287f6)
This commit is contained in:
skyace65 2020-09-11 11:20:21 -04:00 committed by Rémi Verschelde
parent b626f16212
commit de9a5b6229
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/AudioEffectDistortion.xml
View File

@ -2,13 +2,14 @@
<class name="AudioEffectDistortion" inherits="AudioEffect" version="3.2"> <class name="AudioEffectDistortion" inherits="AudioEffect" version="3.2">
<brief_description> <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. Modify the sound to make it distorted.
</brief_description> </brief_description>
<description> <description>
Modify the sound and make it dirty. Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape. 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. 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> </description>
<tutorials> <tutorials>
<link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<methods> <methods>
</methods> </methods>

3
doc/classes/AudioEffectFilter.xml
View File

@ -7,6 +7,7 @@
Allows frequencies other than the [member cutoff_hz] to pass. Allows frequencies other than the [member cutoff_hz] to pass.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<methods> <methods>
</methods> </methods>
@ -20,7 +21,7 @@
Gain amount of the frequencies after the filter. Gain amount of the frequencies after the filter.
</member> </member>
<member name="resonance" type="float" setter="set_resonance" getter="get_resonance" default="0.5"> <member name="resonance" type="float" setter="set_resonance" getter="get_resonance" default="0.5">
Amount of boost in the overtones near the cutoff frequency. Amount of boost in the frequency range near the cutoff frequency.
</member> </member>
</members> </members>
<constants> <constants>