Skip to main content

ScratchPool

Struct ScratchPool 

Source
pub struct ScratchPool { /* private fields */ }
Expand description

Heap-allocated buffer pool for intermediate results during audio processing.

Each call to buf(frames) returns the next available &mut [f32] of the requested length. The cursor wraps around when all slots are used.

Uses interior mutability so multiple buffers can be live simultaneously.

§Example

use sesh_sdk::Scratch;

let scratch = Scratch::new();
let frames = 128;
let a = scratch.buf(frames);
let b = scratch.buf(frames);
let c = scratch.buf(frames);
// a, b, c are all valid simultaneously

Implementations§

Source§

impl ScratchPool

Source

pub fn with_capacity(n: usize, frames_cap: usize) -> Self

Create a new scratch pool with n buffers of frames_cap frames each.

Source

pub fn new() -> Self

Create a default scratch pool: 128 buffers of 2048 frames (1MB).

Source

pub fn buf(&self, frames: usize) -> &mut [f32]

Get the next scratch buffer, sliced to frames. Wraps when all slots are used.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.