gpu 0.2.3

An ergonomic GPU API
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

use super::{Context, ContextDisplay, BackendContext, HasContext};

/// A builder for `Context`.
pub struct ContextBuilder {
    pub(super) cursor  : bool,
    pub(super) vsync   : bool,
    pub(super) display : ContextDisplay
}

impl Default for ContextBuilder {
    fn default() -> Self {
        let cursor  = false;
        let vsync   = true;
        let display = ContextDisplay::Screen;
        Self {cursor,vsync,display}
    }
}

impl ContextBuilder {
    /// Creates a new `ContextBuilder` with the default parameters:
    /// cursor = false
    /// vsync  = true
    /// display = ContextDisplay::None
    pub fn new() -> Self { Default::default() }

    /// Sets the display kind of the `Context`.
    pub fn with_display(mut self, display:ContextDisplay) -> Self {
        self.display = display;
        self
    }

    // FIXME: This doesn't make sense for a context without a display.
    /// Sets if we want a cursor for the created `Context`.
    pub fn cursor(mut self, cursor:bool) -> Self {
        self.cursor = cursor;
        self
    }

    /// Sets if we want vsync for the created `Context`.
    pub fn vsync(mut self, vsync:bool) -> Self {
        self.vsync = vsync;
        self
    }

    /// Creates a new `Context` with all the parameters specified in the `ContextBuilder`.
    pub fn build(self) -> Context {
        Box::new(BackendContext::new(&self))
    }

    #[cfg(target_arch = "wasm32")]
    /// Creates a new `Context` from a `web_sys::HtmlCanvasElement` with all the parameters
    /// specified in the `ContextBuilder`.
    pub fn build_from_canvas(self, canvas: web_sys::HtmlCanvasElement) -> Context {
        Box::new(BackendContext::from_canvas(canvas))
    }
}