alex/nih-plug
1
0
Fork 0
Code Activity

Somewhat clarify initialize_block_smoothers()

Browse source 
This function is meant to be called by the plugin itself, it only lives
in the plugin trait to make using it more convenient.
This commit is contained in:
Robbert van der Helm 2022-04-22 18:04:54 +02:00
parent 42548ef5d1
commit cf3745a4e1
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/plugin.rs
View file

@ -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() {