winit-sonoma-fix/README.md
2015-06-09 06:14:47 -07:00

73 lines
2.1 KiB
Markdown

# glutin - OpenGL, UTilities and INput
[![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)
[![](http://meritbadge.herokuapp.com/glutin)](https://crates.io/crates/glutin)
Alternative to GLFW in pure Rust.
[![Build Status](https://travis-ci.org/tomaka/glutin.png?branch=master)](https://travis-ci.org/tomaka/glutin)
[![Build status](https://ci.appveyor.com/api/projects/status/cv5xewg3uchb3854/branch/master?svg=true)](https://ci.appveyor.com/project/tomaka/glutin/branch/master)
```toml
[dependencies]
glutin = "*"
```
## [Documentation](http://tomaka.github.io/glutin/)
## Try it!
```bash
git clone https://github.com/tomaka/glutin
cd glutin
cargo run --example window
```
## Usage
Glutin is an OpenGL context creation library and doesn't directly provide OpenGL bindings for you.
```toml
[dependencies]
gl = "*"
libc = "*"
```
```rust
extern crate gl;
extern crate glutin;
extern crate libc;
fn main() {
let window = glutin::Window::new().unwrap();
unsafe { window.make_current() };
unsafe {
gl::load_with(|symbol| window.get_proc_address(symbol));
gl::ClearColor(0.0, 1.0, 0.0, 1.0);
}
while !window.is_closed() {
window.wait_events();
unsafe { gl::Clear(gl::COLOR_BUFFER_BIT) };
window.swap_buffers();
}
}
```
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.
## Platform-specific notes
### Android
- 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`
### X11
- 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.