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

use alloc::boxed::Box;

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

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

#[derive(Clone, Debug)]
pub(super) struct Paint {
    fg: Option<Color>,
    bg: Option<Color>,
    timer: EffectTimer,
    area: Option<Rect>,
    cell_filter: Option<FilterProcessor>,
    pattern: AnyPattern,
}

impl Paint {
    pub fn new(fg: Option<Color>, bg: Option<Color>, timer: EffectTimer) -> Self {
        if fg.is_none() && bg.is_none() {
            panic!("At least one of fg or bg must be Some");
        }

        Self {
            fg,
            bg,
            timer,
            area: None,
            cell_filter: None,
            pattern: AnyPattern::default(),
        }
    }
}

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

    fn name(&self) -> &'static str {
        match (self.fg, self.bg) {
            (Some(_), Some(_)) => "paint",
            (Some(_), None) => "paint_fg",
            (None, Some(_)) => "paint_bg",
            (None, None) => unimplemented!("not possible"),
        }
    }

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

        let is_identity_pattern = matches!(self.pattern, AnyPattern::Identity);
        let mut pattern = self.pattern.clone().for_frame(global_alpha, area);
        let cell_iter = self.cell_iter(buf, area);

        cell_iter.for_each_cell(move |pos, cell| {
            if is_identity_pattern || pattern.map_alpha(pos) > 0.0 {
                if let Some(fg) = fg.as_ref() {
                    cell.set_fg(*fg);
                }

                if let Some(bg) = bg.as_ref() {
                    cell.set_bg(*bg);
                }
            }
        });
    }

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

        let s = match (self.fg, self.bg) {
            (Some(fg), Some(bg)) => {
                format!(
                    "fx::paint({}, {}, {})",
                    fg.dsl_format(),
                    bg.dsl_format(),
                    self.timer.dsl_format(),
                )
            },
            (Some(fg), None) => {
                format!(
                    "fx::paint_fg({}, {})",
                    fg.dsl_format(),
                    self.timer.dsl_format(),
                )
            },
            (None, Some(bg)) => {
                format!(
                    "fx::paint_bg({}, {})",
                    bg.dsl_format(),
                    self.timer.dsl_format(),
                )
            },
            (None, None) => unreachable!("At least one of fg or bg must be Some"),
        };
        crate::dsl::EffectExpression::parse(&s)
    }

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