virtualx-engine/doc/classes/AudioEffectFilter.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectFilter" inherits="AudioEffect" version="3.6" 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>
	<methods>
	</methods>
	<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">
		</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">
		</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" ?>`
Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00			`<class name="AudioEffectFilter" inherits="AudioEffect" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
Proofread and improve the whole class reference - 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 2019-06-22 01:04:47 +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>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:11:20 +01:00			`<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>`
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			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff" default="2000.0">`
Proofread and improve the whole class reference - 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 2019-06-22 01:04:47 +02:00			`Threshold frequency for the filter, in Hz.`
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: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB" default="0">`
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: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="gain" type="float" setter="set_gain" getter="get_gain" default="1.0">`
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: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="resonance" type="float" setter="set_resonance" getter="get_resonance" default="0.5">`
Improve AudioEffectDistortion and AudioEffectFilter documentation (cherry picked from commit 959f2287f6065b1ece5eb717d29b6364efc883c2) 2020-09-11 17:20:21 +02:00			`Amount of boost in the frequency range 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>`