Struct EngineConfig 

pub struct EngineConfig {
    pub render_config: RenderConfig,
    pub sample_rate: f32,
    pub enable_per_frame: bool,
    pub enable_per_pixel: bool,
    pub transition_duration_s: f32,
    pub preset_display_duration_s: f32,
    pub profile: bool,
    pub waveform_split_lr: bool,
    pub md1_mesh_override: Option<(u32, u32)>,
    pub progress_source: ProgressSource,
}

Engine configuration.

Fields

render_config: RenderConfig

Render configuration

sample_rate: f32

Audio sample rate

enable_per_frame: bool

Enable per-frame equations

enable_per_pixel: bool

Enable per-pixel equations

transition_duration_s: f32

Duration of the crossfade between two presets. 0.0 disables transitions (instant cut). Default mirrors MD2’s f_transition_time = 2.7 s.

preset_display_duration_s: f32

Length of a preset’s display window in seconds. Drives MD2’s progress uniform: progress = (time - preset_loaded_time) / preset_display_duration_s, clamped to [0, 1]. Presets read progress for fade-ins, build-ups, and once-per-window effects. Default mirrors MD2’s nPresetDisplayLengthSeconds = 16. Set 0.0 to disable (clamps progress to 0).

profile: bool

Record per-phase wall-clock breakdown of every update call into MilkEngine::last_profile. Used by the bench tool. Off in the real GUI/CLI path.

waveform_split_lr: bool

Waveform L/R top-vs-bottom split. When true, the static waveform pass renders the LEFT channel on the upper screen half and the RIGHT channel on the lower half (two dispatches with a ±0.25 wave_y offset). Default false (single mono trace). Surfaced at engine level rather than preset level — MD2 had a player-side option for this, not a preset variable.

md1_mesh_override: Option<(u32, u32)>

MD1-style per-pixel warp mode: when the loaded preset’s version is < 200 (MilkDrop 1), auto-upgrade the warp mesh to this resolution. MD1 presets routinely encode high-frequency warp formulas (dx = sin(40*y), …) that MD2’s mesh-based approach smooths over at coarse resolutions; densifying the mesh for the lifetime of the preset restores the “looks evaluated per pixel” feel without an actual full-resolution CPU eval (which would run EEL2 millions of times per frame).

MD2+ presets revert to the user’s baseline RenderConfig::mesh_cols/mesh_rows on the next load. None disables the override (every preset uses the baseline).

Default Some((96, 72)) — a sweet spot for a true per-pixel feel on classic MD1 presets without thrashing the warp executor’s per-vertex evaluator. Cap is WarpMesh::new’s 192×96; lower if MD1 presets feel choppier than expected on underpowered hardware.

progress_source: ProgressSource

Source for MD2’s progress uniform. Default ProgressSource::LocalWindow derives progress from preset_display_duration_s (the per-preset slot timer). ProgressSource::MprisAutoTrack asks the engine to query the freedesktop MPRIS2 bus on a background thread and use Position / mpris:length of the active player instead — so presets that fade with progress track the song rather than the slot. When the mpris cargo feature is off, the variant is still accepted but the engine silently falls back to LocalWindow.

Implementations

impl EngineConfig

pub fn from_preset(preset: QualityPreset) -> Self

Create configuration from a quality preset.

Trait Implementations

impl Clone for EngineConfig

fn clone(&self) -> EngineConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineConfig

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

Formats the value using the given formatter.

impl Default for EngineConfig

fn default() -> Self

Returns the “default value” for a type.