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

[#691] Update "main library crates" doc

Browse Source 
- sdl2 wasn't mentioned
- mention examples folder (..pending for a few of the crates)
- mention the imgui-examples folder
This commit is contained in:
dbr 2023-01-04 18:31:30 +10:30
parent b1e66d050e
commit df7ccae78c
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.markdown
View File

@ -25,12 +25,25 @@ ui.window("Hello world")
## Main library crates
- imgui: High-level safe API
- imgui-winit-support: Backend platform implementation that uses the `winit`
crate (latest by default, but earlier versions are supported via feature flags)
- imgui-glow-renderer: Renderer implementation that uses the `glow` crate
- imgui-glium-renderer: Renderer implementation that uses the `glium` crate
- imgui-sys: Low-level unsafe API (automatically generated)
The core of imgui-rs consists of:
- `imgui`: High-level safe API
- `imgui-sys`: Low-level unsafe API (automatically generated)
Next, we provide two renderers, and two backend platform implementations:
- `imgui-winit-support`: Backend platform implementation that uses the `winit` crate
- `imgui-sdl2-support`: Backend platform using SDL2
- `imgui-glow-renderer`: Renderer implementation that uses the `glow` crate
- `imgui-glium-renderer`: Renderer implementation that uses the `glium` crate
Each of these contain an `examples` folder showing their usage. Check
the `[dev-dependencies]` section of their respective `Cargo.toml` to
find the versions of dependencies used (e.g `imgui-glow-renderer/Cargo.toml`)
Finally the `imgui-examples` folder contains examples of how to use
the `imgui` crate itself - things like how to show text, how to create
buttons, etc etc.
## Features