Struct rich_sdl2_rust::audio::buffer::AudioBuffer

pub struct AudioBuffer<T> { /* private fields */ }

An audio buffer with a format, sample rates, numbers of channels and a buffer.

Implementations

impl<T> AudioBuffer<T>

pub fn new( format: AudioFormat, samples: u32, channels: u8, buffer: Vec<T> ) -> Self

Constructs an audio buffer from arguments. The size of type which stored by buffer must equal to the format bit size.

Panics

Panics if the size of type T does not equal to the format bit size.

pub fn format(&self) -> &AudioFormat

Returns the format of the audio buffer.

pub fn samples(&self) -> u32

Returns the sample rates of the audio buffer.

pub fn channels(&self) -> u8

Returns the numbers of channels of the audio buffer.

pub fn convert<U: Default + Clone>( self, format: AudioFormat, samples: u32, channels: u8 ) -> Result<AudioBuffer<U>>

Convert into another AudioBuffer with different format, sample rate or channels.

Errors

Returns Err if failed to convert into a specific format.

pub fn convert_in<U: Default + Clone>( self, other: &mut AudioBuffer<U> ) -> Result<()>

Convert and write into another existing AudioBuffer.

Errors

Returns Err if failed to convert between self and other.

impl<T: Default + Clone> AudioBuffer<T>

pub fn mix(&self, volume: u8) -> Self

Mix into another AudioBuffer with the specified volume.

The max value of volume is 128, saturating if it is over the max.

pub fn mix_in(&self, dst: &mut Self, volume: u8) -> Result<()>

Mix into another existing AudioBuffer with the specified volume.

The max value of volume is 128, saturating if it is over the max.

Errors

Return Err if the formats of self and dst are different.

Trait Implementations

impl<T: Clone> Clone for AudioBuffer<T>

fn clone(&self) -> AudioBuffer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AudioBuffer<T>

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

Formats the value using the given formatter.