Dear Imgui for Blender
Use the infamous Dear ImGui library directly in your Blender scripts! This means custom GUI drawing in your operators:
Normally custom UI drawing in Blender is done using the binding of OpenGL from the bgl module as well as shader-related objects from the gpu module, but this is really low-level. Dear ImGui is a now traditional tool used for quick debugging UIs that provides a much more comfortable API.
This repository provides backend code and examples to run Dear ImGui within Blender. This may be used for constant overlays or interactively during modal operators.
Installation
Prior to using the code from this repository, we will install Dear ImGui's Python binding. Beware that it must be installed in Blender's Python, not in system's Python so you must call pip through Blender's python like so:
REM An example on Windows
cd "C:\Program Files\Blender Foundation\Blender 2.91\2.91\python\bin"
.\python.exe -m pip install imgui
# An example on linux
cd /usr/lib/blender/2.91/python/bin
./python3.7m -m pip install imgui
If this fails, start over using a cmd in administrator mode. You may have to adapt the path after "cd".
Examples
To quickly try out examples download ImguiExamples.zip from the last release, don't unzip it and install it as an add-on.
To go further, hack on operators.py and overlays.py and check out pyimgui's documentation!
To embed this into your add-on, you just have to include blender_imgui.py in your add-on's directory.
License
This project has a whole is distributed under the terms of the GPLv3 license. See individual file's notices for more detailed licensing info.
6 Aug 5, 2022
3.3k Jan 1, 2023
283 Nov 30, 2022
283 Nov 30, 2022
111 Jan 7, 2023
22 Oct 4, 2022
2 Dec 15, 2021
40 Dec 13, 2022
55 Jan 5, 2023
1 May 29, 2022
8 Nov 08, 2021
7 Nov 16, 2021
3 Feb 15, 2022
3 May 14, 2022
193 Dec 11, 2022
185 Dec 29, 2022
3 Mar 25, 2022
3 Aug 15, 2021
548 Dec 30, 2022
17.1k Jan 08, 2023
1 Feb 08, 2022
1 Jan 15, 2022
8 Oct 18, 2022
32 Jan 02, 2023
215 Dec 28, 2022
21 Dec 18, 2022
2 Jan 20, 2022