Struct InstanceBuffer 

pub struct InstanceBuffer<T: Clone + Copy + Default> { /* private fields */ }

A memory-efficient buffer of samples with a given number of instances each with a given number of channels. Each channel has a length of frames.

T is the backing type of the storage, typically f32.

This is like a collection of num_instances SequentialBuffers but contiguous in memory.

The number of instances, channels, and frames cannot be changed once constructed.

Implementations

impl<T: Clone + Copy + Default> InstanceBuffer<T>

pub fn new(instances: usize, channels: NonZeroUsize, frames: usize) -> Self

pub fn frames(&self) -> usize

pub fn num_channels(&self) -> NonZeroUsize

pub fn num_instances(&self) -> usize

pub fn instance<const MAX_CHANNELS: usize>( &self, instance_index: usize, channels: usize, frames: usize, ) -> Option<ArrayVec<&[T], MAX_CHANNELS>>

Returns an array of slices to the first frames frames of the backing buffers for the first num_channels channels present of the instance at instance_index.

Clamps num_channels and frames to the available data.

Returns None if there is no instance at instance_index.

pub fn instance_mut<const MAX_CHANNELS: usize>( &mut self, instance_index: usize, channels: usize, frames: usize, ) -> Option<ArrayVec<&mut [T], MAX_CHANNELS>>

Returns an array of mutable slices to the first frames frames of the backing buffers for the first num_channels channels present of the instance at instance_index.

Clamps num_channels and frames to the available data.

Returns None if there is no instance at instance_index.

Trait Implementations

impl<T: Clone + Copy + Default> Clone for InstanceBuffer<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Clone + Copy + Default> Debug for InstanceBuffer<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.