SnapshotConfig

insta_fun::config

Struct SnapshotConfig

pub struct SnapshotConfig {Show 13 fields
    pub num_samples: usize,
    pub sample_rate: f64,
    pub svg_width: Option<usize>,
    pub svg_height_per_channel: usize,
    pub processing_mode: Processing,
    pub with_inputs: bool,
    pub chart_title: Option<String>,
    pub show_grid: bool,
    pub show_labels: bool,
    pub output_colors: Option<Vec<String>>,
    pub input_colors: Option<Vec<String>>,
    pub background_color: String,
    pub line_width: f32,
}

Expand description

Configuration for snapshotting an audio unit.

Fields§

§num_samples: usize

Number of samples to generate.

Default is 1024

§sample_rate: f64

Sample rate of the audio unit.

Default is 44100.0 fundsp::DEFAULT_SR

§svg_width: Option<usize>

Optional width of the SVG viewBox

None means proportional to num_samples

§svg_height_per_channel: usize

Height of one channel in the SVG viewBox

None fallbacks to default - 100

§processing_mode: Processing

Processing mode for snapshotting an audio unit.

Default is Tick

§with_inputs: bool

Whether to include inputs in snapshot

Default is false

§chart_title: Option<String>

Optional chart title

Default is None

§show_grid: bool

Show grid lines on the chart

Default is false

§show_labels: bool

Show axis labels

Default is true

§output_colors: Option<Vec<String>>

Custom colors for output channels (hex strings)

Default is None (uses default palette)

§input_colors: Option<Vec<String>>

Custom colors for input channels (hex strings)

Default is None (uses default palette)

§background_color: String

Chart background color (hex string)

Default is “#000000” (black)

§line_width: f32

Waveform line thickness

Default is 2.0

Trait Implementations§

impl Clone for SnapshotConfig

fn clone(&self) -> SnapshotConfig

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

impl Debug for SnapshotConfig

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

Formats the value using the given formatter. Read more

impl Default for SnapshotConfig

fn default() -> Self

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

Auto Trait Implementations§

impl Freeze for SnapshotConfig

impl RefUnwindSafe for SnapshotConfig

impl Send for SnapshotConfig

impl Sync for SnapshotConfig

impl Unpin for SnapshotConfig

impl UnwindSafe for SnapshotConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.