imgui (C++)

Dear ImGui: the immediate mode GUI library, on which every other module of the bundle builds.

imgui.h¶

Forward declarations and basic types¶

Scalar data types¶

Forward declarations: ImDrawList, ImFontAtlas layer
Forward declarations: ImGui layer
Enumerations

• We don’t use strongly typed enums much because they add constraints (can’t extend in private code, can’t store typed in bit fields, extra casting on iteration)

• Tip: Use your programming IDE navigation facilities on the names in the central column below to find the actual flags/enum lists!

  • In Visual Studio: Ctrl+Comma (“Edit.GoToAll”) can follow symbols inside comments, whereas Ctrl+F12 (“Edit.GoToImplementation”) cannot.

  • In Visual Studio w/ Visual Assist installed: Alt+G (“VAssistX.GoToImplementation”) can also follow symbols inside comments.

  • In VS Code, CLion, etc.: Ctrl+Click can follow symbols inside comments.
    Flags (declared as int to allow using as flags without overhead, and to not pollute the top of this file)

• Tip: Use your programming IDE navigation facilities on the names in the central column below to find the actual flags/enum lists!

  • In Visual Studio: Ctrl+Comma (“Edit.GoToAll”) can follow symbols inside comments, whereas Ctrl+F12 (“Edit.GoToImplementation”) cannot.

  • In Visual Studio w/ Visual Assist installed: Alt+G (“VAssistX.GoToImplementation”) can also follow symbols inside comments.

  • In VS Code, CLion, etc.: Ctrl+Click can follow symbols inside comments.
    Character types (we generally use UTF-8 encoded string in the API. This is storage specifically for a decoded character used for keyboard input and display)
    Callback and functions types

ImVec2 (struct)¶

ImVec2::ImVec2¶

constexpr inline ImVec2() : x(0.0f), y(0.0f);

constexpr inline ImVec2(float _x, float _y) : x(_x), y(_y);

ImVec4 (struct)¶

ImVec4: 4D vector used to store clipping rectangles, colors etc. [Compile-time configurable type]

ImVec4::ImVec4¶

constexpr inline ImVec4() : x(0.0f), y(0.0f), z(0.0f), w(0.0f);

constexpr inline ImVec4(float _x, float _y, float _z, float _w) : x(_x), y(_y), z(_z), w(_w);

Texture identifiers¶

ImTextureRef (struct)¶

ImTextureRef::ImTextureRef¶

ImTextureRef();

ImTextureRef(ImTextureID tex_id);

ImTextureRef::GetTexID¶

inline ImTextureID GetTexID() const;

(private API)

== (_TexData ? _TexData->TexID : _TexID) // Implemented below in the file.

Dear ImGui end-user API functions¶

ImGui::CreateContext¶

IMGUI_API ImGuiContext* CreateContext(ImFontAtlas* shared_font_atlas = NULL);

(Note that ImGui:: being a namespace, you can add extra ImGui:: functions in your own separate file. Please don’t modify imgui source files!)
Context creation and access

• Each context create its own ImFontAtlas by default. You may instance one yourself and pass it to CreateContext() to share a font atlas between contexts.

• DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() for each static/DLL boundary you are calling from. Read “Context and Memory Allocators” section of imgui.cpp for details.

ImGui::DestroyContext¶

IMGUI_API void DestroyContext(ImGuiContext* ctx = NULL);

None = destroy current context

ImGui::GetCurrentContext¶

IMGUI_API ImGuiContext* GetCurrentContext();

ImGui::SetCurrentContext¶

IMGUI_API void SetCurrentContext(ImGuiContext* ctx);

Main¶

ImGui::GetIO¶

IMGUI_API ImGuiIO& GetIO();

access the ImGuiIO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)

ImGui::GetPlatformIO¶

IMGUI_API ImGuiPlatformIO& GetPlatformIO();

access the ImGuiPlatformIO structure (mostly hooks/functions to connect to platform/renderer and OS Clipboard, IME etc.)

ImGui::GetStyle¶

IMGUI_API ImGuiStyle& GetStyle();

access the Style structure (colors, sizes). Always use PushStyleColor(), PushStyleVar() to modify style mid-frame!

ImGui::NewFrame¶

IMGUI_API void NewFrame();

start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().

ImGui::EndFrame¶

IMGUI_API void EndFrame();

ends the Dear ImGui frame. automatically called by Render(). If you don’t need to render data (skipping rendering) you may call EndFrame() without Render()... but you’ll have wasted CPU already! If you don’t need to render, better to not create any windows and not call NewFrame() at all!

ImGui::Render¶

IMGUI_API void Render();

ends the Dear ImGui frame, finalize the draw data. You can then get call GetDrawData().

ImGui::GetDrawData¶

IMGUI_API ImDrawData* GetDrawData();

valid after Render() and until the next call to NewFrame(). Call ImGui_ImplXXXX_RenderDrawData() function in your Renderer Backend to render.

Demo, Debug, Information¶

ImGui::ShowDemoWindow¶

IMGUI_API void ShowDemoWindow(bool* p_open = NULL);

create Demo window. demonstrate most ImGui features. call this to learn about the library! try to make it always available in your application!

ImGui::ShowDemoWindow_MaybeDocked¶

IMGUI_API void ShowDemoWindow_MaybeDocked(bool create_window, bool* p_open = NULL, ImGuiWindowFlags initial_extra_flags = 0, ImVec2 window_pos = ImVec2(0, 0), ImVec2 window_size = ImVec2(0, 0));

ImGui::ShowMetricsWindow¶

IMGUI_API void ShowMetricsWindow(bool* p_open = NULL);

create Metrics/Debugger window. display Dear ImGui internals: windows, draw commands, various internal state, etc.

[/ADAPT_IMGUI_BUNDLE]

ImGui::ShowDebugLogWindow¶

IMGUI_API void ShowDebugLogWindow(bool* p_open = NULL);

create Debug Log window. display a simplified log of important dear imgui events.

ImGui::ShowIDStackToolWindow¶

IMGUI_API void ShowIDStackToolWindow(bool* p_open = NULL);

create Stack Tool window. hover items with mouse to query information about the source of their unique ID.

ImGui::ShowAboutWindow¶

IMGUI_API void ShowAboutWindow(bool* p_open = NULL);

create About window. display Dear ImGui version, credits and build/system information.

ImGui::ShowStyleEditor¶

IMGUI_API void ShowStyleEditor(ImGuiStyle* ref = NULL);

add style editor block (not a window). you can pass in a reference ImGuiStyle structure to compare to, revert to and save to (else it uses the default style)

ImGui::ShowStyleSelector¶

IMGUI_API bool ShowStyleSelector(const char* label);

add style selector block (not a window), essentially a combo listing the default styles.

ImGui::ShowFontSelector¶

IMGUI_API void ShowFontSelector(const char* label);

add font selector block (not a window), essentially a combo listing the loaded fonts.

ImGui::ShowUserGuide¶

IMGUI_API void ShowUserGuide();

add basic help/info block (not a window): how to manipulate ImGui as an end-user (mouse/keyboard controls).

ImGui::GetVersion¶

IMGUI_API const char* GetVersion();

get the compiled version string e.g. “1.80 WIP” (essentially the value for IMGUI_VERSION from the compiled version of imgui.cpp)

Styles¶

ImGui::StyleColorsDark¶

IMGUI_API void StyleColorsDark(ImGuiStyle* dst = NULL);

new, recommended style (default)

ImGui::StyleColorsLight¶

IMGUI_API void StyleColorsLight(ImGuiStyle* dst = NULL);

best used with borders and a custom, thicker font

ImGui::StyleColorsClassic¶

IMGUI_API void StyleColorsClassic(ImGuiStyle* dst = NULL);

classic imgui style

Windows¶

• Begin() = push window to the stack and start appending to it. End() = pop window from the stack.

• Passing ‘bool* p_open != None’ shows a window-closing widget in the upper-right corner of the window, which clicking will set the boolean to False when clicked.

• You may append multiple times to the same window during the same frame by calling Begin()/End() pairs multiple times.
  Some information such as ‘flags’ or ‘p_open’ will only be considered by the first call to Begin().

• Begin() return False to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window. Always call a matching End() for each Begin() call, regardless of its return value!
  [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding
  BeginXXX function returned True. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]

• Note that the bottom of window stack always contains a window called “Debug”.

ImGui::Begin¶

IMGUI_API bool Begin(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0);

ImGui::End¶

IMGUI_API void End();

Child Windows¶

• Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child.

• Before 1.90 (November 2023), the “ImGuiChildFlags child_flags = 0” parameter was “bool border = False”.
  This API is backward compatible with old code, as we guarantee that ImGuiChildFlags_Borders == True.
  Consider updating your old code:

     BeginChild("Name", size, False)   -> Begin("Name", size, 0); or Begin("Name", size, ImGuiChildFlags_None);
     BeginChild("Name", size, True)    -> Begin("Name", size, ImGuiChildFlags_Borders);

• Manual sizing (each axis can use a different setting e.g. ImVec2(0.0, 400.0)):
  == 0.0: use remaining parent window size for this axis.\

  0.0: use specified size for this axis.
  < 0.0: right/bottom-align to specified distance from available content boundaries.

• Specifying ImGuiChildFlags_AutoResizeX or ImGuiChildFlags_AutoResizeY makes the sizing automatic based on child contents.
  Combining both ImGuiChildFlags_AutoResizeX and ImGuiChildFlags_AutoResizeY defeats purpose of a scrolling region and is NOT recommended.

• BeginChild() returns False to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window. Always call a matching EndChild() for each BeginChild() call, regardless of its return value.
  [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding
  BeginXXX function returned True. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]

ImGui::BeginChild¶

IMGUI_API bool BeginChild(const char* str_id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0);

IMGUI_API bool BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0);

ImGui::EndChild¶

IMGUI_API void EndChild();

Windows Utilities¶

• ‘current window’ = the window we are appending into while inside a Begin()/End() block. ‘next window’ = next window we will Begin() into.

ImGui::IsWindowAppearing¶

IMGUI_API bool IsWindowAppearing();

ImGui::IsWindowCollapsed¶

IMGUI_API bool IsWindowCollapsed();

ImGui::IsWindowFocused¶

IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0);

is current window focused? or its root/child, depending on flags. see flags for options.

ImGui::IsWindowHovered¶

IMGUI_API bool IsWindowHovered(ImGuiHoveredFlags flags=0);

is current window hovered and hoverable (e.g. not blocked by a popup/modal)? See ImGuiHoveredFlags_ for options. IMPORTANT: If you are trying to check whether your mouse should be dispatched to Dear ImGui or to your underlying app, you should not use this function! Use the ‘io.WantCaptureMouse’ boolean for that! Refer to FAQ entry “How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?” for details.

ImGui::GetWindowDrawList¶

IMGUI_API ImDrawList* GetWindowDrawList();

get draw list associated to the current window, to append your own drawing primitives

ImGui::GetWindowDpiScale¶

IMGUI_API float GetWindowDpiScale();

get DPI scale currently associated to the current window’s viewport.

ImGui::GetWindowPos¶

IMGUI_API ImVec2 GetWindowPos();

get current window position in screen space (IT IS UNLIKELY YOU EVER NEED TO USE THIS. Consider always using GetCursorScreenPos() and GetContentRegionAvail() instead)

ImGui::GetWindowSize¶

IMGUI_API ImVec2 GetWindowSize();

get current window size (IT IS UNLIKELY YOU EVER NEED TO USE THIS. Consider always using GetCursorScreenPos() and GetContentRegionAvail() instead)

ImGui::GetWindowWidth¶

IMGUI_API float GetWindowWidth();

get current window width (IT IS UNLIKELY YOU EVER NEED TO USE THIS). Shortcut for GetWindowSize().x.

ImGui::GetWindowHeight¶

IMGUI_API float GetWindowHeight();

get current window height (IT IS UNLIKELY YOU EVER NEED TO USE THIS). Shortcut for GetWindowSize().y.

ImGui::GetWindowViewport¶

IMGUI_API ImGuiViewport*GetWindowViewport();

get viewport currently associated to the current window.

Window manipulation¶

• Prefer using SetNextXXX functions (before Begin) rather that SetXXX functions (after Begin).

ImGui::SetNextWindowPos¶

IMGUI_API void SetNextWindowPos(const ImVec2& pos, ImGuiCond cond = 0, const ImVec2& pivot = ImVec2(0, 0));

set next window position. call before Begin(). use pivot=(0.5,0.5) to center on given point, etc.

