imgui.h

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)¶

struct ImVec2

ImVec2::ImVec2¶

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

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

ImVec4 (struct)¶

struct ImVec4

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)¶

struct ImTextureRef

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¶

(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::CreateContext¶

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

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();

See it live: Tools › Style Editor (also used in 24 other sections)

Code from the demo

ImGuiStyle& style = 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);

See it live: Help

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);

See it live: Configuration › Style, Fonts

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);

See it live: Tools › Style Editor

Code from the demo

if (ShowStyleSelector("Colors##Selector"))
    ref_saved_style = style;

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

ImGui::ShowFontSelector¶

IMGUI_API void ShowFontSelector(const char* label);

See it live: Tools › Style Editor

Code from the demo

ShowFontSelector("Fonts##Selector");

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

ImGui::ShowUserGuide¶

IMGUI_API void ShowUserGuide();

See it live: Help

Code from the demo

ImGui::SeparatorText("USER GUIDE:");
ImGui::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);

Python: returns (expanded, p_open): p_open becomes False when the close button is clicked. Without a close button, begin_simple() returns expanded alone.

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);

See it live: Layout › Child windows (also used in 24 other sections)

Code from the demo

static bool disable_mouse_wheel = false;
static bool disable_menu = false;
ImGui::Checkbox("Disable Mouse Wheel", &disable_mouse_wheel);
ImGui::Checkbox("Disable Menu", &disable_menu);

ImGui::EndChild¶

IMGUI_API void EndChild();

See it live: Layout › Child windows (also used in 23 other sections)

Code from the demo

ImGui::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();

See it live: Widgets › Combo (also used in 1 other section)

Code from the demo

if (ImGui::BeginCombo("combo 2 (w/ filter)", combo_preview_value, flags))
{
    static ImGuiTextFilter filter;
    if (ImGui::IsWindowAppearing())
    {
        ImGui::SetKeyboardFocusHere();
        filter.Clear();
    }
    ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_F);
    ImGui::SetNextItemWidth(-FLT_MIN);
    filter.DrawWithHint("##Filter", "Filter (incl -excl)");

    for (int n = 0; n < IM_COUNTOF(items); n++)
    {
...

ImGui::IsWindowCollapsed¶

IMGUI_API bool IsWindowCollapsed();

ImGui::IsWindowFocused¶

IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0);

See it live: Widgets › Querying Window Status (Focused,Hovered etc.) (also used in 1 other section)

Code from the demo

ImGui::BulletText(
    "IsWindowFocused() = %d\n"
    "IsWindowFocused(_ChildWindows) = %d\n"
    "IsWindowFocused(_ChildWindows|_NoPopupHierarchy) = %d\n"
    "IsWindowFocused(_ChildWindows|_DockHierarchy) = %d\n"
    "IsWindowFocused(_ChildWindows|_RootWindow) = %d\n"
    "IsWindowFocused(_ChildWindows|_RootWindow|_NoPopupHierarchy) = %d\n"
    "IsWindowFocused(_ChildWindows|_RootWindow|_DockHierarchy) = %d\n"
    "IsWindowFocused(_RootWindow) = %d\n"
    "IsWindowFocused(_RootWindow|_NoPopupHierarchy) = %d\n"
    "IsWindowFocused(_RootWindow|_DockHierarchy) = %d\n"
    "IsWindowFocused(_AnyWindow) = %d\n",
    ImGui::IsWindowFocused(),
    ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows),
...

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

ImGui::IsWindowHovered¶

IMGUI_API bool IsWindowHovered(ImGuiHoveredFlags flags=0);

See it live: Widgets › Querying Window Status (Focused,Hovered etc.) (also used in 1 other section)

Code from the demo

ImGui::BulletText(
    "IsWindowHovered() = %d\n"
    "IsWindowHovered(_AllowWhenBlockedByPopup) = %d\n"
    "IsWindowHovered(_AllowWhenBlockedByActiveItem) = %d\n"
    "IsWindowHovered(_ChildWindows) = %d\n"
    "IsWindowHovered(_ChildWindows|_NoPopupHierarchy) = %d\n"
    "IsWindowHovered(_ChildWindows|_DockHierarchy) = %d\n"
    "IsWindowHovered(_ChildWindows|_RootWindow) = %d\n"
    "IsWindowHovered(_ChildWindows|_RootWindow|_NoPopupHierarchy) = %d\n"
    "IsWindowHovered(_ChildWindows|_RootWindow|_DockHierarchy) = %d\n"
    "IsWindowHovered(_RootWindow) = %d\n"
    "IsWindowHovered(_RootWindow|_NoPopupHierarchy) = %d\n"
    "IsWindowHovered(_RootWindow|_DockHierarchy) = %d\n"
    "IsWindowHovered(_ChildWindows|_AllowWhenBlockedByPopup) = %d\n"
...

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();

See it live: Examples › Custom rendering › Primitives (also used in 10 other sections)

Code from the demo

ImGui::PushItemWidth(-ImGui::GetFontSize() * 15);
ImGui::PushItemFlag(ImGuiItemFlags_LiveEditOnInput, true);
ImDrawList* draw_list = ImGui::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();

ImGui::SameLine(); HelpMarker("The Background draw list will be rendered below every Dear ImGui windows.");
ImGui::Checkbox("Draw in Foreground draw list", &draw_fg);
ImGui::SameLine(); HelpMarker("The Foreground draw list will be rendered over every Dear ImGui windows.");
ImVec2 window_pos = ImGui::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();

ImGui::Checkbox("Draw in Foreground draw list", &draw_fg);
ImGui::SameLine(); HelpMarker("The Foreground draw list will be rendered over every Dear ImGui windows.");
ImVec2 window_pos = ImGui::GetWindowPos();
ImVec2 window_size = ImGui::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();

See it live: Tools › Style Editor

Code from the demo

PushItemWidth(GetWindowWidth() * 0.50f);

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));

See it live: Popups › Modals (also used in 4 other sections)

Code from the demo

ImVec2 center = ImGui::GetMainViewport()->GetCenter();
ImGui::SetNextWindowPos(center, ImGuiCond_Appearing, ImVec2(0.5f, 0.5f));

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);

See it live: Examples › Console (also used in 1 other section)

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);

See it live: Layout › Child windows (also used in 1 other section)

Code from the demo

ImGui::SetNextWindowSizeConstraints(ImVec2(0.0f, ImGui::GetTextLineHeightWithSpacing() * 1), ImVec2(FLT_MAX, ImGui::GetTextLineHeightWithSpacing() * max_height_in_lines));

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);

See it live: Widgets › Selection State › Multi-Select (with deletion) (also used in 4 other sections)

Code from the demo

const float items_height = ImGui::GetTextLineHeightWithSpacing();
ImGui::SetNextWindowContentSize(ImVec2(0.0f, items.Size * items_height));

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);

See it live: Examples › Constrained Resizing window

Code from the demo

if (ImGui::Button("Set 200x200")) { ImGui::SetWindowSize(ImVec2(200, 200)); } ImGui::SameLine();

