Struct SoundId 

pub struct SoundId(/* private fields */);

Identifies a decoded clip held by the audio engine.

Handles are opaque and cheap to copy; store them in an array indexed by the app’s own cue enum. SoundId::NONE never plays anything.

Implementations

impl SoundId

pub const NONE: SoundId

A handle that refers to no clip. Playing it is a no-op.

pub fn from_raw(raw: u32) -> Self

Wraps a backend-assigned raw handle. Backends allocate from 1 upward.

pub fn raw(self) -> u32

The backend-assigned raw handle.

pub fn is_valid(self) -> bool

Whether this handle refers to a clip.

Trait Implementations

impl Clone for SoundId

fn clone(&self) -> SoundId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SoundId

impl Debug for SoundId

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

Formats the value using the given formatter.

impl Eq for SoundId

impl Hash for SoundId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SoundId

fn cmp(&self, other: &SoundId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SoundId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SoundId

fn partial_cmp(&self, other: &SoundId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SoundId