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 documentation for prepare function

Browse source
This commit is contained in:
reuk 2021-02-23 13:59:01 +00:00
parent 1817c54169
commit 552c7fcc3d
No known key found for this signature in database
GPG key ID: 9ADCD339CFC98A11
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -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&);