From 34f308bc5a861c5ce214e77e5976d19f34db9dde Mon Sep 17 00:00:00 2001 From: reuk Date: Fri, 23 Jul 2021 13:16:58 +0100 Subject: [PATCH] Convolution: Update docs for stylistic consistency --- modules/juce_dsp/frequency/juce_Convolution.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/juce_dsp/frequency/juce_Convolution.h b/modules/juce_dsp/frequency/juce_Convolution.h index 2750f58c60..67a10bc715 100644 --- a/modules/juce_dsp/frequency/juce_Convolution.h +++ b/modules/juce_dsp/frequency/juce_Convolution.h @@ -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&);