(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();

See it live: Layout › Scrolling › Horizontal (also used in 3 other sections)

Code from the demo

float scroll_x = ImGui::GetScrollX();

get scrolling amount [0 .. GetScrollMaxX()]

ImGui::GetScrollY¶

IMGUI_API float GetScrollY();

See it live: Layout › Scrolling › Vertical (also used in 3 other sections)

Code from the demo

float scroll_y = ImGui::GetScrollY();

get scrolling amount [0 .. GetScrollMaxY()]

ImGui::SetScrollX¶

IMGUI_API void SetScrollX(float scroll_x);

See it live: Layout › Scrolling › Horizontal (also used in 1 other section)

Code from the demo

ImGuiWindowFlags child_flags = ImGuiWindowFlags_HorizontalScrollbar | (enable_extra_decorations ? ImGuiWindowFlags_AlwaysVerticalScrollbar : 0);
ImGuiID child_id = ImGui::GetID((void*)(intptr_t)i);
bool child_is_visible = ImGui::BeginChild(child_id, ImVec2(-100, child_height), ImGuiChildFlags_Borders, child_flags);
if (scroll_to_off)
    ImGui::SetScrollX(scroll_to_off_px);

set scrolling amount [0 .. GetScrollMaxX()]

ImGui::SetScrollY¶

IMGUI_API void SetScrollY(float scroll_y);

See it live: Layout › Scrolling › Vertical (also used in 1 other section)

Code from the demo

if (scroll_to_off)
    ImGui::SetScrollY(scroll_to_off_px);

set scrolling amount [0 .. GetScrollMaxY()]

ImGui::GetScrollMaxX¶

IMGUI_API float GetScrollMaxX();

See it live: Layout › Scrolling › Horizontal (also used in 3 other sections)

Code from the demo

float scroll_x = ImGui::GetScrollX();
float scroll_max_x = ImGui::GetScrollMaxX();

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

ImGui::GetScrollMaxY¶

IMGUI_API float GetScrollMaxY();

See it live: Layout › Scrolling › Vertical (also used in 3 other sections)

Code from the demo

float scroll_y = ImGui::GetScrollY();
float scroll_max_y = ImGui::GetScrollMaxY();

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

ImGui::SetScrollHereX¶

IMGUI_API void SetScrollHereX(float center_x_ratio = 0.5f);

See it live: Layout › Scrolling › Horizontal

Code from the demo

if (enable_track && item == track_item)
{
    ImGui::TextColored(ImVec4(1, 1, 0, 1), "Item %d", item);
    ImGui::SetScrollHereX(i * 0.25f); // 0.0f:left, 0.5f:center, 1.0f:right
}

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);

See it live: Layout › Scrolling › Vertical (also used in 1 other section)

Code from the demo

if (enable_track && item == track_item)
{
    ImGui::TextColored(ImVec4(1, 1, 0, 1), "Item %d", item);
    ImGui::SetScrollHereY(i * 0.25f); // 0.0f:top, 0.5f:center, 1.0f:bottom
}

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);

See it live: Layout › Scrolling › Horizontal

Code from the demo

if (scroll_to_pos)
    ImGui::SetScrollFromPosX(ImGui::GetCursorStartPos().x + scroll_to_pos_px, i * 0.25f);

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);

See it live: Layout › Scrolling › Vertical (also used in 1 other section)

Code from the demo

if (scroll_to_pos)
    ImGui::SetScrollFromPosY(ImGui::GetCursorStartPos().y + scroll_to_pos_px, i * 0.25f);

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();

See it live: Widgets › Text › Font Size

Code from the demo

ImGui::Text("ImGui::PushFont(nullptr, custom_size);");
ImGui::PushFont(NULL, custom_size);
ImGui::Text("FontSize = %.2f (== %.2f * global_scale)", ImGui::GetFontSize(), custom_size);
ImGui::PopFont();

ImGui::GetFont¶

IMGUI_API ImFont* GetFont();

See it live: Layout › Text Clipping

Code from the demo

case 2:
    ImVec4 clip_rect(p0.x, p0.y, p1.x, p1.y); // AddText() takes a ImVec4* here so let's convert.
    draw_list->AddRectFilled(p0, p1, IM_COL32(90, 90, 120, 255));

get current font

ImGui::GetFontSize¶

IMGUI_API float GetFontSize();

See it live: Widgets › Text › Font Size (also used in 25 other sections)

Code from the demo

ImGui::Text("style.FontScaleMain = %0.2f", style.FontScaleMain);
ImGui::Text("style.FontScaleDpi = %0.2f", style.FontScaleDpi);
ImGui::Text("global_scale = ~%0.2f", global_scale); // This is not technically accurate as internal scales may apply, but conceptually let's pretend it is.
ImGui::Text("FontSize = %0.2f", ImGui::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);

See it live: Widgets › Basic › Buttons (Colored) (also used in 7 other sections)

Code from the demo

for (int i = 0; i < 7; i++)
{
    if (i > 0)
        ImGui::SameLine();
    ImGui::PushID(i);
    ImGui::PushStyleColor(ImGuiCol_Button, (ImVec4)ImColor::HSV(i / 7.0f, 0.6f, 0.6f));
    ImGui::PushStyleColor(ImGuiCol_ButtonHovered, (ImVec4)ImColor::HSV(i / 7.0f, 0.7f, 0.7f));
    ImGui::PushStyleColor(ImGuiCol_ButtonActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.8f, 0.8f));
    ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 1.0f, 1.0f, 1.0f));
    ImGui::Button("Click");
    ImGui::PopStyleColor(4);
    ImGui::PopID();
}

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

ImGui::PopStyleColor¶

IMGUI_API void PopStyleColor(int count = 1);

See it live: Widgets › Basic › Buttons (Colored) (also used in 7 other sections)

Code from the demo

ImGui::PushStyleColor(ImGuiCol_ButtonActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.8f, 0.8f));
ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 1.0f, 1.0f, 1.0f));
ImGui::Button("Click");
ImGui::PopStyleColor(4);

ImGui::PushStyleVar¶

IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val);

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

See it live: Widgets › Selectables › Alignment (also used in 15 other sections)

Code from the demo

for (int x = 0; x < 3; x++)
{
    ImVec2 alignment = ImVec2((float)x / 2.0f, (float)y / 2.0f);
    char name[32];
    sprintf(name, "(%.1f,%.1f)", alignment.x, alignment.y);
    if (x > 0) ImGui::SameLine();
    ImGui::PushStyleVar(ImGuiStyleVar_SelectableTextAlign, alignment);
    ImGui::Selectable(name, &selected[3 * y + x], ImGuiSelectableFlags_None, ImVec2(size, size));
    ImGui::PopStyleVar();
}

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);

See it live: Widgets › Vertical Sliders

Code from the demo

ImGui::PushStyleVarX(ImGuiStyleVar_ItemSpacing, (float)(int)(style.ItemSpacing.x * 0.5f));

modify X component of a style ImVec2 variable. "

ImGui::PushStyleVarY¶

IMGUI_API void PushStyleVarY(ImGuiStyleVar idx, float val_y);

See it live: Widgets › Selection State › Multi-Select (advanced) (also used in 2 other sections)

Code from the demo

ImVec2 color_button_sz(ImGui::GetFontSize(), ImGui::GetFontSize());
if (widget_type == WidgetType_TreeNode)
    ImGui::PushStyleVarY(ImGuiStyleVar_ItemSpacing, 0.0f);

modify Y component of a style ImVec2 variable. "

ImGui::PopStyleVar¶

IMGUI_API void PopStyleVar(int count = 1);

See it live: Widgets › Selectables › Alignment (also used in 18 other sections)

Code from the demo

if (x > 0) ImGui::SameLine();
ImGui::PushStyleVar(ImGuiStyleVar_SelectableTextAlign, alignment);
ImGui::Selectable(name, &selected[3 * y + x], ImGuiSelectableFlags_None, ImVec2(size, size));
ImGui::PopStyleVar();

ImGui::PushItemFlag¶

IMGUI_API void PushItemFlag(ImGuiItemFlags option, bool enabled);

See it live: Widgets › Basic › Buttons (Repeating) (also used in 7 other sections)

Code from the demo

static int counter = 0;
float spacing = ImGui::GetStyle().ItemInnerSpacing.x;
ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true);

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

ImGui::PopItemFlag¶

IMGUI_API void PopItemFlag();

See it live: Widgets › Basic › Buttons (Repeating) (also used in 7 other sections)

Code from the demo

ImGui::PopItemFlag();

Parameters stacks (current window)¶

ImGui::PushItemWidth¶

IMGUI_API void PushItemWidth(float item_width);

See it live: Tables › Item width (also used in 10 other sections)

Code from the demo

ImGui::TableNextRow();
if (row == 0)
{
    // Setup ItemWidth once (instead of setting up every time, which is also possible but less efficient)
    ImGui::TableSetColumnIndex(0);
    ImGui::PushItemWidth(TEXT_BASE_WIDTH * 3.0f); // Small
    ImGui::TableSetColumnIndex(1);
    ImGui::PushItemWidth(-ImGui::GetContentRegionAvail().x * 0.5f);
    ImGui::TableSetColumnIndex(2);
    ImGui::PushItemWidth(-FLT_MIN); // Right-aligned
}

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();

See it live: Layout › Widgets Width (also used in 10 other sections)

Code from the demo

ImGui::PopItemWidth();

ImGui::SetNextItemWidth¶