ImGui::SetNextWindowSize¶

IMGUI_API void SetNextWindowSize(const ImVec2& size, ImGuiCond cond = 0);

set next window size. set axis to 0.0 to force an auto-fit on this axis. call before Begin()

ImGui::SetNextWindowSizeConstraints¶

IMGUI_API void SetNextWindowSizeConstraints(const ImVec2& size_min, const ImVec2& size_max, ImGuiSizeCallback custom_callback = NULL, void* custom_callback_data = NULL);

set next window size limits. use 0.0 or FLT_MAX if you don’t want limits. Use -1 for both min and max of same axis to preserve current size (which itself is a constraint). Use callback to apply non-trivial programmatic constraints.

ImGui::SetNextWindowContentSize¶

IMGUI_API void SetNextWindowContentSize(const ImVec2& size);

set next window content size (~ scrollable client area, which enforce the range of scrollbars). Not including window decorations (title bar, menu bar, etc.) nor WindowPadding. set an axis to 0.0 to leave it automatic. call before Begin()

ImGui::SetNextWindowCollapsed¶

IMGUI_API void SetNextWindowCollapsed(bool collapsed, ImGuiCond cond = 0);

set next window collapsed state. call before Begin()

ImGui::SetNextWindowFocus¶

IMGUI_API void SetNextWindowFocus();

set next window to be focused / top-most. call before Begin()

ImGui::SetNextWindowScroll¶

IMGUI_API void SetNextWindowScroll(const ImVec2& scroll);

set next window scrolling value (use < 0.0 to not affect a given axis).

ImGui::SetNextWindowBgAlpha¶

IMGUI_API void SetNextWindowBgAlpha(float alpha);

set next window background color alpha. helper to easily override the Alpha component of ImGuiCol_WindowBg/ChildBg/PopupBg. you may also use ImGuiWindowFlags_NoBackground.

ImGui::SetNextWindowViewport¶

IMGUI_API void SetNextWindowViewport(ImGuiID viewport_id);

set next window viewport

ImGui::SetWindowPos¶

IMGUI_API void SetWindowPos(const ImVec2& pos, ImGuiCond cond = 0);

IMGUI_API void SetWindowPos(const char* name, const ImVec2& pos, ImGuiCond cond = 0);

(not recommended) set current window position - call within Begin()/End(). prefer using SetNextWindowPos(), as this may incur tearing and side-effects.

ImGui::SetWindowSize¶

IMGUI_API void SetWindowSize(const ImVec2& size, ImGuiCond cond = 0);

IMGUI_API void SetWindowSize(const char* name, const ImVec2& size, ImGuiCond cond = 0);

(not recommended) set current window size - call within Begin()/End(). set to ImVec2(0, 0) to force an auto-fit. prefer using SetNextWindowSize(), as this may incur tearing and minor side-effects.

ImGui::SetWindowCollapsed¶

IMGUI_API void SetWindowCollapsed(bool collapsed, ImGuiCond cond = 0);

IMGUI_API void SetWindowCollapsed(const char* name, bool collapsed, ImGuiCond cond = 0);

(not recommended) set current window collapsed state. prefer using SetNextWindowCollapsed().

Windows Scrolling¶

• Any change of Scroll will be applied at the beginning of next frame in the first call to Begin().

• You may instead use SetNextWindowScroll() prior to calling Begin() to avoid this delay, as an alternative to using SetScrollX()/SetScrollY().

ImGui::GetScrollX¶

IMGUI_API float GetScrollX();

get scrolling amount [0 .. GetScrollMaxX()]

ImGui::GetScrollY¶

IMGUI_API float GetScrollY();

get scrolling amount [0 .. GetScrollMaxY()]

ImGui::SetScrollX¶

IMGUI_API void SetScrollX(float scroll_x);

set scrolling amount [0 .. GetScrollMaxX()]

ImGui::SetScrollY¶

IMGUI_API void SetScrollY(float scroll_y);

set scrolling amount [0 .. GetScrollMaxY()]

ImGui::GetScrollMaxX¶

IMGUI_API float GetScrollMaxX();

get maximum scrolling amount ~~ ContentSize.x - WindowSize.x - DecorationsSize.x

ImGui::GetScrollMaxY¶

IMGUI_API float GetScrollMaxY();

get maximum scrolling amount ~~ ContentSize.y - WindowSize.y - DecorationsSize.y

ImGui::SetScrollHereX¶

IMGUI_API void SetScrollHereX(float center_x_ratio = 0.5f);

adjust scrolling amount to make current cursor position visible. center_x_ratio=0.0: left, 0.5: center, 1.0: right. When using to make a “default/current item” visible, consider using SetItemDefaultFocus() instead.

ImGui::SetScrollHereY¶

IMGUI_API void SetScrollHereY(float center_y_ratio = 0.5f);

adjust scrolling amount to make current cursor position visible. center_y_ratio=0.0: top, 0.5: center, 1.0: bottom. When using to make a “default/current item” visible, consider using SetItemDefaultFocus() instead.

ImGui::SetScrollFromPosX¶

IMGUI_API void SetScrollFromPosX(float local_x, float center_x_ratio = 0.5f);

adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position.

ImGui::SetScrollFromPosY¶

IMGUI_API void SetScrollFromPosY(float local_y, float center_y_ratio = 0.5f);

adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position.

Parameters stacks (font)¶

 - PushFont(font, 0.0)                       // Change font and keep current size
 - PushFont(None, 20.0)                      // Keep font and change current size
 - PushFont(font, 20.0)                      // Change font and set size to 20.0
 - PushFont(font, style.FontSizeBase * 2.0)  // Change font and set size to be twice bigger than current size.
 - PushFont(font, font->LegacySize)           // Change font and set size to size passed to AddFontXXX() function. Same as pre-1.92 behavior.

IMPORTANT before 1.92, fonts had a single size. They can now be dynamically be adjusted.

• In 1.92 we have REMOVED the single parameter version of PushFont() because it seems like the easiest way to provide an error-proof transition.

• PushFont(font) before 1.92 = PushFont(font, font->LegacySize) after 1.92 // Use default font size as passed to AddFontXXX() function. IMPORTANT global scale factors are applied over the provided size.

• Global scale factors are: ‘style.FontScaleMain’, ‘style.FontScaleDpi’ and maybe more.

• If you want to apply a factor to the current font size:

 - CORRECT:   PushFont(None, style.FontSizeBase)         // use current unscaled size    == does nothing
 - CORRECT:   PushFont(None, style.FontSizeBase * 2.0)  // use current unscaled size x2 == make text twice bigger
 - INCORRECT: PushFont(None, GetFontSize())              // INCORRECT! using size after global factors already applied == GLOBAL SCALING FACTORS WILL APPLY TWICE!
 - INCORRECT: PushFont(None, GetFontSize() * 2.0)       // INCORRECT! using size after global factors already applied == GLOBAL SCALING FACTORS WILL APPLY TWICE!

ImGui::PopFont¶

IMGUI_API void PopFont();

ImGui::GetFont¶

IMGUI_API ImFont* GetFont();

get current font

ImGui::GetFontSize¶

IMGUI_API float GetFontSize();

get current scaled font size (= height in pixels). AFTER global scale factors applied. IMPORTANT DO NOT PASS THIS VALUE TO PushFont()! Use ImGui::GetStyle().FontSizeBase to get value before global scale factors.

ImGui::GetFontBaked¶

IMGUI_API ImFontBaked* GetFontBaked();

get current font bound at current size // == GetFont()->GetFontBaked(GetFontSize())

Parameters stacks (shared)¶

ImGui::PushStyleColor¶

IMGUI_API void PushStyleColor(ImGuiCol idx, ImU32 col);

IMGUI_API void PushStyleColor(ImGuiCol idx, const ImVec4& col);

modify a style color. always use this if you modify the style after NewFrame().

ImGui::PopStyleColor¶

IMGUI_API void PopStyleColor(int count = 1);

ImGui::PushStyleVar¶

IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val);

IMGUI_API void PushStyleVar(ImGuiStyleVar idx, const ImVec2& val);

modify a style float variable. always use this if you modify the style after NewFrame()!

ImGui::PushStyleVarX¶

IMGUI_API void PushStyleVarX(ImGuiStyleVar idx, float val_x);

modify X component of a style ImVec2 variable. "

ImGui::PushStyleVarY¶

IMGUI_API void PushStyleVarY(ImGuiStyleVar idx, float val_y);

modify Y component of a style ImVec2 variable. "

ImGui::PopStyleVar¶

IMGUI_API void PopStyleVar(int count = 1);

ImGui::PushItemFlag¶

IMGUI_API void PushItemFlag(ImGuiItemFlags option, bool enabled);

modify specified shared item flag, e.g. PushItemFlag(ImGuiItemFlags_NoTabStop, True)

ImGui::PopItemFlag¶

IMGUI_API void PopItemFlag();

Parameters stacks (current window)¶

ImGui::PushItemWidth¶

IMGUI_API void PushItemWidth(float item_width);

push width of items for common large “item+label” widgets. >0.0: width in pixels, <0.0 align xx pixels to the right of window (so -FLT_MIN always align width to the right side).

ImGui::PopItemWidth¶

IMGUI_API void PopItemWidth();

ImGui::SetNextItemWidth¶

IMGUI_API void SetNextItemWidth(float item_width);

set width of the next common large “item+label” widget. >0.0: width in pixels, <0.0 align xx pixels to the right of window (so -FLT_MIN always align width to the right side)

ImGui::CalcItemWidth¶

IMGUI_API float CalcItemWidth();

width of item given pushed settings and current cursor position. NOT necessarily the width of last item unlike most ‘Item’ functions.

ImGui::PushTextWrapPos¶

IMGUI_API void PushTextWrapPos(float wrap_local_pos_x = 0.0f);

push word-wrapping position for Text*() commands. < 0.0: no wrapping; 0.0: wrap to end of window (or column); > 0.0: wrap at ‘wrap_pos_x’ position in window local space

ImGui::PopTextWrapPos¶

IMGUI_API void PopTextWrapPos();

Style read access¶

• Use the ShowStyleEditor() function to interactively see/edit the colors.

ImGui::GetFontTexUvWhitePixel¶

IMGUI_API ImVec2 GetFontTexUvWhitePixel();

get UV coordinate for a white pixel, useful to draw custom shapes via the ImDrawList API

ImGui::GetColorU32¶

IMGUI_API ImU32 GetColorU32(ImGuiCol idx, float alpha_mul = 1.0f);

IMGUI_API ImU32 GetColorU32(const ImVec4& col);

IMGUI_API ImU32 GetColorU32(ImU32 col, float alpha_mul = 1.0f);

retrieve given style color with style alpha applied and optional extra alpha multiplier, packed as a 32-bit value suitable for ImDrawList

Layout cursor positioning¶

• By “cursor” we mean the current output position.

• The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.

• You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceding widget.

• YOU CAN DO 99% OF WHAT YOU NEED WITH ONLY GetCursorScreenPos() and GetContentRegionAvail().

• Attention! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:

   - Absolute coordinate:        GetCursorScreenPos(), SetCursorScreenPos(), all ImDrawList:: functions. -> this is the preferred way forward.
   - Window-local coordinates:   SameLine(offset), GetCursorPos(), SetCursorPos(), GetCursorStartPos(), PushTextWrapPos()
   - Window-local coordinates:   GetContentRegionMax(), GetWindowContentRegionMin(), GetWindowContentRegionMax() --> all obsoleted. YOU DON'T NEED THEM.

• GetCursorScreenPos() = GetCursorPos() + GetWindowPos(). GetWindowPos() is almost only ever useful to convert from window-local to absolute coordinates. Try not to use it.

ImGui::GetCursorScreenPos¶

IMGUI_API ImVec2 GetCursorScreenPos();

cursor position, absolute coordinates. THIS IS YOUR BEST FRIEND (prefer using this rather than GetCursorPos(), also more useful to work with ImDrawList API).

ImGui::SetCursorScreenPos¶

IMGUI_API void SetCursorScreenPos(const ImVec2& pos);

cursor position, absolute coordinates. THIS IS YOUR BEST FRIEND.

ImGui::GetContentRegionAvail¶

IMGUI_API ImVec2 GetContentRegionAvail();

available space from current position. THIS IS YOUR BEST FRIEND.

ImGui::GetCursorPos¶

IMGUI_API ImVec2 GetCursorPos();

[window-local] cursor position in window-local coordinates. This is not your best friend.

ImGui::GetCursorPosX¶

