This is a derivative work based on the past maintainers:
Initial objective of this fork was to upgrade the Dear Imgui to v1.92.X (major update with many breaking changes), as well as adding more examples for SDL3 and Metal.
- Generates bindings for the and
dockingImGui branche, usingdear_bindings- No longer supports
masterbranch.
- No longer supports
- Contains bindings for most of the Dear ImGui implementations
- All backends which exist in
vendor:have bindings - These include:
vulkan, sdl2, sdl3, opengl3, sdlrenderer2, glfw, dx11, dx12, win32, osx, metal, wgpu
- All backends which exist in
- Compiles bindings as well as any wanted backends
- Tested on Windows, Linux, and Mac
- Includes several examples which can be used as a reference
GLFW + OpenGL, SDL2 + D3D11, SDL2 + Metal, SDL2 + OpenGL, SDL2 + SDL2 Renderer, SDL2 + Vulkan, GLFW + WGPU
If you don't want to configure and or build yourself, a prebuilt binary has been committed to the repository.
- Only binaries for Windows are committed at the moment. I've tested on Linux, it's just hard to manually get both binaries in there.
- It has all backends listed in
build.pyenabled, which almost definitely more than you need. I strongly suggest building yourself with your wanted backends.
Building is entirely automated, using build.py. All platforms should work (not not: open an issue!), but currently Mac backends are untested as I don't have a Mac (help wanted!)
- Dependencies
gitmust be in your pathdear_bindingsdepends on a library called "ply". link.- You can probably install this with
python -m pip install ply - If your distro manages Python packages, it may be called
python-plyor similar.
- You can probably install this with
- Windows depends on that
vcvarsall.batis in your path. - Linux and OSX depend on
clang,ar
- Clone this repository.
- Optionally configure build at the top of
build.py
- Optionally configure build at the top of
- Run
python build.py - Repository is importable. Copy into your project, or import directly.
Search for @CONFIGURE to see everything configurable.
This project allows you to compile ImGui backends alongside imgui itself, which is what Dear ImGui recommends you do. Bindings have been written for a subset of the backends provided by ImGui
- You can see if a backend is supported by checking the
backendstable inbuild.py. - If a backend is supported it means that:
- Bindings have been written in
imgui_impl_xyz/ - It has been successfully compiled and run in one of the
examples/
- Bindings have been written in
- Some backends have external dependencies. These will automatically be cloned into
backend_depsif necessary. - You can enable a backend by adding it to
wanted_backends - You can enable backends not officially supported.
If set to true, will compile with debug flags
There are some examples in examples/. They are runnable directly.
All backends which can be supported with only vendor have bindings now.
It seems likely to me that SDL3, and maybe Android will exist in vendor in the future, at which point I'll add support.
| Backend | Has bindings | Has example | Comment |
|---|---|---|---|
| Allegro 5 | No | No | No odin bindings in vendor |
| Android | No | No | No odin bindings in vendor |
| Directx 9 | No | No | No odin bindings in vendor |
| Directx 10 | No | No | No odin bindings in vendor |
| Directx 11 | Yes | Yes | |
| Directx 12 | Yes | No | Bindings created, but not tested |
| GLFW | Yes | Yes | |
| GLUT | No | No | Obsolete. Likely will never be implemented. |
| Metal | Yes | Yes | |
| OpenGL 2 | No | No | |
| OpenGL 3 | Yes | Yes | |
| OSX | Yes | No | |
| SDL 2 | Yes | Yes | Examples using DirectX11, Metal, OpenGL3, SDLRenderer2 |
| SDL 3 | Yes | Yes | Examples using Metal, OpenGL3, SDLRenderer3 |
| SDL_Renderer 2 | Yes | Yes | Has example, but Odin vendor library lacks required version (2.0.18) |
| SDL_Renderer 3 | Yes | Yes | |
| Vulkan | Yes | No | Tested in my own engine, but no example yet due to size |
| WebGPU | Yes | Yes | Browser/JS not supported, would require some emscripten workaround |
| win32 | Yes | No | Bindings created, but not tested |
The Dear ImGui commits which have been tested against are listed in build.py.
You can mess with these all you want and see if it works.
To update:
- Use next
dockingtag inbuild.py(eg. if current tag isv1.91.1-docking, then takev1.91.2-docking) - Go over all
imgui_impl_xyzfiles, check if they have changes on dear imgui, then update the "last update" comment.
- If there are any issues, or this package doesn't do everything you want it to, feel free to make an issue, or message me on Discord @ldash4.
- I have not yet tested on Apple devices (though I intend to). If someone with more knowledge about OSX started this initiative though, it would be appreciated!
- A few useful examples have yet to be created in
examples/.- Vulkan - This is implicitly tested against my own private project, but it would be good to have an example.
- Win32 - This should be quite easy, I just haven't had the time.
- DX12 - I'm not a DX12 expert, and this is one of the more complicated examples.
- The remaining Apple examples