IMGUI_API void SetNextItemWidth(float item_width);

See it live: Widgets › Color › ColorPicker (also used in 19 other sections)

Code from the demo

ImGui::Text("Both types:");
float w = (ImGui::GetContentRegionAvail().x - ImGui::GetStyle().ItemSpacing.y) * 0.40f;
ImGui::SetNextItemWidth(w);

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();

See it live: Examples › Custom rendering › Primitives

Code from the demo

ImGui::Text("Gradients");
ImVec2 gradient_size = ImVec2(ImGui::CalcItemWidth(), ImGui::GetFrameHeight());

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);

See it live: Widgets › Text › Word Wrapping

Code from the demo

ImDrawList* draw_list = ImGui::GetWindowDrawList();
for (int n = 0; n < 2; n++)
{
    ImGui::Text("Test paragraph %d:", n);
    ImVec2 pos = ImGui::GetCursorScreenPos();
    ImVec2 marker_min = ImVec2(pos.x + wrap_width, pos.y);
    ImVec2 marker_max = ImVec2(pos.x + wrap_width + 10, pos.y + ImGui::GetTextLineHeight());
    ImGui::PushTextWrapPos(ImGui::GetCursorPos().x + wrap_width);
    if (n == 0)
        ImGui::Text("The lazy dog is a good dog. This paragraph should fit within %.0f pixels. Testing a 1 character word. The quick brown fox jumps over the lazy dog.", wrap_width);
    else
        ImGui::Text("aaaaaaaa bbbbbbbb, c cccccccc,dddddddd. d eeeeeeee   ffffffff. gggggggg!hhhhhhhh");

    // Draw actual text bounding box, following by marker of our expected limit (should not overlap!)
...

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();

See it live: Widgets › Text › Word Wrapping

Code from the demo

draw_list->AddRect(ImGui::GetItemRectMin(), ImGui::GetItemRectMax(), IM_COL32(255, 255, 0, 255));
draw_list->AddRectFilled(marker_min, marker_max, IM_COL32(255, 0, 255, 255));
ImGui::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);

See it live: Tables › Background color (also used in 6 other sections)

Code from the demo

if (row_bg_type != 0)
{
    ImU32 row_bg_color = ImGui::GetColorU32(row_bg_type == 1 ? ImVec4(0.7f, 0.3f, 0.3f, 0.65f) : ImVec4(0.2f + row * 0.1f, 0.2f, 0.2f, 0.65f)); // Flat or Gradient?
    ImGui::TableSetBgColor(ImGuiTableBgTarget_RowBg0 + row_bg_target, row_bg_color);
}

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();

See it live: Widgets › Text › Word Wrapping (also used in 10 other sections)

Code from the demo

ImDrawList* draw_list = ImGui::GetWindowDrawList();
for (int n = 0; n < 2; n++)
{
    ImGui::Text("Test paragraph %d:", n);
    ImVec2 pos = ImGui::GetCursorScreenPos();
    ImVec2 marker_min = ImVec2(pos.x + wrap_width, pos.y);
    ImVec2 marker_max = ImVec2(pos.x + wrap_width + 10, pos.y + ImGui::GetTextLineHeight());
    ImGui::PushTextWrapPos(ImGui::GetCursorPos().x + wrap_width);
    if (n == 0)
        ImGui::Text("The lazy dog is a good dog. This paragraph should fit within %.0f pixels. Testing a 1 character word. The quick brown fox jumps over the lazy dog.", wrap_width);
    else
        ImGui::Text("aaaaaaaa bbbbbbbb, c cccccccc,dddddddd. d eeeeeeee   ffffffff. gggggggg!hhhhhhhh");

    // Draw actual text bounding box, following by marker of our expected limit (should not overlap!)
...

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);

See it live: Layout › Overlap Mode (also used in 2 other sections)

Code from the demo

ImGui::Button("Button 1", ImVec2(80, 80));
ImGui::SetCursorScreenPos(button2_pos);

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

ImGui::GetContentRegionAvail¶

IMGUI_API ImVec2 GetContentRegionAvail();

See it live: Layout › Widgets Width (also used in 15 other sections)

Code from the demo

ImGui::Text("SetNextItemWidth/PushItemWidth(GetContentRegionAvail().x * 0.5f)");
ImGui::SameLine(); HelpMarker("Half of available width.\n(~ right-cursor_pos)\n(works within a column set)");
ImGui::PushItemWidth(ImGui::GetContentRegionAvail().x * 0.5f);

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

ImGui::GetCursorPos¶

IMGUI_API ImVec2 GetCursorPos();

See it live: Widgets › Text › Word Wrapping

Code from the demo

ImDrawList* draw_list = ImGui::GetWindowDrawList();
for (int n = 0; n < 2; n++)
{
    ImGui::Text("Test paragraph %d:", n);
    ImVec2 pos = ImGui::GetCursorScreenPos();
    ImVec2 marker_min = ImVec2(pos.x + wrap_width, pos.y);
    ImVec2 marker_max = ImVec2(pos.x + wrap_width + 10, pos.y + ImGui::GetTextLineHeight());
    ImGui::PushTextWrapPos(ImGui::GetCursorPos().x + wrap_width);
    if (n == 0)
        ImGui::Text("The lazy dog is a good dog. This paragraph should fit within %.0f pixels. Testing a 1 character word. The quick brown fox jumps over the lazy dog.", wrap_width);
    else
        ImGui::Text("aaaaaaaa bbbbbbbb, c cccccccc,dddddddd. d eeeeeeee   ffffffff. gggggggg!hhhhhhhh");

    // Draw actual text bounding box, following by marker of our expected limit (should not overlap!)
...

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

ImGui::GetCursorPosX¶

IMGUI_API float GetCursorPosX();

See it live: Layout › Child windows

Code from the demo

ImGui::SetCursorPosX(ImGui::GetCursorPosX() + (float)offset_x);

[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);

See it live: Layout › Child windows

Code from the demo

ImGui::SetCursorPosX(ImGui::GetCursorPosX() + (float)offset_x);

[window-local] "

ImGui::SetCursorPosY¶

IMGUI_API void SetCursorPosY(float local_y);

[window-local] "

ImGui::GetCursorStartPos¶

IMGUI_API ImVec2 GetCursorStartPos();

See it live: Layout › Scrolling › Vertical (also used in 1 other section)

Code from the demo

if (scroll_to_pos)
    ImGui::SetScrollFromPosY(ImGui::GetCursorStartPos().y + scroll_to_pos_px, i * 0.25f);

[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);

See it live: Layout › Basic Horizontal Layout › SameLine (also used in 98 other sections)

Code from the demo

ImGui::Text("Two items: Hello"); ImGui::SameLine();

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

ImGui::NewLine¶

IMGUI_API void NewLine();

See it live: Widgets › Images › Textured buttons

Code from the demo

ImGui::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);

See it live: Layout › Basic Horizontal Layout › Dummy (also used in 6 other sections)

Code from the demo

ImVec2 button_sz(40, 40);
ImGui::Button("A", button_sz); ImGui::SameLine();
ImGui::Dummy(button_sz); ImGui::SameLine();

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);

See it live: Layout › Widgets Width (also used in 8 other sections)

Code from the demo

ImGui::SameLine(); HelpMarker("Fixed width.");
ImGui::PushItemWidth(100);
ImGui::DragFloat("float##1b", &f);
if (show_indented_items)
{
    ImGui::Indent();
    ImGui::DragFloat("float (indented)##1b", &f);
    ImGui::Unindent();
}

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);

See it live: Layout › Widgets Width (also used in 8 other sections)

Code from the demo

ImGui::SameLine(); HelpMarker("Fixed width.");
ImGui::PushItemWidth(100);
ImGui::DragFloat("float##1b", &f);
if (show_indented_items)
{
    ImGui::Indent();
    ImGui::DragFloat("float (indented)##1b", &f);
    ImGui::Unindent();
}

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

ImGui::BeginGroup¶

IMGUI_API void BeginGroup();

See it live: Layout › Groups (also used in 6 other sections)

Code from the demo

ImGui::BeginGroup();

lock horizontal starting position

ImGui::EndGroup¶

IMGUI_API void EndGroup();

See it live: Layout › Groups (also used in 6 other sections)

Code from the demo

