Struct MatrixConfig 

pub struct MatrixConfig {
    pub charset: CharSet,
    pub theme: Theme,
    pub fps: u16,
    pub speed: f32,
    pub density: f32,
    pub min_trail: u16,
    pub max_trail: u16,
    pub mutation_rate: f32,
    pub bold_head: bool,
    pub head_white: bool,
    pub glitch: f32,
    pub background: Option<Color>,
}

Read-only configuration for MatrixRain.

Construct via MatrixConfig::builder (validated) or MatrixConfig::default (always valid, classic Matrix look). All fields are public so the struct also supports destructuring for inspection.

Example

use matrix_rain::MatrixConfig;

let cfg = MatrixConfig::builder().fps(60).density(0.8).build().unwrap();
assert_eq!(cfg.fps, 60);
assert_eq!(cfg.density, 0.8);

Fields

charset: CharSet

Glyph source. Default: CharSet::Matrix (katakana + digits).

theme: Theme

Color theme. Default: Theme::ClassicGreen.

fps: u16

Frames per second (must be >= 1). Acts as the wall-clock tick budget when wall-clock driving and as the divisor for speed. Default: 30.

speed: f32

Global speed multiplier (must be finite and > 0.0). Scales the effective tick rate consumed from wall-clock elapsed time. Default: 1.0.

density: f32

Fraction of columns to keep active. 0.0 = no spawns ever; 1.0 = every idle column attempts respawn each tick after cooldown. Must be finite and in [0.0, 1.0]. Default: 0.6.

min_trail: u16

Minimum trail length. Must be >= 1 and <= max_trail. Default: 6.

max_trail: u16

Maximum trail length. Must be <= MAX_TRAIL_LIMIT. Default: 20.

mutation_rate: f32

Per-cell glyph-reroll probability per tick. Must be finite and in [0.0, 1.0]. 0.0 freezes glyphs after spawn; 1.0 rerolls every cell every frame. Default: 0.05.

bold_head: bool

Apply Modifier::BOLD to the head cell when true. Default: true.

head_white: bool

Use ColorRamp.head (typically white) for the head cell when true, ColorRamp.bright when false. Default: true.

glitch: f32

Per-cell color-flicker probability per tick. On hit, the cell renders with ColorRamp.head instead of its gradient color (a “sparkle”). Head cell (i=0) is unaffected. Must be finite and in [0.0, 1.0]. Default: 0.0 (off).

background: Option<Color>

Optional background color. None (default) renders transparently, skipping cells in the fade zone so the underlying buffer shows through. Some(c) skips any cell whose computed color equals c — useful when compositing over a known background.

Implementations

impl MatrixConfig

pub fn builder() -> MatrixConfigBuilder

Returns a new MatrixConfigBuilder seeded with defaults. Call setters to override fields, then build to validate and produce a MatrixConfig.

Trait Implementations

impl Clone for MatrixConfig

fn clone(&self) -> MatrixConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MatrixConfig

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

Formats the value using the given formatter.

impl Default for MatrixConfig

fn default() -> Self

Returns the “default value” for a type.