浏览代码

Improve AudioEffectDistortion and AudioEffectFilter documentation

skyace65 5 年之前
父节点
当前提交
959f2287f6
共有 2 个文件被更改,包括 5 次插入3 次删除
  1. 3 2
      doc/classes/AudioEffectDistortion.xml
  2. 2 1
      doc/classes/AudioEffectFilter.xml

+ 3 - 2
doc/classes/AudioEffectDistortion.xml

@@ -2,13 +2,14 @@
 <class name="AudioEffectDistortion" inherits="AudioEffect" version="4.0">
 	<brief_description>
 		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>
 	<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.
 	</description>
 	<tutorials>
+		<link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link>
 	</tutorials>
 	<methods>
 	</methods>

+ 2 - 1
doc/classes/AudioEffectFilter.xml

@@ -7,6 +7,7 @@
 		Allows frequencies other than the [member cutoff_hz] to pass.
 	</description>
 	<tutorials>
+		<link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link>
 	</tutorials>
 	<methods>
 	</methods>
@@ -20,7 +21,7 @@
 			Gain amount of the frequencies after the filter.
 		</member>
 		<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>
 	</members>
 	<constants>