ImGui::BeginGroup();
ImGui::Button("CCC");
ImGui::Button("DDD");
ImGui::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();

See it live: Layout › Text Baseline Alignment (also used in 9 other sections)

Code from the demo

ImGui::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();

See it live: Widgets › Text Input › Multi-line Text Input (also used in 5 other sections)

Code from the demo

ImGui::CheckboxFlags("ImGuiInputTextFlags_AllowTabInput", &flags, ImGuiInputTextFlags_AllowTabInput);
ImGui::SameLine(); HelpMarker("When _AllowTabInput is set, passing through the widget with Tabbing doesn't automatically activate it, in order to also cycling through subsequent widgets.");
ImGui::CheckboxFlags("ImGuiInputTextFlags_CtrlEnterForNewLine", &flags, ImGuiInputTextFlags_CtrlEnterForNewLine);
ImGui::InputTextMultiline("##source", text, IM_COUNTOF(text), ImVec2(-FLT_MIN, ImGui::GetTextLineHeight() * 16), flags);

~ FontSize

ImGui::GetTextLineHeightWithSpacing¶

IMGUI_API float GetTextLineHeightWithSpacing();

See it live: Widgets › List Boxes (also used in 11 other sections)

Code from the demo

ImGui::Text("Full-width:");
if (ImGui::BeginListBox("##listbox 2", ImVec2(-FLT_MIN, 5 * ImGui::GetTextLineHeightWithSpacing())))
{
    for (int n = 0; n < IM_COUNTOF(items); n++)
    {
        bool is_selected = (item_selected_idx == n);
        ImGuiSelectableFlags flags = (item_highlighted_idx == n) ? ImGuiSelectableFlags_Highlight : 0;
        if (ImGui::Selectable(items[n], is_selected, flags))
            item_selected_idx = n;

        // Set the initial focus when opening the combo (scrolling + keyboard navigation focus)
        if (is_selected)
            ImGui::SetItemDefaultFocus();
    }
...

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

ImGui::GetFrameHeight¶

IMGUI_API float GetFrameHeight();

See it live: Widgets › Vertical Sliders (also used in 8 other sections)

Code from the demo

ImGuiStyle& style = ImGui::GetStyle();
ImVec2 slider_sz(ImGui::GetFrameHeight(), ImGui::GetFrameHeight() * 9);

~ FontSize + style.FramePadding.y * 2

ImGui::GetFrameHeightWithSpacing¶

IMGUI_API float GetFrameHeightWithSpacing();

See it live: Layout › Scrolling › Horizontal (more) (also used in 2 other sections)

Code from the demo

ImGui::SliderInt("Lines", &lines, 1, 15);
ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding, 3.0f);
ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(2.0f, 1.0f));
ImVec2 scrolling_child_size = ImVec2(0, ImGui::GetFrameHeightWithSpacing() * 7 + 30);

~ 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 void* ptr_id);

IMGUI_API void PushID(int int_id);

See it live: Widgets › Basic › Buttons (Colored) (also used in 33 other sections)

Code from the demo

for (int i = 0; i < 7; i++)
{
    if (i > 0)
        ImGui::SameLine();
    ImGui::PushID(i);
    ImGui::PushStyleColor(ImGuiCol_Button, (ImVec4)ImColor::HSV(i / 7.0f, 0.6f, 0.6f));
    ImGui::PushStyleColor(ImGuiCol_ButtonHovered, (ImVec4)ImColor::HSV(i / 7.0f, 0.7f, 0.7f));
    ImGui::PushStyleColor(ImGuiCol_ButtonActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.8f, 0.8f));
    ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 1.0f, 1.0f, 1.0f));
    ImGui::Button("Click");
    ImGui::PopStyleColor(4);
    ImGui::PopID();
}

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

ImGui::PopID¶

IMGUI_API void PopID();

See it live: Widgets › Basic › Buttons (Colored) (also used in 33 other sections)

Code from the demo

ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 1.0f, 1.0f, 1.0f));
ImGui::Button("Click");
ImGui::PopStyleColor(4);
ImGui::PopID();

pop from the ID stack.

ImGui::GetID¶

IMGUI_API ImGuiID GetID(const char* str_id);

IMGUI_API ImGuiID GetID(const void* ptr_id);

IMGUI_API ImGuiID GetID(int int_id);

See it live: Layout › Scrolling › Vertical (also used in 4 other sections)

Code from the demo

const ImGuiWindowFlags child_flags = enable_extra_decorations ? ImGuiWindowFlags_MenuBar : 0;
const ImGuiID child_id = ImGui::GetID((void*)(intptr_t)i);

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);

See it live: Widgets › Text Filter (also used in 14 other sections)

Code from the demo

if (filter.PassFilter(item))
    ImGui::TextUnformatted(item);

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, ...) ;

See it live: Widgets › Text › Font Size (also used in 113 other sections)

Code from the demo

ImGuiStyle& style = ImGui::GetStyle();
const float global_scale = style.FontScaleMain * style.FontScaleDpi;
ImGui::Text("style.FontScaleMain = %0.2f", style.FontScaleMain);

formatted text

ImGui::TextColored¶

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

See it live: Widgets › Text › Colored Text (also used in 3 other sections)

Code from the demo

ImGui::TextColored(ImVec4(1.0f, 0.0f, 1.0f, 1.0f), "Pink");

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

ImGui::TextDisabled¶

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

See it live: Widgets › Text › Colored Text (also used in 2 other sections)

Code from the demo

ImGui::TextColored(ImVec4(1.0f, 0.0f, 1.0f, 1.0f), "Pink");
ImGui::TextColored(ImVec4(1.0f, 1.0f, 0.0f, 1.0f), "Yellow");
ImGui::TextDisabled("Disabled");

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

ImGui::TextWrapped¶

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

See it live: Widgets › Text › Word Wrapping (also used in 17 other sections)

Code from the demo

ImGui::TextWrapped(
    "This text should automatically wrap on the edge of the window. The current implementation "
    "for text wrapping follows simple rules suitable for English and possibly other languages.");

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, ...) ;

See it live: Widgets › Basic › Buttons (Repeating)

Code from the demo

ImGui::LabelText("label", "Value");

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

ImGui::BulletText¶

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

See it live: Widgets › Bullets (also used in 12 other sections)

Code from the demo

ImGui::BulletText("Bullet point 1");

shortcut for Bullet()+Text()

ImGui::SeparatorText¶

IMGUI_API void SeparatorText(const char* label);

See it live: Widgets › Basic (also used in 27 other sections)

Code from the demo

ImGui::SeparatorText("General");

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));

See it live: Widgets › Basic › Button (also used in 42 other sections)

Code from the demo

static int clicked = 0;
if (ImGui::Button("Button"))
    clicked++;

button

ImGui::SmallButton¶

IMGUI_API bool SmallButton(const char* label);

See it live: Widgets › Bullets (also used in 15 other sections)

Code from the demo

ImGui::Bullet(); ImGui::Text("Bullet point 3 (two calls)");
ImGui::Bullet(); ImGui::SmallButton("Button");

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);

See it live: Layout › Text Clipping (also used in 2 other sections)

Code from the demo

for (int n = 0; n < 3; n++)
{
    if (n > 0)
        ImGui::SameLine();

    ImGui::PushID(n);
    ImGui::InvisibleButton("##canvas", size);
    if (ImGui::IsItemActive() && ImGui::IsMouseDragging(ImGuiMouseButton_Left))
    {
        offset.x += ImGui::GetIO().MouseDelta.x;
        offset.y += ImGui::GetIO().MouseDelta.y;
    }
    ImGui::PopID();
    if (!ImGui::IsItemVisible()) // Skip rendering as ImDrawList elements are not clipped.
...

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);

See it live: Widgets › Basic › Buttons (Repeating)

Code from the demo

static int counter = 0;
float spacing = ImGui::GetStyle().ItemInnerSpacing.x;
ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true);
if (ImGui::ArrowButton("##left", ImGuiDir_Left)) { counter--; }

square button with an arrow shape

ImGui::Checkbox¶

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

See it live: Widgets › Basic › Checkbox (also used in 49 other sections)

Code from the demo

static bool check = true;
ImGui::Checkbox("checkbox", &check);

ImGui::CheckboxFlags¶

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

