diff options
| author | Jerome67000 | 2017-09-16 18:47:19 +0200 |
|---|---|---|
| committer | Jérôme | 2017-09-28 13:26:18 +0200 |
| commit | 8c19cc7b3da43d143f4316e1b7de2c7c2a35b328 (patch) | |
| tree | 3577acda32688c4171cc0e1c785d6ecb67d27d7c /doc/classes/AudioEffectEQ.xml | |
| parent | 210ebb5cdbecd326c1b0edd35cfda94e3a74c6d9 (diff) | |
| download | godot-8c19cc7b3da43d143f4316e1b7de2c7c2a35b328.tar.gz godot-8c19cc7b3da43d143f4316e1b7de2c7c2a35b328.tar.zst godot-8c19cc7b3da43d143f4316e1b7de2c7c2a35b328.zip | |
[DOCS] Adds AudioEffects doc
Diffstat (limited to '')
| -rw-r--r-- | doc/classes/AudioEffectEQ.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index 94d5c696c..246f6b882 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Base class for audio equalizers. Gives you control over frequencies. + Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs. </brief_description> <description> + AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged). </description> <tutorials> </tutorials> @@ -13,6 +16,7 @@ <return type="int"> </return> <description> + Returns the number of bands of the equalizer. </description> </method> <method name="get_band_gain_db" qualifiers="const"> @@ -21,6 +25,7 @@ <argument index="0" name="band_idx" type="int"> </argument> <description> + Returns the band's gain at the specified index, in dB. </description> </method> <method name="set_band_gain_db"> @@ -31,6 +36,7 @@ <argument index="1" name="volume_db" type="float"> </argument> <description> + Sets band's gain at the specified index, in dB. </description> </method> </methods> |