Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

imgui_explorer (C++)

The ImGui Explorer: the interactive manuals of Dear ImGui, ImPlot, ImPlot3D and ImAnim, as a widget. Each demo is shown next to its code.

The C++ API of Dear ImGui Explorer: the signatures and the documentation of its headers. This page is generated by litgen, the engine behind the Python bindings of Dear ImGui Bundle. Functions without Python bindings are not listed.

imgui_explorer.h

ImGuiExplorerLibrary (enum)

enum class ImGuiExplorerLibrary
MemberValue
ImGui0
ImPlot1
ImPlot3D2
ImAnim3
ImGuiKit }4

SetImGuiExplorerLibraries

void SetImGuiExplorerLibraries(const std::vector<ImGuiExplorerLibrary>& libraries);

The libraries offered by the toolbar (all of them by default), e.g. {ImGui, ImPlot, ImPlot3D}.

ShowImGuiExplorerGui_Cpp

void ShowImGuiExplorerGui_Cpp(std::optional<ImGuiExplorerLibrary> library = std::nullopt, bool show_status_bar = false);

C++ standalone explorer: shows C++/Python toggle and status bar option.

ShowImGuiExplorerGui_Python

void ShowImGuiExplorerGui_Python(std::optional<ImGuiExplorerLibrary> library = std::nullopt, const std::string& pythonPackagePath = "");

Python (PyPI) explorer: Python-only mode, no status bar. pythonPackagePath is the root of the installed imgui_bundle package (used to locate .py demos and .pyi stubs).

ImGuiExplorerCodeTextRect (struct)

struct ImGuiExplorerCodeTextRect

A rectangle on the screen; visible is False when there is none

Member
bool visible = false;
ImVec2 min,
max;

GetImGuiExplorerCodeTextRect

ImGuiExplorerCodeTextRect GetImGuiExplorerCodeTextRect(const std::string& text);

The screen rectangle of a text in the code shown: its first occurrence on screen. For tours and tests, which point at a word of the code