See it live: Widgets › Color (also used in 42 other sections)

Code from the demo

ImGui::SeparatorText("Options");
ImGui::CheckboxFlags("ImGuiColorEditFlags_NoAlpha", &base_flags, ImGuiColorEditFlags_NoAlpha);

ImGui::RadioButton¶

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

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

See it live: Widgets › Basic › RadioButton (also used in 8 other sections)

Code from the demo

static int e = 0;
ImGui::RadioButton("radio a", &e, 0); ImGui::SameLine();

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);

See it live: Widgets › Progress Bars (also used in 1 other section)

Code from the demo

ImGui::ProgressBar(progress, ImVec2(0.0f, 0.0f));

ImGui::Bullet¶

IMGUI_API void Bullet();

See it live: Widgets › Bullets (also used in 1 other section)

Code from the demo

ImGui::Bullet(); ImGui::Text("Bullet point 3 (two calls)");

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);

See it live: Widgets › Basic › RadioButton (also used in 6 other sections)

Code from the demo

ImGui::AlignTextToFramePadding();
ImGui::TextLinkOpenURL("Hyperlink", "https://github.com/ocornut/imgui/wiki/Error-Handling");

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));

See it live: Widgets › Images

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));

See it live: Widgets › Images

Code from the demo

ImVec2 uv_min = ImVec2(0.0f, 0.0f); // Top-left
ImVec2 uv_max = ImVec2(1.0f, 1.0f); // Lower-right
ImGui::PushStyleVar(ImGuiStyleVar_ImageBorderSize, IM_MAX(1.0f, ImGui::GetStyle().ImageBorderSize));
ImGui::ImageWithBg(my_tex_id, ImVec2(my_tex_w, my_tex_h), uv_min, uv_max, ImVec4(0.0f, 0.0f, 0.0f, 1.0f));

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));

See it live: Widgets › Images › Textured buttons

Code from the demo

ImVec2 uv1 = ImVec2(32.0f / my_tex_w, 32.0f / my_tex_h);    // UV coordinates for (32,32) in our texture
ImVec4 bg_col = ImVec4(0.0f, 0.0f, 0.0f, 1.0f);             // Black background
ImVec4 tint_col = ImVec4(1.0f, 1.0f, 1.0f, 1.0f);           // No tint
if (ImGui::ImageButton("", my_tex_id, size, uv0, uv1, bg_col, tint_col))
    pressed_count += 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);

See it live: Widgets › Combo (also used in 1 other section)

Code from the demo

const char* combo_preview_value = items[item_selected_idx];
if (ImGui::BeginCombo("combo 1", combo_preview_value, flags))
{
    for (int n = 0; n < IM_COUNTOF(items); n++)
    {
        const bool is_selected = (item_selected_idx == n);
        if (ImGui::Selectable(items[n], is_selected))
            item_selected_idx = n;

        // Set the initial focus when opening the combo (scrolling + keyboard navigation focus)
        if (is_selected)
            ImGui::SetItemDefaultFocus();
    }
    ImGui::EndCombo();
...

ImGui::EndCombo¶

IMGUI_API void EndCombo();

See it live: Widgets › Combo (also used in 1 other section)

Code from the demo

ImGui::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);

See it live: Widgets › Basic › Combo (also used in 15 other sections)

Code from the demo

const char* items[] = { "AAAA", "BBBB", "CCCC", "DDDD", "EEEE", "FFFF", "GGGG", "HHHH", "IIIIIII", "JJJJ", "KKKKKKK" };
static int item_current = 0;
ImGui::Combo("combo", &item_current, items, IM_COUNTOF(items));

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);

See it live: Widgets › Basic › DragInt, DragFloat (also used in 11 other sections)

Code from the demo

static float f1 = 1.00f, f2 = 0.0067f;
ImGui::DragFloat("drag float", &f1, 0.005f);

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);

See it live: Widgets › Multi-component Widgets (also used in 2 other sections)

Code from the demo

ImGui::SeparatorText("2-wide");
ImGui::InputFloat2("input float2", vec4f);
ImGui::InputInt2("input int2", vec4i);
ImGui::DragFloat2("drag float2", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::SeparatorText("3-wide");
ImGui::InputFloat3("input float3", vec4f);
ImGui::InputInt3("input int3", vec4i);
ImGui::DragFloat3("drag float3", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets (also used in 2 other sections)

Code from the demo

ImGui::SeparatorText("4-wide");
ImGui::InputFloat4("input float4", vec4f);
ImGui::InputInt4("input int4", vec4i);
ImGui::DragFloat4("drag float4", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::SeparatorText("Ranges");
static float begin = 10, end = 90;
static int begin_i = 100, end_i = 1000;
ImGui::DragFloatRange2("range float", &begin, &end, 0.25f, 0.0f, 100.0f, "Min: %.1f %%", "Max: %.1f %%", ImGuiSliderFlags_AlwaysClamp);

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);

See it live: Widgets › Basic › DragInt, DragFloat (also used in 8 other sections)

Code from the demo

static int i1 = 50, i2 = 42, i3 = 128;
ImGui::DragInt("drag int", &i1, 1);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::InputFloat2("input float2", vec4f);
ImGui::InputInt2("input int2", vec4i);
ImGui::DragFloat2("drag float2", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt2("drag int2", vec4i, 1, 0, 255, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::InputFloat3("input float3", vec4f);
ImGui::InputInt3("input int3", vec4i);
ImGui::DragFloat3("drag float3", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt3("drag int3", vec4i, 1, 0, 255, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::InputFloat4("input float4", vec4f);
ImGui::InputInt4("input int4", vec4i);
ImGui::DragFloat4("drag float4", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt4("drag int4", vec4i, 1, 0, 255, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

static float begin = 10, end = 90;
static int begin_i = 100, end_i = 1000;
ImGui::DragFloatRange2("range float", &begin, &end, 0.25f, 0.0f, 100.0f, "Min: %.1f %%", "Max: %.1f %%", ImGuiSliderFlags_AlwaysClamp);
ImGui::DragIntRange2("range int", &begin_i, &end_i, 5, 0, 1000, "Min: %d units", "Max: %d units");

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);

See it live: Widgets › Data Types › Drags

Code from the demo

ImGui::DragScalar("drag s8",        ImGuiDataType_S8,     &s8_v,  drag_speed, drag_clamp ? &s8_zero  : NULL, drag_clamp ? &s8_fifty  : NULL);

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);

See it live: Examples › Property editor

Code from the demo

case ImGuiDataType_S32:
{
    int v_min = INT_MIN, v_max = INT_MAX;
    ImGui::SetNextItemWidth(-FLT_MIN);
    ImGui::DragScalarN("##Editor", field_desc.DataType, field_ptr, field_desc.DataCount, 1.0f, &v_min, &v_max);
    break;
}

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);

See it live: Widgets › Basic › SliderInt, SliderFloat (also used in 12 other sections)

Code from the demo

static float f1 = 0.123f, f2 = 0.0f;
ImGui::SliderFloat("slider float", &f1, 0.0f, 1.0f, "ratio = %.3f");

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);

See it live: Widgets › Multi-component Widgets (also used in 1 other section)

Code from the demo

ImGui::InputInt3("input int3", vec4i);
ImGui::DragFloat3("drag float3", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt3("drag int3", vec4i, 1, 0, 255, NULL, flags);
ImGui::SliderFloat3("slider float3", vec4f, 0.0f, 1.0f, NULL, flags);

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);

See it live: Widgets › Basic › SliderAngle (also used in 2 other sections)

Code from the demo

static float angle = 0.0f;
ImGui::SliderAngle("slider angle", &angle);

ImGui::SliderInt¶

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

See it live: Widgets › Basic › SliderInt, SliderFloat (also used in 9 other sections)

Code from the demo

static int i1 = 0;
ImGui::SliderInt("slider int", &i1, -1, 3);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::DragFloat2("drag float2", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt2("drag int2", vec4i, 1, 0, 255, NULL, flags);
ImGui::SliderFloat2("slider float2", vec4f, 0.0f, 1.0f, NULL, flags);
ImGui::SliderInt2("slider int2", vec4i, 0, 255, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::DragFloat3("drag float3", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt3("drag int3", vec4i, 1, 0, 255, NULL, flags);
ImGui::SliderFloat3("slider float3", vec4f, 0.0f, 1.0f, NULL, flags);
ImGui::SliderInt3("slider int3", vec4i, 0, 255, NULL, flags);

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);

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::DragFloat4("drag float4", vec4f, 0.01f, 0.0f, 1.0f, NULL, flags);
ImGui::DragInt4("drag int4", vec4i, 1, 0, 255, NULL, flags);
ImGui::SliderFloat4("slider float4", vec4f, 0.0f, 1.0f, NULL, flags);
ImGui::SliderInt4("slider int4", vec4i, 0, 255, NULL, flags);

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);

See it live: Widgets › Data Types › Sliders

Code from the demo

ImGui::SeparatorText("Sliders");
ImGui::SliderScalar("slider s8 full",       ImGuiDataType_S8,     &s8_v,  &s8_min,   &s8_max,   "%d");

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);

See it live: Examples › Property editor

Code from the demo

case ImGuiDataType_Float:
{
    float v_min = 0.0f, v_max = 1.0f;
    ImGui::SetNextItemWidth(-FLT_MIN);
    ImGui::SliderScalarN("##Editor", field_desc.DataType, field_ptr, field_desc.DataCount, &v_min, &v_max);
    break;
}

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);

See it live: Widgets › Vertical Sliders

Code from the demo

ImGui::PushStyleColor(ImGuiCol_FrameBgActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.7f, 0.5f));
ImGui::PushStyleColor(ImGuiCol_SliderGrab, (ImVec4)ImColor::HSV(i / 7.0f, 0.8f, 0.7f));
ImGui::PushStyleColor(ImGuiCol_SliderGrabActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.9f, 0.9f));
ImGui::VSliderFloat("##v", slider_sz, &values[i], 0.0f, 1.0f, "");

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);

