godot/doc/classes/AudioEffectFilter.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectFilter" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Adds a filter to the audio bus.
	</brief_description>
	<description>
		Allows frequencies other than the [member cutoff_hz] to pass.
	</description>
	<tutorials>
		<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
	</tutorials>
	<members>
		<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff" default="2000.0">
			Threshold frequency for the filter, in Hz.
		</member>
		<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 name="gain" type="float" setter="set_gain" getter="get_gain" default="1.0">
			Gain amount of the frequencies after the filter.
		</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">
			Cutting off at 6dB per octave.
		</constant>
		<constant name="FILTER_12DB" value="1" enum="FilterDB">
			Cutting off at 12dB per octave.
		</constant>
		<constant name="FILTER_18DB" value="2" enum="FilterDB">
			Cutting off at 18dB per octave.
		</constant>
		<constant name="FILTER_24DB" value="3" enum="FilterDB">
			Cutting off at 24dB per octave.
		</constant>
	</constants>
</class>