SnapshotConfigBuilder

Struct SnapshotConfigBuilder 

Source
pub struct SnapshotConfigBuilder { /* private fields */ }
Expand description

Builder for SnapshotConfig.

Implementations§

Source§

impl SnapshotConfigBuilder

Source

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

Number of samples to generate.

Default is 1024

Source

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

Sample rate of the audio unit.

Default is 44100.0 fundsp::DEFAULT_SR

Source

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

Optional width of the SVG viewBox

None means proportional to num_samples

Source

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

Source

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

Processing mode for snapshotting an audio unit.

Default is Tick

Source

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

Whether to include inputs in snapshot

Default is false

Source

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

Optional chart title

Default is None

Source

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

Show grid lines on the chart

Default is false

Source

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

Show axis labels

Default is true

Source

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

Custom colors for output channels (hex strings)

Default is None (uses default palette)

Source

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

Custom colors for input channels (hex strings)

Default is None (uses default palette)

Source

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

Chart background color (hex string)

Default is “#000000” (black)

Source

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

Waveform line thickness

Default is 2.0

Source

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

Builds a new SnapshotConfig.

§Errors

If a required field has not been initialized.

Trait Implementations§

Source§

impl Clone for SnapshotConfigBuilder

Source§

fn clone(&self) -> SnapshotConfigBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for SnapshotConfigBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.