revue 2.71.1

A Vue-style TUI framework for Rust with CSS styling
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

//! Layer support for canvas composition

use super::braille::{BrailleGrid, Shape};
use crate::style::Color;

/// A drawable layer that can be composed with other layers
///
/// Layers wrap a BrailleGrid and add visibility and opacity controls.
/// Multiple layers can be composited together for complex scenes.
pub struct Layer {
    /// The underlying grid
    grid: BrailleGrid,
    /// Visibility
    visible: bool,
    /// Opacity (0.0 - 1.0)
    opacity: f32,
}

impl Layer {
    /// Create a new layer
    pub fn new(term_width: u16, term_height: u16) -> Self {
        Self {
            grid: BrailleGrid::new(term_width, term_height),
            visible: true,
            opacity: 1.0,
        }
    }

    /// Set visibility
    pub fn set_visible(&mut self, visible: bool) {
        self.visible = visible;
    }

    /// Check if visible
    pub fn is_visible(&self) -> bool {
        self.visible
    }

    /// Set opacity (0.0 - 1.0)
    pub fn set_opacity(&mut self, opacity: f32) {
        self.opacity = opacity.clamp(0.0, 1.0);
    }

    /// Get opacity
    pub fn opacity(&self) -> f32 {
        self.opacity
    }

    /// Get width in braille dots
    pub fn width(&self) -> usize {
        self.grid.width()
    }

    /// Get height in braille dots
    pub fn height(&self) -> usize {
        self.grid.height()
    }

    /// Set a dot
    pub fn set(&mut self, x: usize, y: usize, color: Color) {
        self.grid.set(x, y, color);
    }

    /// Clear the layer
    pub fn clear(&mut self) {
        self.grid.clear();
    }

    /// Draw a shape on this layer
    pub fn draw<S: Shape>(&mut self, shape: &S) {
        self.grid.draw(shape);
    }

    /// Get the underlying grid for reading
    pub fn grid(&self) -> &BrailleGrid {
        &self.grid
    }

    /// Get the underlying grid for writing
    pub fn grid_mut(&mut self) -> &mut BrailleGrid {
        &mut self.grid
    }

    /// Get cells for testing
    #[doc(hidden)]
    pub fn cells(&self) -> &[u8] {
        self.grid.cells()
    }

    /// Get colors for testing
    #[doc(hidden)]
    pub fn colors(&self) -> &[Option<Color>] {
        self.grid.colors()
    }
}