tachyonfx 0.25.0

A ratatui library for creating shader-like effects in TUIs.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use alloc::boxed::Box;

use bon::Builder;
use ratatui_core::{buffer::Buffer, layout::Rect, style::Color};

use crate::{
    cell_filter::FilterProcessor,
    color_space::color_from_hsl,
    color_to_hsl, default_shader_impl,
    effect_timer::EffectTimer,
    pattern::{AnyPattern, InstancedPattern, Pattern},
    shader::Shader,
    CellFilter, ColorCache, Duration, Interpolatable,
};

#[derive(Builder, Clone, Default, Debug)]
pub(super) struct HslShift {
    #[builder(into)]
    timer: EffectTimer,
    hsl_mod_fg: Option<[f32; 3]>,
    hsl_mod_bg: Option<[f32; 3]>,
    area: Option<Rect>,
    cell_filter: Option<FilterProcessor>,
    #[builder(default)]
    pattern: AnyPattern,
}

impl Shader for HslShift {
    default_shader_impl!(area, timer, filter, clone);

    fn name(&self) -> &'static str {
        "hsl_shift"
    }

    fn execute(&mut self, _: Duration, area: Rect, buf: &mut Buffer) {
        let global_alpha = self.timer.alpha();

        let hsl_lerp = |c: &Color, hsl: [f32; 3], alpha: f32| -> Color {
            let (h, s, l) = color_to_hsl(c);

            let (h, s, l) = (
                ((h + 0.0.lerp(&hsl[0], alpha)) % 360.0 + 360.0) % 360.0,
                (s + 0.0.lerp(&hsl[1], alpha)).clamp(0.0, 100.0),
                (l + 0.0.lerp(&hsl[2], alpha)).clamp(0.0, 100.0),
            );

            color_from_hsl(h, s, l)
        };

        let hsl_mod_fg = self.hsl_mod_fg;
        let hsl_mod_bg = self.hsl_mod_bg;

        let mut pattern = self.pattern.clone().for_frame(global_alpha, area);

        let cell_iter = self.cell_iter(buf, area);
        let mut color_cache: ColorCache<u32, 8> = ColorCache::new();

        cell_iter.for_each_cell(|pos, cell| {
            if let Some(hsl_mod) = hsl_mod_fg {
                let alpha = pattern.map_alpha(pos);
                let alpha_bits = u32::from_le_bytes(alpha.to_le_bytes());
                let fg =
                    color_cache.memoize_fg(cell.fg, alpha_bits, |c| hsl_lerp(c, hsl_mod, alpha));
                cell.set_fg(fg);
            }
            if let Some(hsl_mod) = hsl_mod_bg {
                let alpha = pattern.map_alpha(pos);
                let alpha_bits = u32::from_le_bytes(alpha.to_le_bytes());
                let bg =
                    color_cache.memoize_bg(cell.bg, alpha_bits, |c| hsl_lerp(c, hsl_mod, alpha));
                cell.set_bg(bg);
            }
        });
    }

    fn set_pattern(&mut self, pattern: AnyPattern) {
        self.pattern = pattern;
    }

    #[cfg(feature = "dsl")]
    fn to_dsl(&self) -> Result<crate::dsl::EffectExpression, crate::dsl::DslError> {
        use crate::dsl::{DslFormat, EffectExpression};

        let hsl_mod_fg = self.hsl_mod_fg.map_or("None".to_string(), |hsl| {
            format!("Some([{}, {}, {}])", hsl[0], hsl[1], hsl[2])
        });

        let hsl_mod_bg = self.hsl_mod_bg.map_or("None".to_string(), |hsl| {
            format!("Some([{}, {}, {}])", hsl[0], hsl[1], hsl[2])
        });

        EffectExpression::parse(&format!(
            "{}({hsl_mod_fg}, {hsl_mod_bg}, {})",
            self.name(),
            self.timer.dsl_format(),
        ))
    }
}

#[cfg(test)]
#[cfg(feature = "dsl")]
mod tests {
    use indoc::indoc;

    use crate::{
        dsl::{EffectDsl, EffectExpression},
        fx, Effect,
        Interpolation::Linear,
    };

    #[test]
    fn hsl_shift() {
        let input = "fx::hsl_shift(Some([1.0, 2.0, 3.0]), Some([1.0, 2.0, 3.0]), (1000, Linear))";
        let expected = fx::hsl_shift(Some([1.0, 2.0, 3.0]), Some([1.0, 2.0, 3.0]), (1000, Linear));
        let result = compile_effect(input);
        assert_eq!(format!("{result:?}"), format!("{expected:?}"));
    }

    #[test]
    fn test_hsl_shift_fg() {
        let input = "fx::hsl_shift_fg([1.0, 2.0, 3.0], (1000, Linear))";
        let expected = fx::hsl_shift_fg([1.0, 2.0, 3.0], (1000, Linear));
        let result = compile_effect(input);
        assert_eq!(format!("{result:?}"), format!("{expected:?}"));
    }

    #[test]
    fn test_expr_to_dsl() {
        let input = "fx::hsl_shift(Some([1.0, 2.0, 3.0]), Some([1.0, 2.0, 3.0]), (1000, Linear))";
        let result = EffectExpression::parse(input).unwrap();
        assert_eq!(format!("{result}"), indoc! {
            "fx::hsl_shift(
                Some([1.0, 2.0, 3.0]),
                Some([1.0, 2.0, 3.0]),
                (1000, Interpolation::Linear)
            )"
        });
    }

    fn compile_effect(input: &str) -> Effect {
        EffectDsl::new()
            .compiler()
            .compile(input)
            .unwrap()
    }
}