elias/imgui-rs
1
0
Fork 0
mirror of https://github.com/eliasstepanik/imgui-rs.git synced 2026-01-15 07:28:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Joonas Javanainen 2015-08-20 23:02:10 +03:00
parent 0a9dc8033e
commit 25f91b0b2e
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.markdown
View File

@ -2,8 +2,6 @@
**Ultra hyper turbo cyber mega extra über experimental!!!**
ffi module (low-level API) is complete, the safe API is not!
![Hello world](hello_world.png)
```rust
@ -19,6 +17,28 @@ frame.window()
})
```
## Currently implemented things
* Low-level API (ffi module)
* Renderer for easy integration with [Glium](https://github.com/tomaka/glium) projects (optional)
* Parts of high-level API
* Not horrible way of defining and passing null-terminated UTF-8 to ImGui
* Parts of imgui\_demo.cpp reimplemented in Rust as an API usage example (examples/test\_window.rs)
## Important but unimplemented things
* Documentation (rustdoc)
* Support passing a custom Program to Glium renderer (e.g. from a shader cache, or custom shader)
## Core design questions and current choices
* Closures VS begin/end pairs (current choice: closures)
* Mutable references VS return values (current choice: return values)
* Passing around Frame<'fr> VS passing around &'fr Frame (current choice: Frame<'fr>)
* Splitting the API to smaller pieces VS all draw calls in Frame (current choice: all draw calls in Frame)
* Builder pattern for optional arguments VS something else (current choice: builder)
* Mutation functions in builders VS self-consuming functions in builders (current choice: self-consuming)
## Compiling and running the demos
git clone https://github.com/Gekkio/imgui-rs