Struct RaylibAudio

Source
pub struct RaylibAudio(/* private fields */);
Expand description

This token is used to indicate audio is initialized. It’s also used to create Wave, Sound, Music, AudioStream, and SoundAlias. All of those have a lifetime that is bound to RaylibAudio. The compiler will disallow you from using them without ensuring that the RaylibAudio is present while doing so.

Implementations§

Source§

impl RaylibAudio

Source

pub fn init_audio_device() -> Result<RaylibAudio, RaylibAudioInitError>

Initializes audio device and context.

Source

pub fn is_audio_device_ready(&self) -> bool

Checks if audio device is ready.

Source

pub fn get_master_volume(&self) -> f32

Get master volume (listener)

Source

pub fn set_master_volume(&self, volume: f32)

Sets master volume (listener).

Source

pub fn set_audio_stream_buffer_size_default(&self, size: i32)

Sets default audio buffer size for new audio streams.

Source

pub fn new_sound<'aud>(&'aud self, filename: &str) -> Result<Sound<'aud>, Error>

Loads a new sound from file.

Source

pub fn new_sound_from_wave<'aud>( &'aud self, wave: &Wave<'_>, ) -> Result<Sound<'aud>, Error>

Loads sound from wave data.

Source

pub fn new_wave<'aud>(&'aud self, filename: &str) -> Result<Wave<'aud>, Error>

Loads wave data from file into RAM.

Source

pub fn new_wave_from_memory<'aud>( &'aud self, filetype: &str, bytes: &[u8], ) -> Result<Wave<'aud>, Error>

Load wave from memory buffer, fileType refers to extension: i.e. ‘.wav’

Source

pub fn new_music<'aud>(&'aud self, filename: &str) -> Result<Music<'aud>, Error>

Loads music stream from file.

Source

pub fn new_music_from_memory<'aud>( &'aud self, filetype: &str, bytes: &Vec<u8>, ) -> Result<Music<'aud>, Error>

Load music stream from data

Source

pub fn new_audio_stream<'aud>( &'aud self, sample_rate: u32, sample_size: u32, channels: u32, ) -> AudioStream<'aud>

Initializes audio stream (to stream raw PCM data).

Trait Implementations§

Source§

impl Clone for RaylibAudio

Source§

fn clone(&self) -> RaylibAudio

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RaylibAudio

Source§

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

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

impl<'aud> Drop for RaylibAudio

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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> 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.