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

use alloc::boxed::Box;

use ratatui_core::{buffer::Buffer, layout::Rect, style::Style};

use crate::{
    cell_filter::FilterProcessor,
    default_shader_impl,
    effect_timer::EffectTimer,
    pattern::{AnyPattern, InstancedPattern, Pattern},
    shader::Shader,
    simple_rng::SimpleRng,
    CellFilter, Duration,
};

#[derive(Clone, Debug, Default)]
pub(super) struct Dissolve {
    timer: EffectTimer,
    dissolved_style: Option<Style>,
    area: Option<Rect>,
    cell_filter: Option<FilterProcessor>,
    lcg: SimpleRng,
    pattern: AnyPattern,
}

impl Dissolve {
    pub fn new(lifetime: EffectTimer) -> Self {
        Self { timer: lifetime, ..Self::default() }
    }

    pub fn with_style(style: Style, lifetime: EffectTimer) -> Self {
        Self {
            dissolved_style: Some(style),
            timer: lifetime,
            ..Self::default()
        }
    }
}

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

    fn name(&self) -> &'static str {
        match (self.dissolved_style, self.timer.is_reversed()) {
            (Some(_), true) => "coalesce_from",
            (Some(_), false) => "dissolve_to",
            (None, true) => "coalesce",
            (None, false) => "dissolve",
        }
    }

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

        // Use pattern-based alpha mapping for all cases (Identity pattern = no change for
        // original behavior)
        let mut pattern_frame = self.pattern.clone().for_frame(global_alpha, area);

        self.cell_iter(buf, area)
            .for_each_cell(|pos, cell| {
                let cell_alpha = pattern_frame.map_alpha(pos);

                // For dissolve effects, we use random thresholding
                // Pattern controls the alpha, random determines which cells at that alpha level
                // dissolve
                if cell_alpha > lcg.gen_f32() {
                    cell.set_char(' ');
                    if let Some(style) = dissolved_style {
                        cell.set_style(style);
                    }
                }
            });
    }

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

    fn set_rng(&mut self, rng: SimpleRng) {
        self.lcg = rng;
    }

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

        if let Some(style) = &self.dissolved_style {
            EffectExpression::parse(&format!(
                "fx::{}({}, {})",
                self.name(),
                style.dsl_format(),
                self.timer.dsl_format(),
            ))
        } else {
            EffectExpression::parse(&format!("fx::{}({})", self.name(), self.timer.dsl_format(),))
        }
    }
}

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

    use crate::{fx, EffectTimer, Interpolation::SineOut};

    #[test]
    fn dsl_format_dissolve() {
        assert_eq!(fx::dissolve(1000).to_dsl().unwrap().to_string(), indoc! {
            "fx::dissolve(EffectTimer::from_ms(1000, Interpolation::Linear))"
        });
    }

    #[test]
    fn dsl_format_coalesce() {
        assert_eq!(fx::coalesce(1000).to_dsl().unwrap().to_string(), indoc! {
            "fx::coalesce(EffectTimer::from_ms(1000, Interpolation::Linear))"
        });
    }

    #[test]
    fn dsl_format_dissolve_to() {
        let dissolve = fx::dissolve_to(Style::default(), EffectTimer::from_ms(100, SineOut))
            .to_dsl()
            .unwrap();
        assert_eq!(dissolve.to_string(), indoc! {
            "fx::dissolve_to(Style::new(), EffectTimer::from_ms(100, Interpolation::SineOut))"
        });
    }

    #[test]
    fn dsl_format_coalesce_from() {
        assert_eq!(
            fx::coalesce_from(Style::default(), 1000)
                .to_dsl()
                .unwrap()
                .to_string(),
            indoc! {
                "fx::coalesce_from(Style::new(), EffectTimer::from_ms(1000, Interpolation::Linear))"
            }
        );
    }
}