mirui 0.39.1

A lightweight, no_std ECS-driven UI framework for embedded, desktop, and WebAssembly
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Renderer trait → Scene capture. Sits alongside other backends because it
//! satisfies the same trait the screen renderers do, even though the "target"
//! is an op stream rather than pixels.

use alloc::vec::Vec;

use crate::render::command::DrawCommand;
use crate::render::renderer::Renderer;
use crate::render::scene::Scene;
use crate::render::scene::record::{RecordError, ResourceResolver, record_command};
use crate::types::Rect;

/// Records draws into a Scene through the Renderer trait. Errors accumulate
/// because Renderer::draw can't return Result without desyncing the caller's
/// group stack.
pub struct SceneRenderer<'a> {
    pub scene: &'a mut Scene,
    pub resolver: &'a mut dyn ResourceResolver,
    pub errors: Vec<RecordError>,
}

impl<'a> SceneRenderer<'a> {
    pub fn new(scene: &'a mut Scene, resolver: &'a mut dyn ResourceResolver) -> Self {
        Self {
            scene,
            resolver,
            errors: Vec::new(),
        }
    }
}

impl Renderer for SceneRenderer<'_> {
    fn draw(&mut self, cmd: &DrawCommand, _clip: &Rect) {
        match record_command(cmd, self.resolver) {
            Ok(op) => {
                self.scene.push(op);
            }
            Err(e) => self.errors.push(e),
        }
    }

    fn flush(&mut self) {}
}

impl Scene {
    pub fn renderer<'a>(&'a mut self, resolver: &'a mut dyn ResourceResolver) -> SceneRenderer<'a> {
        SceneRenderer::new(self, resolver)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::render::font::Font;
    use crate::render::scene::{ResourceRef, SceneOp};
    use crate::render::texture::Texture;
    use crate::types::{Color, Fixed, Point, Transform};

    struct PanicResolver;
    impl ResourceResolver for PanicResolver {
        fn resolve_font(&mut self, _: &Font) -> ResourceRef {
            unreachable!("driver does not draw Label")
        }
        fn resolve_texture(&mut self, _: &Texture<'_>) -> ResourceRef {
            unreachable!("driver does not draw Blit")
        }
    }

    fn red() -> Color {
        Color {
            r: 255,
            g: 0,
            b: 0,
            a: 255,
        }
    }

    #[test]
    fn scene_renderer_captures_a_full_pipeline_to_mirx_and_back() {
        fn driver(r: &mut dyn Renderer, clip: &Rect) {
            r.draw(
                &DrawCommand::Line {
                    p1: Point::ZERO,
                    p2: Point {
                        x: Fixed::from_int(10),
                        y: Fixed::from_int(10),
                    },
                    transform: Transform::IDENTITY,
                    color: red(),
                    width: Fixed::from_int(1),
                    opa: 255,
                },
                clip,
            );
            r.draw(
                &DrawCommand::Fill {
                    area: Rect {
                        x: Fixed::ZERO,
                        y: Fixed::ZERO,
                        w: Fixed::from_int(8),
                        h: Fixed::from_int(8),
                    },
                    transform: Transform::IDENTITY,
                    quad: None,
                    color: red(),
                    radius: Fixed::ZERO,
                    opa: 200,
                },
                clip,
            );
            r.flush();
        }

        let mut scene = Scene::new();
        let clip = Rect {
            x: Fixed::ZERO,
            y: Fixed::ZERO,
            w: Fixed::from_int(100),
            h: Fixed::from_int(100),
        };
        {
            let mut r = PanicResolver;
            let mut sink = scene.renderer(&mut r);
            driver(&mut sink, &clip);
            assert!(sink.errors.is_empty());
        }
        assert_eq!(scene.ops.len(), 2);

        let payload = scene.encode().unwrap();
        let mirx_bytes = mirx::encode_chunk_generic(
            mirx::chunk_type::VECTOR,
            mirx::ChunkEntry::FLAG_CRITICAL,
            &payload,
        );

        let parsed = mirx::parse_chunk(&mirx_bytes).unwrap();
        let extracted = parsed
            .chunk_payload(&mirx_bytes, mirx::chunk_type::VECTOR)
            .unwrap();
        let back = Scene::decode(extracted).unwrap();

        assert_eq!(back.ops, scene.ops);
        assert!(matches!(back.ops[0], SceneOp::Line { .. }));
        assert!(matches!(back.ops[1], SceneOp::FillRect { .. }));
    }
}