See it live: Widgets › Vertical Sliders

Code from the demo

static int int_value = 0;
ImGui::VSliderInt("##int", slider_sz, &int_value, 0, 5);

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);

See it live: Widgets › Basic › InputInt, InputFloat (also used in 4 other sections)

Code from the demo

static float f0 = 0.001f;
ImGui::InputFloat("input float", &f0, 0.01f, 1.0f, "%.3f");

ImGui::InputFloat3¶

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

See it live: Widgets › Multi-component Widgets (also used in 2 other sections)

Code from the demo

ImGui::SeparatorText("3-wide");
ImGui::InputFloat3("input float3", vec4f);

ImGui::InputInt¶

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

See it live: Widgets › Basic › InputInt, InputFloat (also used in 1 other section)

Code from the demo

static int i0 = 123;
ImGui::InputInt("input int", &i0);

ImGui::InputInt2¶

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

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::SeparatorText("2-wide");
ImGui::InputFloat2("input float2", vec4f);
ImGui::InputInt2("input int2", vec4i);

ImGui::InputInt3¶

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

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::SeparatorText("3-wide");
ImGui::InputFloat3("input float3", vec4f);
ImGui::InputInt3("input int3", vec4i);

ImGui::InputInt4¶

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

See it live: Widgets › Multi-component Widgets

Code from the demo

ImGui::SeparatorText("4-wide");
ImGui::InputFloat4("input float4", vec4f);
ImGui::InputInt4("input int4", vec4i);

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);

See it live: Widgets › Basic › InputInt, InputFloat

Code from the demo

static double d0 = 999999.00000001;
ImGui::InputDouble("input double", &d0, 0.01f, 1.0f, "%.8f");

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);

See it live: Widgets › Data Types › Inputs

Code from the demo

ImGui::CheckboxFlags("ImGuiInputTextFlags_ReadOnly", &flags, ImGuiInputTextFlags_ReadOnly);
ImGui::CheckboxFlags("ImGuiInputTextFlags_ParseEmptyRefVal", &flags, ImGuiInputTextFlags_ParseEmptyRefVal);
ImGui::CheckboxFlags("ImGuiInputTextFlags_DisplayEmptyRefVal", &flags, ImGuiInputTextFlags_DisplayEmptyRefVal);
ImGui::InputScalar("input s8",      ImGuiDataType_S8,     &s8_v,  inputs_step ? &s8_one  : NULL, NULL, "%d", flags);

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);

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

ImGui::ColorButton¶

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

See it live: Widgets › Color › ColorButton (with custom Picker popup) (also used in 8 other sections)

Code from the demo

static ImVec4 backup_color;
bool open_popup = ImGui::ColorButton("MyColor##3b", color, base_flags);

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

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, ...) ;

See it live: Widgets › Tree Nodes (also used in 92 other sections)

Code from the demo

if (ImGui::TreeNode("Basic Trees"))
{
    for (int i = 0; i < 5; i++)
    {
        // Use SetNextItemOpen() so set the default state of a node to be open. We could
        // also use TreeNodeEx() with the ImGuiTreeNodeFlags_DefaultOpen flag to achieve the same thing!
        if (i == 0)
            ImGui::SetNextItemOpen(true, ImGuiCond_Once);

        // Here we use PushID() to generate a unique base ID, and then the "" used as TreeNode id won't conflict.
        // An alternative to using 'PushID() + TreeNode("", ...)' to generate a unique ID is to use 'TreeNode((void*)(intptr_t)i, ...)',
        // aka generate a dummy pointer-sized value to be hashed. The demo below uses that technique. Both are fine.
        ImGui::PushID(i);
        if (ImGui::TreeNode("", "Child %d", i))
...

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, ...) ;

See it live: Widgets › Tree Nodes › Advanced (also used in 10 other sections)

Code from the demo

ImGuiTreeNodeFlags node_flags = base_flags;
if (node_n < 3)
{
    // Items 0..2 are Tree Node
    bool is_open = ImGui::TreeNodeEx((void*)(intptr_t)node_n, node_flags, "Selectable Node %d", node_n);
    if (use_drag_and_drop && ImGui::BeginDragDropSource())
    {
        ImGui::SetDragDropPayload("MY_TREENODE_PAYLOAD_TYPE", NULL, 0);
        ImGui::Text("This is a drag and drop source");
        ImGui::EndDragDropSource();
    }
    if (node_n == 2 && (base_flags & ImGuiTreeNodeFlags_SpanLabelWidth))
    {
        // Item 2 has an additional inline button to help demonstrate SpanLabelWidth.
...

ImGui::TreePush¶

IMGUI_API void TreePush(const char* str_id);

IMGUI_API void TreePush(const void* ptr_id);

See it live: Examples › Property editor

Code from the demo

is_open = (node->Childs.Size > 0 && ImGui::TreeNodeGetOpen((ImGuiID)node->UID));
if (is_open)
    ImGui::TreePush(node->Name);

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

ImGui::TreePop¶

IMGUI_API void TreePop();

See it live: Widgets › Selection State › Multi-Select (trees) (also used in 115 other sections)

Code from the demo

ImGui::SetNextItemSelectionUserData((ImGuiSelectionUserData)(intptr_t)node);
ImGui::SetNextItemStorageID((ImGuiID)node->UID);
if (ImGui::TreeNodeEx(node->Name, tree_node_flags))
{
    for (ExampleTreeNode* child : node->Childs)
        DrawNode(child, selection);
    ImGui::TreePop();
}

~ Unindent()+PopID()

ImGui::GetTreeNodeToLabelSpacing¶

IMGUI_API float GetTreeNodeToLabelSpacing();

See it live: Widgets › Tree Nodes › Advanced

Code from the demo

ImGui::Checkbox("Align label with current X position", &align_label_with_current_x_position);
ImGui::Checkbox("Make Tree Nodes as drag & drop sources", &use_drag_and_drop);
if (align_label_with_current_x_position)
    ImGui::Unindent(ImGui::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);

See it live: Widgets › Collapsing Headers (also used in 5 other sections)

Code from the demo

static bool closable_group = true;
ImGui::Checkbox("Show 2nd header", &closable_group);
if (ImGui::CollapsingHeader("Header", ImGuiTreeNodeFlags_None))
{
    ImGui::Text("IsItemHovered: %d", ImGui::IsItemHovered());
    for (int i = 0; i < 5; i++)
        ImGui::Text("Some content %d", i);
}

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);

See it live: Widgets › Tree Nodes › Basic Trees (also used in 24 other sections)

Code from the demo

if (i == 0)
    ImGui::SetNextItemOpen(true, ImGuiCond_Once);

set next TreeNode/CollapsingHeader open state.

ImGui::SetNextItemStorageID¶

IMGUI_API void SetNextItemStorageID(ImGuiID storage_id);

See it live: Widgets › Selection State › Multi-Select (trees) (also used in 1 other section)

Code from the demo

ImGui::SetNextItemSelectionUserData((ImGuiSelectionUserData)(intptr_t)node);
ImGui::SetNextItemStorageID((ImGuiID)node->UID);

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

ImGui::TreeNodeGetOpen¶

IMGUI_API bool TreeNodeGetOpen(ImGuiID storage_id);

See it live: Widgets › Selection State › Multi-Select (trees) (also used in 1 other section)

Code from the demo

static int TreeCloseAndUnselectChildNodes(ExampleTreeNode* node, ImGuiSelectionBasicStorage* selection, int depth = 0)
{
    // Recursive close (the test for depth == 0 is because we call this on a node that was just closed!)
    int unselected_count = selection->Contains((ImGuiID)node->UID) ? 1 : 0;
    if (depth == 0 || ImGui::TreeNodeGetOpen((ImGuiID)node->UID))
    {
        for (ExampleTreeNode* child : node->Childs)
            unselected_count += TreeCloseAndUnselectChildNodes(child, selection, depth + 1);
        ImGui::TreeNodeSetOpen((ImGuiID)node->UID, false);
    }

    // Select root node if any of its child was selected, otherwise unselect
    selection->SetItemSelected((ImGuiID)node->UID, (depth == 0 && unselected_count > 0));
    return unselected_count;
...

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));

See it live: Widgets › Selectables › Multiple items on the same line (also used in 30 other sections)

Code from the demo

static bool selected[3] = {};
ImGui::SetNextItemAllowOverlap(); ImGui::Selectable("main.c", &selected[0]); ImGui::SameLine(); ImGui::SmallButton("Link 1");

“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);

