imgui-bundle 0.7.2

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

ImGui Bundle

ImGui Bundle is a bundle for Dear ImGui, including various powerful libraries from its ecosystem.

It is aimed at application developers, researchers, and beginners who want to quickly get started.

It enables to easily create ImGui applications in C++ and Python, under Windows, macOS, and Linux.

Test it in 1 minute with python

pip install imgui-bundle
pip install opencv-python
imgui_bundle_demo

Transparent port between C++ and 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++.

Python C++

Batteries included

ImGui Bundle includes:

• imgui : Dear ImGui: Bloat-free Graphical User interface for C++ with minimal dependencies
• implot: Immediate Mode Plotting
• Hello ImGui: cross-platform Gui apps with the simplicity of a "Hello World" app
• ImGuizmo: Immediate mode 3D gizmo for scene editing and other controls based on Dear Imgui
• ImGuiColorTextEdit: Colorizing text editor for ImGui
• imgui-node-editor: Node Editor built using Dear ImGui
• imgui-knobs: Knobs widgets for ImGui
• ImFileDialog: A file dialog library for Dear ImGui
• portable-file-dialogs Portable GUI dialogs library (C++11, single-header)
• imgui_md: Markdown renderer for Dear ImGui using MD4C parser
• imspinner: Set of nice spinners for imgui
• imgui_toggle: A toggle switch widget for Dear ImGui. Homepage
• ImmVision: immediate image debugger and insights
• imgui_tex_inspect: A texture inspector tool for Dear ImGui

Philosophy

• Closely mirrors the original API of ImGui and other libraries
• Original code documentation is meticulously 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

Usage with Python

Installation and demo

Install from pypi

pip install imgui-bundle
# in order to run the immvision module, install opencv-python or opencv-contrib-python
pip install opencv-contrib-python

or install from source:

git clone https://github.com/pthom/imgui_bundle.git
cd imgui_bundle 
git submodule update --init --recursive
pip install -v .
pip install opencv-contrib-python

Demo

# imgui_bundle_demo will run the full demo shown on this page. 
# 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_python.

Usage with C++: get started in 5 minutes

Read the instructions inside _example_integration.

Quick application development features

You can develop standard ImGui application the standard way with ImGui Bundle.

However, it also comes with HelloImGui, which provides:

• DPI aware application (window size, font loading and scaling, etc)
• Power Save mode: reduce FPS when application is idle
• Theme tweaking
• Window geometry utilities (autosize, restore window position)
• Assets embedding on all platforms
• Auto initialization of third parties modules (implot, imgui-node-editor, markdown, etc)
• Easy integration in a C++ project (see _example_integration)

ImGui Backend

ImGui Bundle uses Hello ImGui, which is configured to use GLFW + OpenGL3. As an alternative, SDL support can be enabled.

You can also use any backend, by providing your own integration code (see ImGui examples).