Struct rich_sdl2_rust::mixer::chunk::MixChunk

pub struct MixChunk<'device> { /* private fields */ }

A chunk buffer of the audio data.

Implementations

impl<'device> MixChunk<'device>

pub fn new( _device: &'device MixDevice<'device>, file_name: &str ) -> Result<Self>

Constructs a chunk from the file name, or Err on failure.

Panics

Panics if file_name is empty.

pub unsafe fn from_file_bytes_unchecked( _device: &'device MixDevice<'device>, file: &[u8] ) -> Self

Constructs a chunk from the wave file bytes.

Safety

buf must be a valid WAVE format file bytes. Otherwise the Undefined Behavior occurs.

pub unsafe fn from_buf_unchecked( _device: &'device MixDevice<'device>, buf: &'device mut [u8] ) -> Self

Constructs a chunk from the raw wave buffer bytes.

Safety

buf must be a valid WAVE format buffer bytes. Otherwise the Undefined Behavior occurs.

pub fn volume(&self) -> u32

Returns the output volume of the chunk. The volume is in 0..=128.

pub fn set_volume(&self, volume: u32)

Sets the output volume of the chunk. The volume is clamped to 0..=128.

Trait Implementations

impl Drop for MixChunk<'_>

fn drop(&mut self)

Executes the destructor for this type.