IMGUI_API float GetCursorPosX();

[window-local] "

ImGui::GetCursorPosY¶

IMGUI_API float GetCursorPosY();

[window-local] "

ImGui::SetCursorPos¶

IMGUI_API void SetCursorPos(const ImVec2& local_pos);

[window-local] "

ImGui::SetCursorPosX¶

IMGUI_API void SetCursorPosX(float local_x);

[window-local] "

ImGui::SetCursorPosY¶

IMGUI_API void SetCursorPosY(float local_y);

[window-local] "

ImGui::GetCursorStartPos¶

IMGUI_API ImVec2 GetCursorStartPos();

[window-local] initial cursor position, in window-local coordinates. Call GetCursorScreenPos() after Begin() to get the absolute coordinates version.

Other layout functions¶

ImGui::Separator¶

IMGUI_API void Separator();

separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.

ImGui::SameLine¶

IMGUI_API void SameLine(float offset_from_start_x=0.0f, float spacing=-1.0f);

call between widgets or groups to layout them horizontally. X position given in window coordinates.

ImGui::NewLine¶

IMGUI_API void NewLine();

undo a SameLine() or force a new line when in a horizontal-layout context.

ImGui::Spacing¶

IMGUI_API void Spacing();

add vertical spacing.

ImGui::Dummy¶

IMGUI_API void Dummy(const ImVec2& size);

add a dummy item of given size. unlike InvisibleButton(), Dummy() won’t take the mouse click or be navigable into.

ImGui::Indent¶

IMGUI_API void Indent(float indent_w = 0.0f);

move content position toward the right, by indent_w, or style.IndentSpacing if indent_w <= 0

ImGui::Unindent¶

IMGUI_API void Unindent(float indent_w = 0.0f);

move content position back to the left, by indent_w, or style.IndentSpacing if indent_w <= 0

ImGui::BeginGroup¶

IMGUI_API void BeginGroup();

lock horizontal starting position

ImGui::EndGroup¶

IMGUI_API void EndGroup();

unlock horizontal starting position + capture the whole group bounding box into one “item” (so you can use IsItemHovered() or layout primitives such as SameLine() on whole group, etc.)

ImGui::AlignTextToFramePadding¶

IMGUI_API void AlignTextToFramePadding();

vertically align upcoming text baseline to FramePadding.y so that it will align properly to regularly framed items (call if you have text on a line before a framed item)

ImGui::GetTextLineHeight¶

IMGUI_API float GetTextLineHeight();

~ FontSize

ImGui::GetTextLineHeightWithSpacing¶

IMGUI_API float GetTextLineHeightWithSpacing();

~ FontSize + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of text)

ImGui::GetFrameHeight¶

IMGUI_API float GetFrameHeight();

~ FontSize + style.FramePadding.y * 2

ImGui::GetFrameHeightWithSpacing¶

IMGUI_API float GetFrameHeightWithSpacing();

~ FontSize + style.FramePadding.y * 2 + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets)

ID stack/scopes¶

Read the FAQ (docs/FAQ.md or http://dearimgui.com/faq) for more details about how ID are handled in dear imgui.

• Those questions are answered and impacted by understanding of the ID stack system:

  • “Q: Why is my widget not reacting when I click on it?”

  • “Q: How can I have widgets with an empty label?”

  • “Q: How can I have multiple widgets with the same label?”

• Short version: ID are hashes of the entire ID stack. If you are creating widgets in a loop you most likely want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them.

• You can also use the “Label##foobar” syntax within widget label to distinguish them from each others.

• In this header file we use the “label”/“name” terminology to denote a string that will be displayed + used as an ID, whereas “str_id” denote a string that is only used as an ID and not normally displayed.

ImGui::PushID¶

IMGUI_API void PushID(const char* str_id);

IMGUI_API void PushID(const char* str_id_begin, const char* str_id_end);

IMGUI_API void PushID(const void* ptr_id);

IMGUI_API void PushID(int int_id);

push string into the ID stack (will hash string).

ImGui::PopID¶

IMGUI_API void PopID();

pop from the ID stack.

ImGui::GetID¶

IMGUI_API ImGuiID GetID(const char* str_id);

IMGUI_API ImGuiID GetID(const char* str_id_begin, const char* str_id_end);

IMGUI_API ImGuiID GetID(const void* ptr_id);

IMGUI_API ImGuiID GetID(int int_id);

calculate unique ID (hash of whole ID stack + given parameter). e.g. if you want to query into ImGuiStorage yourself

Widgets: Text¶

• Note that all functions taking format strings in the API may be passed (“%s”, text) or (“%.*s”, text_len, text): which will automatically bypass the formatter.

ImGui::TextUnformatted¶

IMGUI_API void TextUnformatted(const char* text, const char* text_end = NULL);

raw text without formatting. Practically equivalent to ‘Text(“%s”, text)’ but doesn’t require null terminated string if ‘text_end’ is specified.

ImGui::Text¶

IMGUI_API void Text(const char* fmt, ...) ;

formatted text

ImGui::TextColored¶

IMGUI_API void TextColored(const ImVec4& col, const char* fmt, ...) ;

shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor();

ImGui::TextDisabled¶

IMGUI_API void TextDisabled(const char* fmt, ...) ;

shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(fmt, ...); PopStyleColor();

ImGui::TextWrapped¶

IMGUI_API void TextWrapped(const char* fmt, ...) ;

shortcut for PushTextWrapPos(0.0); Text(fmt, ...); PopTextWrapPos();. Note that this won’t work on an auto-resizing window if there’s no other widgets to extend the window width, yoy may need to set a size using SetNextWindowSize().

ImGui::LabelText¶

IMGUI_API void LabelText(const char* label, const char* fmt, ...) ;

display text+label aligned the same way as value+label widgets

ImGui::BulletText¶

IMGUI_API void BulletText(const char* fmt, ...) ;

shortcut for Bullet()+Text()

ImGui::SeparatorText¶

IMGUI_API void SeparatorText(const char* label);

currently: formatted text with a horizontal line

Widgets: Main¶

• Most widgets return True when the value has been changed or when pressed/selected

• You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state.

ImGui::Button¶

IMGUI_API bool Button(const char* label, const ImVec2& size = ImVec2(0, 0));

button

ImGui::SmallButton¶

IMGUI_API bool SmallButton(const char* label);

button with (FramePadding.y == 0) to easily embed within text

ImGui::InvisibleButton¶

IMGUI_API bool InvisibleButton(const char* str_id, const ImVec2& size, ImGuiButtonFlags flags = 0);

flexible button behavior without the visuals, frequently useful to build custom behaviors using the public api (along with IsItemActive, IsItemHovered, etc.)

ImGui::ArrowButton¶

IMGUI_API bool ArrowButton(const char* str_id, ImGuiDir dir);

square button with an arrow shape

ImGui::Checkbox¶

IMGUI_API bool Checkbox(const char* label, bool* v);

ImGui::CheckboxFlags¶

IMGUI_API bool CheckboxFlags(const char* label, int* flags, int flags_value);

ImGui::RadioButton¶

IMGUI_API bool RadioButton(const char* label, bool active);

IMGUI_API bool RadioButton(const char* label, int* v, int v_button);

use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; }

ImGui::ProgressBar¶

IMGUI_API void ProgressBar(float fraction, const ImVec2& size_arg = ImVec2(-FLT_MIN, 0), const char* overlay = NULL);

ImGui::Bullet¶

IMGUI_API void Bullet();

draw a small circle + keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses

ImGui::TextLink¶

IMGUI_API bool TextLink(const char* label);

hyperlink text button, return True when clicked

ImGui::TextLinkOpenURL¶

IMGUI_API bool TextLinkOpenURL(const char* label, const char* url = NULL);

hyperlink text button, automatically open file/url when clicked

Widgets: Images¶

• Read about ImTextureID/ImTextureRef here: https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples

• ‘uv0’ and ‘uv1’ are texture coordinates. Read about them from the same link above.

• Image() adds style.ImageBorderSize on each side, ImageButton() adds style.FramePadding on each side.

• ImageButton() draws a background based on regular Button() color + optionally an inner background if specified.

• An obsolete version of Image(), before 1.91.9 (March 2025), had a ‘tint_col’ parameter which is now supported by the ImageWithBg() function.

ImGui::Image¶

IMGUI_API void Image(ImTextureRef tex_ref, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1));

ImGui::ImageWithBg¶

IMGUI_API void ImageWithBg(ImTextureRef tex_ref, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1));

ImGui::ImageButton¶

IMGUI_API bool ImageButton(const char* str_id, ImTextureRef tex_ref, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1));

Widgets: Combo Box (Dropdown)¶

• The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.

• The old Combo() api are helpers over BeginCombo()/EndCombo() which are kept available for convenience purpose. This is analogous to how ListBox are created.

ImGui::BeginCombo¶

IMGUI_API bool BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags = 0);

ImGui::EndCombo¶

IMGUI_API void EndCombo();

only call EndCombo() if BeginCombo() returns True!

ImGui::Combo¶

IMGUI_API bool Combo(const char* label, int* current_item, const char* const items[], int items_count, int popup_max_height_in_items = -1);

IMGUI_API bool Combo(const char* label, int* current_item, const char* items_separated_by_zeros, int popup_max_height_in_items = -1);

Separate items with \0 within a string, end item-list with \0\0. e.g. “One\0Two\0Three\0”

Widgets: Drag Sliders¶

• Ctrl+Click on any drag box to turn them into an input box. Manually input values aren’t clamped by default and can go off-bounds. Use ImGuiSliderFlags_AlwaysClamp to always clamp.

• For all the Float2/Float3/Float4/Int2/Int3/Int4 versions of every function, note that a ‘float v[X]’ function argument is the same as ‘float* v’, the array syntax is just a way to document the number of elements that are expected to be accessible. You can pass address of your first element out of a contiguous set, e.g. &myvector.x

• Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. “%.3” -> 1.234; “%5.2 secs” -> 01.23 secs; “Biscuit: %.0” -> Biscuit: 1; etc.

• Format string may also be set to None or use the default format (“%f” or “%d”).

• Speed are per-pixel of mouse movement (v_speed=0.2: mouse needs to move by 5 pixels to increase value by 1). For keyboard/gamepad navigation, minimum speed is Max(v_speed, minimum_step_at_given_precision).

• Use v_min < v_max to clamp edits to given limits. Note that Ctrl+Click manual input can override those limits if ImGuiSliderFlags_AlwaysClamp is not used.

• Use v_max = FLT_MAX / INT_MAX etc to avoid clamping to a maximum, same with v_min = -FLT_MAX / INT_MIN to avoid clamping to a minimum.

• We use the same sets of flags for DragXXX() and SliderXXX() functions as the features are the same and it makes it easier to swap them.

• Legacy: Pre-1.78 there are DragXXX() function signatures that take a final float power=1.0' argument instead of the ImGuiSliderFlags flags=0’ argument.
  If you get a warning converting a float to ImGuiSliderFlags, read ocornut/imgui#3361

ImGui::DragFloat¶

