Update the README
This commit is contained in:
parent
01007dbfd4
commit
e577995fc8
1 changed files with 5 additions and 24 deletions
29
README.md
29
README.md
|
|
@ -1,6 +1,8 @@
|
||||||
# glutin - OpenGL, UTilities and INput
|
# glutin - OpenGL, UTilities and INput
|
||||||
[](https://gitter.im/tomaka/glutin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
[](https://gitter.im/tomaka/glutin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
|
|
||||||
|
[](https://crates.io/crates/glutin)
|
||||||
|
|
||||||
Alternative to GLFW in pure Rust.
|
Alternative to GLFW in pure Rust.
|
||||||
|
|
||||||
[](https://travis-ci.org/tomaka/glutin)
|
[](https://travis-ci.org/tomaka/glutin)
|
||||||
|
|
@ -11,13 +13,6 @@ Alternative to GLFW in pure Rust.
|
||||||
glutin = "*"
|
glutin = "*"
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that the crates.io version won't compile on OS/X and Android because the required dependencies haven't been uploaded yet. Instead you can use the git version which works everywhere:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies.glutin]
|
|
||||||
git = "https://github.com/tomaka/glutin"
|
|
||||||
```
|
|
||||||
|
|
||||||
## [Documentation](http://tomaka.github.io/glutin/)
|
## [Documentation](http://tomaka.github.io/glutin/)
|
||||||
|
|
||||||
## Try it!
|
## Try it!
|
||||||
|
|
@ -64,32 +59,18 @@ fn main() {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
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
|
## Platform-specific notes
|
||||||
|
|
||||||
### Android
|
### 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`
|
- 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`
|
||||||
- Events and vsync are not implemented
|
|
||||||
- Headless rendering doesn't work
|
|
||||||
|
|
||||||
### Emscripten
|
|
||||||
|
|
||||||
- Work will start when Emscripten gets updated to LLVM 3.5 (which should happen soon)
|
|
||||||
|
|
||||||
### OS/X
|
|
||||||
|
|
||||||
- Some events are not implemented
|
|
||||||
- Implementation is still work-in-progress
|
|
||||||
- Vsync not implemented
|
|
||||||
|
|
||||||
### Win32
|
### Win32
|
||||||
|
|
||||||
- You must call `glFlush` before `swap_buffers`, or else on Windows 8 nothing will be visible on the window
|
- You must call `glFlush` before `swap_buffers`, or else on Windows 8 nothing will be visible on the window
|
||||||
- Changing the cursor (set_cursor) is not implemented
|
|
||||||
|
|
||||||
### X11
|
### X11
|
||||||
|
|
||||||
- Some input events are not implemented
|
- 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.
|
||||||
- Pixel formats not implemented
|
|
||||||
- Vsync not implemented
|
|
||||||
- Not all mouse cursors are implemented (ContextMenu, ...)
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue