Struct GraphBuilder

pub struct GraphBuilder<S>
where
    S: Sample,
{ /* private fields */ }

Fluent builder for constructing DSP graphs.

Provides methods to add blocks, create connections, and set up modulation. Call build to finalize and prepare the graph.

Implementations

impl<S> GraphBuilder<S>

where S: Sample,

pub fn new( sample_rate: f64, buffer_size: usize, num_channels: usize, ) -> GraphBuilder<S>

Create a GraphBuilder that will construct a Graph with a given sample rate, buffer size, and number of channels.

pub fn with_layout( sample_rate: f64, buffer_size: usize, layout: ChannelLayout, ) -> GraphBuilder<S>

Create a GraphBuilder with a specific channel layout.

This constructor sets both the channel count and the layout, which enables layout-aware processing for blocks like panners and decoders.

pub fn add<B>(&mut self, block: B) -> BlockId

where B: Into<BlockType<S>>,

Add a block to the graph.

Accepts any block type that implements Into<BlockType<S>>.

Example

use bbx_dsp::prelude::*;

let mut builder = GraphBuilder::<f32>::new(44100.0, 512, 2);
let osc = builder.add(OscillatorBlock::new(440.0, Waveform::Sine, None));
let gain = builder.add(GainBlock::new(-6.0, None));
builder.connect(osc, 0, gain, 0);
let graph = builder.build();

pub fn connect( &mut self, from: BlockId, from_output: usize, to: BlockId, to_input: usize, ) -> &mut GraphBuilder<S>

Form a Connection between two particular blocks.

pub fn modulate( &mut self, source: BlockId, target: BlockId, parameter: &str, ) -> &mut GraphBuilder<S>

Specify a Parameter to be modulated by a Modulator block.

pub fn capture_topology(&self) -> GraphTopologySnapshot

Capture a snapshot of the current graph topology for visualization.

Returns owned data suitable for cross-thread transfer to a visualization thread. Call this before build() to capture the user-defined topology (the output block is added during build).

pub fn build(self) -> Graph<S>

Prepare the final DSP Graph.

Automatically inserts a mixer before the output block when multiple terminal blocks exist, unless the developer has already provided their own mixer or output block connections.

Panics

Panics if any block has more inputs or outputs than the realtime-safe limits (MAX_BLOCK_INPUTS or MAX_BLOCK_OUTPUTS).