From 552c7fcc3dfbd3f7b1ad3941b8059cf1e4454523 Mon Sep 17 00:00:00 2001 From: reuk Date: Tue, 23 Feb 2021 13:59:01 +0000 Subject: [PATCH] Convolution: Update documentation for prepare function --- modules/juce_dsp/frequency/juce_Convolution.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/modules/juce_dsp/frequency/juce_Convolution.h b/modules/juce_dsp/frequency/juce_Convolution.h index 63e364070a..2750f58c60 100644 --- a/modules/juce_dsp/frequency/juce_Convolution.h +++ b/modules/juce_dsp/frequency/juce_Convolution.h @@ -164,8 +164,16 @@ public: ~Convolution() noexcept; //============================================================================== - /** Must be called before loading any impulse response. This provides the - maximumBufferSize and the sample rate required for any resampling. + /** Must be called before first calling process. + + 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. */ void prepare (const ProcessSpec&);