Struct sdl2::mixer::Chunk

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

The internal format for an audio chunk.

Fields

raw: *mut Mix_Chunk

owned: bool

Methods

impl Chunk

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

Load file for use as a sample.

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.

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

Set chunk->volume to volume.

pub fn get_volume(&self) -> i32

current volume for the chunk.

Trait Implementations

impl Drop for Chunk

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Chunk> for Chunk

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

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

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

This method tests for !=.

impl StructuralPartialEq for Chunk