retroglyph-core 0.6.0

A 2D pseudographic terminal library -- core types, no backend
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

use crate::color::Style;
use crate::grid::{Grid, Offset, Pos, Rect, Size};

use super::Surface;

/// A [`Surface`](crate::surface::Surface) with a [`Style`](crate::color::Style) bound in, returned by [`Surface::with_style`](crate::surface::Surface::with_style).
///
/// Every draw call omits the `style` argument the underlying [`Surface`](crate::surface::Surface) method would otherwise
/// need, using the bound style instead. Reach back to the underlying surface (e.g. to call
/// [`Surface::print_line`](crate::surface::Surface::print_line), whose per-span styles make a bound style meaningless) via
/// [`StyledSurface::surface`](crate::surface::StyledSurface::surface).
pub struct StyledSurface<'s, 'a> {
    pub(super) surface: &'s mut Surface<'a>,
    pub(super) style: Style,
}

impl<'a> StyledSurface<'_, 'a> {
    /// The style every draw call on this view uses.
    #[must_use]
    pub const fn style(&self) -> Style {
        self.style
    }

    /// Borrows the underlying [`Surface`](crate::surface::Surface) directly, for calls that need an explicit style (e.g.
    /// [`Surface::print_line`](crate::surface::Surface::print_line)) or a capability [`StyledSurface`](crate::surface::StyledSurface) doesn't expose.
    pub const fn surface(&mut self) -> &mut Surface<'a> {
        self.surface
    }

    /// [`Surface::put`](crate::surface::Surface::put) using this view's bound style.
    pub fn put(&mut self, pos: impl Into<Pos>, ch: char) {
        self.surface.put(pos, ch, self.style);
    }

    /// [`Surface::print`](crate::surface::Surface::print) using this view's bound style.
    pub fn print(&mut self, pos: impl Into<Pos>, text: &str) {
        self.surface.print(pos, text, self.style);
    }

    /// [`Surface::fill_rect`](crate::surface::Surface::fill_rect) using this view's bound style.
    pub fn fill_rect(&mut self, rect: Rect, ch: char) {
        self.surface.fill_rect(rect, ch, self.style);
    }

    /// [`Surface::put_span`](crate::surface::Surface::put_span) using this view's bound style.
    pub fn put_span<S: AsRef<str>>(&mut self, pos: impl Into<Pos>, rows: &[S]) -> Option<()> {
        self.surface.put_span(pos, rows, self.style)
    }

    /// [`Surface::put_span_uniform`](crate::surface::Surface::put_span_uniform) using this view's bound style.
    pub fn put_span_uniform(
        &mut self,
        pos: impl Into<Pos>,
        size: impl Into<Size>,
        anchor: char,
        fill: char,
    ) -> Option<()> {
        self.surface
            .put_span_uniform(pos, size, anchor, fill, self.style)
    }

    /// [`Surface::put_offset`](crate::surface::Surface::put_offset) using this view's bound style.
    pub fn put_offset(&mut self, pos: impl Into<Pos>, offset: impl Into<Offset>, ch: char) {
        self.surface.put_offset(pos, offset, ch, self.style);
    }

    /// [`Surface::put_signed`](crate::surface::Surface::put_signed) using this view's bound style.
    pub fn put_signed(&mut self, pos: (i32, i32), ch: char) {
        self.surface.put_signed(pos, ch, self.style);
    }

    /// [`Surface::blit`](crate::surface::Surface::blit). Takes no style: `grid`'s own tiles carry their own.
    pub fn blit(&mut self, grid: &Grid, x: u16, y: u16) {
        self.surface.blit(grid, x, y);
    }

    /// [`Surface::clear`](crate::surface::Surface::clear). Takes no style: cleared cells reset to [`Tile::default`](crate::tile::Tile::default).
    pub fn clear(&mut self) {
        self.surface.clear();
    }

    /// [`Surface::clear_region`](crate::surface::Surface::clear_region). Takes no style: cleared cells reset to
    /// [`Tile::default`](crate::tile::Tile::default).
    pub fn clear_region(&mut self, rect: Rect) {
        self.surface.clear_region(rect);
    }

    /// [`Surface::width`](crate::surface::Surface::width) of the underlying surface.
    #[must_use]
    pub const fn width(&self) -> u16 {
        self.surface.width()
    }

    /// [`Surface::height`](crate::surface::Surface::height) of the underlying surface.
    #[must_use]
    pub const fn height(&self) -> u16 {
        self.surface.height()
    }

    /// [`Surface::area`](crate::surface::Surface::area) of the underlying surface.
    #[must_use]
    pub const fn area(&self) -> Rect {
        self.surface.area()
    }

    /// [`Surface::clip_rect`](crate::surface::Surface::clip_rect) of the underlying surface.
    #[must_use]
    pub const fn clip_rect(&self) -> Rect {
        self.surface.clip_rect()
    }

    /// [`Surface::area`](crate::surface::Surface::area) of the underlying surface, translated to its own local coordinate
    /// space (`self.area().at_origin()`).
    #[must_use]
    pub const fn local_area(&self) -> Rect {
        self.surface.area().at_origin()
    }
}