Struct rust_raylib::audio::Sound

source ·
pub struct Sound { /* private fields */ }
Expand description

Sound

Implementations§

source§

impl Sound

source

pub fn frame_count(&self) -> u32

Total number of frames (considering channels)

source

pub fn from_file(filname: &str) -> Option<Self>

Load sound from file

source

pub fn from_wave(wave: &Wave) -> Option<Self>

Load sound from wave data

source

pub fn update(&mut self, data: &[u8], sample_count: u32)

Update sound buffer with new data

source

pub fn play(&self, _device: &mut AudioDevice)

Play a sound

source

pub fn stop(&self, _device: &mut AudioDevice)

Stop playing a sound

source

pub fn pause(&self, _device: &mut AudioDevice)

Pause a sound

source

pub fn resume(&self, _device: &mut AudioDevice)

Resume a paused sound

source

pub fn is_playing(&self, _device: &mut AudioDevice) -> bool

Check if a sound is currently playing

source

pub fn set_volume(&self, volume: f32, _device: &mut AudioDevice)

Set volume for a sound (1.0 is max level)

source

pub fn set_pitch(&self, pitch: f32, _device: &mut AudioDevice)

Set pitch for a sound (1.0 is base level)

source

pub fn set_pan(&self, pan: f32, _device: &mut AudioDevice)

Set pan for a sound (0.5 is center)

source

pub fn as_raw(&self) -> &Sound

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

source

pub fn as_raw_mut(&mut self) -> &mut Sound

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

source

pub unsafe fn from_raw(raw: Sound) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety
  • The raw object must be correctly initialized
  • The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations§

source§

impl Debug for Sound

source§

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

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

impl Drop for Sound

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Sound

§

impl !Send for Sound

§

impl !Sync for Sound

§

impl Unpin for Sound

§

impl UnwindSafe for Sound

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.