From de9a5b62295bdbe0e486024be1f5c330be58f3f6 Mon Sep 17 00:00:00 2001 From: skyace65 Date: Fri, 11 Sep 2020 11:20:21 -0400 Subject: [PATCH] Improve AudioEffectDistortion and AudioEffectFilter documentation (cherry picked from commit 959f2287f6065b1ece5eb717d29b6364efc883c2) --- doc/classes/AudioEffectDistortion.xml | 5 +++-- doc/classes/AudioEffectFilter.xml | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index 5ea4c5d2e3f..670f1323b12 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -2,13 +2,14 @@ Adds a distortion audio effect to an Audio bus. - Modify the sound to make it dirty. + Modify the sound to make it distorted. - 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. + https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 04a555a2237..a605ec4185a 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -7,6 +7,7 @@ Allows frequencies other than the [member cutoff_hz] to pass. + https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html @@ -20,7 +21,7 @@ Gain amount of the frequencies after the filter. - Amount of boost in the overtones near the cutoff frequency. + Amount of boost in the frequency range near the cutoff frequency.