IMGUI_API bool DragFloat(const char* label, float* v, float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

If v_min >= v_max we have no bound

ImGui::DragFloat2¶

IMGUI_API bool DragFloat2(const char* label, float v[2], float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

ImGui::DragFloat3¶

IMGUI_API bool DragFloat3(const char* label, float v[3], float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

ImGui::DragFloat4¶

IMGUI_API bool DragFloat4(const char* label, float v[4], float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

ImGui::DragFloatRange2¶

IMGUI_API bool DragFloatRange2(const char* label, float* v_current_min, float* v_current_max, float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", const char* format_max = NULL, ImGuiSliderFlags flags = 0);

ImGui::DragInt¶

IMGUI_API bool DragInt(const char* label, int* v, float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0);

If v_min >= v_max we have no bound

ImGui::DragInt2¶

IMGUI_API bool DragInt2(const char* label, int v[2], float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::DragInt3¶

IMGUI_API bool DragInt3(const char* label, int v[3], float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::DragInt4¶

IMGUI_API bool DragInt4(const char* label, int v[4], float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::DragIntRange2¶

IMGUI_API bool DragIntRange2(const char* label, int* v_current_min, int* v_current_max, float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", const char* format_max = NULL, ImGuiSliderFlags flags = 0);

ImGui::DragScalar¶

IMGUI_API bool DragScalar(const char* label, ImGuiDataType data_type, void* p_data, float v_speed = 1.0f, const void* p_min = NULL, const void* p_max = NULL, const char* format = NULL, ImGuiSliderFlags flags = 0);

ImGui::DragScalarN¶

IMGUI_API bool DragScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, float v_speed = 1.0f, const void* p_min = NULL, const void* p_max = NULL, const char* format = NULL, ImGuiSliderFlags flags = 0);

Widgets: Regular Sliders¶

• Ctrl+Click on any slider to turn them into an input box. Manually input values aren’t clamped by default and can go off-bounds. Use ImGuiSliderFlags_AlwaysClamp to always clamp.

• Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. “%.3” -> 1.234; “%5.2 secs” -> 01.23 secs; “Biscuit: %.0” -> Biscuit: 1; etc.

• Format string may also be set to None or use the default format (“%f” or “%d”).

• Legacy: Pre-1.78 there are SliderXXX() function signatures that take a final float power=1.0' argument instead of the ImGuiSliderFlags flags=0’ argument.
  If you get a warning converting a float to ImGuiSliderFlags, read ocornut/imgui#3361

ImGui::SliderFloat¶

IMGUI_API bool SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

adjust format to decorate the value with a prefix or a suffix for in-slider labels or unit display.

ImGui::SliderFloat3¶

IMGUI_API bool SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

ImGui::SliderAngle¶

IMGUI_API bool SliderAngle(const char* label, float* v_rad, float v_degrees_min = -360.0f, float v_degrees_max = +360.0f, const char* format = "%.0f deg", ImGuiSliderFlags flags = 0);

ImGui::SliderInt¶

IMGUI_API bool SliderInt(const char* label, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::SliderInt2¶

IMGUI_API bool SliderInt2(const char* label, int v[2], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::SliderInt3¶

IMGUI_API bool SliderInt3(const char* label, int v[3], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::SliderInt4¶

IMGUI_API bool SliderInt4(const char* label, int v[4], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::SliderScalar¶

IMGUI_API bool SliderScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format = NULL, ImGuiSliderFlags flags = 0);

ImGui::SliderScalarN¶

IMGUI_API bool SliderScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, const void* p_min, const void* p_max, const char* format = NULL, ImGuiSliderFlags flags = 0);

ImGui::VSliderFloat¶

IMGUI_API bool VSliderFloat(const char* label, const ImVec2& size, float* v, float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);

ImGui::VSliderInt¶

IMGUI_API bool VSliderInt(const char* label, const ImVec2& size, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);

ImGui::VSliderScalar¶

IMGUI_API bool VSliderScalar(const char* label, const ImVec2& size, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format = NULL, ImGuiSliderFlags flags = 0);

Widgets: Input with Keyboard¶

• If you want to use InputText() with std::string or any custom dynamic string type, use the wrapper in misc/cpp/imgui_stdlib.h/.cpp!

• Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc.

ImGui::InputFloat¶

IMGUI_API bool InputFloat(const char* label, float* v, float step = 0.0f, float step_fast = 0.0f, const char* format = "%.3f", ImGuiInputTextFlags flags = 0);

ImGui::InputFloat3¶

IMGUI_API bool InputFloat3(const char* label, float v[3], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);

ImGui::InputInt¶

IMGUI_API bool InputInt(const char* label, int* v, int step = 1, int step_fast = 100, ImGuiInputTextFlags flags = 0);

ImGui::InputInt2¶

IMGUI_API bool InputInt2(const char* label, int v[2], ImGuiInputTextFlags flags = 0);

ImGui::InputInt3¶

IMGUI_API bool InputInt3(const char* label, int v[3], ImGuiInputTextFlags flags = 0);

ImGui::InputInt4¶

IMGUI_API bool InputInt4(const char* label, int v[4], ImGuiInputTextFlags flags = 0);

ImGui::InputDouble¶

IMGUI_API bool InputDouble(const char* label, double* v, double step = 0.0, double step_fast = 0.0, const char* format = "%.6f", ImGuiInputTextFlags flags = 0);

ImGui::InputScalar¶

IMGUI_API bool InputScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_step = NULL, const void* p_step_fast = NULL, const char* format = NULL, ImGuiInputTextFlags flags = 0);

ImGui::InputScalarN¶

IMGUI_API bool InputScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, const void* p_step = NULL, const void* p_step_fast = NULL, const char* format = NULL, ImGuiInputTextFlags flags = 0);

ImGui::ColorButton¶

IMGUI_API bool ColorButton(const char* desc_id, const ImVec4& col, ImGuiColorEditFlags flags = 0, const ImVec2& size = ImVec2(0, 0));

display a color square/button, hover for details, return True when pressed.

Widgets: Color Editor/Picker (tip: the ColorEdit* functions have a little color square that can be left-clicked to open a picker, and right-clicked to open an option menu.)

• Note that in C++ a ‘float v[X]’ function argument is the same as ‘float* v’, the array syntax is just a way to document the number of elements that are expected to be accessible.

• You can pass the address of a first float element out of a contiguous structure, e.g. &myvector.x

Widgets: Trees¶

• TreeNode functions return True when the node is open, in which case you need to also call TreePop() when you are finished displaying the tree node contents.

ImGui::TreeNode¶

IMGUI_API bool TreeNode(const char* label);

IMGUI_API bool TreeNode(const char* str_id, const char* fmt, ...) ;

IMGUI_API bool TreeNode(const void* ptr_id, const char* fmt, ...) ;

helper variation to easily decorrelate the id from the displayed string. Read the FAQ about why and how to use ID. to align arbitrary text at the same level as a TreeNode() you can use Bullet().

ImGui::TreeNodeEx¶

IMGUI_API bool TreeNodeEx(const char* label, ImGuiTreeNodeFlags flags = 0);

IMGUI_API bool TreeNodeEx(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) ;

IMGUI_API bool TreeNodeEx(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) ;

ImGui::TreePush¶

IMGUI_API void TreePush(const char* str_id);

IMGUI_API void TreePush(const void* ptr_id);

~ Indent()+PushID(). Already called by TreeNode() when returning True, but you can call TreePush/TreePop yourself if desired.

ImGui::TreePop¶

IMGUI_API void TreePop();

~ Unindent()+PopID()

ImGui::GetTreeNodeToLabelSpacing¶

IMGUI_API float GetTreeNodeToLabelSpacing();

horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode

ImGui::CollapsingHeader¶

IMGUI_API bool CollapsingHeader(const char* label, ImGuiTreeNodeFlags flags = 0);

IMGUI_API bool CollapsingHeader(const char* label, bool* p_visible, ImGuiTreeNodeFlags flags = 0);

if returning ‘True’ the header is open. doesn’t indent nor push on ID stack. user doesn’t have to call TreePop().

ImGui::SetNextItemOpen¶

IMGUI_API void SetNextItemOpen(bool is_open, ImGuiCond cond = 0);

set next TreeNode/CollapsingHeader open state.

ImGui::SetNextItemStorageID¶

IMGUI_API void SetNextItemStorageID(ImGuiID storage_id);

set id to use for open/close storage (default to same as item id).

ImGui::TreeNodeGetOpen¶

IMGUI_API bool TreeNodeGetOpen(ImGuiID storage_id);

retrieve tree node open/close state.

Widgets: Selectables¶

• A selectable highlights when hovered, and can display another color when selected.

• Neighbors selectable extend their highlight bounds in order to leave no gap between them. This is so a series of selected Selectable appear contiguous.

ImGui::Selectable¶

IMGUI_API bool Selectable(const char* label, bool* p_selected, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0, 0));

“bool* p_selected” point to the selection state (read-write), as a convenient helper.

ImGui::BeginMultiSelect¶

IMGUI_API ImGuiMultiSelectIO* BeginMultiSelect(ImGuiMultiSelectFlags flags, int selection_size = -1, int items_count = -1);

Multi-selection system for Selectable(), Checkbox(), TreeNode() functions [BETA]

• This enables standard multi-selection/range-selection idioms (Ctrl+Mouse/Keyboard, Shift+Mouse/Keyboard, etc.) in a way that also allow a clipper to be used.

• ImGuiSelectionUserData is often used to store your item index within the current view (but may store something else).

• Read comments near ImGuiMultiSelectIO for instructions/details and see ‘Demo->Widgets->Selection State & Multi-Select’ for demo.

• TreeNode() is technically supported but... using this correctly is more complicated. You need some sort of linear/random access to your tree, which is suited to advanced trees setups already implementing filters and clipper. We will work simplifying the current demo.

• ‘selection_size’ and ‘items_count’ parameters are optional and used by a few features. If they are costly for you to compute, you may avoid them.

ImGui::EndMultiSelect¶

IMGUI_API ImGuiMultiSelectIO* EndMultiSelect();

ImGui::SetNextItemSelectionUserData¶

IMGUI_API void SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data);

ImGui::IsItemToggledSelection¶

IMGUI_API bool IsItemToggledSelection();

Was the last item selection state toggled? Useful if you need the per-item information before reaching EndMultiSelect(). We only returns toggle event in order to handle clipping correctly.

Widgets: List Boxes¶

• This is essentially a thin wrapper to using BeginChild/EndChild with the ImGuiChildFlags_FrameStyle flag for stylistic changes + displaying a label.

• If you don’t need a label you can probably simply use BeginChild() with the ImGuiChildFlags_FrameStyle flag for the same result.

• You can submit contents and manage your selection state however you want it, by creating e.g. Selectable() or any other items.

• The simplified/old ListBox() api are helpers over BeginListBox()/EndListBox() which are kept available for convenience purpose. This is analogous to how Combos are created.

• Choose frame width: size.x > 0.0: custom / size.x < 0.0 or -FLT_MIN: right-align / size.x = 0.0 (default): use current ItemWidth

• Choose frame height: size.y > 0.0: custom / size.y < 0.0 or -FLT_MIN: bottom-align / size.y = 0.0 (default): arbitrary default height which can fit ~7 items

ImGui::BeginListBox¶

IMGUI_API bool BeginListBox(const char* label, const ImVec2& size = ImVec2(0, 0));

open a framed scrolling region

ImGui::EndListBox¶

IMGUI_API void EndListBox();

only call EndListBox() if BeginListBox() returned True!

ImGui::ListBox¶

IMGUI_API bool ListBox(const char* label, int* current_item, const char* const items[], int items_count, int height_in_items = -1);

Widgets: Data Plotting¶

• Consider using ImPlot (https://github.com/epezent/implot) which is much better!

ImGui::PlotLines¶

IMGUI_API void PlotLines(const char* label, const float* values, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0), int stride = sizeof(float));

ImGui::PlotHistogram¶

IMGUI_API void PlotHistogram(const char* label, const float* values, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0), int stride = sizeof(float));

ImGui::Value¶

IMGUI_API void Value(const char* prefix, bool b);

IMGUI_API void Value(const char* prefix, int v);

IMGUI_API void Value(const char* prefix, float v, const char* float_format = NULL);

Widgets: Value() Helpers.

• Those are merely shortcut to calling Text() with a format string. Output single value in “name: value” format (tip: freely declare more in your code to handle your types. you can add functions to the ImGui namespace)

Widgets: Menus¶

• Use BeginMenuBar() on a window ImGuiWindowFlags_MenuBar to append to its menu bar.

• Use BeginMainMenuBar() to create a menu bar at the top of the screen and append to it.

• Use BeginMenu() to create a menu. You can call BeginMenu() multiple time with the same identifier to append more items to it.

• Note that MenuItem() keyboard shortcuts are displayed as a convenience but not processed by Dear ImGui at the moment.

ImGui::BeginMenuBar¶

IMGUI_API bool BeginMenuBar();

append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).

ImGui::EndMenuBar¶

IMGUI_API void EndMenuBar();

only call EndMenuBar() if BeginMenuBar() returns True!

ImGui::BeginMainMenuBar¶

IMGUI_API bool BeginMainMenuBar();

create and append to a full screen menu-bar.

ImGui::EndMainMenuBar¶

IMGUI_API void EndMainMenuBar();

only call EndMainMenuBar() if BeginMainMenuBar() returns True!

ImGui::BeginMenu¶

IMGUI_API bool BeginMenu(const char* label, bool enabled = true);

create a sub-menu entry. only call EndMenu() if this returns True!

ImGui::EndMenu¶

IMGUI_API void EndMenu();

only call EndMenu() if BeginMenu() returns True!

ImGui::MenuItem¶

IMGUI_API bool MenuItem(const char* label, const char* shortcut, bool* p_selected, bool enabled = true);

return True when activated + toggle (*p_selected) if p_selected != None

Tooltips¶

• Tooltips are windows following the mouse. They do not take focus away.

• A tooltip window can contain items of any types.

• SetTooltip() is more or less a shortcut for the ‘if (BeginTooltip()) { Text(...); EndTooltip(); }’ idiom (with a subtlety that it discard any previously submitted tooltip)

ImGui::BeginTooltip¶

IMGUI_API bool BeginTooltip();

begin/append a tooltip window.

ImGui::EndTooltip¶

IMGUI_API void EndTooltip();

only call EndTooltip() if BeginTooltip()/BeginItemTooltip() returns True!

ImGui::SetTooltip¶

IMGUI_API void SetTooltip(const char* fmt, ...) ;

set a text-only tooltip. Often used after a ImGui::IsItemHovered() check. Override any previous call to SetTooltip().

ImGui::BeginItemTooltip¶

IMGUI_API bool BeginItemTooltip();

begin/append a tooltip window if preceding item was hovered.

Tooltips: helpers for showing a tooltip when hovering an item

• BeginItemTooltip() is a shortcut for the ‘if (IsItemHovered(ImGuiHoveredFlags_ForTooltip) && BeginTooltip())’ idiom.

• SetItemTooltip() is a shortcut for the ‘if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) { SetTooltip(...); }’ idiom.

• Where ‘ImGuiHoveredFlags_ForTooltip’ itself is a shortcut to use ‘style.HoverFlagsForTooltipMouse’ or ‘style.HoverFlagsForTooltipNav’ depending on active input type. For mouse it defaults to ‘ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort’.

ImGui::SetItemTooltip¶

IMGUI_API void SetItemTooltip(const char* fmt, ...) ;

set a text-only tooltip if preceding item was hovered. override any previous call to SetTooltip().

Popups, Modals¶

• They block normal mouse hovering detection (and therefore most mouse interactions) behind them.

• If not modal: they can be closed by clicking anywhere outside them, or by pressing Escape (call ‘Shortcut(ImGuiKey_Escape)’ to claim a higher-priority shortcut).

• Their visibility state (~bool) is held internally instead of being held by the programmer as we are used to with regular Begin*() calls.

• The 3 properties above are related: we need to retain popup visibility state in the library because popups may be closed as any time.

• You can bypass the hovering restriction by using ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered().

• IMPORTANT: Popup identifiers are relative to the current ID stack, so OpenPopup and BeginPopup generally needs to be at the same level of the stack.
  This is sometimes leading to confusing mistakes. May rework this in the future.

• BeginPopup(): query popup state, if open start appending into the window. Call EndPopup() afterwards if returned True. ImGuiWindowFlags are forwarded to the window.

• BeginPopupModal(): block every interaction behind the window, cannot be closed by user, add a dimming background, has a title bar.

ImGui::BeginPopup¶

IMGUI_API bool BeginPopup(const char* str_id, ImGuiWindowFlags flags = 0);

return True if the popup is open, and you can start outputting to it.

ImGui::BeginPopupModal¶

IMGUI_API bool BeginPopupModal(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0);

return True if the modal is open, and you can start outputting to it.

ImGui::EndPopup¶

IMGUI_API void EndPopup();

only call EndPopup() if BeginPopupXXX() returns True!

Popups: open/close functions¶

• OpenPopup(): set popup state to open (unless one of the specified ImGuiPopupFlags prevent opening).

• OpenPopupXXX() functions return True when the popup is toggled open, which allows you to capture local state if needed.
  You may also call IsWindowAppearing() inside the later BeginPopup() scope if you need to prepare/compute data for the popup.

• If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.

• CloseCurrentPopup(): use inside the BeginPopup()/EndPopup() scope to close manually.

• CloseCurrentPopup() is called by default by Selectable()/MenuItem() when activated (FIXME: need some options).

• Use ImGuiPopupFlags_NoOpenOverExistingPopup to avoid opening a popup if there’s already one at the same level. This is equivalent to e.g. testing for !IsAnyPopupOpen() prior to OpenPopup().

• Use IsWindowAppearing() after BeginPopup() to tell if a window just opened.

ImGui::OpenPopup¶

IMGUI_API bool OpenPopup(const char* str_id, ImGuiPopupFlags popup_flags = 0);

IMGUI_API bool OpenPopup(ImGuiID id, ImGuiPopupFlags popup_flags = 0);

call to mark popup as open (don’t call every frame!).

ImGui::OpenPopupOnItemClick¶

IMGUI_API bool OpenPopupOnItemClick(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 0);

helper to open popup when clicked on last item. Default to ImGuiPopupFlags_MouseButtonRight == 1. (note: actually triggers on the mouse released event to be consistent with popup behaviors)

ImGui::CloseCurrentPopup¶

IMGUI_API void CloseCurrentPopup();

manually close the popup we have begin-ed into.

ImGui::BeginPopupContextItem¶

IMGUI_API bool BeginPopupContextItem(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 0);

open+begin popup when clicked on last item. Use str_id==None to associate the popup to previous item. If you want to use that on a non-interactive item such as Text() you need to pass in an explicit ID here. read comments in .cpp!

Popups: Open+Begin popup combined functions helpers to create context menus.

• Helpers to do OpenPopup+BeginPopup where the Open action is triggered by e.g. hovering an item and right-clicking.

• IMPORTANT: Notice that BeginPopupContextXXX takes ImGuiPopupFlags just like OpenPopup() and unlike BeginPopup(). For full consistency, we may add ImGuiWindowFlags to the BeginPopupContextXXX functions in the future.

• IMPORTANT: If you ever used the left mouse button with BeginPopupContextXXX() helpers before 1.92.6:

  • Before this version, OpenPopupOnItemClick(), BeginPopupContextItem(), BeginPopupContextWindow(), BeginPopupContextVoid() had ‘a ImGuiPopupFlags popup_flags = 1’ default value in their function signature.

  • Before: Explicitly passing a literal 0 meant ImGuiPopupFlags_MouseButtonLeft. The default = 1 meant ImGuiPopupFlags_MouseButtonRight.

  • After: The default = 0 means ImGuiPopupFlags_MouseButtonRight. Explicitly passing a literal 1 also means ImGuiPopupFlags_MouseButtonRight (if legacy behavior are enabled) or will assert (if legacy behavior are disabled).

  • TL;DR: if you don’t want to use right mouse button for popups, always specify it explicitly using a named ImGuiPopupFlags_MouseButtonXXXX value.

  • Read “API BREAKING CHANGES” 2026/01/07 (1.92.6) entry in imgui.cpp or GitHub topic #9157 for all details.

ImGui::BeginPopupContextWindow¶

IMGUI_API bool BeginPopupContextWindow(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 0);

open+begin popup when clicked on current window.

ImGui::BeginPopupContextVoid¶

IMGUI_API bool BeginPopupContextVoid(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 0);

open+begin popup when clicked in None (where there are no windows).

Popups: query functions¶

• IsPopupOpen(): return True if the popup is open at the current BeginPopup() level of the popup stack.

• IsPopupOpen() with ImGuiPopupFlags_AnyPopupId: return True if any popup is open at the current BeginPopup() level of the popup stack.

• IsPopupOpen() with ImGuiPopupFlags_AnyPopupId + ImGuiPopupFlags_AnyPopupLevel: return True if any popup is open.

ImGui::IsPopupOpen¶

IMGUI_API bool IsPopupOpen(const char* str_id, ImGuiPopupFlags flags = 0);

return True if the popup is open.

Tables¶

• Full-featured replacement for old Columns API.

• See Demo->Tables for demo code. See top of imgui_tables.cpp for general commentary.

• See ImGuiTableFlags_ and ImGuiTableColumnFlags_ enums for a description of available flags.
  The typical call flow is:

• 1. Call BeginTable(), early out if returning False.

• 2. Optionally call TableSetupColumn() to submit column name/flags/defaults.

• 3. Optionally call TableSetupScrollFreeze() to request scroll freezing of columns/rows.

• 4. Optionally call TableHeadersRow() to submit a header row. Names are pulled from TableSetupColumn() data.

• 5. Populate contents:

  • In most situations you can use TableNextRow() + TableSetColumnIndex(N) to start appending into a column.

  • If you are using tables as a sort of grid, where every column is holding the same type of contents, you may prefer using TableNextColumn() instead of TableNextRow() + TableSetColumnIndex().
    TableNextColumn() will automatically wrap-around into the next row if needed.

  • IMPORTANT: Comparatively to the old Columns() API, we need to call TableNextColumn() for the first column!

  • Summary of possible call flow:

       - TableNextRow() -> TableSetColumnIndex(0) -> Text("Hello 0") -> TableSetColumnIndex(1) -> Text("Hello 1")  // OK
       - TableNextRow() -> TableNextColumn()      -> Text("Hello 0") -> TableNextColumn()      -> Text("Hello 1")  // OK
       -                   TableNextColumn()      -> Text("Hello 0") -> TableNextColumn()      -> Text("Hello 1")  // OK: TableNextColumn() automatically gets to next row!
       - TableNextRow()                           -> Text("Hello 0")                                               // Not OK! Missing TableSetColumnIndex() or TableNextColumn()! Text will not appear!

• 5. Call EndTable()

ImGui::BeginTable¶

IMGUI_API bool BeginTable(const char* str_id, int columns, ImGuiTableFlags flags = 0, const ImVec2& outer_size = ImVec2(0.0f, 0.0f), float inner_width = 0.0f);

ImGui::EndTable¶

IMGUI_API void EndTable();

only call EndTable() if BeginTable() returns True!

ImGui::TableNextRow¶

IMGUI_API void TableNextRow(ImGuiTableRowFlags row_flags = 0, float min_row_height = 0.0f);

append into the first cell of a new row. ‘min_row_height’ include the minimum top and bottom padding aka CellPadding.y * 2.0.

ImGui::TableNextColumn¶

IMGUI_API bool TableNextColumn();

append into the next column (or first column of next row if currently in last column). Return True when column is visible.

ImGui::TableSetColumnIndex¶

IMGUI_API bool TableSetColumnIndex(int column_n);

append into the specified column. Return True when column is visible.

Tables: Headers & Columns declaration¶

• Use TableSetupColumn() to specify label, resizing policy, default width/weight, various other flags etc. (the trailing ‘ImGuiID user_data’, which used to be referred to as ‘ImGuiID user_id’, is merely user data that is blindly copied in ImGuiTableColumnSortSpecs).

• Use TableHeadersRow() to create a header row and automatically submit a TableHeader() for each column.
  Headers are required to perform: reordering, sorting, and opening the context menu.
  The context menu can also be made available in columns body using ImGuiTableFlags_ContextMenuInBody.

• You may manually submit headers using TableNextRow() + TableHeader() calls, but this is only useful in some advanced use cases (e.g. adding custom widgets in header row).

• Use TableSetupScrollFreeze() to lock columns/rows so they stay visible when scrolled. When freezing columns you would usually also use ImGuiTableColumnFlags_NoHide on them.

ImGui::TableSetupColumn¶

IMGUI_API void TableSetupColumn(const char* label, ImGuiTableColumnFlags flags = 0, float init_width_or_weight = 0.0f, ImGuiID user_data = 0);

ImGui::TableSetupScrollFreeze¶

IMGUI_API void TableSetupScrollFreeze(int cols, int rows);

lock columns/rows so they stay visible when scrolled.

ImGui::TableHeader¶

IMGUI_API void TableHeader(const char* label);

submit one header cell manually (rarely used)

ImGui::TableHeadersRow¶

IMGUI_API void TableHeadersRow();

submit a row with headers cells based on data provided to TableSetupColumn() + submit context menu

ImGui::TableAngledHeadersRow¶

IMGUI_API void TableAngledHeadersRow();

submit a row with angled headers for every column with the ImGuiTableColumnFlags_AngledHeader flag. MUST BE FIRST ROW.

Tables: Sorting & Miscellaneous functions¶

• Sorting: call TableGetSortSpecs() to retrieve latest sort specs for the table. None when not sorting.
  When ‘sort_specs->SpecsDirty == True’ you should sort your data. It will be True when sorting specs have changed since last call, or the first time. Make sure to set ‘SpecsDirty = False’ after sorting, else you may wastefully sort your data every frame!

• Functions args ‘int column_n’ treat the default value of -1 as the same as passing the current column index.

ImGui::TableGetSortSpecs¶

IMGUI_API ImGuiTableSortSpecs* TableGetSortSpecs();

get latest sort specs for the table (None if not sorting). Lifetime: don’t hold on this pointer over multiple frames or past any subsequent call to BeginTable().

ImGui::TableGetColumnCount¶

IMGUI_API int TableGetColumnCount();

return number of columns (value passed to BeginTable)

ImGui::TableGetColumnIndex¶

IMGUI_API int TableGetColumnIndex();

return current column index.

ImGui::TableGetRowIndex¶

IMGUI_API int TableGetRowIndex();

return current row index (header rows are accounted for)

ImGui::TableGetColumnName¶

IMGUI_API const char* TableGetColumnName(int column_n = -1);

return “” if column didn’t have a name declared by TableSetupColumn(). Pass -1 to use current column.

ImGui::TableGetColumnFlags¶

IMGUI_API ImGuiTableColumnFlags TableGetColumnFlags(int column_n = -1);

return column flags so you can query their Enabled/Visible/Sorted/Hovered status flags. Pass -1 to use current column.

ImGui::TableSetColumnEnabled¶

IMGUI_API void TableSetColumnEnabled(int column_n, bool v);

change user accessible enabled/disabled state of a column. Set to False to hide the column. User can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody)

ImGui::TableGetHoveredColumn¶

IMGUI_API int TableGetHoveredColumn();

return hovered column. return -1 when table is not hovered. return columns_count if the unused space at the right of visible columns is hovered. Can also use (TableGetColumnFlags() & ImGuiTableColumnFlags_IsHovered) instead.

ImGui::TableSetBgColor¶

IMGUI_API void TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n = -1);

change the color of a cell, row, or column. See ImGuiTableBgTarget_ flags for details.

Legacy Columns API (prefer using Tables!)¶

• You can also use SameLine(pos_x) to mimic simplified columns.

ImGui::Columns¶

IMGUI_API void Columns(int count = 1, const char* id = NULL, bool borders = true);

ImGui::NextColumn¶

IMGUI_API void NextColumn();

next column, defaults to current row or next row if the current row is finished

ImGui::GetColumnIndex¶

IMGUI_API int GetColumnIndex();

get current column index

ImGui::GetColumnWidth¶

IMGUI_API float GetColumnWidth(int column_index = -1);

get column width (in pixels). pass -1 to use current column

ImGui::SetColumnWidth¶

IMGUI_API void SetColumnWidth(int column_index, float width);

set column width (in pixels). pass -1 to use current column

ImGui::GetColumnOffset¶

IMGUI_API float GetColumnOffset(int column_index = -1);

get position of column line (in pixels, from the left side of the contents region). pass -1 to use current column, otherwise 0..GetColumnsCount() inclusive. column 0 is typically 0.0

ImGui::SetColumnOffset¶

IMGUI_API void SetColumnOffset(int column_index, float offset_x);

set position of column line (in pixels, from the left side of the contents region). pass -1 to use current column

ImGui::GetColumnsCount¶

IMGUI_API int GetColumnsCount();

Tab Bars, Tabs¶

• Note: Tabs are automatically created by the docking system (when in ‘docking’ branch). Use this to create tab bars/tabs yourself.

ImGui::BeginTabBar¶

IMGUI_API bool BeginTabBar(const char* str_id, ImGuiTabBarFlags flags = 0);

create and append into a TabBar

ImGui::EndTabBar¶

IMGUI_API void EndTabBar();

only call EndTabBar() if BeginTabBar() returns True!

ImGui::BeginTabItem¶

IMGUI_API bool BeginTabItem(const char* label, bool* p_open = NULL, ImGuiTabItemFlags flags = 0);

create a Tab. Returns True if the Tab is selected.

ImGui::EndTabItem¶

IMGUI_API void EndTabItem();

only call EndTabItem() if BeginTabItem() returns True!

ImGui::TabItemButton¶

IMGUI_API bool TabItemButton(const char* label, ImGuiTabItemFlags flags = 0);

create a Tab behaving like a button. return True when clicked. cannot be selected in the tab bar.

ImGui::SetTabItemClosed¶

IMGUI_API void SetTabItemClosed(const char* tab_or_docked_window_label);

notify TabBar or Docking system of a closed tab/window ahead (useful to reduce visual flicker on reorderable tab bars). For tab-bar: call after BeginTabBar() and before Tab submissions. Otherwise call with a window name.

Docking¶

• Read https://github.com/ocornut/imgui/wiki/Docking for details.

• Enable with io.ConfigFlags |= ImGuiConfigFlags_DockingEnable.

• You can use many Docking facilities without calling any API.

  • Drag from window title bar or their tab to dock/undock. Hold SHIFT to disable docking.

  • Drag from window menu button (upper-left button) to undock an entire node (all windows).

  • When io.ConfigDockingWithShift == True, you instead need to hold SHIFT to enable docking.

• DockSpaceOverViewport:

  • This is a helper to create an invisible window covering a viewport, then submit a DockSpace() into it.

  • Most applications can simply call DockSpaceOverViewport() once to allow docking windows into e.g. the edge of your screen.

    e.g. ImGui::NewFrame(); ImGui::DockSpaceOverViewport();                                                   // Create a dockspace in main viewport.
     or: ImGui::NewFrame(); ImGui::DockSpaceOverViewport(0, None, ImGuiDockNodeFlags_PassthruCentralNode); // Create a dockspace in main viewport, central node is transparent.

• Dockspaces:

  • A dockspace is an explicit dock node within an existing window.

  • IMPORTANT: Dockspaces need to be submitted before any window they can host. Submit them early in your frame!

  • IMPORTANT: Dockspaces need to be kept alive if hidden, otherwise windows docked into it will be undocked.
    If you have e.g. multiple tabs with a dockspace inside each tab: submit the non-visible dockspaces with ImGuiDockNodeFlags_KeepAliveOnly.

  • See ‘Demo->Examples->Dockspace’ or ‘Demo->Examples->Documents’ for more detailed demos.

• Programmatic docking:

  • There is no public API yet other than the very limited SetNextWindowDockID() function. Sorry for that!

  • Read https://github.com/ocornut/imgui/wiki/Docking for examples of how to use current internal API.

ImGui::DockSpace¶

IMGUI_API ImGuiID DockSpace(ImGuiID dockspace_id, const ImVec2& size = ImVec2(0, 0), ImGuiDockNodeFlags flags = 0, const ImGuiWindowClass* window_class = NULL);

ImGui::DockSpaceOverViewport¶

IMGUI_API ImGuiID DockSpaceOverViewport(ImGuiID dockspace_id = 0, const ImGuiViewport* viewport = NULL, ImGuiDockNodeFlags flags = 0, const ImGuiWindowClass* window_class = NULL);

ImGui::SetNextWindowDockID¶

IMGUI_API void SetNextWindowDockID(ImGuiID dock_id, ImGuiCond cond = 0);

set next window dock id

ImGui::SetNextWindowClass¶

IMGUI_API void SetNextWindowClass(const ImGuiWindowClass* window_class);

set next window class (control docking compatibility + provide hints to platform backend via custom viewport flags and platform parent/child relationship)

ImGui::GetWindowDockID¶

IMGUI_API ImGuiID GetWindowDockID();

get dock id of current window, or 0 if not associated to any docking node.

ImGui::IsWindowDocked¶

IMGUI_API bool IsWindowDocked();

is current window docked into another window?

Logging/Capture¶

• All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.

ImGui::LogToTTY¶

IMGUI_API void LogToTTY(int auto_open_depth = -1);

start logging to tty (stdout)

ImGui::LogToFile¶

IMGUI_API void LogToFile(int auto_open_depth = -1, const char* filename = NULL);

start logging to file

ImGui::LogToClipboard¶

IMGUI_API void LogToClipboard(int auto_open_depth = -1);

start logging to OS clipboard

ImGui::LogFinish¶

IMGUI_API void LogFinish();

stop logging (close file, etc.)

ImGui::LogButtons¶

IMGUI_API void LogButtons();

helper to display buttons for logging to tty/file/clipboard

ImGui::LogText¶

IMGUI_API void LogText(const char* fmt, ...) ;

pass text data straight to log (without being displayed)

Drag and Drop¶

• On source items, call BeginDragDropSource(), if it returns True also call SetDragDropPayload() + EndDragDropSource().

• On target candidates, call BeginDragDropTarget(), if it returns True also call AcceptDragDropPayload() + EndDragDropTarget().

• If you stop calling BeginDragDropSource() the payload is preserved however it won’t have a preview tooltip (we currently display a fallback “...” tooltip, see #1725)

• An item can be both drag source and drop target.

ImGui::BeginDragDropSource¶

IMGUI_API bool BeginDragDropSource(ImGuiDragDropFlags flags = 0);

call after submitting an item which may be dragged. when this return True, you can call SetDragDropPayload() + EndDragDropSource()

ImGui::EndDragDropSource¶

IMGUI_API void EndDragDropSource();

only call EndDragDropSource() if BeginDragDropSource() returns True!

ImGui::BeginDragDropTarget¶

IMGUI_API bool BeginDragDropTarget();

call after submitting an item that may receive a payload. If this returns True, you can call AcceptDragDropPayload() + EndDragDropTarget()

ImGui::EndDragDropTarget¶

IMGUI_API void EndDragDropTarget();

only call EndDragDropTarget() if BeginDragDropTarget() returns True!

Disabling [BETA API]¶

• Disable all user interactions and dim items visuals (applying style.DisabledAlpha over current colors)

• Those can be nested but it cannot be used to enable an already disabled section (a single BeginDisabled(True) in the stack is enough to keep everything disabled)

• Tooltips windows are automatically opted out of disabling. Note that IsItemHovered() by default returns False on disabled items, unless using ImGuiHoveredFlags_AllowWhenDisabled.

• BeginDisabled(False)/EndDisabled() essentially does nothing but is provided to facilitate use of boolean expressions (as a micro-optimization: if you have tens of thousands of BeginDisabled(False)/EndDisabled() pairs, you might want to reformulate your code to avoid making those calls)

ImGui::BeginDisabled¶

IMGUI_API void BeginDisabled(bool disabled = true);

ImGui::EndDisabled¶

IMGUI_API void EndDisabled();

Clipping¶

• Mouse hovering is affected by ImGui::PushClipRect() calls, unlike direct calls to ImDrawList::PushClipRect() which are render only.

ImGui::PushClipRect¶

IMGUI_API void PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect);

ImGui::PopClipRect¶

IMGUI_API void PopClipRect();

Focus, Activation¶

ImGui::SetItemDefaultFocus¶

IMGUI_API void SetItemDefaultFocus();

make last item the default focused item of a newly appearing window.

ImGui::SetKeyboardFocusHere¶

IMGUI_API void SetKeyboardFocusHere(int offset = 0);

focus keyboard on the next widget. Use positive ‘offset’ to access sub components of a multiple component widget. Use -1 to access previous widget.

Keyboard/Gamepad Navigation¶

ImGui::SetNavCursorVisible¶

IMGUI_API void SetNavCursorVisible(bool visible);

alter visibility of keyboard/gamepad cursor. by default: show when using an arrow key, hide when clicking with mouse.

Overlapping mode¶

ImGui::SetNextItemAllowOverlap¶

IMGUI_API void SetNextItemAllowOverlap();

allow next item to be overlapped by a subsequent item. Typically useful with InvisibleButton(), Selectable(), TreeNode() covering an area where subsequent items may need to be added. Note that both Selectable() and TreeNode() have dedicated flags doing this.

Item/Widgets Utilities and Query Functions¶

• Most of the functions are referring to the previous Item that has been submitted.

• See Demo Window under “Widgets->Querying Status” for an interactive visualization of most of those functions.

ImGui::IsItemHovered¶

IMGUI_API bool IsItemHovered(ImGuiHoveredFlags flags = 0);

is the last item hovered? (and usable, aka not blocked by a popup, etc.). See ImGuiHoveredFlags for more options.

ImGui::IsItemActive¶

IMGUI_API bool IsItemActive();

is the last item active? (e.g. button being held, text field being edited. This will continuously return True while holding mouse button on an item. Items that don’t interact will always return False)

ImGui::IsItemFocused¶

IMGUI_API bool IsItemFocused();

is the last item focused for keyboard/gamepad navigation?

ImGui::IsItemClicked¶

IMGUI_API bool IsItemClicked(ImGuiMouseButton mouse_button = 0);

is the last item hovered and mouse clicked on? () == IsMouseClicked(mouse_button) && IsItemHovered()Important. () this is NOT equivalent to the behavior of e.g. Button(). Read comments in function definition.

ImGui::IsItemVisible¶

IMGUI_API bool IsItemVisible();

is the last item visible? (items may be out of sight because of clipping/scrolling)

ImGui::IsItemEdited¶

IMGUI_API bool IsItemEdited();

did the last item modify its underlying value this frame? or was pressed? This is generally the same as the “bool” return value of many widgets.

ImGui::IsItemActivated¶

IMGUI_API bool IsItemActivated();

was the last item just made active (item was previously inactive).

ImGui::IsItemDeactivated¶

IMGUI_API bool IsItemDeactivated();

was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that require continuous editing.

ImGui::IsItemDeactivatedAfterEdit¶

IMGUI_API bool IsItemDeactivatedAfterEdit();

was the last item just made inactive and made a value change when it was active? (e.g. Slider/Drag moved). Useful for Undo/Redo patterns with widgets that require continuous editing. Note that you may get False positives (some widgets such as Combo()/ListBox()/Selectable() will return True even when clicking an already selected item).

ImGui::IsItemToggledOpen¶

IMGUI_API bool IsItemToggledOpen();

was the last item open state toggled? set by TreeNode().

ImGui::IsAnyItemHovered¶

IMGUI_API bool IsAnyItemHovered();

is any item hovered?

ImGui::IsAnyItemActive¶

IMGUI_API bool IsAnyItemActive();

is any item active?

ImGui::IsAnyItemFocused¶

IMGUI_API bool IsAnyItemFocused();

is any item focused?

ImGui::GetItemID¶

IMGUI_API ImGuiID GetItemID();

get ID of last item (~~ often same ImGui::GetID(label) beforehand)

ImGui::GetItemRectMin¶

IMGUI_API ImVec2 GetItemRectMin();

get upper-left bounding rectangle of the last item (screen space)

ImGui::GetItemRectMax¶

IMGUI_API ImVec2 GetItemRectMax();

get lower-right bounding rectangle of the last item (screen space)

ImGui::GetItemRectSize¶

IMGUI_API ImVec2 GetItemRectSize();

get size of last item

ImGui::GetItemFlags¶

IMGUI_API ImGuiItemFlags GetItemFlags();

get generic flags of last item

ImGui::GetItemClickedCountWithSingleClickDelay¶

IMGUI_API int GetItemClickedCountWithSingleClickDelay(ImGuiMouseButton mouse_button = 0, float delay = -1.0f);

[BETA] building block for disambiguation between single-click and double-click. Returns 1 on single-click but delayed by io.MouseSingleClickDelay after mouse release. Returns 2+ on double-click or repeated clicks.

Viewports¶

• Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.

• In ‘docking’ branch with multi-viewport enabled, we extend this concept to have multiple active viewports.

• In the future we will extend this concept further to also represent Platform Monitor and support a “no main platform window” operation mode.

ImGui::GetMainViewport¶

IMGUI_API ImGuiViewport* GetMainViewport();

return primary/default viewport. This can never be None.

Background/Foreground Draw Lists¶

ImGui::GetBackgroundDrawList¶

IMGUI_API ImDrawList* GetBackgroundDrawList(ImGuiViewport* viewport = NULL);

get background draw list for the given viewport or viewport associated to the current window. this draw list will be the first rendering one. Useful to quickly draw shapes/text behind dear imgui contents.

ImGui::GetForegroundDrawList¶

IMGUI_API ImDrawList* GetForegroundDrawList(ImGuiViewport* viewport = NULL);

get foreground draw list for the given viewport or viewport associated to the current window. this draw list will be the top-most rendered one. Useful to quickly draw shapes/text over dear imgui contents.

Miscellaneous Utilities¶

ImGui::IsRectVisible¶

IMGUI_API bool IsRectVisible(const ImVec2& size);

IMGUI_API bool IsRectVisible(const ImVec2& rect_min, const ImVec2& rect_max);

test if rectangle (of given size, starting from cursor position) is visible / not clipped.

ImGui::GetTime¶

IMGUI_API double GetTime();

get global imgui time. incremented by io.DeltaTime every frame.

ImGui::GetFrameCount¶

IMGUI_API int GetFrameCount();

get global imgui frame count. incremented by 1 every frame.

ImGui::GetDrawListSharedData¶

IMGUI_API ImDrawListSharedData* GetDrawListSharedData();

you may use this when creating your own ImDrawList instances.

ImGui::GetStyleColorName¶

IMGUI_API const char* GetStyleColorName(ImGuiCol idx);

get a string corresponding to the enum value (for display, saving, etc.).

ImGui::SetStateStorage¶

IMGUI_API void SetStateStorage(ImGuiStorage* storage);

replace current window storage with our own (if you want to manipulate it yourself, typically clear subsection of it)

ImGui::GetStateStorage¶

IMGUI_API ImGuiStorage* GetStateStorage();

ImGui::CalcTextSize¶

IMGUI_API ImVec2 CalcTextSize(const char* text, const char* text_end = NULL, bool hide_text_after_double_hash = false, float wrap_width = -1.0f);

Text Utilities

Color Utilities¶

ImGui::ColorConvertU32ToFloat4¶

IMGUI_API ImVec4 ColorConvertU32ToFloat4(ImU32 in);

ImGui::ColorConvertFloat4ToU32¶

IMGUI_API ImU32 ColorConvertFloat4ToU32(const ImVec4& in);

Inputs Utilities: Raw Keyboard/Mouse/Gamepad Access¶

• Consider using the Shortcut() function instead of IsKeyPressed()/IsKeyChordPressed()! Shortcut() is easier to use and better featured (can do focus routing check).

• the ImGuiKey enum contains all possible keyboard, mouse and gamepad inputs (e.g. ImGuiKey_A, ImGuiKey_MouseLeft, ImGuiKey_GamepadDpadUp...).

• (legacy: before v1.87 (2022-02), we used ImGuiKey < 512 values to carry native/user indices as defined by each backends. This was obsoleted in 1.87 (2022-02) and completely removed in 1.91.5 (2024-11). See ocornut/imgui#4921)

ImGui::IsKeyDown¶

IMGUI_API bool IsKeyDown(ImGuiKey key);

is key being held.

ImGui::IsKeyPressed¶

IMGUI_API bool IsKeyPressed(ImGuiKey key, bool repeat = true);

was key pressed (went from !Down to Down)? Repeat rate uses io.KeyRepeatDelay / KeyRepeatRate.

ImGui::IsKeyReleased¶

IMGUI_API bool IsKeyReleased(ImGuiKey key);

was key released (went from Down to !Down)?

ImGui::IsKeyChordPressed¶

IMGUI_API bool IsKeyChordPressed(ImGuiKeyChord key_chord);

was key chord (mods + key) pressed, e.g. you can pass ‘ImGuiMod_Ctrl | ImGuiKey_S’ as a key-chord. This doesn’t do any routing or focus check, please consider using Shortcut() function instead.

ImGui::GetKeyPressedAmount¶

IMGUI_API int GetKeyPressedAmount(ImGuiKey key, float repeat_delay, float rate);

uses provided repeat rate/delay. return a count, most often 0 or 1 but might be >1 if RepeatRate is small enough that DeltaTime > RepeatRate

ImGui::GetKeyName¶

IMGUI_API const char* GetKeyName(ImGuiKey key);

[DEBUG] returns English name of the key. Those names are provided for debugging purpose and are not meant to be saved persistently nor compared.

ImGui::SetNextFrameWantCaptureKeyboard¶

IMGUI_API void SetNextFrameWantCaptureKeyboard(bool want_capture_keyboard);

Override io.WantCaptureKeyboard flag next frame (said flag is left for your application to handle, typically when True it instructs your app to ignore inputs). e.g. force capture keyboard when your widget is being hovered. This is equivalent to setting “io.WantCaptureKeyboard = want_capture_keyboard”; after the next NewFrame() call.

Inputs Utilities: Shortcut Testing & Routing¶

• Typical use is e.g.: ‘if (ImGui::Shortcut(ImGuiMod_Ctrl | ImGuiKey_S)) { ... }’.

• Flags: Default route use ImGuiInputFlags_RouteFocused, but see ImGuiInputFlags_RouteGlobal and other options in ImGuiInputFlags_!

• Flags: Use ImGuiInputFlags_Repeat to support repeat.

• ImGuiKeyChord = a ImGuiKey + optional ImGuiMod_Alt/ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Super.

      ImGuiKey_C                          // Accepted by functions taking ImGuiKey or ImGuiKeyChord arguments
      ImGuiMod_Ctrl | ImGuiKey_C          // Accepted by functions taking ImGuiKeyChord arguments

only ImGuiMod_XXX values are legal to combine with an ImGuiKey. You CANNOT combine two ImGuiKey values.

• The general idea is that several callers may register interest in a shortcut, and only one owner gets it.

     Parent   -> call Shortcut(Ctrl+S)    // When Parent is focused, Parent gets the shortcut.
       Child1 -> call Shortcut(Ctrl+S)    // When Child1 is focused, Child1 gets the shortcut (Child1 overrides Parent shortcuts)
       Child2 -> no call                  // When Child2 is focused, Parent gets the shortcut.

The whole system is order independent, so if Child1 makes its calls before Parent, results will be identical.
This is an important property as it facilitate working with foreign code or larger codebase.

• To understand the difference:

  • IsKeyChordPressed() compares mods and call IsKeyPressed()
    -> the function has no side-effect.

  • Shortcut() submits a route, routes are resolved, if it currently can be routed it calls IsKeyChordPressed()
    -> the function has (desirable) side-effects as it can prevents another call from getting the route.

• Visualize registered routes in ‘Metrics/Debugger->Inputs’.

ImGui::Shortcut¶

IMGUI_API bool Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);

ImGui::SetNextItemShortcut¶

IMGUI_API void SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);

