o
odinpkg.dev
packages / library / odin-imgui

odin-imgui

329744clibrary

Fork from https://gitlab.com/L-4/odin-imgui

MIT · updated 3 months ago

Odin ImGui

Generated Dear ImGui bindings using dear_bindings

  • Generates bindings for the and docking ImGui branche, using dear_bindings
    • No longer supports master branch.
  • Contains bindings for most of the Dear ImGui implementations
    • All backends which exist in vendor: have bindings
    • These include: vulkan, sdl2, opengl3, sdlrenderer2, glfw, dx11, dx12, win32, osx, metal, wgpu
  • 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, JS/GLFW + W(eb)GPU, JS + WebGL

Usage

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.py enabled, which almost definitely more than you need. I strongly suggest building yourself with your wanted backends.

Building

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!)

  1. Dependencies
    • git must be in your path
    • dear_bindings depends 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-ply or similar.
    • Windows depends on that vcvarsall.bat is in your path.
    • Linux and OSX depend on clang, ar
  2. Clone this repository.
    • Optionally configure build at the top of build.py
  3. Run python build.py
  4. Repository is importable. Copy into your project, or import directly.

Configuring

Search for @CONFIGURE to see everything configurable.

wanted_backends

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 backends table in build.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/
  • Some backends have external dependencies. These will automatically be cloned into backend_deps if necessary.
  • You can enable a backend by adding it to wanted_backends
  • You can enable backends not officially supported.

compile_debug

If set to true, will compile with debug flags

build_wasm

If set to true, will compile WASM object files too

Examples

There are some examples in examples/. They are runnable directly.

Available backends

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
SDL 3 No No No odin bindings in vendor (yet)
SDL_Renderer 2 Yes Yes Has example, but Odin vendor library lacks required version (2.0.18)
SDL_Renderer 3 No No No odin bindings in vendor (yet)
Vulkan Yes No Tested in my own engine, but no example yet due to size
win32 Yes No Bindings created, but not tested. Note: as of v1.91.5, this backend can no longer be compiled due to ImGui_ImplWin32_WndProcHandler and ImGui_ImplWin32_WndProcHandlerEx
JS Yes Yes Native Odin backend - Docking doesn't work for some reason
WebGPU Yes Yes Native Odin backend
WebGL Yes Yes Native Odin backend - WebGL 2 only

Updating

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 docking tag in build.py (eg. if current tag is v1.91.1-docking, then take v1.91.2-docking)
  • Go over all imgui_impl_xyz files, check if they have changes on dear imgui, then update the "last update" comment.
  • If an example stops working, the same process should be applied to these.
  • Finally, all possible examples should be run.

Help wanted!

  • 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