Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

AudioEffectFilter and StereoEnhance: Documentation improvements

Browse Source
This commit is contained in:
betalars 2024-10-24 01:07:52 +02:00
parent 44fa552343
commit 1be2f8c535
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/AudioEffectFilter.xml
View File

@ -14,6 +14,7 @@
Threshold frequency for the filter, in Hz. Threshold frequency for the filter, in Hz.
</member> </member>
<member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB" default="0"> <member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB" default="0">
Steepness of the cutoff curve in dB per octave, also known as the order of the filter. Higher orders have a more aggressive cutoff.
</member> </member>
<member name="gain" type="float" setter="set_gain" getter="get_gain" default="1.0"> <member name="gain" type="float" setter="set_gain" getter="get_gain" default="1.0">
Gain amount of the frequencies after the filter. Gain amount of the frequencies after the filter.
@ -24,12 +25,16 @@
</members> </members>
<constants> <constants>
<constant name="FILTER_6DB" value="0" enum="FilterDB"> <constant name="FILTER_6DB" value="0" enum="FilterDB">
Cutting off at 6dB per octave.
</constant> </constant>
<constant name="FILTER_12DB" value="1" enum="FilterDB"> <constant name="FILTER_12DB" value="1" enum="FilterDB">
Cutting off at 12dB per octave.
</constant> </constant>
<constant name="FILTER_18DB" value="2" enum="FilterDB"> <constant name="FILTER_18DB" value="2" enum="FilterDB">
Cutting off at 18dB per octave.
</constant> </constant>
<constant name="FILTER_24DB" value="3" enum="FilterDB"> <constant name="FILTER_24DB" value="3" enum="FilterDB">
Cutting off at 24dB per octave.
</constant> </constant>
</constants> </constants>
</class> </class>

4
doc/classes/AudioEffectStereoEnhance.xml
View File

@ -11,11 +11,13 @@
</tutorials> </tutorials>
<members> <members>
<member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout" default="1.0"> <member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout" default="1.0">
Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono. Amplifies the difference between stereo channels, increasing or decreasing existing panning. A value of 0.0 will downmix stereo to mono. Does not affect a mono signal.
</member> </member>
<member name="surround" type="float" setter="set_surround" getter="get_surround" default="0.0"> <member name="surround" type="float" setter="set_surround" getter="get_surround" default="0.0">
Widens sound stage through phase shifting in conjunction with [member time_pullout_ms]. Just pans sound to the left channel if [member time_pullout_ms] is 0.
</member> </member>
<member name="time_pullout_ms" type="float" setter="set_time_pullout" getter="get_time_pullout" default="0.0"> <member name="time_pullout_ms" type="float" setter="set_time_pullout" getter="get_time_pullout" default="0.0">
Widens sound stage through phase shifting in conjunction with [member surround]. Just delays the right channel if [member surround] is 0.
</member> </member>
</members> </members>
</class> </class>