Skip to content

Commit eb104c0

Browse files
authored
Merge pull request #9401 from skyace65/HardLimiter
Document HardLimiter audio bus effect
2 parents 83a98d8 + 6122e64 commit eb104c0

File tree

4 files changed

+18
-5
lines changed

4 files changed

+18
-5
lines changed

tutorials/audio/audio_buses.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Adding effects
9191
Audio buses can contain all sorts of effects. These effects modify the sound in
9292
one way or another and are applied in order.
9393

94-
.. image:: img/audio_buses4.png
94+
.. image:: img/audio_buses4.webp
9595

9696
For information on what each effect does, see :ref:`doc_audio_effects`.
9797

tutorials/audio/audio_effects.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Audio effects
88
Godot includes several audio effects that can be added to an audio bus to
99
alter every sound file that goes through that bus.
1010

11-
.. image:: img/audio_buses4.png
11+
.. image:: img/audio_buses4.webp
1212

1313
Try them all out to get a sense of how they alter sound. Here follows a short
1414
description of the available effects:
@@ -123,6 +123,13 @@ Filter
123123

124124
Filter is what all other filters inherit from and should not be used directly.
125125

126+
HardLimiter
127+
~~~~~~~~~~~
128+
129+
A limiter is similar to a compressor, but it's less flexible and designed to
130+
prevent a signal's amplitude exceeding a given dB threshold. Adding a limiter to the final point of
131+
the Master bus is good practice, as it offers an easy safeguard against clipping.
132+
126133
HighPassFilter
127134
~~~~~~~~~~~~~~
128135

@@ -140,9 +147,15 @@ Reduces all frequencies above a specific *Cutoff* frequency.
140147
Limiter
141148
~~~~~~~
142149

143-
A limiter is similar to a compressor, but it's less flexible and designed to
144-
prevent a signal's amplitude exceeding a given dB threshold. Adding a limiter to the final point of
145-
the Master bus is good practice, as it offers an easy safeguard against clipping.
150+
This is the old limiter effect, and it is recommended to use the new HardLimiter
151+
effect instead.
152+
153+
Here is an example of how this effect works, if the ceiling is set to -12 dB, and the
154+
threshold is 0 dB, all samples going through get reduced by 12dB. This changes the
155+
waveform of the sound and introduces distortion.
156+
157+
This effect is being kept to preserve compatibility, however it should be considered
158+
deprecated.
146159

147160
LowPassFilter
148161
~~~~~~~~~~~~~
-6.26 KB
Binary file not shown.
7.25 KB
Loading

0 commit comments

Comments
 (0)