Inputs Utilities: Key/Input Ownership [BETA]¶

• One common use case would be to allow your items to disable standard inputs behaviors such as Tab or Alt key handling, Mouse Wheel scrolling, etc. e.g. Button(...); if (SetItemKeyOwner(ImGuiKey_MouseWheelY)) { ... } to make hovering/activating a button disable wheel for scrolling.

• Reminder ImGuiKey enum include access to mouse buttons and gamepad, so key ownership can apply to them.

• The return value of SetItemKeyOwner() says if ownership has been requested for the item, which is a shortcut to calling yet non-public TestKeyOwner() function.

• Many related features are still in imgui_internal.h. For instance, most IsKeyXXX()/IsMouseXXX() functions have an owner-id-aware version.

ImGui::SetItemKeyOwner¶

IMGUI_API bool SetItemKeyOwner(ImGuiKey key);

Set key owner to last item ID if it is hovered or active. Return True when ownership has been set. Roughly equivalent to ‘if (TestKeyOwner(key, GetItemID()) && (IsItemHovered() || IsItemActive())) { SetKeyOwner(key, GetItemID());’.

Inputs Utilities: Mouse¶

• To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.

• You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.

• Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see ‘lock_threshold’ and ‘io.MouseDraggingThreshold’)

ImGui::IsMouseDown¶

