Skip to main content

SourcePool

Struct SourcePool 

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

Backend-agnostic voice-slot policy for a fixed pool of spatial tracks — pure and unit-tested here so every backend (the built-in kira one, or a host’s own AudioOut) inherits the same behaviour (hazard 2: tracks are created up front and reused; a per-shot allocation storm is the classic mistake). One-shots are stealable (oldest first) when the pool is full; loops hold their slot until explicitly stopped.

Implementations§

Source§

impl SourcePool

Source

pub fn new(capacity: usize) -> Self

A pool of capacity voice slots (at least 1).

Source

pub fn allocate( &mut self, looping: bool, finished: impl FnMut(usize) -> bool, ) -> Option<(usize, SourceId)>

Allocate a slot for a new source. finished reports whether the backend says slot i’s current sound has stopped on its own (finished one-shots are reclaimed eagerly). Returns (slot index, fresh id); None only when every slot holds a loop or a younger one-shot than everything stealable.

Source

pub fn slot_of(&self, id: SourceId) -> Option<usize>

The slot currently owned by id, if it hasn’t been stolen or stopped since.

Source

pub fn release(&mut self, id: SourceId) -> Option<usize>

Free id’s slot (explicit stop). Stale ids are ignored.

Trait Implementations§

Source§

impl Debug for SourcePool

Source§

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

Formats the value using the given formatter. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.