grixy 0.6.0

Zero-cost 2D grids for embedded systems and graphics
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

use crate::{
    core::{Pos, Rect},
    ops::{GridRead, GridWrite},
};

/// Copies a rectangular region from a source grid to a destination grid.
///
/// The operation starts by copying the top-left corner to the specified offset; if there is
/// insufficient space in the current grid, or the rectangle is out of bounds of the source grid,
/// those individual cells are ignored and not copied to/from.
///
/// ## Examples
///
/// ```rust
/// use grixy::{core::{Pos, Rect}, transform::GridConvertExt as _, ops::{copy_rect, GridRead, GridWrite}, buf::GridBuf};
///
/// let src = GridBuf::new_filled(3, 3, 1);
/// let mut dst = GridBuf::new(5, 5);
/// copy_rect(&src.copied(), &mut dst, Rect::from_ltwh(0, 0, 3, 3), Pos::new(2, 2));
///
/// assert_eq!(dst.get(Pos::new(2, 2)), Some(&1));
/// assert_eq!(dst.get(Pos::new(4, 4)), Some(&1));
/// assert_eq!(dst.get(Pos::new(5, 5)), None);
/// ```
#[inline]
pub fn copy_rect<'a, E>(
    src: &'a impl GridRead<Element<'a> = E>,
    dst: &mut impl GridWrite<Element = E>,
    from: Rect,
    to: Pos,
) {
    dst.fill_rect_iter(
        Rect::from_ltwh(to.x, to.y, from.width(), from.height()),
        src.iter_rect(from),
    );
}

#[cfg(test)]
mod tests {
    extern crate alloc;

    use crate::{test::NaiveGrid, transform::GridConvertExt as _};
    use alloc::vec::Vec;

    use super::*;

    #[test]
    fn copy_rect_within_bounds() {
        #[rustfmt::skip]
        let src = NaiveGrid::<i32>::with_cells(3, 3, [
            1, 1, 1,
            1, 1, 1,
            1, 1, 1,
        ]);

        let mut dst = NaiveGrid::<i32>::new(5, 5);
        copy_rect(
            &src.copied(),
            &mut dst,
            Rect::from_ltwh(0, 0, 3, 3),
            Pos::new(2, 2),
        );

        #[rustfmt::skip]
        assert_eq!(dst.into_iter().collect::<Vec<_>>(),
        &[
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0,
            0, 0, 1, 1, 1,
            0, 0, 1, 1, 1,
            0, 0, 1, 1, 1,
        ]);
    }

    #[test]
    fn copy_rect_partially_out_of_bounds() {
        #[rustfmt::skip]
        let src = NaiveGrid::<i32>::with_cells(3, 3, [
            1, 1, 1,
            1, 1, 1,
            1, 1, 1,
        ]);

        let mut dst = NaiveGrid::<i32>::new(5, 5);
        copy_rect(
            &src.copied(),
            &mut dst,
            Rect::from_ltwh(0, 0, 3, 3),
            Pos::new(4, 4),
        );

        #[rustfmt::skip]
        assert_eq!(dst.into_iter().collect::<Vec<_>>(),
        &[
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 1,
        ]);
    }

    #[test]
    fn copy_rect_completely_outof_bounds() {
        #[rustfmt::skip]
        let src = NaiveGrid::<i32>::with_cells(3, 3, [
            1, 1, 1,
            1, 1, 1,
            1, 1, 1,
        ]);

        let mut dst = NaiveGrid::<i32>::new(5, 5);
        copy_rect(
            &src.copied(),
            &mut dst,
            Rect::from_ltwh(0, 0, 3, 3),
            Pos::new(6, 6),
        );

        #[rustfmt::skip]
        assert_eq!(dst.into_iter().collect::<Vec<_>>(),
        &[
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 
            0, 0, 0, 0, 0,
        ]);
    }
}