matrix-rain 0.3.0

Classic Matrix digital rain effect as a ratatui widget (no_std-capable) and standalone TUI binary.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Frame-rendering benchmarks. Spec §9 target: < 1 ms per frame on a 200×60
//! terminal on a modern CPU.
//!
//! Run with: `cargo bench --bench render`

use criterion::{black_box, criterion_group, criterion_main, BenchmarkId, Criterion, Throughput};
use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::widgets::StatefulWidget;

use matrix_rain::{MatrixConfig, MatrixRain, MatrixRainState};

const SEED: u64 = 0xC0FFEE;
const WARMUP_FRAMES: usize = 60;

/// Drive enough renders to fill the column field before measurement, so the
/// bench measures steady-state cost rather than cold-start allocation.
fn warm(area: Rect, cfg: &MatrixConfig, state: &mut MatrixRainState, buf: &mut Buffer) {
    for _ in 0..WARMUP_FRAMES {
        MatrixRain::new(cfg).render(area, buf, state);
        state.tick();
    }
}

fn bench_default_200x60(c: &mut Criterion) {
    let area = Rect::new(0, 0, 200, 60);
    let cfg = MatrixConfig::default();
    let mut state = MatrixRainState::with_seed(SEED);
    let mut buf = Buffer::empty(area);
    warm(area, &cfg, &mut state, &mut buf);

    c.bench_function("render_200x60_default", |b| {
        b.iter(|| {
            MatrixRain::new(&cfg).render(black_box(area), &mut buf, &mut state);
        });
    });
}

fn bench_per_tier_200x60(c: &mut Criterion) {
    let area = Rect::new(0, 0, 200, 60);
    let cfg = MatrixConfig::default();
    let mut group = c.benchmark_group("render_200x60_by_tier");
    // 200 × 60 = 12000 cells per frame; report per-cell amortized cost too.
    group.throughput(Throughput::Elements((area.width as u64) * (area.height as u64)));

    for &tier in &[16u16, 256u16, u16::MAX] {
        let label = match tier {
            16 => "16-color",
            256 => "256-color",
            _ => "truecolor",
        };
        let mut state = MatrixRainState::with_seed(SEED);
        state.set_color_count(tier);
        let mut buf = Buffer::empty(area);
        warm(area, &cfg, &mut state, &mut buf);

        group.bench_with_input(BenchmarkId::from_parameter(label), &tier, |b, _| {
            b.iter(|| {
                MatrixRain::new(&cfg).render(black_box(area), &mut buf, &mut state);
            });
        });
    }
    group.finish();
}

fn bench_size_scaling(c: &mut Criterion) {
    let cfg = MatrixConfig::default();
    let mut group = c.benchmark_group("render_size_scaling");

    for &(w, h) in &[(80u16, 24u16), (120, 40), (200, 60), (300, 80)] {
        let area = Rect::new(0, 0, w, h);
        let mut state = MatrixRainState::with_seed(SEED);
        let mut buf = Buffer::empty(area);
        warm(area, &cfg, &mut state, &mut buf);

        group.throughput(Throughput::Elements((w as u64) * (h as u64)));
        group.bench_with_input(
            BenchmarkId::new("render", format!("{}x{}", w, h)),
            &area,
            |b, &a| {
                b.iter(|| {
                    MatrixRain::new(&cfg).render(black_box(a), &mut buf, &mut state);
                });
            },
        );
    }
    group.finish();
}

fn bench_with_glitch_and_mutation(c: &mut Criterion) {
    let area = Rect::new(0, 0, 200, 60);
    let cfg = MatrixConfig::builder()
        .mutation_rate(0.2)
        .glitch(0.1)
        .build()
        .unwrap();
    let mut state = MatrixRainState::with_seed(SEED);
    let mut buf = Buffer::empty(area);
    warm(area, &cfg, &mut state, &mut buf);

    c.bench_function("render_200x60_mutation_glitch", |b| {
        b.iter(|| {
            MatrixRain::new(&cfg).render(black_box(area), &mut buf, &mut state);
        });
    });
}

criterion_group!(
    benches,
    bench_default_200x60,
    bench_per_tier_200x60,
    bench_size_scaling,
    bench_with_glitch_and_mutation,
);
criterion_main!(benches);