Struct sdl2::mixer::Chunk[−][src]

pub struct Chunk {
    pub raw: *mut Mix_Chunk,
    pub owned: bool,
}

Expand description

The internal format for an audio chunk.

Fields

raw: *mut Mix_Chunkowned: bool

Implementations

[src]

impl Chunk

[src]

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Chunk, String>

Load file for use as a sample.

[src]

pub fn from_raw_buffer<T: AudioFormatNum>(
buffer: Box<[T]>
) -> Result<Chunk, String>

Load chunk from a buffer containing raw audio data in the mixer format. The length of the buffer has to fit in 32-bit unsigned integer. The chunk takes ownership of the buffer.

It’s your responsibility to provide the audio data in the right format, as no conversion will take place when using this method.

[src]

pub fn set_volume(&mut self, volume: i32) -> i32

Set chunk->volume to volume.

[src]

pub fn get_volume(&self) -> i32

current volume for the chunk.

Trait Implementations

[src]

impl Drop for Chunk

[src]

fn drop(&mut self)

Executes the destructor for this type. Read more

[src]

impl PartialEq<Chunk> for Chunk

[src]

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

This method tests for self and other values to be equal, and is used by ==. Read more

[src]

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

This method tests for !=.

[src]

impl StructuralPartialEq for Chunk

Auto Trait Implementations

impl RefUnwindSafe for Chunk

impl !Send for Chunk

impl !Sync for Chunk

impl Unpin for Chunk

impl UnwindSafe for Chunk

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct sdl2::mixer::Chunk[−][src]

Fields

Implementations

impl Chunk

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Chunk, String>

pub fn from_raw_buffer<T: AudioFormatNum>(
buffer: Box<[T]>
) -> Result<Chunk, String>

pub fn set_volume(&mut self, volume: i32) -> i32

pub fn get_volume(&self) -> i32

Trait Implementations

impl Drop for Chunk

fn drop(&mut self)

impl PartialEq<Chunk> for Chunk

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

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

impl StructuralPartialEq for Chunk

Auto Trait Implementations

impl RefUnwindSafe for Chunk

impl !Send for Chunk

impl !Sync for Chunk

impl Unpin for Chunk

impl UnwindSafe for Chunk

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct sdl2::mixer::Chunk[−][src]

Fields

Implementations

impl Chunk

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Chunk, String>

pub fn from_raw_buffer<T: AudioFormatNum>( buffer: Box<[T]>) -> Result<Chunk, String>

pub fn set_volume(&mut self, volume: i32) -> i32

pub fn get_volume(&self) -> i32

Trait Implementations

impl Drop for Chunk

fn drop(&mut self)

impl PartialEq<Chunk> for Chunk

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

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

impl StructuralPartialEq for Chunk

Auto Trait Implementations

impl RefUnwindSafe for Chunk

impl !Send for Chunk

impl !Sync for Chunk

impl Unpin for Chunk

impl UnwindSafe for Chunk

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn from_raw_buffer<T: AudioFormatNum>(
buffer: Box<[T]>
) -> Result<Chunk, String>

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

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

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,