AudioEffectFilter: enhance documentation

betalars · Oct 21, 2024 · 370da05 · 370da05
1 parent 44fa552
commit 370da05
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 10 deletions.
diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml
@@ -14,22 +14,27 @@
 			Threshold frequency for the filter, in Hz.
 		</member>
 		<member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB" default="0">
+			Steepnes of the cutoff curve in dB per octave, also known as order of the filter. Higher orders have a more aggressive cutoff.
 		</member>
 		<member name="gain" type="float" setter="set_gain" getter="get_gain" default="1.0">
-			Gain amount of the frequencies after the filter.
-		</member>
+			Boosts frequencies at the cutoff.
+		</member>			
 		<member name="resonance" type="float" setter="set_resonance" getter="get_resonance" default="0.5">
 			Amount of boost in the frequency range near the cutoff frequency.
 		</member>
 	</members>
 	<constants>
 		<constant name="FILTER_6DB" value="0" enum="FilterDB">
+			First order filter, cutting off at 6dB per octave.
 		</constant>
 		<constant name="FILTER_12DB" value="1" enum="FilterDB">
+			Second order filter, cutting off at 12dB per octave.
 		</constant>
 		<constant name="FILTER_18DB" value="2" enum="FilterDB">
+			Third order filter, cutting off at 18dB per octave.
 		</constant>
 		<constant name="FILTER_24DB" value="3" enum="FilterDB">
+			Fourth order filter, cutting off at 24dB per octave.
 		</constant>
 	</constants>
 </class>
diff --git a/doc/translations/de.po b/doc/translations/de.po
@@ -13315,8 +13315,8 @@ msgstr "Lässt andere Frequenzen als den [member cutoff_hz] passieren."
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "Schwellenfrequenz für den Filter, in Hz."
 
-msgid "Gain amount of the frequencies after the filter."
-msgstr "Verstärkungsgrad der Frequenzen nach dem Filter."
+msgid "Boosts frequencies at the cutoff."
+msgstr "Verstärkt die Frequenzen an der Filtergrenze."
 
 msgid "Amount of boost in the frequency range near the cutoff frequency."
 msgstr "Höhe der Anhebung im Frequenzbereich nahe der Grenzfrequenz."

diff --git a/doc/translations/es.po b/doc/translations/es.po
@@ -3767,7 +3767,7 @@ msgstr ""
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "Frecuencia de umbral para el filtro, en Hz."
 
-msgid "Gain amount of the frequencies after the filter."
+msgid "Boosts frequencies at the cutoff."
 msgstr "Ganar cantidad de frecuencias después del filtro."
 
 msgid ""

diff --git a/doc/translations/fr.po b/doc/translations/fr.po
@@ -3455,7 +3455,7 @@ msgstr "Autorise les fréquences autres que [membre cutoff_hz] à passer."
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "Le fréquence seuil pour le filtre, en Hz."
 
-msgid "Gain amount of the frequencies after the filter."
+msgid "Boosts frequencies at the cutoff."
 msgstr "La valeur du gain de fréquences après le filtre."
 
 msgid "Amount of boost in the frequency range near the cutoff frequency."

diff --git a/doc/translations/ga.po b/doc/translations/ga.po
@@ -16512,7 +16512,7 @@ msgstr ""
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "Minicíocht tairsí don scagaire, i Hz."
 
-msgid "Gain amount of the frequencies after the filter."
+msgid "Boosts frequencies at the cutoff."
 msgstr "Faigh méid na minicíochtaí tar éis an scagaire."
 
 msgid "Amount of boost in the frequency range near the cutoff frequency."

diff --git a/doc/translations/it.po b/doc/translations/it.po
@@ -13301,7 +13301,7 @@ msgstr "Consente le frequenze diverse da [member cutoff_hz] a passare."
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "Frequenza di soglia per il filtro, in Hz."
 
-msgid "Gain amount of the frequencies after the filter."
+msgid "Boosts frequencies at the cutoff."
 msgstr "Quantità di guadagno delle frequenze dopo il filtro."
 
 msgid "Amount of boost in the frequency range near the cutoff frequency."

diff --git a/doc/translations/zh_CN.po b/doc/translations/zh_CN.po
@@ -15100,7 +15100,7 @@ msgstr "允许通过 [member cutoff_hz] 以外的频率。"
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "滤波器的阈值频率，单位为 Hz。"
 
-msgid "Gain amount of the frequencies after the filter."
+msgid "Boosts frequencies at the cutoff."
 msgstr "滤波后频率的增益量。"
 
 msgid "Amount of boost in the frequency range near the cutoff frequency."

diff --git a/doc/translations/zh_TW.po b/doc/translations/zh_TW.po
@@ -9719,7 +9719,7 @@ msgstr "允許通過 [member cutoff_hz] 以外的頻率。"
 msgid "Threshold frequency for the filter, in Hz."
 msgstr "濾波器的閾值頻率，單位為 Hz。"
 
-msgid "Gain amount of the frequencies after the filter."
+msgid "Boosts frequencies at the cutoff."
 msgstr "濾波後頻率的增益量。"
 
 msgid "Amount of boost in the frequency range near the cutoff frequency."