osmic-render 0.1.0

Backend abstraction, scene graph, tessellation
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

use osmic_core::error::OsmicResult;

use crate::scene::SceneGraph;

/// Configuration for rendering.
#[derive(Debug, Clone)]
pub struct RenderConfig {
    pub width: u32,
    pub height: u32,
    pub background: osmic_core::Color,
    /// Device pixel ratio (1.0 = standard, 2.0 = retina).
    pub pixel_ratio: f32,
}

impl Default for RenderConfig {
    fn default() -> Self {
        Self {
            width: 1024,
            height: 1024,
            background: osmic_core::Color::from_hex("#f8f4f0").unwrap(),
            pixel_ratio: 1.0,
        }
    }
}

/// Abstraction over rendering backends (software, GPU).
pub trait RenderBackend {
    /// Initialize the backend with the given configuration.
    fn init(config: &RenderConfig) -> OsmicResult<Self>
    where
        Self: Sized;

    /// Render a scene graph to the internal buffer.
    fn render(&mut self, scene: &SceneGraph) -> OsmicResult<()>;

    /// Read the rendered pixels as RGBA bytes.
    fn read_pixels(&self) -> Option<Vec<u8>>;

    /// Resize the render target.
    fn resize(&mut self, width: u32, height: u32);
}