Sampler

Struct Sampler 

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

A vecmap of FMOD sounds.

Implementations§

Source§

impl Sampler

Source

pub fn new(system: &System) -> Self

Source

pub fn load(&mut self, files: VecMap<String>)

Source

pub fn load_memory(&mut self, files: VecMap<&[u8]>)

Source

pub fn load_pcm(&mut self, pcms: VecMap<&[i16]>)

Source

pub fn get(&self, id: Id) -> Option<&Sound>

Source

pub fn get_mut(&mut self, id: Id) -> Option<&mut Sound>

Source

pub fn set(&mut self, sample: Sound, id: Id)

Source

pub fn remove(&mut self, id: Id) -> Option<Sound>

Source

pub fn play( &mut self, id: Id, mode: Option<Mode>, channel_group: Option<&mut ChannelGroup>, ) -> Channel

Start playing on a fresh channel; the priority system will “steal” an existing channel if there are no free channels.

If no mode is given, the current mode for the sound (sound.get_mode()) will be used. Providing a mode will set the mode on the sound.

Source

pub fn cue( &mut self, id: Id, mode: Option<Mode>, channel_group: Option<&mut ChannelGroup>, ) -> Channel

“Play” on a fresh channel with ‘paused = true’

Trait Implementations§

Source§

impl Debug for Sampler

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Sampler

Source§

fn eq(&self, other: &Sampler) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Sampler

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.