IMGUI_API bool IsMouseDown(ImGuiMouseButton button);

is mouse button held?

ImGui::IsMouseClicked¶

IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, bool repeat = false);

did mouse button clicked? (went from !Down to Down). Same as GetMouseClickedCount() == 1.

ImGui::IsMouseReleased¶

IMGUI_API bool IsMouseReleased(ImGuiMouseButton button);

did mouse button released? (went from Down to !Down)

ImGui::IsMouseDoubleClicked¶

IMGUI_API bool IsMouseDoubleClicked(ImGuiMouseButton button);

did mouse button double-clicked? Same as GetMouseClickedCount() == 2. (note that a double-click will also report IsMouseClicked() == True)

ImGui::IsMouseReleasedWithDelay¶

IMGUI_API bool IsMouseReleasedWithDelay(ImGuiMouseButton button, float delay=-1.f);

delayed mouse release. Use sparingly. Prefer higher-level helper GetItemClickedCountWithSingleClickDelay(). Generally used with ‘delay >= io.MouseDoubleClickTime’ + combined with a ‘io.MouseClickedLastCount==1’ test.

ImGui::GetMouseClickedCount¶

IMGUI_API int GetMouseClickedCount(ImGuiMouseButton button);

return the number of successive mouse-clicks at the time where a click happen (otherwise 0).

