embedded-3dgfx 0.3.1

3D graphics rendering for embedded systems (fork of embedded-gfx by Kezii)
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

use heapless::Vec;

use crate::{
    DrawPrimitive,
    error::{BudgetKind, RenderError},
};

#[derive(Debug, Clone)]
pub enum RenderCommand {
    ClearColor(embedded_graphics_core::pixelcolor::Rgb565),
    ClearDepth(u32),
    Draw(DrawPrimitive),
}

pub struct CommandBuffer<const MAX: usize> {
    commands: Vec<RenderCommand, MAX>,
}

impl<const MAX: usize> CommandBuffer<MAX> {
    pub const fn new() -> Self {
        Self {
            commands: Vec::new(),
        }
    }

    pub fn clear(&mut self) {
        self.commands.clear();
    }

    pub fn len(&self) -> usize {
        self.commands.len()
    }

    pub fn is_empty(&self) -> bool {
        self.commands.is_empty()
    }

    pub fn push(&mut self, cmd: RenderCommand) -> Result<(), RenderError> {
        self.commands.push(cmd).map_err(|_| {
            RenderError::OutOfBudget(BudgetKind::DrawPrimitives {
                attempted: self.commands.len() + 1,
                max: MAX,
            })
        })
    }

    pub fn iter(&self) -> core::slice::Iter<'_, RenderCommand> {
        self.commands.iter()
    }

    pub fn get(&self, index: usize) -> Option<&RenderCommand> {
        self.commands.get(index)
    }
}

impl<const MAX: usize> Default for CommandBuffer<MAX> {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use embedded_graphics_core::pixelcolor::Rgb565;
    use nalgebra::Point2;

    #[test]
    fn new_buffer_starts_empty() {
        let buf: CommandBuffer<4> = CommandBuffer::new();
        assert_eq!(buf.len(), 0);
        assert!(buf.is_empty());
    }

    #[test]
    fn push_and_get_roundtrip() {
        let mut buf: CommandBuffer<4> = CommandBuffer::new();
        buf.push(RenderCommand::Draw(DrawPrimitive::ColoredPoint(
            Point2::new(3, 7),
            Rgb565::new(31, 0, 0),
        )))
        .unwrap();
        assert_eq!(buf.len(), 1);
        assert!(matches!(
            buf.get(0),
            Some(RenderCommand::Draw(DrawPrimitive::ColoredPoint(_, _)))
        ));
    }

    #[test]
    fn push_over_capacity_returns_budget_error() {
        let mut buf: CommandBuffer<1> = CommandBuffer::new();
        buf.push(RenderCommand::ClearDepth(0)).unwrap();
        let err = buf
            .push(RenderCommand::ClearDepth(1))
            .expect_err("overflow must fail");
        assert_eq!(
            err,
            RenderError::OutOfBudget(BudgetKind::DrawPrimitives {
                attempted: 2,
                max: 1
            })
        );
    }
}