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

Added description to Audio Filter Effects

Browse Source 
Also doccumented Filter member variables and methods.
[ci skip]
This commit is contained in:
Henrique Campos 2017-10-21 13:45:27 -02:00 committed by Rémi Verschelde
parent 8f382879cf
commit bc667aeada
6 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/AudioEffectBandLimitFilter.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Adds a band limit filter to the Audio Bus.
</brief_description>
<description>
Limits the frequencies in a range around the [member cutoff_hz] and allows frequencies outside of this range to pass.
</description>
<tutorials>
</tutorials>

2
doc/classes/AudioEffectBandPassFilter.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Adds a band pass filter to the Audio Bus.
</brief_description>
<description>
Attenuates the frequencies inside of a range around the [member cutoff_hz] and cuts frequencies outside of this band.
</description>
<tutorials>
</tutorials>

6
doc/classes/AudioEffectFilter.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Adds a filter to the Audio Bus.
</brief_description>
<description>
Allows frequencies other than the [member cutoff_hz] to pass.
</description>
<tutorials>
</tutorials>
@ -68,12 +70,16 @@
</methods>
<members>
<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff">
Threshold frequency for the filter.
</member>
<member name="dB" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB">
The volume in decibels of the filter.
</member>
<member name="gain" type="float" setter="set_gain" getter="get_gain">
Gain amount of the frequences after the filter.
</member>
<member name="resonance" type="float" setter="set_resonance" getter="get_resonance">
Amount of boost in the overtones near the cutoff frequency.
</member>
</members>
<constants>

2
doc/classes/AudioEffectHighPassFilter.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Adds a high pass filter to the Audio Bus.
</brief_description>
<description>
Cuts frequencies lower than the [member cutoff_hz] and allows higher frequencies to pass.
</description>
<tutorials>
</tutorials>

2
doc/classes/AudioEffectLowPassFilter.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Adds a low pass filter to the Audio Bus.
</brief_description>
<description>
Cuts frequencies higher than the [member cutoff_hz] and allows lower frequencies to pass.
</description>
<tutorials>
</tutorials>

2
doc/classes/AudioEffectNotchFilter.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Adds a notch filter to the Audio Bus.
</brief_description>
<description>
Attenuates frequencies in a narrow band around the [member cutoff_hz] and cuts frequencies outside of this range.
</description>
<tutorials>
</tutorials>