ImGui::IsMouseHoveringRect¶

IMGUI_API bool IsMouseHoveringRect(const ImVec2& r_min, const ImVec2& r_max, bool clip = true);

is mouse hovering given bounding rect (in screen space). clipped by current clipping settings, but disregarding of other consideration of focus/window ordering/popup-block.

ImGui::IsMousePosValid¶

IMGUI_API bool IsMousePosValid(const ImVec2* mouse_pos = NULL);

by convention we use (-FLT_MAX,-FLT_MAX) to denote that there is no mouse available

ImGui::IsAnyMouseDown¶

IMGUI_API bool IsAnyMouseDown();

[WILL OBSOLETE] is any mouse button held? This was designed for backends, but prefer having backend maintain a mask of held mouse buttons, because upcoming input queue system will make this invalid.

ImGui::GetMousePos¶

IMGUI_API ImVec2 GetMousePos();

shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls

ImGui::GetMousePosOnOpeningCurrentPopup¶

IMGUI_API ImVec2 GetMousePosOnOpeningCurrentPopup();

retrieve mouse position at the time of opening popup we have BeginPopup() into (helper to avoid user backing that value themselves)

ImGui::IsMouseDragging¶

IMGUI_API bool IsMouseDragging(ImGuiMouseButton button, float lock_threshold = -1.0f);

