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

Move upgrading imgui docs to new docs subdir

Browse Source 
Add a basic README for imgui-sys for display on crates.io etc
This commit is contained in:
dbr 2021-03-05 11:28:10 +11:00
parent 90c2178366
commit 142490040f
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
imgui-sys/README.md → docs/upgrading_imgui.md
View File

@ -75,6 +75,8 @@ Luckily running the generator is quite straight forward:
4. Run the generator as per https://github.com/cimgui/cimgui#using-generator
5. Run `cargo xtask bindgen` and follow the rest of the steps as usual
Note actually committing this change may be more complicated as you will need to either replace the submodule with a copy of the source, or update the cimgui submodule to point at your fork of imgui
## Common sources of problems
### Function changes

10
imgui-sys/README.markdown Normal file
View File

@ -0,0 +1,10 @@
# imgui-sys: Low level bindings
This crate contains the raw FFI bindings to the Dear ImGui C++
library, by using the [cimgui](https://github.com/cimgui/cimgui) (a C
API wrapper project for Dear ImGui), then creating Rust bindings using
[bindgen](https://github.com/rust-lang/rust-bindgen).
These low level, mostly `unsafe` bindings are then used by `imgui-rs`
which wraps them in a nice to use, mostly safe API. Therefore most
users should not need to interact with this crate directly.