From cf3745a4e15b620b150e3e47b020a6ba82fbe03b Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Fri, 22 Apr 2022 18:04:54 +0200 Subject: [PATCH] Somewhat clarify initialize_block_smoothers() This function is meant to be called by the plugin itself, it only lives in the plugin trait to make using it more convenient. --- src/plugin.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/plugin.rs b/src/plugin.rs index 0cfac489..2a0a8e20 100644 --- a/src/plugin.rs +++ b/src/plugin.rs @@ -130,10 +130,10 @@ pub trait Plugin: Default + Send + Sync + 'static { /// TODO: Create an example plugin that uses block-based processing fn process(&mut self, buffer: &mut Buffer, context: &mut impl ProcessContext) -> ProcessStatus; - /// Convenience function to allocate memory for block-based smoothing. Since this allocates - /// memory, this should be called in [`initialize()`][Self::initialize()]. If you are going to - /// use [`Buffer::iter_blocks()`] and want to use parameter smoothing in those blocks, then call - /// this function with the same maximum block size first before calling + /// Convenience function provided to allocate memory for block-based smoothing for this plugin. + /// Since this allocates memory, this should be called in [`initialize()`][Self::initialize()]. + /// If you are going to use [`Buffer::iter_blocks()`] and want to use parameter smoothing in + /// those blocks, then call this function with the same maximum block size first before calling /// [`Smoother::next_block()`][crate::prelude::Smoother::next_block()]. fn initialize_block_smoothers(&mut self, max_block_size: usize) { for (_, mut param, _) in self.params().param_map() {