See it live: Widgets › Selection State › Multi-Select (also used in 8 other sections)

Code from the demo

if (ImGui::BeginChild("##Basket", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY))
{
    ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect1d;
    ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, ITEMS_COUNT);
    selection.ApplyRequests(ms_io);

    for (int n = 0; n < ITEMS_COUNT; n++)
    {
        char label[64];
        sprintf(label, "Object %05d: %s", n, ExampleNames[n % IM_COUNTOF(ExampleNames)]);
        bool item_is_selected = selection.Contains((ImGuiID)n);
        ImGui::SetNextItemSelectionUserData(n);
        ImGui::Selectable(label, item_is_selected);
    }
...

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();

See it live: Widgets › Selection State › Multi-Select (also used in 8 other sections)

Code from the demo

ms_io = ImGui::EndMultiSelect();

ImGui::SetNextItemSelectionUserData¶

IMGUI_API void SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data);

See it live: Widgets › Selection State › Multi-Select (also used in 8 other sections)

Code from the demo

for (int n = 0; n < ITEMS_COUNT; n++)
{
    char label[64];
    sprintf(label, "Object %05d: %s", n, ExampleNames[n % IM_COUNTOF(ExampleNames)]);
    bool item_is_selected = selection.Contains((ImGuiID)n);
    ImGui::SetNextItemSelectionUserData(n);
    ImGui::Selectable(label, item_is_selected);
}

ImGui::IsItemToggledSelection¶

IMGUI_API bool IsItemToggledSelection();

See it live: Examples › Assets Browser

Code from the demo

if (ImGui::IsItemToggledSelection())
    item_is_selected = !item_is_selected;

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));

See it live: Widgets › List Boxes (also used in 1 other section)

Code from the demo

if (ImGui::BeginListBox("listbox 1"))
{
    for (int n = 0; n < IM_COUNTOF(items); n++)
    {
        const bool is_selected = (item_selected_idx == n);
        if (ImGui::Selectable(items[n], is_selected))
            item_selected_idx = n;

        if (item_highlight && ImGui::IsItemHovered())
            item_highlighted_idx = n;

        // Set the initial focus when opening the combo (scrolling + keyboard navigation focus)
        if (is_selected)
            ImGui::SetItemDefaultFocus();
...

open a framed scrolling region

ImGui::EndListBox¶

IMGUI_API void EndListBox();

See it live: Widgets › List Boxes (also used in 1 other section)

Code from the demo

ImGui::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);

See it live: Widgets › Basic › ListBox (also used in 2 other sections)

Code from the demo

const char* items[] = { "Apple", "Banana", "Cherry", "Kiwi", "Mango", "Orange", "Pineapple", "Strawberry", "Watermelon" };
static int item_current = 1;
ImGui::ListBox("listbox", &item_current, items, IM_COUNTOF(items), 4);

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));

See it live: Widgets › Plotting (also used in 1 other section)

Code from the demo

static float arr[] = { 0.6f, 0.1f, 1.0f, 0.5f, 0.92f, 0.1f, 0.2f };
ImGui::PlotLines("Frame Times", arr, IM_COUNTOF(arr));

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));

See it live: Widgets › Plotting (also used in 1 other section)

Code from the demo

static float arr[] = { 0.6f, 0.1f, 1.0f, 0.5f, 0.92f, 0.1f, 0.2f };
ImGui::PlotLines("Frame Times", arr, IM_COUNTOF(arr));
ImGui::PlotHistogram("Histogram", arr, IM_COUNTOF(arr), 0, NULL, 0.0f, 1.0f, plot_sz);

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();

See it live: Layout › Child windows (also used in 6 other sections)

Code from the demo

ImGui::PushStyleVar(ImGuiStyleVar_ChildRounding, 5.0f);
ImGui::BeginChild("ChildR", ImVec2(0, 260), ImGuiChildFlags_Borders, window_flags);
if (!disable_menu && ImGui::BeginMenuBar())
{
    if (ImGui::BeginMenu("Menu"))
    {
        ShowExampleMenuFile();
        ImGui::EndMenu();
    }
    ImGui::EndMenuBar();
}

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

ImGui::EndMenuBar¶

IMGUI_API void EndMenuBar();

See it live: Layout › Child windows (also used in 6 other sections)

Code from the demo

ImGui::PushStyleVar(ImGuiStyleVar_ChildRounding, 5.0f);
ImGui::BeginChild("ChildR", ImVec2(0, 260), ImGuiChildFlags_Borders, window_flags);
if (!disable_menu && ImGui::BeginMenuBar())
{
    if (ImGui::BeginMenu("Menu"))
    {
        ShowExampleMenuFile();
        ImGui::EndMenu();
    }
    ImGui::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);

See it live: Popups › Menus inside a regular window (also used in 10 other sections)

Code from the demo

ImGui::MenuItem("Menu item", "Ctrl+M");
if (ImGui::BeginMenu("Menu inside a regular window"))
{
    ShowExampleMenuFile();
    ImGui::EndMenu();
}

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

ImGui::EndMenu¶

IMGUI_API void EndMenu();

See it live: Popups › Menus inside a regular window (also used in 10 other sections)

Code from the demo

ImGui::MenuItem("Menu item", "Ctrl+M");
if (ImGui::BeginMenu("Menu inside a regular window"))
{
    ShowExampleMenuFile();
    ImGui::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);

See it live: Popups › Menus inside a regular window (also used in 14 other sections)

Code from the demo

ImGui::MenuItem("Menu item", "Ctrl+M");

return True when activated + toggle (*p_selected) if p_selected != None
Python: returns (activated, p_selected): p_selected toggles when activated. menu_item_simple() returns activated alone.

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();

See it live: Widgets › Tooltips (also used in 1 other section)

Code from the demo

else if (always_on == 2 && ImGui::BeginTooltip())
{
    ImGui::ProgressBar(sinf((float)ImGui::GetTime()) * 0.5f + 0.5f, ImVec2(ImGui::GetFontSize() * 25, 0.0f));
    ImGui::EndTooltip();
}

begin/append a tooltip window.

ImGui::EndTooltip¶

IMGUI_API void EndTooltip();

See it live: Widgets › Tooltips (also used in 1 other section)

Code from the demo

