micro_framebuffer 0.1.0

A very simple framebuffer for embedded systems
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

use std::ops::{Index, Range};

use crate::pixel_formats::PixelChunk;
use crate::pixel_row::PixelRow;

#[allow(dead_code)]
pub struct FrameBuffer<T: PixelChunk> {
    width: usize,
    height: usize,
    rows: Vec<PixelRow<T>>,
}

impl<T: PixelChunk<PixelType = T>> FrameBuffer<T> {
    pub fn new(width: usize, height: usize) -> FrameBuffer<T> {
        FrameBuffer {
            width,
            height,
            rows: vec![PixelRow::new(width); height],
        }
    }

    pub fn new_with(width: usize, height: usize, pixel: T) -> FrameBuffer<T> {
        FrameBuffer {
            width,
            height,
            rows: vec![PixelRow::new_with(width, pixel); height],
        }
    }

    pub fn row(&self, y: usize) -> Option<&PixelRow<T>> {
        self.rows.get(y)
    }

    pub fn pixel(&self, x: usize, y: usize) -> Option<T> {
        self.rows.get(y).and_then(|row| row.pixel(x))
    }
}

impl<T: PixelChunk> Index<usize> for FrameBuffer<T> {
    type Output = PixelRow<T>;

    fn index(&self, index: usize) -> &PixelRow<T> {
        &self.rows[index]
    }
}

// impl<T> IndexMut<usize> for FrameBuffer<T> {
//     fn index_mut(&mut self, index: usize) -> &mut PixelRow<T> {
//         &mut self.rows[index]
//     }
// }

impl<T: PixelChunk> Index<Range<usize>> for FrameBuffer<T> {
    type Output = [PixelRow<T>];

    fn index(&self, range: Range<usize>) -> &[PixelRow<T>] {
        &self.rows[range]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::pixel_formats::Pixel8;

    #[test]
    fn can_create_frame_buffer() {
        let buffer: FrameBuffer<Pixel8> = FrameBuffer::new(7, 3);
        assert_eq!(buffer.rows.len(), 3);
        assert_eq!(buffer.rows.len(), buffer.height);
        for row in buffer.rows.iter() {
            assert_eq!(row.len(), 7);
            assert_eq!(row.len(), buffer.width);
        }
    }

    #[test]
    fn can_create_frame_buffer_with_pixel() {
        let buffer: FrameBuffer<Pixel8> = FrameBuffer::new_with(3, 3, 5.into());
        for row in buffer.rows.iter() {
            for i in 0..row.len() {
                assert_eq!(row[i], 5.into());
            }
        }
    }

    #[test]
    fn can_get_row() {
        let buffer: FrameBuffer<Pixel8> = FrameBuffer::new(3, 3);
        assert_eq!(buffer.row(0).unwrap().len(), 3);
        assert_eq!(buffer.row(1).unwrap().len(), 3);
        assert_eq!(buffer.row(2).unwrap().len(), 3);
        assert_eq!(buffer.row(3), None);
    }

    #[test]
    fn can_get_pixel() {
        let buffer: FrameBuffer<Pixel8> = FrameBuffer::new(3, 3);
        assert_eq!(buffer.pixel(0, 0), Some(0.into()));
        assert_eq!(buffer.pixel(1, 1), Some(0.into()));
        assert_eq!(buffer.pixel(2, 2), Some(0.into()));
        assert_eq!(buffer.pixel(3, 3), None);
    }
}