Skip to main content

SoundSpec

Struct SoundSpec 

Source
pub struct SoundSpec<'a> {
    pub name: &'static str,
    pub bytes: &'a [u8],
    pub base_volume: f32,
    pub bus: AudioBus,
}
Expand description

One entry in a SoundBank: where the bytes come from and how the cue should sit in the mix before per-call parameters are applied.

Fields§

§name: &'static str

A stable name used for lookups and error reporting.

§bytes: &'a [u8]

The encoded clip, typically an include_bytes! WAV.

§base_volume: f32

The cue’s own level, so a loud explosion and a quiet tick can share one call site without per-call bookkeeping.

§bus: AudioBus

The bus the cue plays on.

Implementations§

Source§

impl<'a> SoundSpec<'a>

Source

pub fn new(name: &'static str, bytes: &'a [u8]) -> SoundSpec<'a>

A cue at unity gain on the effects bus.

Source

pub fn volume(self, base_volume: f32) -> SoundSpec<'a>

Sets the cue’s own level.

Source

pub fn bus(self, bus: AudioBus) -> SoundSpec<'a>

Sets the cue’s bus.

Trait Implementations§

Source§

impl<'a> Clone for SoundSpec<'a>

Source§

fn clone(&self) -> SoundSpec<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SoundSpec<'a>

Source§

impl<'a> Debug for SoundSpec<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SoundSpec<'a>

§

impl<'a> RefUnwindSafe for SoundSpec<'a>

§

impl<'a> Send for SoundSpec<'a>

§

impl<'a> Sync for SoundSpec<'a>

§

impl<'a> Unpin for SoundSpec<'a>

§

impl<'a> UnsafeUnpin for SoundSpec<'a>

§

impl<'a> UnwindSafe for SoundSpec<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.