Struct SnapshotConfigBuilder 

pub struct SnapshotConfigBuilder { /* private fields */ }

Builder for SnapshotConfig.

Implementations

impl SnapshotConfigBuilder

pub fn num_samples(&mut self, value: usize) -> &mut Self

Number of samples to generate.

Default is 1024

pub fn sample_rate(&mut self, value: f64) -> &mut Self

Sample rate of the audio unit.

Default is 44100.0 fundsp::DEFAULT_SR

pub fn svg_width(&mut self, value: usize) -> &mut Self

Optional width of the SVG viewBox

None means proportional to num_samples

pub fn svg_height_per_channel(&mut self, value: usize) -> &mut Self

Height of one channel in the SVG viewBox

None fallbacks to default - 100

pub fn processing_mode(&mut self, value: Processing) -> &mut Self

Processing mode for snapshotting an audio unit.

Default is Tick

pub fn with_inputs(&mut self, value: bool) -> &mut Self

Whether to include inputs in snapshot

Default is false

pub fn chart_title<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Optional chart title

Default is None

pub fn output_titles<VALUE: Into<Vec<String>>>( &mut self, value: VALUE, ) -> &mut Self

Optional titles for output channels

Default is empty Vec

pub fn output_title<VALUE, FROM_VALUE: Into<VALUE>>( &mut self, item: FROM_VALUE, ) -> &mut Self

where Vec<String>: Default + Extend<VALUE>,

Optional titles for output channels

Default is empty Vec

pub fn input_titles<VALUE: Into<Vec<String>>>( &mut self, value: VALUE, ) -> &mut Self

Optional titles for input channels

Default is empty Vec

pub fn input_title<VALUE, FROM_VALUE: Into<VALUE>>( &mut self, item: FROM_VALUE, ) -> &mut Self

where Vec<String>: Default + Extend<VALUE>,

Optional titles for input channels

Default is empty Vec

pub fn show_grid(&mut self, value: bool) -> &mut Self

Show grid lines on the chart

Default is false

pub fn show_labels(&mut self, value: bool) -> &mut Self

Show axis labels

Default is true

pub fn output_colors<VALUE: Into<Vec<String>>>( &mut self, value: VALUE, ) -> &mut Self

Custom colors for output channels (hex strings)

Default is None (uses default palette)

pub fn output_color<VALUE, FROM_VALUE: Into<VALUE>>( &mut self, item: FROM_VALUE, ) -> &mut Self

where Vec<String>: Default + Extend<VALUE>,

Custom colors for output channels (hex strings)

Default is None (uses default palette)

pub fn input_colors<VALUE: Into<Vec<String>>>( &mut self, value: VALUE, ) -> &mut Self

Custom colors for input channels (hex strings)

Default is None (uses default palette)

pub fn input_color<VALUE, FROM_VALUE: Into<VALUE>>( &mut self, item: FROM_VALUE, ) -> &mut Self

where Vec<String>: Default + Extend<VALUE>,

Custom colors for input channels (hex strings)

Default is None (uses default palette)

pub fn background_color<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

Chart background color (hex string)

Default is “#000000” (black)

pub fn line_width(&mut self, value: f32) -> &mut Self

Waveform line thickness

Default is 2.0

pub fn build(&self) -> Result<SnapshotConfig, SnapshotConfigBuilderError>

Builds a new SnapshotConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SnapshotConfigBuilder

fn clone(&self) -> SnapshotConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SnapshotConfigBuilder

fn default() -> Self

Returns the “default value” for a type.