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.

API reference

The libraries of Dear ImGui Bundle, as Python modules, with the C++ signature next to each Python one: the bindings are generated from the C++ headers, and their names follow them (ImGui::Button is imgui.button, ImPlotFlags_ is implot.Flags_). These pages come from the Python stubs (.pyi), which keep the headers’ comments. To learn, start with the demos; to look up a name, use these pages, or the stubs in your editor. For AI assistants, the same reference exists in plain text, one file per library: https://imgui-bundle.pages.dev/llms/api/index.txt

LibraryWhat it doesModules
Dear ImGuiThe immediate mode GUI: windows, widgets, layouts, tables, the draw list, styles, IO.imgui_bundle.imgui, imgui_bundle.imgui.internal, imgui_bundle.imgui.test_engine, imgui_bundle.imgui.backends
Hello ImGuiThe app runner: the window and its backends, docking layouts, fonts, assets, DPI, idling.imgui_bundle.hello_imgui, imgui_bundle.hello_imgui_nb
ImmAppRuns an app in one call, with the add-ons set up (ImPlot, markdown, the node editor...); helpers for demos, tests and notebooks.imgui_bundle.immapp, imgui_bundle.immapp.nb
ImPlot2D plots: lines, scatter, bars, heatmaps, histograms, pies, real-time data.imgui_bundle.implot, imgui_bundle.implot.internal
ImPlot3D3D plots: lines, scatter, surfaces, meshes, with rotation and zoom.imgui_bundle.implot3d, imgui_bundle.implot3d.internal
ImmVisionImage display and inspection: zoom, pan, pixel values, colormaps, linked views (OpenCV images, numpy arrays).imgui_bundle.immvision
ImGui Node EditorNode graphs: nodes, pins and links on a zoomable canvas.imgui_bundle.imgui_node_editor
ImGuizmo3D gizmos to move, rotate and scale, and a view manipulator.imgui_bundle.imguizmo
NanoVGAntialiased 2D vector drawing: paths, gradients, text, images; in an ImGui window or a framebuffer.imgui_bundle.nanovg
ImAnimAnimation for Dear ImGui: tweens, easings, springs, timelines.imgui_bundle.im_anim
ImGuiColorTextEditA code editor widget: syntax highlighting, multiple cursors, a diff view, filters.imgui_bundle.imgui_color_text_edit
Rich MarkdownMarkdown rendered in ImGui: text, tables, code, images, math, admonitions, transclusions.imgui_bundle.rich_md
MicroTeXLaTeX formulas rendered in ImGui (the markdown’s math uses it).imgui_bundle.imgui_microtex
ImGui KnobsRotary knobs, in several styles.imgui_bundle.imgui_knobs
ImGui ToggleToggle switches, with styles and animation.imgui_bundle.imgui_toggle
ImSpinnerLoading spinners, dozens of them.imgui_bundle.imspinner
ImCoolBarA dock-like bar whose icons magnify under the mouse.imgui_bundle.im_cool_bar
ImGui Command PaletteA command palette, as in Sublime Text or VS Code.imgui_bundle.imgui_command_palette
ImFileDialogA file dialog drawn with ImGui.imgui_bundle.im_file_dialog
Portable File DialogsThe native file dialogs, message boxes and notifications of each platform.imgui_bundle.portable_file_dialogs
ImGui Tex InspectA texture inspector: zoom into a texture, read its texels.imgui_bundle.imgui_tex_inspect
Dear ImGui ExplorerThe interactive manuals of Dear ImGui, ImPlot, ImPlot3D and ImAnim, as a widget.imgui_bundle.imgui_explorer
WebGL helpersWebGL from Python, in Pyodide.imgui_bundle.webgl