godot/doc/classes/AudioEffectPhaser.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPhaser" inherits="AudioEffect" version="4.0">
	<brief_description>
		Adds a phaser audio effect to an Audio bus.
		Combines the original signal with a copy that is slightly out of phase with the original.
	</brief_description>
	<description>
		Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a low-frequency oscillator.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">
			Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.
		</member>
		<member name="feedback" type="float" setter="set_feedback" getter="get_feedback" default="0.7">
			Output percent of modified sound. Value can range from 0.1 to 0.9.
		</member>
		<member name="range_max_hz" type="float" setter="set_range_max_hz" getter="get_range_max_hz" default="1600.0">
			Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
		</member>
		<member name="range_min_hz" type="float" setter="set_range_min_hz" getter="get_range_min_hz" default="440.0">
			Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
		</member>
		<member name="rate_hz" type="float" setter="set_rate_hz" getter="get_rate_hz" default="0.5">
			Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.
		</member>
	</members>
</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 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 01:03:48 +00:00			`<class name="AudioEffectPhaser" inherits="AudioEffect" version="4.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 20:42:36 +00: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-21 23:04:47 +00:00			`Adds a phaser audio effect to an Audio bus.`
[DOCS] Adds AudioEffects doc 2017-09-16 16:47:19 +00:00			`Combines the original signal with a copy that is slightly out of phase with the original.`
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 20:42:36 +00:00			`</brief_description>`
			`<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-21 23:04:47 +00:00			`Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a low-frequency oscillator.`
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 20:42:36 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="feedback" type="float" setter="set_feedback" getter="get_feedback" default="0.7">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`Output percent of modified sound. Value can range from 0.1 to 0.9.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="range_max_hz" type="float" setter="set_range_max_hz" getter="get_range_max_hz" default="1600.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="range_min_hz" type="float" setter="set_range_min_hz" getter="get_range_min_hz" default="440.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="rate_hz" type="float" setter="set_rate_hz" getter="get_rate_hz" default="0.5">`
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-21 23:04:47 +00:00			`Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.`
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 20:42:36 +00:00			`</member>`
			`</members>`
			`</class>`