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

//! Context creation module.

mod context_display;
pub use context_display::ContextDisplay;

mod context_builder;
pub use context_builder::ContextBuilder;

pub mod backend;
pub(crate) use backend::gl_context::{GLContext, HasGLContext};

/// A trait defining the `GPUContext` interface.
pub trait HasContext: HasGLContext {
    /// Creates a new `Context`.
    fn new(builder: &ContextBuilder) -> Self where Self: Sized;

    /// Runs the `Context` and returns `false` if the `Context` is no longer available.
    fn run(&mut self) -> bool;

    /// Makes the `Context` current for the current thread.
    fn make_current(&self) -> Result<(), ContextError>;

    /// Swap buffers for presenting in the `ContextDisplay`.
    fn swap_buffers(&self) -> Result<(), ContextError>;

    /// OpenGL function dynamic loading.
    fn get_proc_address(&self, addr: &str) -> *const ();

    /// Gets the inner dimensions of the `ContextDisplay`.
    fn inner_dimensions(&self) -> (usize, usize);
}

/// The `Context` object.
pub type Context = Box<dyn HasContext>;

#[cfg(not(all(target_arch = "wasm32")))]
mod platform {
    mod desktop;
    pub use desktop::Context as BackendContext;
    pub use desktop::ContextError;
}

#[cfg(all(target_arch = "wasm32"))]
mod platform {
    mod web;
    pub use web::Context as BackendContext;
    pub use web::ContextError;
}

/// The Context object.
pub use platform::*;