2014-10-03 21:12:42 +10:00
# glutin - OpenGL, UTilities and INput
2014-10-05 03:18:09 +11:00
[![Gitter ](https://badges.gitter.im/Join Chat.svg )](https://gitter.im/tomaka/glutin?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2014-07-27 18:55:37 +10:00
2015-05-04 23:18:03 +10:00
[![ ](http://meritbadge.herokuapp.com/glutin )](https://crates.io/crates/glutin)
2014-07-27 18:55:37 +10:00
Alternative to GLFW in pure Rust.
2014-07-27 23:59:58 +10:00
2014-10-03 17:16:36 +10:00
[![Build Status ](https://travis-ci.org/tomaka/glutin.png?branch=master )](https://travis-ci.org/tomaka/glutin)
2015-01-13 19:43:09 +11:00
[![Build status ](https://ci.appveyor.com/api/projects/status/cv5xewg3uchb3854/branch/master?svg=true )](https://ci.appveyor.com/project/tomaka/glutin/branch/master)
2014-09-20 03:51:54 +10:00
2015-02-16 04:28:12 +11:00
```toml
[dependencies]
glutin = "*"
```
2014-12-17 20:57:13 +11:00
## [Documentation](http://tomaka.github.io/glutin/)
2014-07-28 19:45:59 +10:00
## Try it!
2014-09-08 04:28:43 +10:00
```bash
2014-10-03 17:16:36 +10:00
git clone https://github.com/tomaka/glutin
cd glutin
2014-10-30 06:38:54 +11:00
cargo run --example window
2014-07-28 19:45:59 +10:00
```
2014-07-27 23:59:58 +10:00
## Usage
2015-02-22 21:31:27 +11:00
Glutin is an OpenGL context creation library and doesn't directly provide OpenGL bindings for you.
```toml
[dependencies]
gl = "*"
2015-02-23 00:01:44 +11:00
libc = "*"
2015-02-22 21:31:27 +11:00
```
2014-07-27 23:59:58 +10:00
```rust
2015-06-09 23:14:47 +10:00
extern crate gl;
2014-09-21 19:33:09 +10:00
extern crate glutin;
2014-07-27 23:59:58 +10:00
extern crate libc;
fn main() {
2014-09-21 19:33:09 +10:00
let window = glutin::Window::new().unwrap();
2014-07-27 23:59:58 +10:00
2014-07-31 02:12:39 +10:00
unsafe { window.make_current() };
2014-07-27 23:59:58 +10:00
2015-02-22 21:31:27 +11:00
unsafe {
gl::load_with(|symbol| window.get_proc_address(symbol));
2014-07-27 23:59:58 +10:00
2015-02-22 21:31:27 +11:00
gl::ClearColor(0.0, 1.0, 0.0, 1.0);
}
2014-07-27 23:59:58 +10:00
2014-08-03 19:43:57 +10:00
while !window.is_closed() {
2014-07-27 23:59:58 +10:00
window.wait_events();
2015-02-22 21:31:27 +11:00
unsafe { gl::Clear(gl::COLOR_BUFFER_BIT) };
2014-07-27 23:59:58 +10:00
window.swap_buffers();
}
}
```
2014-09-15 21:46:37 +10:00
2015-05-04 23:18:03 +10:00
Note that glutin aims at being a low-level brick in your rendering infrastructure. You are encouraged to write another layer of abstraction between glutin and your application.
2014-09-15 21:46:37 +10:00
## Platform-specific notes
### Android
2014-10-28 18:20:59 +11:00
- To compile the examples for android, initialize the submodules, go to `deps/apk-builder/apk-builder` and run `cargo build` , then go back to `glutin` and call `ANDROID_HOME=/path/to/sdk NDK_HOME=/path/to/ndk NDK_STANDALONE=/path/to/standalone cargo test --no-run --target=arm-linux-androideabi`
2015-02-19 02:52:22 +11:00
2014-09-15 21:46:37 +10:00
### X11
2015-05-04 23:18:03 +10:00
- The plan is that glutin tries to dynamically link-to and use wayland if possible. If it doesn't work, it will try xlib instead. If it doesn't work, it will try libcaca. This is work-in-progress.