virtualx-engine/doc/classes/AudioEffectFilter.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0.1">
	<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>
	<demos>
	</demos>
	<methods>
	</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">
		</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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update doc version strings to 3.0.1 2018-02-24 18:59:38 +01:00			`<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0.1">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Added description to Audio Filter Effects Also doccumented Filter member variables and methods. [ci skip] 2017-10-21 17:45:27 +02:00			`Adds a filter to the Audio Bus.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Added description to Audio Filter Effects Also doccumented Filter member variables and methods. [ci skip] 2017-10-21 17:45:27 +02:00			`Allows frequencies other than the [member cutoff_hz] to pass.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<demos>`
			`</demos>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff">`
Added description to Audio Filter Effects Also doccumented Filter member variables and methods. [ci skip] 2017-10-21 17:45:27 +02:00			`Threshold frequency for the filter.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip] 2017-10-22 12:56:11 +02:00			`<member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="gain" type="float" setter="set_gain" getter="get_gain">`
Added description for camera2D missing members Also fixed typo in AudioEffectFilter. [ci skip] 2017-10-25 15:07:45 +02:00			`Gain amount of the frequencies after the filter.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="resonance" type="float" setter="set_resonance" getter="get_resonance">`
Added description to Audio Filter Effects Also doccumented Filter member variables and methods. [ci skip] 2017-10-21 17:45:27 +02:00			`Amount of boost in the overtones near the cutoff frequency.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="FILTER_6DB" value="0" enum="FilterDB">`
doc: Sync classref with current source [ci skip] 2017-09-16 01:46:14 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="FILTER_12DB" value="1" enum="FilterDB">`
doc: Sync classref with current source [ci skip] 2017-09-16 01:46:14 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="FILTER_18DB" value="2" enum="FilterDB">`
doc: Sync classref with current source [ci skip] 2017-09-16 01:46:14 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="FILTER_24DB" value="3" enum="FilterDB">`
doc: Sync classref with current source [ci skip] 2017-09-16 01:46:14 +02:00			`</constant>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constants>`
			`</class>`