godot/doc/classes/AudioEffectDistortion.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectDistortion" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Adds a distortion audio effect to an Audio bus.
		Modifies the sound to make it distorted.
	</brief_description>
	<description>
		Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.
		By distorting the waveform the frequency content changes, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.
	</description>
	<tutorials>
		<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
	</tutorials>
	<members>
		<member name="drive" type="float" setter="set_drive" getter="get_drive" default="0.0">
			Distortion power. Value can range from 0 to 1.
		</member>
		<member name="keep_hf_hz" type="float" setter="set_keep_hf_hz" getter="get_keep_hf_hz" default="16000.0">
			High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
		</member>
		<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="AudioEffectDistortion.Mode" default="0">
			Distortion type.
		</member>
		<member name="post_gain" type="float" setter="set_post_gain" getter="get_post_gain" default="0.0">
			Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24.
		</member>
		<member name="pre_gain" type="float" setter="set_pre_gain" getter="get_pre_gain" default="0.0">
			Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60.
		</member>
	</members>
	<constants>
		<constant name="MODE_CLIP" value="0" enum="Mode">
			Digital distortion effect which cuts off peaks at the top and bottom of the waveform.
		</constant>
		<constant name="MODE_ATAN" value="1" enum="Mode">
		</constant>
		<constant name="MODE_LOFI" value="2" enum="Mode">
			Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices.
		</constant>
		<constant name="MODE_OVERDRIVE" value="3" enum="Mode">
			Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. The [member drive] property has no effect in this mode.
		</constant>
		<constant name="MODE_WAVESHAPE" value="4" enum="Mode">
			Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.
		</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-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 16:08:05 +08:00			`<class name="AudioEffectDistortion" inherits="AudioEffect" 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-13 04:42:36 +08: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 07:04:47 +08:00			`Adds a distortion audio effect to an Audio bus.`
AudioEffectDistorion docs & inspector edits Fixing a few typos in the AudioEffectDistortion docs, making a few things clearer, etc Also adding the decibel (dB) suffix to the pre/post gain properties in the inspector. 2022-11-21 13:04:11 +08:00			`Modifies the sound to make it distorted.`
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-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Improve AudioEffectDistortion and AudioEffectFilter documentation 2020-09-11 23:20:21 +08:00			`Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.`
AudioEffectDistorion docs & inspector edits Fixing a few typos in the AudioEffectDistortion docs, making a few things clearer, etc Also adding the decibel (dB) suffix to the pre/post gain properties in the inspector. 2022-11-21 13:04:11 +08:00			`By distorting the waveform the frequency content changes, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.`
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-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:43:07 +08: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-13 04:42:36 +08:00			`</tutorials>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="drive" type="float" setter="set_drive" getter="get_drive" default="0.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Distortion power. Value can range from 0 to 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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="keep_hf_hz" type="float" setter="set_keep_hf_hz" getter="get_keep_hf_hz" default="16000.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.`
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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="AudioEffectDistortion.Mode" default="0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Distortion type.`
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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="post_gain" type="float" setter="set_post_gain" getter="get_post_gain" default="0.0">`
AudioEffectDistorion docs & inspector edits Fixing a few typos in the AudioEffectDistortion docs, making a few things clearer, etc Also adding the decibel (dB) suffix to the pre/post gain properties in the inspector. 2022-11-21 13:04:11 +08:00			`Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24.`
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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pre_gain" type="float" setter="set_pre_gain" getter="get_pre_gain" default="0.0">`
AudioEffectDistorion docs & inspector edits Fixing a few typos in the AudioEffectDistortion docs, making a few things clearer, etc Also adding the decibel (dB) suffix to the pre/post gain properties in the inspector. 2022-11-21 13:04:11 +08:00			`Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60.`
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-13 04:42:36 +08:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_CLIP" value="0" enum="Mode">`
[DOCS] Adds AudioEffects doc 2017-09-17 00:47:19 +08:00			`Digital distortion effect which cuts off peaks at the top and bottom of the waveform.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_ATAN" value="1" enum="Mode">`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_LOFI" value="2" enum="Mode">`
AudioEffectDistorion docs & inspector edits Fixing a few typos in the AudioEffectDistortion docs, making a few things clearer, etc Also adding the decibel (dB) suffix to the pre/post gain properties in the inspector. 2022-11-21 13:04:11 +08:00			`Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_OVERDRIVE" value="3" enum="Mode">`
AudioEffectDistorion docs & inspector edits Fixing a few typos in the AudioEffectDistortion docs, making a few things clearer, etc Also adding the decibel (dB) suffix to the pre/post gain properties in the inspector. 2022-11-21 13:04:11 +08:00			`Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. The [member drive] property has no effect in this mode.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_WAVESHAPE" value="4" enum="Mode">`
[DOCS] Adds AudioEffects doc 2017-09-17 00:47:19 +08:00			`Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08: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-13 04:42:36 +08:00			`</constants>`
			`</class>`