f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
37 lines
1.2 KiB
XML
37 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.2">
|
|
<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>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff">
|
|
Threshold frequency for the filter, in Hz.
|
|
</member>
|
|
<member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB">
|
|
</member>
|
|
<member name="gain" type="float" setter="set_gain" getter="get_gain">
|
|
Gain amount of the frequencies 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>
|
|
<constant name="FILTER_6DB" value="0" enum="FilterDB">
|
|
</constant>
|
|
<constant name="FILTER_12DB" value="1" enum="FilterDB">
|
|
</constant>
|
|
<constant name="FILTER_18DB" value="2" enum="FilterDB">
|
|
</constant>
|
|
<constant name="FILTER_24DB" value="3" enum="FilterDB">
|
|
</constant>
|
|
</constants>
|
|
</class>
|