mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Convolution: Update docs for stylistic consistency

Browse source
This commit is contained in:
reuk 2021-07-23 13:16:58 +01:00
parent 0f76c7d097
commit 34f308bc5a
No known key found for this signature in database
GPG key ID: 9ADCD339CFC98A11
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
modules/juce_dsp/frequency/juce_Convolution.h
View file

@ -92,9 +92,9 @@ private:
Threading: It is not safe to interleave calls to the methods of this
class. If you need to load new impulse responses during processing the
`load` calls must be synchronised with `process` calls, which in practice
means making the `load` call from the audio thread. The
`loadImpulseResponse` functions *are* wait-free and are therefore
load() calls must be synchronised with process() calls, which in practice
means making the load() call from the audio thread. The
loadImpulseResponse() functions *are* wait-free and are therefore
suitable for use in a realtime context.
@see FIRFilter, FIRFilter::Coefficients, FFT
@ -166,14 +166,14 @@ public:
//==============================================================================
/** Must be called before first calling process.
In general, calls to `loadImpulseResponse` load the impulse response (IR)
In general, calls to loadImpulseResponse() load the impulse response (IR)
asynchronously. The IR will become active once it has been completely loaded
and processed, which may take some time.
Calling process will ensure that the IR supplied to the most recent call to
`loadImpulseResponse` is fully initialised. This IR will then be active during
the next call to `process`. It is recommended to call `loadImpulseResponse` *before*
`process` if a specific IR must be active during the first process call.
Calling prepare() will ensure that the IR supplied to the most recent call to
loadImpulseResponse() is fully initialised. This IR will then be active during
the next call to process(). It is recommended to call loadImpulseResponse() *before*
prepare() if a specific IR must be active during the first process() call.
*/
void prepare (const ProcessSpec&);