console_engine 2.5.0

A simple terminal framework to draw things and manage user input
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

//! Character and color management

use crossterm::style::Color;

/// # Pixel structure
/// contains color data and character data
#[derive(Clone, Eq, PartialEq, Copy)]
pub struct Pixel {
    /// Background color of the Pixel
    pub bg: Color,
    /// Foreground color of the Pixel
    pub fg: Color,
    /// Character of the Pixel
    pub chr: char,
}
impl Pixel {
    /// returns a tuple containing the background and foreground colors of a Pixel
    pub fn get_colors(&self) -> (Color, Color) {
        (self.fg, self.bg)
    }
}

/// Generate a pixel using a character, a foreground and background color
///
/// usage:
/// ```
/// use console_engine::pixel;
/// use console_engine::Color;
/// // ...
/// engine.set_pxl(0,0,pixel::pxl_fbg('X', Color::Blue, Color::White));
/// ```
pub fn pxl_fbg(value: char, fg: Color, bg: Color) -> Pixel {
    Pixel { bg, fg, chr: value }
}

/// Generate a pixel using a character and a foreground color.  
/// Background color is always black.
///
/// usage:
/// ```
/// use console_engine::pixel;
/// use console_engine::Color;
/// // ...
/// engine.set_pxl(0,0,pixel::pxl_fg('X', Color::Cyan));
/// ```
pub fn pxl_fg(value: char, fg: Color) -> Pixel {
    Pixel {
        fg,
        bg: Color::Reset,
        chr: value,
    }
}
/// Generate a pixel using a character and a background color.  
/// Foreground color is always White.
///
/// usage:
/// ```
/// use console_engine::pixel;
/// use console_engine::Color;
/// // ...
/// engine.set_pxl(0,0,pixel::pxl_bg('X', Color::Magenta));
/// ```
pub fn pxl_bg(value: char, bg: Color) -> Pixel {
    Pixel {
        fg: Color::Reset,
        bg,
        chr: value,
    }
}

/// Generate a pixel using a character  
/// Foreground color is always White.  
/// Background color is always black.
///
/// usage:
/// ```
/// use console_engine::pixel;
/// // ...
/// engine.set_pxl(0,0,pixel::pxl('X'));
/// ```
pub fn pxl(value: char) -> Pixel {
    Pixel {
        fg: Color::Reset,
        bg: Color::Reset,
        chr: value,
    }
}