ImGui::Button("Fancy", sz);
if (ImGui::BeginItemTooltip())
{
    ImGui::Text("I am a fancy tooltip");
    static float arr[] = { 0.6f, 0.1f, 1.0f, 0.5f, 0.92f, 0.1f, 0.2f };
    ImGui::PlotLines("Curve", arr, IM_COUNTOF(arr));
    ImGui::Text("Sin(time) = %f", sinf((float)ImGui::GetTime()));
    ImGui::EndTooltip();
}

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

ImGui::SetTooltip¶

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

See it live: Widgets › Drag and Drop › Tooltip at target location (also used in 3 other sections)

Code from the demo

ImGuiDragDropFlags drop_target_flags = ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoPreviewTooltip;
if (const ImGuiPayload* payload = ImGui::AcceptDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_4F, drop_target_flags))
{
    IM_UNUSED(payload);
    ImGui::SetMouseCursor(ImGuiMouseCursor_NotAllowed);
    ImGui::SetTooltip("Cannot drop here!");
}

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

ImGui::BeginItemTooltip¶

IMGUI_API bool BeginItemTooltip();

See it live: Widgets › Tooltips

Code from the demo

ImGui::Button("Fancy", sz);
if (ImGui::BeginItemTooltip())
{
    ImGui::Text("I am a fancy tooltip");
    static float arr[] = { 0.6f, 0.1f, 1.0f, 0.5f, 0.92f, 0.1f, 0.2f };
    ImGui::PlotLines("Curve", arr, IM_COUNTOF(arr));
    ImGui::Text("Sin(time) = %f", sinf((float)ImGui::GetTime()));
    ImGui::EndTooltip();
}

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, ...) ;

See it live: Widgets › Tooltips (also used in 5 other sections)

Code from the demo

ImGui::Button("Basic", sz);
ImGui::SetItemTooltip("I am a tooltip");

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);

See it live: Widgets › Color › ColorButton (with custom Picker popup) (also used in 7 other sections)

Code from the demo

float ref_sz = ImGui::GetFrameHeight();
if (ImGui::BeginPopup("mypicker"))
{
    ImGui::Text("MY CUSTOM COLOR PICKER WITH AN AMAZING PALETTE!");
    ImGui::Separator();
    ImGui::ColorPicker4("##picker", (float*)&color, base_flags | ImGuiColorEditFlags_NoSidePreview | ImGuiColorEditFlags_NoSmallPreview);
    ImGui::SameLine();

    ImVec2 color_button_sz(ref_sz * 3.0f, ref_sz * 2.0f);
    ImGui::BeginGroup(); // Lock X position
    ImGui::Text("Current");
    ImGui::ColorButton("##current", color, ImGuiColorEditFlags_NoPicker | ImGuiColorEditFlags_AlphaPreviewHalf, color_button_sz);
    ImGui::Text("Previous");
    if (ImGui::ColorButton("##previous", backup_color, ImGuiColorEditFlags_NoPicker | ImGuiColorEditFlags_AlphaPreviewHalf, color_button_sz))
...

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);

See it live: Popups › Modals (also used in 1 other section)

Code from the demo

if (ImGui::BeginPopupModal("Delete?", NULL, ImGuiWindowFlags_AlwaysAutoResize))
{
    ImGui::Text("All those beautiful files will be deleted.\nThis operation cannot be undone!");
    ImGui::Separator();

    //static int unused_i = 0;
    //ImGui::Combo("Combo", &unused_i, "Delete\0Delete harder\0");

    static bool dont_ask_me_next_time = false;
    ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(0, 0));
    ImGui::Checkbox("Don't ask me next time", &dont_ask_me_next_time);
    ImGui::PopStyleVar();

    if (ImGui::Button("OK", ImVec2(120, 0))) { ImGui::CloseCurrentPopup(); }
...

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

ImGui::EndPopup¶

IMGUI_API void EndPopup();

See it live: Widgets › Color › ColorButton (with custom Picker popup) (also used in 13 other sections)

Code from the demo

ImGui::EndGroup();
ImGui::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);

See it live: Popups › Popups (also used in 8 other sections)

Code from the demo

if (ImGui::Button("Select.."))
    ImGui::OpenPopup("my_select_popup");

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);

See it live: Popups › Context menus (also used in 1 other section)

Code from the demo

ImGui::Text("(2) Or right-click this text");
ImGui::OpenPopupOnItemClick("my popup", ImGuiPopupFlags_MouseButtonRight);

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();

See it live: Popups › Context menus (also used in 3 other sections)

Code from the demo

selected = n;
ImGui::Text("This is a popup for \"%s\"!", names[n]);
if (ImGui::Button("Close"))
    ImGui::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);

See it live: Popups › Context menus (also used in 4 other sections)

Code from the demo

const char* names[5] = { "Label1", "Label2", "Label3", "Label4", "Label5" };
static int selected = -1;
for (int n = 0; n < 5; n++)
{
    if (ImGui::Selectable(names[n], selected == n))
        selected = n;
    if (ImGui::BeginPopupContextItem()) // <-- use last item id as popup id
    {
        selected = n;
        ImGui::Text("This is a popup for \"%s\"!", names[n]);
        if (ImGui::Button("Close"))
            ImGui::CloseCurrentPopup();
        ImGui::EndPopup();
    }
...

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);

if (ImGui::BeginPopupContextWindow())
{
    if (ImGui::MenuItem("Custom",       NULL, location == -1)) location = -1;
    if (ImGui::MenuItem("Center",       NULL, location == -2)) location = -2;
    if (ImGui::MenuItem("Top-left",     NULL, location == 0)) location = 0;
    if (ImGui::MenuItem("Top-right",    NULL, location == 1)) location = 1;
    if (ImGui::MenuItem("Bottom-left",  NULL, location == 2)) location = 2;
    if (ImGui::MenuItem("Bottom-right", NULL, location == 3)) location = 3;
    if (p_open && ImGui::MenuItem("Close")) *p_open = false;
    ImGui::EndPopup();
}

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);

See it live: Examples › Documents

Code from the demo

if (!ImGui::IsPopupOpen("Save?"))
    ImGui::OpenPopup("Save?");

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);

See it live: Tables › Basic (also used in 31 other sections)

Code from the demo

HelpMarker("Using TableNextRow() + calling TableSetColumnIndex() _before_ each cell, in a loop.");
if (ImGui::BeginTable("table1", 3))
{
    for (int row = 0; row < 4; row++)
    {
        ImGui::TableNextRow();
        for (int column = 0; column < 3; column++)
        {
            ImGui::TableSetColumnIndex(column);
            ImGui::Text("Row %d Column %d", row, column);
        }
    }
    ImGui::EndTable();
}

ImGui::EndTable¶

IMGUI_API void EndTable();

See it live: Widgets › Selectables › In Tables (also used in 31 other sections)

Code from the demo

ImGui::EndTable();

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

ImGui::TableNextRow¶

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

See it live: Tables › Basic (also used in 25 other sections)

Code from the demo

for (int row = 0; row < 4; row++)
{
    ImGui::TableNextRow();
    for (int column = 0; column < 3; column++)
    {
        ImGui::TableSetColumnIndex(column);
        ImGui::Text("Row %d Column %d", row, column);
    }
}

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();

See it live: Tables › Basic (also used in 17 other sections)

Code from the demo

for (int row = 0; row < 4; row++)
{
    ImGui::TableNextRow();
    ImGui::TableNextColumn();
    ImGui::Text("Row %d", row);
    ImGui::TableNextColumn();
    ImGui::Text("Some contents");
    ImGui::TableNextColumn();
    ImGui::Text("123.456");
}

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);

See it live: Tables › Basic (also used in 16 other sections)

Code from the demo

ImGui::TableNextRow();
for (int column = 0; column < 3; column++)
{
    ImGui::TableSetColumnIndex(column);
    ImGui::Text("Row %d Column %d", row, column);
}

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);

See it live: Tables › Borders, background (also used in 20 other sections)

Code from the demo

if (display_headers)
{
    ImGui::TableSetupColumn("One");
    ImGui::TableSetupColumn("Two");
    ImGui::TableSetupColumn("Three");
    ImGui::TableHeadersRow();
}

ImGui::TableSetupScrollFreeze¶

IMGUI_API void TableSetupScrollFreeze(int cols, int rows);