Struct xsynth_core::buffered_renderer::BufferedRenderer

pub struct BufferedRenderer { /* private fields */ }

The helper struct for deferred sample rendering. Helps avoid stutter when the render time is exceding the max time allowed by the audio driver.

Instead, it renders in a separate thread with much smaller sample sizes, causing a minimal impact on latency while allowing more time to render per sample.

Designed to be used in realtime playback only.

Implementations

impl BufferedRenderer

pub fn new<F: 'static + AudioPipe + Send>( render: F, stream_params: AudioStreamParams, render_size: usize, ) -> Self

Creates a new instance of BufferedRenderer.

• render: An object implementing the AudioPipe struct for BufferedRenderer to read samples from
• stream_params: Parameters of the output audio
• render_size: The number of samples to render each iteration

pub fn read(&mut self, dest: &mut [f32])

Reads samples from the remainder and the output queue into the destination array.

pub fn set_render_size(&self, size: usize)

Sets the number of samples that should be rendered each iteration.

pub fn get_buffer_stats(&self) -> BufferedRendererStatsReader

Returns a statistics reader. See the BufferedRendererStatsReader documentation for more information.

Trait Implementations

impl AudioPipe for BufferedRenderer

fn stream_params(&self) -> &AudioStreamParams

The audio stream parameters of the audio pipe.

fn read_samples_unchecked(&mut self, to: &mut [f32])

Reads samples from the pipe without checking the channel count of the output.

fn read_samples(&mut self, to: &mut [f32])

Reads samples from the pipe.

impl Drop for BufferedRenderer

fn drop(&mut self)

Executes the destructor for this type.