is mouse dragging? (uses io.MouseDraggingThreshold if lock_threshold < 0.0)

ImGui::GetMouseDragDelta¶

IMGUI_API ImVec2 GetMouseDragDelta(ImGuiMouseButton button = 0, float lock_threshold = -1.0f);

return the delta from the initial clicking position while the mouse button is pressed or was just released. This is locked and return 0.0 until the mouse moves past a distance threshold at least once (uses io.MouseDraggingThreshold if lock_threshold < 0.0)

ImGui::ResetMouseDragDelta¶

IMGUI_API void ResetMouseDragDelta(ImGuiMouseButton button = 0);

ImGui::GetMouseCursor¶

IMGUI_API ImGuiMouseCursor GetMouseCursor();

get desired mouse cursor shape. Important: reset in ImGui::NewFrame(), this is updated during the frame. valid before Render(). If you use software rendering by setting io.MouseDrawCursor ImGui will render those for you

ImGui::SetMouseCursor¶

IMGUI_API void SetMouseCursor(ImGuiMouseCursor cursor_type);

set desired mouse cursor shape

ImGui::SetNextFrameWantCaptureMouse¶

IMGUI_API void SetNextFrameWantCaptureMouse(bool want_capture_mouse);

Override io.WantCaptureMouse flag next frame (said flag is left for your application to handle, typical when True it instructs your app to ignore inputs). This is equivalent to setting “io.WantCaptureMouse = want_capture_mouse;” after the next NewFrame() call.

Clipboard Utilities¶

• Also see the LogToClipboard() function to capture GUI into clipboard, or easily output text data to the clipboard.

ImGui::SetClipboardText¶

IMGUI_API void SetClipboardText(const char* text);

Settings/.Ini Utilities¶

• The disk functions are automatically called if io.IniFilename != None (default is “imgui.ini”).

• Set io.IniFilename to None to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually.

• Important: default value “imgui.ini” is relative to current working dir! Most apps will want to lock this to an absolute path (e.g. same path as executables).

ImGui::LoadIniSettingsFromDisk¶

IMGUI_API void LoadIniSettingsFromDisk(const char* ini_filename);

call after CreateContext() and before the first call to NewFrame(). NewFrame() automatically calls LoadIniSettingsFromDisk(io.IniFilename).

ImGui::LoadIniSettingsFromMemory¶

IMGUI_API void LoadIniSettingsFromMemory(const char* ini_data, size_t ini_size=0);

call after CreateContext() and before the first call to NewFrame() to provide .ini data from your own data source.

ImGui::SaveIniSettingsToDisk¶

IMGUI_API void SaveIniSettingsToDisk(const char* ini_filename);

this is automatically called (if io.IniFilename is not empty) a few seconds after any modification that should be reflected in the .ini file (and also by DestroyContext).

ImGui::SaveIniSettingsToMemory¶

IMGUI_API const char* SaveIniSettingsToMemory(size_t* out_ini_size = NULL);

return a zero-terminated string with the .ini data which you can save by your own mean. call when io.WantSaveIniSettings is set, then save data by your own mean and clear io.WantSaveIniSettings.

Debug Utilities¶

• Your main debugging friend is the ShowMetricsWindow() function.

• Interactive tools are all accessible from the ‘Dear ImGui Demo->Tools’ menu.

• Read https://github.com/ocornut/imgui/wiki/Debug-Tools for a description of all available debug tools.

ImGui::DebugTextEncoding¶

IMGUI_API void DebugTextEncoding(const char* text);

ImGui::DebugFlashStyleColor¶

IMGUI_API void DebugFlashStyleColor(ImGuiCol idx);

ImGui::DebugStartItemPicker¶

IMGUI_API void DebugStartItemPicker();

ImGui::DebugCheckVersionAndDataLayout¶

IMGUI_API bool DebugCheckVersionAndDataLayout(const char* version_str, size_t sz_io, size_t sz_style, size_t sz_vec2, size_t sz_vec4, size_t sz_drawvert, size_t sz_drawidx);

This is called by IMGUI_CHECKVERSION() macro.

Memory Allocators¶

• Those functions are not reliant on the current context.

• DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() for each static/DLL boundary you are calling from. Read “Context and Memory Allocators” section of imgui.cpp for more details. (Optional) Platform/OS interface for multi-viewport support
  Read comments around the ImGuiPlatformIO structure for more details.
  Note: You may use GetWindowViewport() to get the current viewport of the current window.

ImGui::UpdatePlatformWindows¶

IMGUI_API void UpdatePlatformWindows();

call in main loop. will call CreateWindow/ResizeWindow/etc. platform functions for each secondary viewport, and DestroyWindow for each inactive viewport.

ImGui::RenderPlatformWindowsDefault¶

IMGUI_API void RenderPlatformWindowsDefault(void* platform_render_arg = NULL, void* renderer_render_arg = NULL);

call in main loop. will call RenderWindow/SwapBuffers platform functions for each secondary viewport which doesn’t have the ImGuiViewportFlags_Minimized flag set. May be reimplemented by user for custom rendering needs.

ImGui::DestroyPlatformWindows¶

IMGUI_API void DestroyPlatformWindows();

call DestroyWindow platform functions for all viewports. call from backend Shutdown() if you need to close platform windows before imgui shutdown. otherwise will be called by DestroyContext().

ImGui::FindViewportByID¶

IMGUI_API ImGuiViewport* FindViewportByID(ImGuiID viewport_id);

this is a helper for backends.

ImGui::FindViewportByPlatformHandle¶

IMGUI_API ImGuiViewport* FindViewportByPlatformHandle(void* platform_handle);

this is a helper for backends. the type platform_handle is decided by the backend (e.g. HWND, MyWindow*, GLFWwindow* etc.)

Flags & Enumerations¶

WindowFlags_ (enum)¶

Flags for ImGui::Begin() (Those are per-window flags. There are shared flags in ImGuiIO: io.ConfigWindowsResizeFromEdges and io.ConfigWindowsMoveFromTitleBarOnly)

Obsolete names¶

ChildFlags_ (enum)¶

Flags for ImGui::BeginChild() (Legacy: bit 0 must always correspond to ImGuiChildFlags_Borders to be backward compatible with old API using ‘bool border = False’.)
About using AutoResizeX/AutoResizeY flags:

• May be combined with SetNextWindowSizeConstraints() to set a min/max size for each axis (see “Demo->Child->Auto-resize with Constraints”).

• Size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing.

  • This allows BeginChild() to return False when not within boundaries (e.g. when scrolling), which is more optimal. BUT it won’t update its auto-size while clipped.
    While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional “resizing after becoming visible again” glitch.

  • You may also use ImGuiChildFlags_AlwaysAutoResize to force an update even when child window is not in view.
    HOWEVER PLEASE UNDERSTAND THAT DOING SO WILL PREVENT BeginChild() FROM EVER RETURNING FALSE, disabling benefits of coarse clipping.

Obsolete names¶

ItemFlags_ (enum)¶

Flags for ImGui::PushItemFlag() (Those are shared by all submitted items)

InputTextFlags_ (enum)¶

Flags for ImGui::InputText() (Those are per-item flags. There are shared flags in ImGuiIO: io.ConfigInputTextCursorBlink and io.ConfigInputTextEnterKeepActive)

Obsolete names¶

ImGuiInputTextFlags_AlwaysInsertMode  = ImGuiInputTextFlags_AlwaysOverwrite   // [renamed in 1.82] name was not matching behavior

TreeNodeFlags_ (enum)¶

Flags for ImGui::TreeNodeEx(), ImGui::CollapsingHeader*()

PopupFlags_ (enum)¶

Flags for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() functions.

• IMPORTANT: If you ever used the left mouse button with BeginPopupContextXXX() helpers before 1.92.6: Read “API BREAKING CHANGES” 2026/01/07 (1.92.6) entry in imgui.cpp or GitHub topic #9157.

• Multiple buttons currently cannot be combined/or-ed in those functions (we could allow it later).

SelectableFlags_ (enum)¶

Flags for ImGui::Selectable()

ComboFlags_ (enum)¶

Flags for ImGui::BeginCombo()

TabBarFlags_ (enum)¶

Flags for ImGui::BeginTabBar()

TabItemFlags_ (enum)¶

Flags for ImGui::BeginTabItem()

FocusedFlags_ (enum)¶

Flags for ImGui::IsWindowFocused()

HoveredFlags_ (enum)¶

Flags for ImGui::IsItemHovered(), ImGui::IsWindowHovered()
Note: if you are trying to check whether your mouse should be dispatched to Dear ImGui or to your app, you should use ‘io.WantCaptureMouse’ instead! Please read the FAQ!
Note: windows with the ImGuiWindowFlags_NoInputs flag are ignored by IsWindowHovered() calls.

DockNodeFlags_ (enum)¶

Flags for ImGui::DockSpace(), shared/inherited by child nodes. (Some flags can be applied to individual nodes directly)
FIXME-DOCK: Also see ImGuiDockNodeFlagsPrivate_ which may involve using the WIP and internal DockBuilder api.

DragDropFlags_ (enum)¶

Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload()

DataType_ (enum)¶

A primary data type

Dir (enum)¶

A cardinal direction

SortDirection (enum)¶

A sorting direction

Key (enum)¶

A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value): can represent Keyboard, Mouse and Gamepad values.
All our named keys are >= 512. Keys value 0 to 511 are left unused and were legacy native/opaque key values (< 1.87).
Support for legacy keys was completely removed in 1.91.5.
Read details about the 1.87+ transition : ocornut/imgui#4921
Note that “Keys” related to physical keys and are not the same concept as input “Characters”, the latter are submitted via io.AddInputCharacter().
The keyboard key enum values are named after the keys on a standard US keyboard, and on other keyboard types the keys reported may not match the keycaps.

InputFlags_ (enum)¶

Flags for Shortcut(), SetNextItemShortcut(), (and for upcoming extended versions of IsKeyPressed(), IsMouseClicked(), Shortcut(), SetKeyOwner(), SetItemKeyOwner() that are still in imgui_internal.h)
Don’t mistake with ImGuiInputTextFlags! (which is for ImGui::InputText() function)

ConfigFlags_ (enum)¶

Configuration flags stored in io.ConfigFlags. Set by user/application.
Note that nowadays most of our configuration options are in other ImGuiIO fields, e.g. io.ConfigWindowsMoveFromTitleBarOnly.

BackendFlags_ (enum)¶

Backend capabilities flags stored in io.BackendFlags. Set by imgui_impl_xxx or custom backend.

Col_ (enum)¶

Enumeration for PushStyleColor() / PopStyleColor()

StyleVar_ (enum)¶

Enumeration for PushStyleVar() / PopStyleVar() to temporarily modify the ImGuiStyle structure.

• The enum only refers to fields of ImGuiStyle which makes sense to be pushed/popped inside UI code.
  During initialization or between frames, feel free to just poke into ImGuiStyle directly.

• Tip: Use your programming IDE navigation facilities on the names in the second column below to find the actual members and their description.

  • In Visual Studio: Ctrl+Comma (“Edit.GoToAll”) can follow symbols inside comments, whereas Ctrl+F12 (“Edit.GoToImplementation”) cannot.

  • In Visual Studio w/ Visual Assist installed: Alt+G (“VAssistX.GoToImplementation”) can also follow symbols inside comments.

  • In VS Code, CLion, etc.: Ctrl+Click can follow symbols inside comments.

• When changing this enum, you need to update the associated internal table GStyleVarInfo[] accordingly. This is where we link enum values to members offset/type.