diff options
| author | Henrique Campos | 2017-10-21 13:45:27 -0200 |
|---|---|---|
| committer | Rémi Verschelde | 2017-10-22 11:57:25 +0200 |
| commit | bc667aeada757463fbb562eb262d404968f0ca37 (patch) | |
| tree | 0da2ed69a78617819b4336950f41b84a6bd74f6e /doc/classes/AudioEffectFilter.xml | |
| parent | 8f382879cf327038a89e0530c3adbb1fd124ad1a (diff) | |
| download | godot-bc667aeada757463fbb562eb262d404968f0ca37.tar.gz godot-bc667aeada757463fbb562eb262d404968f0ca37.tar.zst godot-bc667aeada757463fbb562eb262d404968f0ca37.zip | |
Added description to Audio Filter Effects
Also doccumented Filter member variables and methods.
[ci skip]
Diffstat (limited to 'doc/classes/AudioEffectFilter.xml')
| -rw-r--r-- | doc/classes/AudioEffectFilter.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 17aa01d60..dc547c9fe 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -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> |