imgui-bundle 0.6.6

ImGui Bundle: easily create ImGui applications in Python and C++. Batteries included!

ImGui Bundle

ImGui Bundle is a bundle for Dear ImGui, including various useful libraries from its ecosystem. It enables to easily create ImGui applications in C++, as well as in Python.

The python bindings were autogenerated from the original C++ code, so that they are easier to keep up to date, and the python API closely matches the C++ api, making it possible to easily port research code from Python to C++.

Request for feedback : ImGui Bundle is a brand-new python and C++ package (Oct 2022). Feedback from users would be appreciated in order to make sure it works on different platforms.

Warning : The API might evolve a bit during the month of November 2022. I'll remove this warning once it is more stable.

Python C++

Batteries included

ImGui Bundle include:

• imgui : Immediate Gui library
• hello imgui: multiplatform backend provider for imgui.
• implot: plotting library based on ImGui
• ImGuiColorTextEdit: Colorizing text editor
• imgui-node-editor: Node editor
• imgui-knobs: Knobs for ImGui
• ImFileDialog: File dialogs
• imgui_md: Markdown for ImGui
• imspinner: Spinners
• imgui_toggle: Toggle switch widget

Philosophy

• Closely mirrors the original API of ImGui and other libraries
• Original code documentation is consciously kept inside the python stubs. See for example the documentation for:
  • imgui
  • implot
  • hello imgui
• Fully typed bindings, so that code completion works like a charm

ImGui Backend

ImGui Bundle uses Hello ImGui, which is configured to use GLFW + OpenGL3. Under C++, this is configurable (see Hello ImGui docs), with some adaptations inside on the cmake side.

Usage with Python

Install

# Install from pypi
pip install imgui-bundle

# or install from clone
git clone https://github.com/pthom/imgui_bundle.git
cd imgui_bundle
pip install -v .

Demo

# imgui_bundle_demo will run the demo shown below. 
# It also acts as a manual for ImGui Bundle with lots of examples and related code source.
imgui_bundle_demo 

The source for the demos can be found inside bindings/imgui_bundle/demos.

Usage with C++

git clone https://github.com/pthom/imgui_bundle.git

Then, take inspiration from demos_cpp/demo_haiku_implot_heart, or demos_cpp/demo_widgets_docking