https://github.com/unrust/uni-gl
Unrust native/wasm compatibility layer for openGL API
https://github.com/unrust/uni-gl
opengl wasm
Last synced: 12 months ago
JSON representation
Unrust native/wasm compatibility layer for openGL API
- Host: GitHub
- URL: https://github.com/unrust/uni-gl
- Owner: unrust
- License: apache-2.0
- Created: 2018-06-26T07:48:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T22:29:44.000Z (over 3 years ago)
- Last Synced: 2025-05-31T11:28:51.178Z (about 1 year ago)
- Topics: opengl, wasm
- Language: Rust
- Homepage:
- Size: 52.7 KB
- Stars: 17
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# unrust / uni-gl
[](https://travis-ci.org/unrust/uni-gl)
[](https://docs.rs/uni-gl)
[](https://crates.io/crates/uni-gl)
This library is a part of [Unrust](https://github.com/unrust/unrust), a pure rust native/wasm game engine.
This library provides a native/wasm compatibility layer for following components :
* OpenGL API
When used in conjonction with uni-app, on native target, it provides an OpenGL 3.2+ or OpenGLES 2.0+ Core Profile context.
On web target, it provides a WebGL 2.0 context where available, else a WebGL 1.0 context.
## Usage
```toml
[dependencies]
uni-app="0.3.*"
uni-gl="0.3.*"
```
```rust
extern crate uni_app;
extern crate uni_gl;
fn main() {
// create the game window (native) or canvas (web)
let app = uni_app::App::new(uni_app::AppConfig {
size: (800, 600),
title: "my game".to_owned(),
vsync: true,
show_cursor: true,
headless: false,
resizable: true,
fullscreen: false,
intercept_close_request: false,
});
// retrieve the opengl context
let gl = uni_gl::WebGLRenderingContext::new(app.canvas());
// start game loop
app.run(move |_app: &mut uni_app::App| {
// do some openGL stuff
gl.clear_color(0.0, 0.0, 1.0, 1.0);
gl.clear(uni_gl::BufferBit::Color);
});
}
```
## Build
### As web app (wasm32-unknown-unknown)
Install wasm32 target :
```
rustup target install wasm32-unknown-unknown
```
Install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
and [npm](https://www.npmjs.com/get-npm)
Compile the demo with
```
wasm-pack build examples
```
This creates a wasm package in examples/pkg
Run the demo with
```
cd www
npm install
npm run start
```
Open your browser at http://localhost:8080/
### As desktop app (native-opengl)
```
cargo run --example basic --release
```
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.