Struct Sound

pub struct Sound<'a>(/* private fields */);

Implementations

impl<'a> Sound<'a>

pub unsafe fn unwrap(self) -> Sound

Take the raw ffi type. Must manually free memory by calling the proper unload function

impl<'aud> Sound<'aud>

pub fn is_sound_valid(&self) -> bool

pub fn frame_count(&self) -> u32

pub unsafe fn inner(self) -> Sound

pub fn play(&self)

Plays a sound.

pub fn pause(&self)

Pauses a sound.

pub fn resume(&self)

Resumes a paused sound.

pub fn stop(&self)

Stops playing a sound.

pub fn is_playing(&self) -> bool

Checks if a sound is currently playing.

pub fn set_volume(&self, volume: f32)

Sets volume for a sound (1.0 is max level).

pub fn set_pitch(&self, pitch: f32)

Sets pitch for a sound (1.0 is base level).

pub fn set_pan(&self, pan: f32)

impl<'bind> Sound<'_>

pub fn alias<'snd>(&'snd self) -> Result<SoundAlias<'bind, 'snd>, Error>

Trait Implementations

impl<'aud> AsMut<AudioStream> for Sound<'aud>

fn as_mut(&mut self) -> &mut AudioStream

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a> AsMut<Sound> for Sound<'a>

fn as_mut(&mut self) -> &mut Sound

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'aud> AsRef<AudioStream> for Sound<'aud>

fn as_ref(&self) -> &AudioStream

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> AsRef<Sound> for Sound<'a>

fn as_ref(&self) -> &Sound

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for Sound<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Sound<'a>

type Target = Sound

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for Sound<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> Drop for Sound<'a>

fn drop(&mut self)

Executes the destructor for this type.