git repos / blockattack-game

blame: source/code/Libs/imgui/imgui.h

normal view · raw

1193b4be Poul Sander 2025-02-03 21:28 1
// dear imgui, v1.91.4
1193b4be Poul Sander 2025-02-03 21:28 2
// (headers)
1193b4be Poul Sander 2025-02-03 21:28 3
1193b4be Poul Sander 2025-02-03 21:28 4
// Help:
1193b4be Poul Sander 2025-02-03 21:28 5
// - See links below.
1193b4be Poul Sander 2025-02-03 21:28 6
// - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that.
1193b4be Poul Sander 2025-02-03 21:28 7
// - Read top of imgui.cpp for more details, links and comments.
1193b4be Poul Sander 2025-02-03 21:28 8
// - Add '#define IMGUI_DEFINE_MATH_OPERATORS' before including this file (or in imconfig.h) to access courtesy maths operators for ImVec2 and ImVec4.
1193b4be Poul Sander 2025-02-03 21:28 9
1193b4be Poul Sander 2025-02-03 21:28 10
// Resources:
1193b4be Poul Sander 2025-02-03 21:28 11
// - FAQ ........................ https://dearimgui.com/faq (in repository as docs/FAQ.md)
1193b4be Poul Sander 2025-02-03 21:28 12
// - Homepage ................... https://github.com/ocornut/imgui
1193b4be Poul Sander 2025-02-03 21:28 13
// - Releases & changelog ....... https://github.com/ocornut/imgui/releases
1193b4be Poul Sander 2025-02-03 21:28 14
// - Gallery .................... https://github.com/ocornut/imgui/issues?q=label%3Agallery (please post your screenshots/video there!)
1193b4be Poul Sander 2025-02-03 21:28 15
// - Wiki ....................... https://github.com/ocornut/imgui/wiki (lots of good stuff there)
1193b4be Poul Sander 2025-02-03 21:28 16
//   - Getting Started            https://github.com/ocornut/imgui/wiki/Getting-Started (how to integrate in an existing app by adding ~25 lines of code)
1193b4be Poul Sander 2025-02-03 21:28 17
//   - Third-party Extensions     https://github.com/ocornut/imgui/wiki/Useful-Extensions (ImPlot & many more)
1193b4be Poul Sander 2025-02-03 21:28 18
//   - Bindings/Backends          https://github.com/ocornut/imgui/wiki/Bindings (language bindings, backends for various tech/engines)
1193b4be Poul Sander 2025-02-03 21:28 19
//   - Glossary                   https://github.com/ocornut/imgui/wiki/Glossary
1193b4be Poul Sander 2025-02-03 21:28 20
//   - Debug Tools                https://github.com/ocornut/imgui/wiki/Debug-Tools
1193b4be Poul Sander 2025-02-03 21:28 21
//   - Software using Dear ImGui  https://github.com/ocornut/imgui/wiki/Software-using-dear-imgui
1193b4be Poul Sander 2025-02-03 21:28 22
// - Issues & support ........... https://github.com/ocornut/imgui/issues
1193b4be Poul Sander 2025-02-03 21:28 23
// - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps)
1193b4be Poul Sander 2025-02-03 21:28 24
1193b4be Poul Sander 2025-02-03 21:28 25
// For first-time users having issues compiling/linking/running/loading fonts:
1193b4be Poul Sander 2025-02-03 21:28 26
// please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above.
1193b4be Poul Sander 2025-02-03 21:28 27
// Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there.
1193b4be Poul Sander 2025-02-03 21:28 28
1193b4be Poul Sander 2025-02-03 21:28 29
// Library Version
1193b4be Poul Sander 2025-02-03 21:28 30
// (Integer encoded as XYYZZ for use in #if preprocessor conditionals, e.g. '#if IMGUI_VERSION_NUM >= 12345')
1193b4be Poul Sander 2025-02-03 21:28 31
#define IMGUI_VERSION       "1.91.4"
1193b4be Poul Sander 2025-02-03 21:28 32
#define IMGUI_VERSION_NUM   19140
1193b4be Poul Sander 2025-02-03 21:28 33
#define IMGUI_HAS_TABLE
1193b4be Poul Sander 2025-02-03 21:28 34
#define IMGUI_HAS_VIEWPORT          // Viewport WIP branch
1193b4be Poul Sander 2025-02-03 21:28 35
#define IMGUI_HAS_DOCK              // Docking WIP branch
1193b4be Poul Sander 2025-02-03 21:28 36
1193b4be Poul Sander 2025-02-03 21:28 37
/*
1193b4be Poul Sander 2025-02-03 21:28 38
1193b4be Poul Sander 2025-02-03 21:28 39
Index of this file:
1193b4be Poul Sander 2025-02-03 21:28 40
// [SECTION] Header mess
1193b4be Poul Sander 2025-02-03 21:28 41
// [SECTION] Forward declarations and basic types
1193b4be Poul Sander 2025-02-03 21:28 42
// [SECTION] Dear ImGui end-user API functions
1193b4be Poul Sander 2025-02-03 21:28 43
// [SECTION] Flags & Enumerations
1193b4be Poul Sander 2025-02-03 21:28 44
// [SECTION] Tables API flags and structures (ImGuiTableFlags, ImGuiTableColumnFlags, ImGuiTableRowFlags, ImGuiTableBgTarget, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs)
1193b4be Poul Sander 2025-02-03 21:28 45
// [SECTION] Helpers: Debug log, Memory allocations macros, ImVector<>
1193b4be Poul Sander 2025-02-03 21:28 46
// [SECTION] ImGuiStyle
1193b4be Poul Sander 2025-02-03 21:28 47
// [SECTION] ImGuiIO
1193b4be Poul Sander 2025-02-03 21:28 48
// [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiWindowClass, ImGuiPayload)
1193b4be Poul Sander 2025-02-03 21:28 49
// [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, Math Operators, ImColor)
1193b4be Poul Sander 2025-02-03 21:28 50
// [SECTION] Multi-Select API flags and structures (ImGuiMultiSelectFlags, ImGuiMultiSelectIO, ImGuiSelectionRequest, ImGuiSelectionBasicStorage, ImGuiSelectionExternalStorage)
1193b4be Poul Sander 2025-02-03 21:28 51
// [SECTION] Drawing API (ImDrawCallback, ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawFlags, ImDrawListFlags, ImDrawList, ImDrawData)
1193b4be Poul Sander 2025-02-03 21:28 52
// [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontGlyphRangesBuilder, ImFontAtlasFlags, ImFontAtlas, ImFont)
1193b4be Poul Sander 2025-02-03 21:28 53
// [SECTION] Viewports (ImGuiViewportFlags, ImGuiViewport)
1193b4be Poul Sander 2025-02-03 21:28 54
// [SECTION] ImGuiPlatformIO + other Platform Dependent Interfaces (ImGuiPlatformMonitor, ImGuiPlatformImeData)
1193b4be Poul Sander 2025-02-03 21:28 55
// [SECTION] Obsolete functions and types
1193b4be Poul Sander 2025-02-03 21:28 56
1193b4be Poul Sander 2025-02-03 21:28 57
*/
1193b4be Poul Sander 2025-02-03 21:28 58
1193b4be Poul Sander 2025-02-03 21:28 59
#pragma once
1193b4be Poul Sander 2025-02-03 21:28 60
1193b4be Poul Sander 2025-02-03 21:28 61
// Configuration file with compile-time options
1193b4be Poul Sander 2025-02-03 21:28 62
// (edit imconfig.h or '#define IMGUI_USER_CONFIG "myfilename.h" from your build system)
1193b4be Poul Sander 2025-02-03 21:28 63
#ifdef IMGUI_USER_CONFIG
1193b4be Poul Sander 2025-02-03 21:28 64
#include IMGUI_USER_CONFIG
1193b4be Poul Sander 2025-02-03 21:28 65
#endif
1193b4be Poul Sander 2025-02-03 21:28 66
#include "imconfig.h"
1193b4be Poul Sander 2025-02-03 21:28 67
1193b4be Poul Sander 2025-02-03 21:28 68
#ifndef IMGUI_DISABLE
1193b4be Poul Sander 2025-02-03 21:28 69
1193b4be Poul Sander 2025-02-03 21:28 70
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 71
// [SECTION] Header mess
1193b4be Poul Sander 2025-02-03 21:28 72
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 73
1193b4be Poul Sander 2025-02-03 21:28 74
// Includes
1193b4be Poul Sander 2025-02-03 21:28 75
#include <float.h>                  // FLT_MIN, FLT_MAX
1193b4be Poul Sander 2025-02-03 21:28 76
#include <stdarg.h>                 // va_list, va_start, va_end
1193b4be Poul Sander 2025-02-03 21:28 77
#include <stddef.h>                 // ptrdiff_t, NULL
1193b4be Poul Sander 2025-02-03 21:28 78
#include <string.h>                 // memset, memmove, memcpy, strlen, strchr, strcpy, strcmp
1193b4be Poul Sander 2025-02-03 21:28 79
1193b4be Poul Sander 2025-02-03 21:28 80
// Define attributes of all API symbols declarations (e.g. for DLL under Windows)
1193b4be Poul Sander 2025-02-03 21:28 81
// IMGUI_API is used for core imgui functions, IMGUI_IMPL_API is used for the default backends files (imgui_impl_xxx.h)
1193b4be Poul Sander 2025-02-03 21:28 82
// Using dear imgui via a shared library is not recommended: we don't guarantee backward nor forward ABI compatibility + this is a call-heavy library and function call overhead adds up.
1193b4be Poul Sander 2025-02-03 21:28 83
#ifndef IMGUI_API
1193b4be Poul Sander 2025-02-03 21:28 84
#define IMGUI_API
1193b4be Poul Sander 2025-02-03 21:28 85
#endif
1193b4be Poul Sander 2025-02-03 21:28 86
#ifndef IMGUI_IMPL_API
1193b4be Poul Sander 2025-02-03 21:28 87
#define IMGUI_IMPL_API              IMGUI_API
1193b4be Poul Sander 2025-02-03 21:28 88
#endif
1193b4be Poul Sander 2025-02-03 21:28 89
1193b4be Poul Sander 2025-02-03 21:28 90
// Helper Macros
1193b4be Poul Sander 2025-02-03 21:28 91
#ifndef IM_ASSERT
1193b4be Poul Sander 2025-02-03 21:28 92
#include <assert.h>
1193b4be Poul Sander 2025-02-03 21:28 93
#define IM_ASSERT(_EXPR)            assert(_EXPR)                               // You can override the default assert handler by editing imconfig.h
1193b4be Poul Sander 2025-02-03 21:28 94
#endif
1193b4be Poul Sander 2025-02-03 21:28 95
#define IM_ARRAYSIZE(_ARR)          ((int)(sizeof(_ARR) / sizeof(*(_ARR))))     // Size of a static C-style array. Don't use on pointers!
1193b4be Poul Sander 2025-02-03 21:28 96
#define IM_UNUSED(_VAR)             ((void)(_VAR))                              // Used to silence "unused variable warnings". Often useful as asserts may be stripped out from final builds.
1193b4be Poul Sander 2025-02-03 21:28 97
1193b4be Poul Sander 2025-02-03 21:28 98
// Check that version and structures layouts are matching between compiled imgui code and caller. Read comments above DebugCheckVersionAndDataLayout() for details.
1193b4be Poul Sander 2025-02-03 21:28 99
#define IMGUI_CHECKVERSION()        ImGui::DebugCheckVersionAndDataLayout(IMGUI_VERSION, sizeof(ImGuiIO), sizeof(ImGuiStyle), sizeof(ImVec2), sizeof(ImVec4), sizeof(ImDrawVert), sizeof(ImDrawIdx))
1193b4be Poul Sander 2025-02-03 21:28 100
1193b4be Poul Sander 2025-02-03 21:28 101
// Helper Macros - IM_FMTARGS, IM_FMTLIST: Apply printf-style warnings to our formatting functions.
1193b4be Poul Sander 2025-02-03 21:28 102
// (MSVC provides an equivalent mechanism via SAL Annotations but it would require the macros in a different
1193b4be Poul Sander 2025-02-03 21:28 103
//  location. e.g. #include <sal.h> + void myprintf(_Printf_format_string_ const char* format, ...))
1193b4be Poul Sander 2025-02-03 21:28 104
#if !defined(IMGUI_USE_STB_SPRINTF) && defined(__MINGW32__) && !defined(__clang__)
1193b4be Poul Sander 2025-02-03 21:28 105
#define IM_FMTARGS(FMT)             __attribute__((format(gnu_printf, FMT, FMT+1)))
1193b4be Poul Sander 2025-02-03 21:28 106
#define IM_FMTLIST(FMT)             __attribute__((format(gnu_printf, FMT, 0)))
1193b4be Poul Sander 2025-02-03 21:28 107
#elif !defined(IMGUI_USE_STB_SPRINTF) && (defined(__clang__) || defined(__GNUC__))
1193b4be Poul Sander 2025-02-03 21:28 108
#define IM_FMTARGS(FMT)             __attribute__((format(printf, FMT, FMT+1)))
1193b4be Poul Sander 2025-02-03 21:28 109
#define IM_FMTLIST(FMT)             __attribute__((format(printf, FMT, 0)))
1193b4be Poul Sander 2025-02-03 21:28 110
#else
1193b4be Poul Sander 2025-02-03 21:28 111
#define IM_FMTARGS(FMT)
1193b4be Poul Sander 2025-02-03 21:28 112
#define IM_FMTLIST(FMT)
1193b4be Poul Sander 2025-02-03 21:28 113
#endif
1193b4be Poul Sander 2025-02-03 21:28 114
1193b4be Poul Sander 2025-02-03 21:28 115
// Disable some of MSVC most aggressive Debug runtime checks in function header/footer (used in some simple/low-level functions)
1193b4be Poul Sander 2025-02-03 21:28 116
#if defined(_MSC_VER) && !defined(__clang__)  && !defined(__INTEL_COMPILER) && !defined(IMGUI_DEBUG_PARANOID)
1193b4be Poul Sander 2025-02-03 21:28 117
#define IM_MSVC_RUNTIME_CHECKS_OFF      __pragma(runtime_checks("",off))     __pragma(check_stack(off)) __pragma(strict_gs_check(push,off))
1193b4be Poul Sander 2025-02-03 21:28 118
#define IM_MSVC_RUNTIME_CHECKS_RESTORE  __pragma(runtime_checks("",restore)) __pragma(check_stack())    __pragma(strict_gs_check(pop))
1193b4be Poul Sander 2025-02-03 21:28 119
#else
1193b4be Poul Sander 2025-02-03 21:28 120
#define IM_MSVC_RUNTIME_CHECKS_OFF
1193b4be Poul Sander 2025-02-03 21:28 121
#define IM_MSVC_RUNTIME_CHECKS_RESTORE
1193b4be Poul Sander 2025-02-03 21:28 122
#endif
1193b4be Poul Sander 2025-02-03 21:28 123
1193b4be Poul Sander 2025-02-03 21:28 124
// Warnings
1193b4be Poul Sander 2025-02-03 21:28 125
#ifdef _MSC_VER
1193b4be Poul Sander 2025-02-03 21:28 126
#pragma warning (push)
1193b4be Poul Sander 2025-02-03 21:28 127
#pragma warning (disable: 26495)    // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6).
1193b4be Poul Sander 2025-02-03 21:28 128
#endif
1193b4be Poul Sander 2025-02-03 21:28 129
#if defined(__clang__)
1193b4be Poul Sander 2025-02-03 21:28 130
#pragma clang diagnostic push
1193b4be Poul Sander 2025-02-03 21:28 131
#if __has_warning("-Wunknown-warning-option")
1193b4be Poul Sander 2025-02-03 21:28 132
#pragma clang diagnostic ignored "-Wunknown-warning-option"         // warning: unknown warning group 'xxx'
1193b4be Poul Sander 2025-02-03 21:28 133
#endif
1193b4be Poul Sander 2025-02-03 21:28 134
#pragma clang diagnostic ignored "-Wunknown-pragmas"                // warning: unknown warning group 'xxx'
1193b4be Poul Sander 2025-02-03 21:28 135
#pragma clang diagnostic ignored "-Wold-style-cast"
1193b4be Poul Sander 2025-02-03 21:28 136
#pragma clang diagnostic ignored "-Wfloat-equal"                    // warning: comparing floating point with == or != is unsafe
1193b4be Poul Sander 2025-02-03 21:28 137
#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant"
1193b4be Poul Sander 2025-02-03 21:28 138
#pragma clang diagnostic ignored "-Wreserved-identifier"            // warning: identifier '_Xxx' is reserved because it starts with '_' followed by a capital letter
1193b4be Poul Sander 2025-02-03 21:28 139
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"            // warning: 'xxx' is an unsafe pointer used for buffer access
1193b4be Poul Sander 2025-02-03 21:28 140
#elif defined(__GNUC__)
1193b4be Poul Sander 2025-02-03 21:28 141
#pragma GCC diagnostic push
1193b4be Poul Sander 2025-02-03 21:28 142
#pragma GCC diagnostic ignored "-Wpragmas"          // warning: unknown option after '#pragma GCC diagnostic' kind
1193b4be Poul Sander 2025-02-03 21:28 143
#pragma GCC diagnostic ignored "-Wclass-memaccess"  // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead
1193b4be Poul Sander 2025-02-03 21:28 144
#endif
1193b4be Poul Sander 2025-02-03 21:28 145
1193b4be Poul Sander 2025-02-03 21:28 146
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 147
// [SECTION] Forward declarations and basic types
1193b4be Poul Sander 2025-02-03 21:28 148
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 149
1193b4be Poul Sander 2025-02-03 21:28 150
// Scalar data types
1193b4be Poul Sander 2025-02-03 21:28 151
typedef unsigned int        ImGuiID;// A unique ID used by widgets (typically the result of hashing a stack of string)
1193b4be Poul Sander 2025-02-03 21:28 152
typedef signed char         ImS8;   // 8-bit signed integer
1193b4be Poul Sander 2025-02-03 21:28 153
typedef unsigned char       ImU8;   // 8-bit unsigned integer
1193b4be Poul Sander 2025-02-03 21:28 154
typedef signed short        ImS16;  // 16-bit signed integer
1193b4be Poul Sander 2025-02-03 21:28 155
typedef unsigned short      ImU16;  // 16-bit unsigned integer
1193b4be Poul Sander 2025-02-03 21:28 156
typedef signed int          ImS32;  // 32-bit signed integer == int
1193b4be Poul Sander 2025-02-03 21:28 157
typedef unsigned int        ImU32;  // 32-bit unsigned integer (often used to store packed colors)
1193b4be Poul Sander 2025-02-03 21:28 158
typedef signed   long long  ImS64;  // 64-bit signed integer
1193b4be Poul Sander 2025-02-03 21:28 159
typedef unsigned long long  ImU64;  // 64-bit unsigned integer
1193b4be Poul Sander 2025-02-03 21:28 160
1193b4be Poul Sander 2025-02-03 21:28 161
// Forward declarations
1193b4be Poul Sander 2025-02-03 21:28 162
struct ImDrawChannel;               // Temporary storage to output draw commands out of order, used by ImDrawListSplitter and ImDrawList::ChannelsSplit()
1193b4be Poul Sander 2025-02-03 21:28 163
struct ImDrawCmd;                   // A single draw command within a parent ImDrawList (generally maps to 1 GPU draw call, unless it is a callback)
1193b4be Poul Sander 2025-02-03 21:28 164
struct ImDrawData;                  // All draw command lists required to render the frame + pos/size coordinates to use for the projection matrix.
1193b4be Poul Sander 2025-02-03 21:28 165
struct ImDrawList;                  // A single draw command list (generally one per window, conceptually you may see this as a dynamic "mesh" builder)
1193b4be Poul Sander 2025-02-03 21:28 166
struct ImDrawListSharedData;        // Data shared among multiple draw lists (typically owned by parent ImGui context, but you may create one yourself)
1193b4be Poul Sander 2025-02-03 21:28 167
struct ImDrawListSplitter;          // Helper to split a draw list into different layers which can be drawn into out of order, then flattened back.
1193b4be Poul Sander 2025-02-03 21:28 168
struct ImDrawVert;                  // A single vertex (pos + uv + col = 20 bytes by default. Override layout with IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT)
1193b4be Poul Sander 2025-02-03 21:28 169
struct ImFont;                      // Runtime data for a single font within a parent ImFontAtlas
1193b4be Poul Sander 2025-02-03 21:28 170
struct ImFontAtlas;                 // Runtime data for multiple fonts, bake multiple fonts into a single texture, TTF/OTF font loader
1193b4be Poul Sander 2025-02-03 21:28 171
struct ImFontBuilderIO;             // Opaque interface to a font builder (stb_truetype or FreeType).
1193b4be Poul Sander 2025-02-03 21:28 172
struct ImFontConfig;                // Configuration data when adding a font or merging fonts
1193b4be Poul Sander 2025-02-03 21:28 173
struct ImFontGlyph;                 // A single font glyph (code point + coordinates within in ImFontAtlas + offset)
1193b4be Poul Sander 2025-02-03 21:28 174
struct ImFontGlyphRangesBuilder;    // Helper to build glyph ranges from text/string data
1193b4be Poul Sander 2025-02-03 21:28 175
struct ImColor;                     // Helper functions to create a color that can be converted to either u32 or float4 (*OBSOLETE* please avoid using)
1193b4be Poul Sander 2025-02-03 21:28 176
struct ImGuiContext;                // Dear ImGui context (opaque structure, unless including imgui_internal.h)
1193b4be Poul Sander 2025-02-03 21:28 177
struct ImGuiIO;                     // Main configuration and I/O between your application and ImGui (also see: ImGuiPlatformIO)
1193b4be Poul Sander 2025-02-03 21:28 178
struct ImGuiInputTextCallbackData;  // Shared state of InputText() when using custom ImGuiInputTextCallback (rare/advanced use)
1193b4be Poul Sander 2025-02-03 21:28 179
struct ImGuiKeyData;                // Storage for ImGuiIO and IsKeyDown(), IsKeyPressed() etc functions.
1193b4be Poul Sander 2025-02-03 21:28 180
struct ImGuiListClipper;            // Helper to manually clip large list of items
1193b4be Poul Sander 2025-02-03 21:28 181
struct ImGuiMultiSelectIO;          // Structure to interact with a BeginMultiSelect()/EndMultiSelect() block
1193b4be Poul Sander 2025-02-03 21:28 182
struct ImGuiOnceUponAFrame;         // Helper for running a block of code not more than once a frame
1193b4be Poul Sander 2025-02-03 21:28 183
struct ImGuiPayload;                // User data payload for drag and drop operations
1193b4be Poul Sander 2025-02-03 21:28 184
struct ImGuiPlatformIO;             // Interface between platform/renderer backends and ImGui (e.g. Clipboard, IME, Multi-Viewport support). Extends ImGuiIO.
1193b4be Poul Sander 2025-02-03 21:28 185
struct ImGuiPlatformImeData;        // Platform IME data for io.PlatformSetImeDataFn() function.
1193b4be Poul Sander 2025-02-03 21:28 186
struct ImGuiPlatformMonitor;        // Multi-viewport support: user-provided bounds for each connected monitor/display. Used when positioning popups and tooltips to avoid them straddling monitors
1193b4be Poul Sander 2025-02-03 21:28 187
struct ImGuiSelectionBasicStorage;  // Optional helper to store multi-selection state + apply multi-selection requests.
1193b4be Poul Sander 2025-02-03 21:28 188
struct ImGuiSelectionExternalStorage;//Optional helper to apply multi-selection requests to existing randomly accessible storage.
1193b4be Poul Sander 2025-02-03 21:28 189
struct ImGuiSelectionRequest;       // A selection request (stored in ImGuiMultiSelectIO)
1193b4be Poul Sander 2025-02-03 21:28 190
struct ImGuiSizeCallbackData;       // Callback data when using SetNextWindowSizeConstraints() (rare/advanced use)
1193b4be Poul Sander 2025-02-03 21:28 191
struct ImGuiStorage;                // Helper for key->value storage (container sorted by key)
1193b4be Poul Sander 2025-02-03 21:28 192
struct ImGuiStoragePair;            // Helper for key->value storage (pair)
1193b4be Poul Sander 2025-02-03 21:28 193
struct ImGuiStyle;                  // Runtime data for styling/colors
1193b4be Poul Sander 2025-02-03 21:28 194
struct ImGuiTableSortSpecs;         // Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
1193b4be Poul Sander 2025-02-03 21:28 195
struct ImGuiTableColumnSortSpecs;   // Sorting specification for one column of a table
1193b4be Poul Sander 2025-02-03 21:28 196
struct ImGuiTextBuffer;             // Helper to hold and append into a text buffer (~string builder)
1193b4be Poul Sander 2025-02-03 21:28 197
struct ImGuiTextFilter;             // Helper to parse and apply text filters (e.g. "aaaaa[,bbbbb][,ccccc]")
1193b4be Poul Sander 2025-02-03 21:28 198
struct ImGuiViewport;               // A Platform Window (always 1 unless multi-viewport are enabled. One per platform window to output to). In the future may represent Platform Monitor
1193b4be Poul Sander 2025-02-03 21:28 199
struct ImGuiWindowClass;            // Window class (rare/advanced uses: provide hints to the platform backend via altered viewport flags and parent/child info)
1193b4be Poul Sander 2025-02-03 21:28 200
1193b4be Poul Sander 2025-02-03 21:28 201
// Enumerations
1193b4be Poul Sander 2025-02-03 21:28 202
// - 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)
1193b4be Poul Sander 2025-02-03 21:28 203
// - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists!
1193b4be Poul Sander 2025-02-03 21:28 204
//   - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
1193b4be Poul Sander 2025-02-03 21:28 205
//   - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
1193b4be Poul Sander 2025-02-03 21:28 206
//   - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
1193b4be Poul Sander 2025-02-03 21:28 207
enum ImGuiDir : int;                // -> enum ImGuiDir              // Enum: A cardinal direction (Left, Right, Up, Down)
1193b4be Poul Sander 2025-02-03 21:28 208
enum ImGuiKey : int;                // -> enum ImGuiKey              // Enum: A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value)
1193b4be Poul Sander 2025-02-03 21:28 209
enum ImGuiMouseSource : int;        // -> enum ImGuiMouseSource      // Enum; A mouse input source identifier (Mouse, TouchScreen, Pen)
1193b4be Poul Sander 2025-02-03 21:28 210
enum ImGuiSortDirection : ImU8;     // -> enum ImGuiSortDirection    // Enum: A sorting direction (ascending or descending)
1193b4be Poul Sander 2025-02-03 21:28 211
typedef int ImGuiCol;               // -> enum ImGuiCol_             // Enum: A color identifier for styling
1193b4be Poul Sander 2025-02-03 21:28 212
typedef int ImGuiCond;              // -> enum ImGuiCond_            // Enum: A condition for many Set*() functions
1193b4be Poul Sander 2025-02-03 21:28 213
typedef int ImGuiDataType;          // -> enum ImGuiDataType_        // Enum: A primary data type
1193b4be Poul Sander 2025-02-03 21:28 214
typedef int ImGuiMouseButton;       // -> enum ImGuiMouseButton_     // Enum: A mouse button identifier (0=left, 1=right, 2=middle)
1193b4be Poul Sander 2025-02-03 21:28 215
typedef int ImGuiMouseCursor;       // -> enum ImGuiMouseCursor_     // Enum: A mouse cursor shape
1193b4be Poul Sander 2025-02-03 21:28 216
typedef int ImGuiStyleVar;          // -> enum ImGuiStyleVar_        // Enum: A variable identifier for styling
1193b4be Poul Sander 2025-02-03 21:28 217
typedef int ImGuiTableBgTarget;     // -> enum ImGuiTableBgTarget_   // Enum: A color target for TableSetBgColor()
1193b4be Poul Sander 2025-02-03 21:28 218
1193b4be Poul Sander 2025-02-03 21:28 219
// Flags (declared as int to allow using as flags without overhead, and to not pollute the top of this file)
1193b4be Poul Sander 2025-02-03 21:28 220
// - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists!
1193b4be Poul Sander 2025-02-03 21:28 221
//   - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
1193b4be Poul Sander 2025-02-03 21:28 222
//   - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
1193b4be Poul Sander 2025-02-03 21:28 223
//   - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
1193b4be Poul Sander 2025-02-03 21:28 224
typedef int ImDrawFlags;            // -> enum ImDrawFlags_          // Flags: for ImDrawList functions
1193b4be Poul Sander 2025-02-03 21:28 225
typedef int ImDrawListFlags;        // -> enum ImDrawListFlags_      // Flags: for ImDrawList instance
1193b4be Poul Sander 2025-02-03 21:28 226
typedef int ImFontAtlasFlags;       // -> enum ImFontAtlasFlags_     // Flags: for ImFontAtlas build
1193b4be Poul Sander 2025-02-03 21:28 227
typedef int ImGuiBackendFlags;      // -> enum ImGuiBackendFlags_    // Flags: for io.BackendFlags
1193b4be Poul Sander 2025-02-03 21:28 228
typedef int ImGuiButtonFlags;       // -> enum ImGuiButtonFlags_     // Flags: for InvisibleButton()
1193b4be Poul Sander 2025-02-03 21:28 229
typedef int ImGuiChildFlags;        // -> enum ImGuiChildFlags_      // Flags: for BeginChild()
1193b4be Poul Sander 2025-02-03 21:28 230
typedef int ImGuiColorEditFlags;    // -> enum ImGuiColorEditFlags_  // Flags: for ColorEdit4(), ColorPicker4() etc.
1193b4be Poul Sander 2025-02-03 21:28 231
typedef int ImGuiConfigFlags;       // -> enum ImGuiConfigFlags_     // Flags: for io.ConfigFlags
1193b4be Poul Sander 2025-02-03 21:28 232
typedef int ImGuiComboFlags;        // -> enum ImGuiComboFlags_      // Flags: for BeginCombo()
1193b4be Poul Sander 2025-02-03 21:28 233
typedef int ImGuiDockNodeFlags;     // -> enum ImGuiDockNodeFlags_   // Flags: for DockSpace()
1193b4be Poul Sander 2025-02-03 21:28 234
typedef int ImGuiDragDropFlags;     // -> enum ImGuiDragDropFlags_   // Flags: for BeginDragDropSource(), AcceptDragDropPayload()
1193b4be Poul Sander 2025-02-03 21:28 235
typedef int ImGuiFocusedFlags;      // -> enum ImGuiFocusedFlags_    // Flags: for IsWindowFocused()
1193b4be Poul Sander 2025-02-03 21:28 236
typedef int ImGuiHoveredFlags;      // -> enum ImGuiHoveredFlags_    // Flags: for IsItemHovered(), IsWindowHovered() etc.
1193b4be Poul Sander 2025-02-03 21:28 237
typedef int ImGuiInputFlags;        // -> enum ImGuiInputFlags_      // Flags: for Shortcut(), SetNextItemShortcut()
1193b4be Poul Sander 2025-02-03 21:28 238
typedef int ImGuiInputTextFlags;    // -> enum ImGuiInputTextFlags_  // Flags: for InputText(), InputTextMultiline()
1193b4be Poul Sander 2025-02-03 21:28 239
typedef int ImGuiItemFlags;         // -> enum ImGuiItemFlags_       // Flags: for PushItemFlag(), shared by all items
1193b4be Poul Sander 2025-02-03 21:28 240
typedef int ImGuiKeyChord;          // -> ImGuiKey | ImGuiMod_XXX    // Flags: for IsKeyChordPressed(), Shortcut() etc. an ImGuiKey optionally OR-ed with one or more ImGuiMod_XXX values.
1193b4be Poul Sander 2025-02-03 21:28 241
typedef int ImGuiPopupFlags;        // -> enum ImGuiPopupFlags_      // Flags: for OpenPopup*(), BeginPopupContext*(), IsPopupOpen()
1193b4be Poul Sander 2025-02-03 21:28 242
typedef int ImGuiMultiSelectFlags;  // -> enum ImGuiMultiSelectFlags_// Flags: for BeginMultiSelect()
1193b4be Poul Sander 2025-02-03 21:28 243
typedef int ImGuiSelectableFlags;   // -> enum ImGuiSelectableFlags_ // Flags: for Selectable()
1193b4be Poul Sander 2025-02-03 21:28 244
typedef int ImGuiSliderFlags;       // -> enum ImGuiSliderFlags_     // Flags: for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
1193b4be Poul Sander 2025-02-03 21:28 245
typedef int ImGuiTabBarFlags;       // -> enum ImGuiTabBarFlags_     // Flags: for BeginTabBar()
1193b4be Poul Sander 2025-02-03 21:28 246
typedef int ImGuiTabItemFlags;      // -> enum ImGuiTabItemFlags_    // Flags: for BeginTabItem()
1193b4be Poul Sander 2025-02-03 21:28 247
typedef int ImGuiTableFlags;        // -> enum ImGuiTableFlags_      // Flags: For BeginTable()
1193b4be Poul Sander 2025-02-03 21:28 248
typedef int ImGuiTableColumnFlags;  // -> enum ImGuiTableColumnFlags_// Flags: For TableSetupColumn()
1193b4be Poul Sander 2025-02-03 21:28 249
typedef int ImGuiTableRowFlags;     // -> enum ImGuiTableRowFlags_   // Flags: For TableNextRow()
1193b4be Poul Sander 2025-02-03 21:28 250
typedef int ImGuiTreeNodeFlags;     // -> enum ImGuiTreeNodeFlags_   // Flags: for TreeNode(), TreeNodeEx(), CollapsingHeader()
1193b4be Poul Sander 2025-02-03 21:28 251
typedef int ImGuiViewportFlags;     // -> enum ImGuiViewportFlags_   // Flags: for ImGuiViewport
1193b4be Poul Sander 2025-02-03 21:28 252
typedef int ImGuiWindowFlags;       // -> enum ImGuiWindowFlags_     // Flags: for Begin(), BeginChild()
1193b4be Poul Sander 2025-02-03 21:28 253
1193b4be Poul Sander 2025-02-03 21:28 254
// ImTexture: user data for renderer backend to identify a texture [Compile-time configurable type]
1193b4be Poul Sander 2025-02-03 21:28 255
// - To use something else than an opaque void* pointer: override with e.g. '#define ImTextureID MyTextureType*' in your imconfig.h file.
1193b4be Poul Sander 2025-02-03 21:28 256
// - This can be whatever to you want it to be! read the FAQ about ImTextureID for details.
1193b4be Poul Sander 2025-02-03 21:28 257
// - You can make this a structure with various constructors if you need. You will have to implement ==/!= operators.
1193b4be Poul Sander 2025-02-03 21:28 258
// - (note: before v1.91.4 (2024/10/08) the default type for ImTextureID was void*. Use intermediary intptr_t cast and read FAQ if you have casting warnings)
1193b4be Poul Sander 2025-02-03 21:28 259
#ifndef ImTextureID
1193b4be Poul Sander 2025-02-03 21:28 260
typedef ImU64 ImTextureID;          // Default: store a pointer or an integer fitting in a pointer (most renderer backends are ok with that)
1193b4be Poul Sander 2025-02-03 21:28 261
#endif
1193b4be Poul Sander 2025-02-03 21:28 262
1193b4be Poul Sander 2025-02-03 21:28 263
// ImDrawIdx: vertex index. [Compile-time configurable type]
1193b4be Poul Sander 2025-02-03 21:28 264
// - To use 16-bit indices + allow large meshes: backend need to set 'io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset' and handle ImDrawCmd::VtxOffset (recommended).
1193b4be Poul Sander 2025-02-03 21:28 265
// - To use 32-bit indices: override with '#define ImDrawIdx unsigned int' in your imconfig.h file.
1193b4be Poul Sander 2025-02-03 21:28 266
#ifndef ImDrawIdx
1193b4be Poul Sander 2025-02-03 21:28 267
typedef unsigned short ImDrawIdx;   // Default: 16-bit (for maximum compatibility with renderer backends)
1193b4be Poul Sander 2025-02-03 21:28 268
#endif
1193b4be Poul Sander 2025-02-03 21:28 269
1193b4be Poul Sander 2025-02-03 21:28 270
// Character types
1193b4be Poul Sander 2025-02-03 21:28 271
// (we generally use UTF-8 encoded string in the API. This is storage specifically for a decoded character used for keyboard input and display)
1193b4be Poul Sander 2025-02-03 21:28 272
typedef unsigned int ImWchar32;     // A single decoded U32 character/code point. We encode them as multi bytes UTF-8 when used in strings.
1193b4be Poul Sander 2025-02-03 21:28 273
typedef unsigned short ImWchar16;   // A single decoded U16 character/code point. We encode them as multi bytes UTF-8 when used in strings.
1193b4be Poul Sander 2025-02-03 21:28 274
#ifdef IMGUI_USE_WCHAR32            // ImWchar [configurable type: override in imconfig.h with '#define IMGUI_USE_WCHAR32' to support Unicode planes 1-16]
1193b4be Poul Sander 2025-02-03 21:28 275
typedef ImWchar32 ImWchar;
1193b4be Poul Sander 2025-02-03 21:28 276
#else
1193b4be Poul Sander 2025-02-03 21:28 277
typedef ImWchar16 ImWchar;
1193b4be Poul Sander 2025-02-03 21:28 278
#endif
1193b4be Poul Sander 2025-02-03 21:28 279
1193b4be Poul Sander 2025-02-03 21:28 280
// Multi-Selection item index or identifier when using BeginMultiSelect()
1193b4be Poul Sander 2025-02-03 21:28 281
// - Used by SetNextItemSelectionUserData() + and inside ImGuiMultiSelectIO structure.
1193b4be Poul Sander 2025-02-03 21:28 282
// - Most users are likely to use this store an item INDEX but this may be used to store a POINTER/ID as well. Read comments near ImGuiMultiSelectIO for details.
1193b4be Poul Sander 2025-02-03 21:28 283
typedef ImS64 ImGuiSelectionUserData;
1193b4be Poul Sander 2025-02-03 21:28 284
1193b4be Poul Sander 2025-02-03 21:28 285
// Callback and functions types
1193b4be Poul Sander 2025-02-03 21:28 286
typedef int     (*ImGuiInputTextCallback)(ImGuiInputTextCallbackData* data);    // Callback function for ImGui::InputText()
1193b4be Poul Sander 2025-02-03 21:28 287
typedef void    (*ImGuiSizeCallback)(ImGuiSizeCallbackData* data);              // Callback function for ImGui::SetNextWindowSizeConstraints()
1193b4be Poul Sander 2025-02-03 21:28 288
typedef void*   (*ImGuiMemAllocFunc)(size_t sz, void* user_data);               // Function signature for ImGui::SetAllocatorFunctions()
1193b4be Poul Sander 2025-02-03 21:28 289
typedef void    (*ImGuiMemFreeFunc)(void* ptr, void* user_data);                // Function signature for ImGui::SetAllocatorFunctions()
1193b4be Poul Sander 2025-02-03 21:28 290
1193b4be Poul Sander 2025-02-03 21:28 291
// ImVec2: 2D vector used to store positions, sizes etc. [Compile-time configurable type]
1193b4be Poul Sander 2025-02-03 21:28 292
// - This is a frequently used type in the API. Consider using IM_VEC2_CLASS_EXTRA to create implicit cast from/to our preferred type.
1193b4be Poul Sander 2025-02-03 21:28 293
// - Add '#define IMGUI_DEFINE_MATH_OPERATORS' before including this file (or in imconfig.h) to access courtesy maths operators for ImVec2 and ImVec4.
1193b4be Poul Sander 2025-02-03 21:28 294
IM_MSVC_RUNTIME_CHECKS_OFF
1193b4be Poul Sander 2025-02-03 21:28 295
struct ImVec2
1193b4be Poul Sander 2025-02-03 21:28 296
{
1193b4be Poul Sander 2025-02-03 21:28 297
    float                                   x, y;
1193b4be Poul Sander 2025-02-03 21:28 298
    constexpr ImVec2()                      : x(0.0f), y(0.0f) { }
1193b4be Poul Sander 2025-02-03 21:28 299
    constexpr ImVec2(float _x, float _y)    : x(_x), y(_y) { }
1193b4be Poul Sander 2025-02-03 21:28 300
    float& operator[] (size_t idx)          { IM_ASSERT(idx == 0 || idx == 1); return ((float*)(void*)(char*)this)[idx]; } // We very rarely use this [] operator, so the assert overhead is fine.
1193b4be Poul Sander 2025-02-03 21:28 301
    float  operator[] (size_t idx) const    { IM_ASSERT(idx == 0 || idx == 1); return ((const float*)(const void*)(const char*)this)[idx]; }
1193b4be Poul Sander 2025-02-03 21:28 302
#ifdef IM_VEC2_CLASS_EXTRA
1193b4be Poul Sander 2025-02-03 21:28 303
    IM_VEC2_CLASS_EXTRA     // Define additional constructors and implicit cast operators in imconfig.h to convert back and forth between your math types and ImVec2.
1193b4be Poul Sander 2025-02-03 21:28 304
#endif
1193b4be Poul Sander 2025-02-03 21:28 305
};
1193b4be Poul Sander 2025-02-03 21:28 306
1193b4be Poul Sander 2025-02-03 21:28 307
// ImVec4: 4D vector used to store clipping rectangles, colors etc. [Compile-time configurable type]
1193b4be Poul Sander 2025-02-03 21:28 308
struct ImVec4
1193b4be Poul Sander 2025-02-03 21:28 309
{
1193b4be Poul Sander 2025-02-03 21:28 310
    float                                                     x, y, z, w;
1193b4be Poul Sander 2025-02-03 21:28 311
    constexpr ImVec4()                                        : x(0.0f), y(0.0f), z(0.0f), w(0.0f) { }
1193b4be Poul Sander 2025-02-03 21:28 312
    constexpr ImVec4(float _x, float _y, float _z, float _w)  : x(_x), y(_y), z(_z), w(_w) { }
1193b4be Poul Sander 2025-02-03 21:28 313
#ifdef IM_VEC4_CLASS_EXTRA
1193b4be Poul Sander 2025-02-03 21:28 314
    IM_VEC4_CLASS_EXTRA     // Define additional constructors and implicit cast operators in imconfig.h to convert back and forth between your math types and ImVec4.
1193b4be Poul Sander 2025-02-03 21:28 315
#endif
1193b4be Poul Sander 2025-02-03 21:28 316
};
1193b4be Poul Sander 2025-02-03 21:28 317
IM_MSVC_RUNTIME_CHECKS_RESTORE
1193b4be Poul Sander 2025-02-03 21:28 318
1193b4be Poul Sander 2025-02-03 21:28 319
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 320
// [SECTION] Dear ImGui end-user API functions
1193b4be Poul Sander 2025-02-03 21:28 321
// (Note that ImGui:: being a namespace, you can add extra ImGui:: functions in your own separate file. Please don't modify imgui source files!)
1193b4be Poul Sander 2025-02-03 21:28 322
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 323
1193b4be Poul Sander 2025-02-03 21:28 324
namespace ImGui
1193b4be Poul Sander 2025-02-03 21:28 325
{
1193b4be Poul Sander 2025-02-03 21:28 326
    // Context creation and access
1193b4be Poul Sander 2025-02-03 21:28 327
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 328
    // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
1193b4be Poul Sander 2025-02-03 21:28 329
    //   for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for details.
1193b4be Poul Sander 2025-02-03 21:28 330
    IMGUI_API ImGuiContext* CreateContext(ImFontAtlas* shared_font_atlas = NULL);
1193b4be Poul Sander 2025-02-03 21:28 331
    IMGUI_API void          DestroyContext(ImGuiContext* ctx = NULL);   // NULL = destroy current context
1193b4be Poul Sander 2025-02-03 21:28 332
    IMGUI_API ImGuiContext* GetCurrentContext();
1193b4be Poul Sander 2025-02-03 21:28 333
    IMGUI_API void          SetCurrentContext(ImGuiContext* ctx);
1193b4be Poul Sander 2025-02-03 21:28 334
1193b4be Poul Sander 2025-02-03 21:28 335
    // Main
1193b4be Poul Sander 2025-02-03 21:28 336
    IMGUI_API ImGuiIO&      GetIO();                                    // access the ImGuiIO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)
1193b4be Poul Sander 2025-02-03 21:28 337
    IMGUI_API ImGuiPlatformIO& GetPlatformIO();                         // access the ImGuiPlatformIO structure (mostly hooks/functions to connect to platform/renderer and OS Clipboard, IME etc.)
1193b4be Poul Sander 2025-02-03 21:28 338
    IMGUI_API ImGuiStyle&   GetStyle();                                 // access the Style structure (colors, sizes). Always use PushStyleColor(), PushStyleVar() to modify style mid-frame!
1193b4be Poul Sander 2025-02-03 21:28 339
    IMGUI_API void          NewFrame();                                 // start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().
1193b4be Poul Sander 2025-02-03 21:28 340
    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!
1193b4be Poul Sander 2025-02-03 21:28 341
    IMGUI_API void          Render();                                   // ends the Dear ImGui frame, finalize the draw data. You can then get call GetDrawData().
1193b4be Poul Sander 2025-02-03 21:28 342
    IMGUI_API ImDrawData*   GetDrawData();                              // valid after Render() and until the next call to NewFrame(). this is what you have to render.
1193b4be Poul Sander 2025-02-03 21:28 343
1193b4be Poul Sander 2025-02-03 21:28 344
    // Demo, Debug, Information
1193b4be Poul Sander 2025-02-03 21:28 345
    IMGUI_API void          ShowDemoWindow(bool* p_open = NULL);        // create Demo window. demonstrate most ImGui features. call this to learn about the library! try to make it always available in your application!
1193b4be Poul Sander 2025-02-03 21:28 346
    IMGUI_API void          ShowMetricsWindow(bool* p_open = NULL);     // create Metrics/Debugger window. display Dear ImGui internals: windows, draw commands, various internal state, etc.
1193b4be Poul Sander 2025-02-03 21:28 347
    IMGUI_API void          ShowDebugLogWindow(bool* p_open = NULL);    // create Debug Log window. display a simplified log of important dear imgui events.
1193b4be Poul Sander 2025-02-03 21:28 348
    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.
1193b4be Poul Sander 2025-02-03 21:28 349
    IMGUI_API void          ShowAboutWindow(bool* p_open = NULL);       // create About window. display Dear ImGui version, credits and build/system information.
1193b4be Poul Sander 2025-02-03 21:28 350
    IMGUI_API void          ShowStyleEditor(ImGuiStyle* ref = NULL);    // add style editor block (not a window). you can pass in a reference ImGuiStyle structure to compare to, revert to and save to (else it uses the default style)
1193b4be Poul Sander 2025-02-03 21:28 351
    IMGUI_API bool          ShowStyleSelector(const char* label);       // add style selector block (not a window), essentially a combo listing the default styles.
1193b4be Poul Sander 2025-02-03 21:28 352
    IMGUI_API void          ShowFontSelector(const char* label);        // add font selector block (not a window), essentially a combo listing the loaded fonts.
1193b4be Poul Sander 2025-02-03 21:28 353
    IMGUI_API void          ShowUserGuide();                            // add basic help/info block (not a window): how to manipulate ImGui as an end-user (mouse/keyboard controls).
1193b4be Poul Sander 2025-02-03 21:28 354
    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)
1193b4be Poul Sander 2025-02-03 21:28 355
1193b4be Poul Sander 2025-02-03 21:28 356
    // Styles
1193b4be Poul Sander 2025-02-03 21:28 357
    IMGUI_API void          StyleColorsDark(ImGuiStyle* dst = NULL);    // new, recommended style (default)
1193b4be Poul Sander 2025-02-03 21:28 358
    IMGUI_API void          StyleColorsLight(ImGuiStyle* dst = NULL);   // best used with borders and a custom, thicker font
1193b4be Poul Sander 2025-02-03 21:28 359
    IMGUI_API void          StyleColorsClassic(ImGuiStyle* dst = NULL); // classic imgui style
1193b4be Poul Sander 2025-02-03 21:28 360
1193b4be Poul Sander 2025-02-03 21:28 361
    // Windows
1193b4be Poul Sander 2025-02-03 21:28 362
    // - Begin() = push window to the stack and start appending to it. End() = pop window from the stack.
1193b4be Poul Sander 2025-02-03 21:28 363
    // - Passing 'bool* p_open != NULL' shows a window-closing widget in the upper-right corner of the window,
1193b4be Poul Sander 2025-02-03 21:28 364
    //   which clicking will set the boolean to false when clicked.
1193b4be Poul Sander 2025-02-03 21:28 365
    // - You may append multiple times to the same window during the same frame by calling Begin()/End() pairs multiple times.
1193b4be Poul Sander 2025-02-03 21:28 366
    //   Some information such as 'flags' or 'p_open' will only be considered by the first call to Begin().
1193b4be Poul Sander 2025-02-03 21:28 367
    // - Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting
1193b4be Poul Sander 2025-02-03 21:28 368
    //   anything to the window. Always call a matching End() for each Begin() call, regardless of its return value!
1193b4be Poul Sander 2025-02-03 21:28 369
    //   [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions
1193b4be Poul Sander 2025-02-03 21:28 370
    //    such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding
1193b4be Poul Sander 2025-02-03 21:28 371
    //    BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
1193b4be Poul Sander 2025-02-03 21:28 372
    // - Note that the bottom of window stack always contains a window called "Debug".
1193b4be Poul Sander 2025-02-03 21:28 373
    IMGUI_API bool          Begin(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 374
    IMGUI_API void          End();
1193b4be Poul Sander 2025-02-03 21:28 375
1193b4be Poul Sander 2025-02-03 21:28 376
    // Child Windows
1193b4be Poul Sander 2025-02-03 21:28 377
    // - Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child.
1193b4be Poul Sander 2025-02-03 21:28 378
    // - Before 1.90 (November 2023), the "ImGuiChildFlags child_flags = 0" parameter was "bool border = false".
1193b4be Poul Sander 2025-02-03 21:28 379
    //   This API is backward compatible with old code, as we guarantee that ImGuiChildFlags_Borders == true.
1193b4be Poul Sander 2025-02-03 21:28 380
    //   Consider updating your old code:
1193b4be Poul Sander 2025-02-03 21:28 381
    //      BeginChild("Name", size, false)   -> Begin("Name", size, 0); or Begin("Name", size, ImGuiChildFlags_None);
1193b4be Poul Sander 2025-02-03 21:28 382
    //      BeginChild("Name", size, true)    -> Begin("Name", size, ImGuiChildFlags_Borders);
1193b4be Poul Sander 2025-02-03 21:28 383
    // - Manual sizing (each axis can use a different setting e.g. ImVec2(0.0f, 400.0f)):
1193b4be Poul Sander 2025-02-03 21:28 384
    //     == 0.0f: use remaining parent window size for this axis.
1193b4be Poul Sander 2025-02-03 21:28 385
    //      > 0.0f: use specified size for this axis.
1193b4be Poul Sander 2025-02-03 21:28 386
    //      < 0.0f: right/bottom-align to specified distance from available content boundaries.
1193b4be Poul Sander 2025-02-03 21:28 387
    // - Specifying ImGuiChildFlags_AutoResizeX or ImGuiChildFlags_AutoResizeY makes the sizing automatic based on child contents.
1193b4be Poul Sander 2025-02-03 21:28 388
    //   Combining both ImGuiChildFlags_AutoResizeX _and_ ImGuiChildFlags_AutoResizeY defeats purpose of a scrolling region and is NOT recommended.
1193b4be Poul Sander 2025-02-03 21:28 389
    // - BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting
1193b4be Poul Sander 2025-02-03 21:28 390
    //   anything to the window. Always call a matching EndChild() for each BeginChild() call, regardless of its return value.
1193b4be Poul Sander 2025-02-03 21:28 391
    //   [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions
1193b4be Poul Sander 2025-02-03 21:28 392
    //    such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding
1193b4be Poul Sander 2025-02-03 21:28 393
    //    BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
1193b4be Poul Sander 2025-02-03 21:28 394
    IMGUI_API bool          BeginChild(const char* str_id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 395
    IMGUI_API bool          BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 396
    IMGUI_API void          EndChild();
1193b4be Poul Sander 2025-02-03 21:28 397
1193b4be Poul Sander 2025-02-03 21:28 398
    // Windows Utilities
1193b4be Poul Sander 2025-02-03 21:28 399
    // - 'current window' = the window we are appending into while inside a Begin()/End() block. 'next window' = next window we will Begin() into.
1193b4be Poul Sander 2025-02-03 21:28 400
    IMGUI_API bool          IsWindowAppearing();
1193b4be Poul Sander 2025-02-03 21:28 401
    IMGUI_API bool          IsWindowCollapsed();
1193b4be Poul Sander 2025-02-03 21:28 402
    IMGUI_API bool          IsWindowFocused(ImGuiFocusedFlags flags=0); // is current window focused? or its root/child, depending on flags. see flags for options.
1193b4be Poul Sander 2025-02-03 21:28 403
    IMGUI_API bool          IsWindowHovered(ImGuiHoveredFlags flags=0); // is current window hovered and hoverable (e.g. not blocked by a popup/modal)? See ImGuiHoveredFlags_ for options. IMPORTANT: If you are trying to check whether your mouse should be dispatched to Dear ImGui or to your underlying app, you should not use this function! Use the 'io.WantCaptureMouse' boolean for that! Refer to FAQ entry "How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?" for details.
1193b4be Poul Sander 2025-02-03 21:28 404
    IMGUI_API ImDrawList*   GetWindowDrawList();                        // get draw list associated to the current window, to append your own drawing primitives
1193b4be Poul Sander 2025-02-03 21:28 405
    IMGUI_API float         GetWindowDpiScale();                        // get DPI scale currently associated to the current window's viewport.
1193b4be Poul Sander 2025-02-03 21:28 406
    IMGUI_API ImVec2        GetWindowPos();                             // get current window position in screen space (IT IS UNLIKELY YOU EVER NEED TO USE THIS. Consider always using GetCursorScreenPos() and GetContentRegionAvail() instead)
1193b4be Poul Sander 2025-02-03 21:28 407
    IMGUI_API ImVec2        GetWindowSize();                            // get current window size (IT IS UNLIKELY YOU EVER NEED TO USE THIS. Consider always using GetCursorScreenPos() and GetContentRegionAvail() instead)
1193b4be Poul Sander 2025-02-03 21:28 408
    IMGUI_API float         GetWindowWidth();                           // get current window width (IT IS UNLIKELY YOU EVER NEED TO USE THIS). Shortcut for GetWindowSize().x.
1193b4be Poul Sander 2025-02-03 21:28 409
    IMGUI_API float         GetWindowHeight();                          // get current window height (IT IS UNLIKELY YOU EVER NEED TO USE THIS). Shortcut for GetWindowSize().y.
1193b4be Poul Sander 2025-02-03 21:28 410
    IMGUI_API ImGuiViewport*GetWindowViewport();                        // get viewport currently associated to the current window.
1193b4be Poul Sander 2025-02-03 21:28 411
1193b4be Poul Sander 2025-02-03 21:28 412
    // Window manipulation
1193b4be Poul Sander 2025-02-03 21:28 413
    // - Prefer using SetNextXXX functions (before Begin) rather that SetXXX functions (after Begin).
1193b4be Poul Sander 2025-02-03 21:28 414
    IMGUI_API void          SetNextWindowPos(const ImVec2& pos, ImGuiCond cond = 0, const ImVec2& pivot = ImVec2(0, 0)); // set next window position. call before Begin(). use pivot=(0.5f,0.5f) to center on given point, etc.
1193b4be Poul Sander 2025-02-03 21:28 415
    IMGUI_API void          SetNextWindowSize(const ImVec2& size, ImGuiCond cond = 0);                  // set next window size. set axis to 0.0f to force an auto-fit on this axis. call before Begin()
1193b4be Poul Sander 2025-02-03 21:28 416
    IMGUI_API void          SetNextWindowSizeConstraints(const ImVec2& size_min, const ImVec2& size_max, ImGuiSizeCallback custom_callback = NULL, void* custom_callback_data = NULL); // set next window size limits. use 0.0f 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.
1193b4be Poul Sander 2025-02-03 21:28 417
    IMGUI_API void          SetNextWindowContentSize(const ImVec2& size);                               // set next window content size (~ scrollable client area, which enforce the range of scrollbars). Not including window decorations (title bar, menu bar, etc.) nor WindowPadding. set an axis to 0.0f to leave it automatic. call before Begin()
1193b4be Poul Sander 2025-02-03 21:28 418
    IMGUI_API void          SetNextWindowCollapsed(bool collapsed, ImGuiCond cond = 0);                 // set next window collapsed state. call before Begin()
1193b4be Poul Sander 2025-02-03 21:28 419
    IMGUI_API void          SetNextWindowFocus();                                                       // set next window to be focused / top-most. call before Begin()
1193b4be Poul Sander 2025-02-03 21:28 420
    IMGUI_API void          SetNextWindowScroll(const ImVec2& scroll);                                  // set next window scrolling value (use < 0.0f to not affect a given axis).
1193b4be Poul Sander 2025-02-03 21:28 421
    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.
1193b4be Poul Sander 2025-02-03 21:28 422
    IMGUI_API void          SetNextWindowViewport(ImGuiID viewport_id);                                 // set next window viewport
1193b4be Poul Sander 2025-02-03 21:28 423
    IMGUI_API void          SetWindowPos(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.
1193b4be Poul Sander 2025-02-03 21:28 424
    IMGUI_API void          SetWindowSize(const ImVec2& size, ImGuiCond cond = 0);                      // (not recommended) set current window size - call within Begin()/End(). set to ImVec2(0, 0) to force an auto-fit. prefer using SetNextWindowSize(), as this may incur tearing and minor side-effects.
1193b4be Poul Sander 2025-02-03 21:28 425
    IMGUI_API void          SetWindowCollapsed(bool collapsed, ImGuiCond cond = 0);                     // (not recommended) set current window collapsed state. prefer using SetNextWindowCollapsed().
1193b4be Poul Sander 2025-02-03 21:28 426
    IMGUI_API void          SetWindowFocus();                                                           // (not recommended) set current window to be focused / top-most. prefer using SetNextWindowFocus().
1193b4be Poul Sander 2025-02-03 21:28 427
    IMGUI_API void          SetWindowFontScale(float scale);                                            // [OBSOLETE] set font scale. Adjust IO.FontGlobalScale if you want to scale all windows. This is an old API! For correct scaling, prefer to reload font + rebuild ImFontAtlas + call style.ScaleAllSizes().
1193b4be Poul Sander 2025-02-03 21:28 428
    IMGUI_API void          SetWindowPos(const char* name, const ImVec2& pos, ImGuiCond cond = 0);      // set named window position.
1193b4be Poul Sander 2025-02-03 21:28 429
    IMGUI_API void          SetWindowSize(const char* name, const ImVec2& size, ImGuiCond cond = 0);    // set named window size. set axis to 0.0f to force an auto-fit on this axis.
1193b4be Poul Sander 2025-02-03 21:28 430
    IMGUI_API void          SetWindowCollapsed(const char* name, bool collapsed, ImGuiCond cond = 0);   // set named window collapsed state
1193b4be Poul Sander 2025-02-03 21:28 431
    IMGUI_API void          SetWindowFocus(const char* name);                                           // set named window to be focused / top-most. use NULL to remove focus.
1193b4be Poul Sander 2025-02-03 21:28 432
1193b4be Poul Sander 2025-02-03 21:28 433
    // Windows Scrolling
1193b4be Poul Sander 2025-02-03 21:28 434
    // - Any change of Scroll will be applied at the beginning of next frame in the first call to Begin().
1193b4be Poul Sander 2025-02-03 21:28 435
    // - You may instead use SetNextWindowScroll() prior to calling Begin() to avoid this delay, as an alternative to using SetScrollX()/SetScrollY().
1193b4be Poul Sander 2025-02-03 21:28 436
    IMGUI_API float         GetScrollX();                                                   // get scrolling amount [0 .. GetScrollMaxX()]
1193b4be Poul Sander 2025-02-03 21:28 437
    IMGUI_API float         GetScrollY();                                                   // get scrolling amount [0 .. GetScrollMaxY()]
1193b4be Poul Sander 2025-02-03 21:28 438
    IMGUI_API void          SetScrollX(float scroll_x);                                     // set scrolling amount [0 .. GetScrollMaxX()]
1193b4be Poul Sander 2025-02-03 21:28 439
    IMGUI_API void          SetScrollY(float scroll_y);                                     // set scrolling amount [0 .. GetScrollMaxY()]
1193b4be Poul Sander 2025-02-03 21:28 440
    IMGUI_API float         GetScrollMaxX();                                                // get maximum scrolling amount ~~ ContentSize.x - WindowSize.x - DecorationsSize.x
1193b4be Poul Sander 2025-02-03 21:28 441
    IMGUI_API float         GetScrollMaxY();                                                // get maximum scrolling amount ~~ ContentSize.y - WindowSize.y - DecorationsSize.y
1193b4be Poul Sander 2025-02-03 21:28 442
    IMGUI_API void          SetScrollHereX(float center_x_ratio = 0.5f);                    // adjust scrolling amount to make current cursor position visible. center_x_ratio=0.0: left, 0.5: center, 1.0: right. When using to make a "default/current item" visible, consider using SetItemDefaultFocus() instead.
1193b4be Poul Sander 2025-02-03 21:28 443
    IMGUI_API void          SetScrollHereY(float center_y_ratio = 0.5f);                    // adjust scrolling amount to make current cursor position visible. center_y_ratio=0.0: top, 0.5: center, 1.0: bottom. When using to make a "default/current item" visible, consider using SetItemDefaultFocus() instead.
1193b4be Poul Sander 2025-02-03 21:28 444
    IMGUI_API void          SetScrollFromPosX(float local_x, float center_x_ratio = 0.5f);  // adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position.
1193b4be Poul Sander 2025-02-03 21:28 445
    IMGUI_API void          SetScrollFromPosY(float local_y, float center_y_ratio = 0.5f);  // adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position.
1193b4be Poul Sander 2025-02-03 21:28 446
1193b4be Poul Sander 2025-02-03 21:28 447
    // Parameters stacks (shared)
1193b4be Poul Sander 2025-02-03 21:28 448
    IMGUI_API void          PushFont(ImFont* font);                                         // use NULL as a shortcut to push default font
1193b4be Poul Sander 2025-02-03 21:28 449
    IMGUI_API void          PopFont();
1193b4be Poul Sander 2025-02-03 21:28 450
    IMGUI_API void          PushStyleColor(ImGuiCol idx, ImU32 col);                        // modify a style color. always use this if you modify the style after NewFrame().
1193b4be Poul Sander 2025-02-03 21:28 451
    IMGUI_API void          PushStyleColor(ImGuiCol idx, const ImVec4& col);
1193b4be Poul Sander 2025-02-03 21:28 452
    IMGUI_API void          PopStyleColor(int count = 1);
1193b4be Poul Sander 2025-02-03 21:28 453
    IMGUI_API void          PushStyleVar(ImGuiStyleVar idx, float val);                     // modify a style float variable. always use this if you modify the style after NewFrame()!
1193b4be Poul Sander 2025-02-03 21:28 454
    IMGUI_API void          PushStyleVar(ImGuiStyleVar idx, const ImVec2& val);             // modify a style ImVec2 variable. "
1193b4be Poul Sander 2025-02-03 21:28 455
    IMGUI_API void          PushStyleVarX(ImGuiStyleVar idx, float val_x);                  // modify X component of a style ImVec2 variable. "
1193b4be Poul Sander 2025-02-03 21:28 456
    IMGUI_API void          PushStyleVarY(ImGuiStyleVar idx, float val_y);                  // modify Y component of a style ImVec2 variable. "
1193b4be Poul Sander 2025-02-03 21:28 457
    IMGUI_API void          PopStyleVar(int count = 1);
1193b4be Poul Sander 2025-02-03 21:28 458
    IMGUI_API void          PushItemFlag(ImGuiItemFlags option, bool enabled);              // modify specified shared item flag, e.g. PushItemFlag(ImGuiItemFlags_NoTabStop, true)
1193b4be Poul Sander 2025-02-03 21:28 459
    IMGUI_API void          PopItemFlag();
1193b4be Poul Sander 2025-02-03 21:28 460
1193b4be Poul Sander 2025-02-03 21:28 461
    // Parameters stacks (current window)
1193b4be Poul Sander 2025-02-03 21:28 462
    IMGUI_API void          PushItemWidth(float item_width);                                // push width of items for common large "item+label" widgets. >0.0f: width in pixels, <0.0f align xx pixels to the right of window (so -FLT_MIN always align width to the right side).
1193b4be Poul Sander 2025-02-03 21:28 463
    IMGUI_API void          PopItemWidth();
1193b4be Poul Sander 2025-02-03 21:28 464
    IMGUI_API void          SetNextItemWidth(float item_width);                             // set width of the _next_ common large "item+label" widget. >0.0f: width in pixels, <0.0f align xx pixels to the right of window (so -FLT_MIN always align width to the right side)
1193b4be Poul Sander 2025-02-03 21:28 465
    IMGUI_API float         CalcItemWidth();                                                // width of item given pushed settings and current cursor position. NOT necessarily the width of last item unlike most 'Item' functions.
1193b4be Poul Sander 2025-02-03 21:28 466
    IMGUI_API void          PushTextWrapPos(float wrap_local_pos_x = 0.0f);                 // push word-wrapping position for Text*() commands. < 0.0f: no wrapping; 0.0f: wrap to end of window (or column); > 0.0f: wrap at 'wrap_pos_x' position in window local space
1193b4be Poul Sander 2025-02-03 21:28 467
    IMGUI_API void          PopTextWrapPos();
1193b4be Poul Sander 2025-02-03 21:28 468
1193b4be Poul Sander 2025-02-03 21:28 469
    // Style read access
1193b4be Poul Sander 2025-02-03 21:28 470
    // - Use the ShowStyleEditor() function to interactively see/edit the colors.
1193b4be Poul Sander 2025-02-03 21:28 471
    IMGUI_API ImFont*       GetFont();                                                      // get current font
1193b4be Poul Sander 2025-02-03 21:28 472
    IMGUI_API float         GetFontSize();                                                  // get current font size (= height in pixels) of current font with current scale applied
1193b4be Poul Sander 2025-02-03 21:28 473
    IMGUI_API ImVec2        GetFontTexUvWhitePixel();                                       // get UV coordinate for a white pixel, useful to draw custom shapes via the ImDrawList API
1193b4be Poul Sander 2025-02-03 21:28 474
    IMGUI_API ImU32         GetColorU32(ImGuiCol idx, float alpha_mul = 1.0f);              // retrieve given style color with style alpha applied and optional extra alpha multiplier, packed as a 32-bit value suitable for ImDrawList
1193b4be Poul Sander 2025-02-03 21:28 475
    IMGUI_API ImU32         GetColorU32(const ImVec4& col);                                 // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList
1193b4be Poul Sander 2025-02-03 21:28 476
    IMGUI_API ImU32         GetColorU32(ImU32 col, float alpha_mul = 1.0f);                 // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList
1193b4be Poul Sander 2025-02-03 21:28 477
    IMGUI_API const ImVec4& GetStyleColorVec4(ImGuiCol idx);                                // retrieve style color as stored in ImGuiStyle structure. use to feed back into PushStyleColor(), otherwise use GetColorU32() to get style color with style alpha baked in.
1193b4be Poul Sander 2025-02-03 21:28 478
1193b4be Poul Sander 2025-02-03 21:28 479
    // Layout cursor positioning
1193b4be Poul Sander 2025-02-03 21:28 480
    // - By "cursor" we mean the current output position.
1193b4be Poul Sander 2025-02-03 21:28 481
    // - The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
1193b4be Poul Sander 2025-02-03 21:28 482
    // - You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceding widget.
1193b4be Poul Sander 2025-02-03 21:28 483
    // - YOU CAN DO 99% OF WHAT YOU NEED WITH ONLY GetCursorScreenPos() and GetContentRegionAvail().
1193b4be Poul Sander 2025-02-03 21:28 484
    // - Attention! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:
1193b4be Poul Sander 2025-02-03 21:28 485
    //    - Absolute coordinate:        GetCursorScreenPos(), SetCursorScreenPos(), all ImDrawList:: functions. -> this is the preferred way forward.
1193b4be Poul Sander 2025-02-03 21:28 486
    //    - Window-local coordinates:   SameLine(offset), GetCursorPos(), SetCursorPos(), GetCursorStartPos(), PushTextWrapPos()
1193b4be Poul Sander 2025-02-03 21:28 487
    //    - Window-local coordinates:   GetContentRegionMax(), GetWindowContentRegionMin(), GetWindowContentRegionMax() --> all obsoleted. YOU DON'T NEED THEM.
1193b4be Poul Sander 2025-02-03 21:28 488
    // - GetCursorScreenPos() = GetCursorPos() + GetWindowPos(). GetWindowPos() is almost only ever useful to convert from window-local to absolute coordinates. Try not to use it.
1193b4be Poul Sander 2025-02-03 21:28 489
    IMGUI_API ImVec2        GetCursorScreenPos();                                           // cursor position, absolute coordinates. THIS IS YOUR BEST FRIEND (prefer using this rather than GetCursorPos(), also more useful to work with ImDrawList API).
1193b4be Poul Sander 2025-02-03 21:28 490
    IMGUI_API void          SetCursorScreenPos(const ImVec2& pos);                          // cursor position, absolute coordinates. THIS IS YOUR BEST FRIEND.
1193b4be Poul Sander 2025-02-03 21:28 491
    IMGUI_API ImVec2        GetContentRegionAvail();                                        // available space from current position. THIS IS YOUR BEST FRIEND.
1193b4be Poul Sander 2025-02-03 21:28 492
    IMGUI_API ImVec2        GetCursorPos();                                                 // [window-local] cursor position in window-local coordinates. This is not your best friend.
1193b4be Poul Sander 2025-02-03 21:28 493
    IMGUI_API float         GetCursorPosX();                                                // [window-local] "
1193b4be Poul Sander 2025-02-03 21:28 494
    IMGUI_API float         GetCursorPosY();                                                // [window-local] "
1193b4be Poul Sander 2025-02-03 21:28 495
    IMGUI_API void          SetCursorPos(const ImVec2& local_pos);                          // [window-local] "
1193b4be Poul Sander 2025-02-03 21:28 496
    IMGUI_API void          SetCursorPosX(float local_x);                                   // [window-local] "
1193b4be Poul Sander 2025-02-03 21:28 497
    IMGUI_API void          SetCursorPosY(float local_y);                                   // [window-local] "
1193b4be Poul Sander 2025-02-03 21:28 498
    IMGUI_API ImVec2        GetCursorStartPos();                                            // [window-local] initial cursor position, in window-local coordinates. Call GetCursorScreenPos() after Begin() to get the absolute coordinates version.
1193b4be Poul Sander 2025-02-03 21:28 499
1193b4be Poul Sander 2025-02-03 21:28 500
    // Other layout functions
1193b4be Poul Sander 2025-02-03 21:28 501
    IMGUI_API void          Separator();                                                    // separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.
1193b4be Poul Sander 2025-02-03 21:28 502
    IMGUI_API void          SameLine(float offset_from_start_x=0.0f, float spacing=-1.0f);  // call between widgets or groups to layout them horizontally. X position given in window coordinates.
1193b4be Poul Sander 2025-02-03 21:28 503
    IMGUI_API void          NewLine();                                                      // undo a SameLine() or force a new line when in a horizontal-layout context.
1193b4be Poul Sander 2025-02-03 21:28 504
    IMGUI_API void          Spacing();                                                      // add vertical spacing.
1193b4be Poul Sander 2025-02-03 21:28 505
    IMGUI_API void          Dummy(const ImVec2& size);                                      // add a dummy item of given size. unlike InvisibleButton(), Dummy() won't take the mouse click or be navigable into.
1193b4be Poul Sander 2025-02-03 21:28 506
    IMGUI_API void          Indent(float indent_w = 0.0f);                                  // move content position toward the right, by indent_w, or style.IndentSpacing if indent_w <= 0
1193b4be Poul Sander 2025-02-03 21:28 507
    IMGUI_API void          Unindent(float indent_w = 0.0f);                                // move content position back to the left, by indent_w, or style.IndentSpacing if indent_w <= 0
1193b4be Poul Sander 2025-02-03 21:28 508
    IMGUI_API void          BeginGroup();                                                   // lock horizontal starting position
1193b4be Poul Sander 2025-02-03 21:28 509
    IMGUI_API void          EndGroup();                                                     // unlock horizontal starting position + capture the whole group bounding box into one "item" (so you can use IsItemHovered() or layout primitives such as SameLine() on whole group, etc.)
1193b4be Poul Sander 2025-02-03 21:28 510
    IMGUI_API void          AlignTextToFramePadding();                                      // vertically align upcoming text baseline to FramePadding.y so that it will align properly to regularly framed items (call if you have text on a line before a framed item)
1193b4be Poul Sander 2025-02-03 21:28 511
    IMGUI_API float         GetTextLineHeight();                                            // ~ FontSize
1193b4be Poul Sander 2025-02-03 21:28 512
    IMGUI_API float         GetTextLineHeightWithSpacing();                                 // ~ FontSize + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of text)
1193b4be Poul Sander 2025-02-03 21:28 513
    IMGUI_API float         GetFrameHeight();                                               // ~ FontSize + style.FramePadding.y * 2
1193b4be Poul Sander 2025-02-03 21:28 514
    IMGUI_API float         GetFrameHeightWithSpacing();                                    // ~ FontSize + style.FramePadding.y * 2 + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets)
1193b4be Poul Sander 2025-02-03 21:28 515
1193b4be Poul Sander 2025-02-03 21:28 516
    // ID stack/scopes
1193b4be Poul Sander 2025-02-03 21:28 517
    // Read the FAQ (docs/FAQ.md or http://dearimgui.com/faq) for more details about how ID are handled in dear imgui.
1193b4be Poul Sander 2025-02-03 21:28 518
    // - Those questions are answered and impacted by understanding of the ID stack system:
1193b4be Poul Sander 2025-02-03 21:28 519
    //   - "Q: Why is my widget not reacting when I click on it?"
1193b4be Poul Sander 2025-02-03 21:28 520
    //   - "Q: How can I have widgets with an empty label?"
1193b4be Poul Sander 2025-02-03 21:28 521
    //   - "Q: How can I have multiple widgets with the same label?"
1193b4be Poul Sander 2025-02-03 21:28 522
    // - Short version: ID are hashes of the entire ID stack. If you are creating widgets in a loop you most likely
1193b4be Poul Sander 2025-02-03 21:28 523
    //   want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them.
1193b4be Poul Sander 2025-02-03 21:28 524
    // - You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
1193b4be Poul Sander 2025-02-03 21:28 525
    // - In this header file we use the "label"/"name" terminology to denote a string that will be displayed + used as an ID,
1193b4be Poul Sander 2025-02-03 21:28 526
    //   whereas "str_id" denote a string that is only used as an ID and not normally displayed.
1193b4be Poul Sander 2025-02-03 21:28 527
    IMGUI_API void          PushID(const char* str_id);                                     // push string into the ID stack (will hash string).
1193b4be Poul Sander 2025-02-03 21:28 528
    IMGUI_API void          PushID(const char* str_id_begin, const char* str_id_end);       // push string into the ID stack (will hash string).
1193b4be Poul Sander 2025-02-03 21:28 529
    IMGUI_API void          PushID(const void* ptr_id);                                     // push pointer into the ID stack (will hash pointer).
1193b4be Poul Sander 2025-02-03 21:28 530
    IMGUI_API void          PushID(int int_id);                                             // push integer into the ID stack (will hash integer).
1193b4be Poul Sander 2025-02-03 21:28 531
    IMGUI_API void          PopID();                                                        // pop from the ID stack.
1193b4be Poul Sander 2025-02-03 21:28 532
    IMGUI_API ImGuiID       GetID(const char* str_id);                                      // calculate unique ID (hash of whole ID stack + given parameter). e.g. if you want to query into ImGuiStorage yourself
1193b4be Poul Sander 2025-02-03 21:28 533
    IMGUI_API ImGuiID       GetID(const char* str_id_begin, const char* str_id_end);
1193b4be Poul Sander 2025-02-03 21:28 534
    IMGUI_API ImGuiID       GetID(const void* ptr_id);
1193b4be Poul Sander 2025-02-03 21:28 535
    IMGUI_API ImGuiID       GetID(int int_id);
1193b4be Poul Sander 2025-02-03 21:28 536
1193b4be Poul Sander 2025-02-03 21:28 537
    // Widgets: Text
1193b4be Poul Sander 2025-02-03 21:28 538
    IMGUI_API void          TextUnformatted(const char* text, const char* text_end = NULL); // raw text without formatting. Roughly equivalent to Text("%s", text) but: A) doesn't require null terminated string if 'text_end' is specified, B) it's faster, no memory copy is done, no buffer size limits, recommended for long chunks of text.
1193b4be Poul Sander 2025-02-03 21:28 539
    IMGUI_API void          Text(const char* fmt, ...)                                      IM_FMTARGS(1); // formatted text
1193b4be Poul Sander 2025-02-03 21:28 540
    IMGUI_API void          TextV(const char* fmt, va_list args)                            IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 541
    IMGUI_API void          TextColored(const ImVec4& col, const char* fmt, ...)            IM_FMTARGS(2); // shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor();
1193b4be Poul Sander 2025-02-03 21:28 542
    IMGUI_API void          TextColoredV(const ImVec4& col, const char* fmt, va_list args)  IM_FMTLIST(2);
1193b4be Poul Sander 2025-02-03 21:28 543
    IMGUI_API void          TextDisabled(const char* fmt, ...)                              IM_FMTARGS(1); // shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(fmt, ...); PopStyleColor();
1193b4be Poul Sander 2025-02-03 21:28 544
    IMGUI_API void          TextDisabledV(const char* fmt, va_list args)                    IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 545
    IMGUI_API void          TextWrapped(const char* fmt, ...)                               IM_FMTARGS(1); // shortcut for PushTextWrapPos(0.0f); 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().
1193b4be Poul Sander 2025-02-03 21:28 546
    IMGUI_API void          TextWrappedV(const char* fmt, va_list args)                     IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 547
    IMGUI_API void          LabelText(const char* label, const char* fmt, ...)              IM_FMTARGS(2); // display text+label aligned the same way as value+label widgets
1193b4be Poul Sander 2025-02-03 21:28 548
    IMGUI_API void          LabelTextV(const char* label, const char* fmt, va_list args)    IM_FMTLIST(2);
1193b4be Poul Sander 2025-02-03 21:28 549
    IMGUI_API void          BulletText(const char* fmt, ...)                                IM_FMTARGS(1); // shortcut for Bullet()+Text()
1193b4be Poul Sander 2025-02-03 21:28 550
    IMGUI_API void          BulletTextV(const char* fmt, va_list args)                      IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 551
    IMGUI_API void          SeparatorText(const char* label);                               // currently: formatted text with an horizontal line
1193b4be Poul Sander 2025-02-03 21:28 552
1193b4be Poul Sander 2025-02-03 21:28 553
    // Widgets: Main
1193b4be Poul Sander 2025-02-03 21:28 554
    // - Most widgets return true when the value has been changed or when pressed/selected
1193b4be Poul Sander 2025-02-03 21:28 555
    // - You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state.
1193b4be Poul Sander 2025-02-03 21:28 556
    IMGUI_API bool          Button(const char* label, const ImVec2& size = ImVec2(0, 0));   // button
1193b4be Poul Sander 2025-02-03 21:28 557
    IMGUI_API bool          SmallButton(const char* label);                                 // button with (FramePadding.y == 0) to easily embed within text
1193b4be Poul Sander 2025-02-03 21:28 558
    IMGUI_API bool          InvisibleButton(const char* str_id, const ImVec2& size, ImGuiButtonFlags flags = 0); // flexible button behavior without the visuals, frequently useful to build custom behaviors using the public api (along with IsItemActive, IsItemHovered, etc.)
1193b4be Poul Sander 2025-02-03 21:28 559
    IMGUI_API bool          ArrowButton(const char* str_id, ImGuiDir dir);                  // square button with an arrow shape
1193b4be Poul Sander 2025-02-03 21:28 560
    IMGUI_API bool          Checkbox(const char* label, bool* v);
1193b4be Poul Sander 2025-02-03 21:28 561
    IMGUI_API bool          CheckboxFlags(const char* label, int* flags, int flags_value);
1193b4be Poul Sander 2025-02-03 21:28 562
    IMGUI_API bool          CheckboxFlags(const char* label, unsigned int* flags, unsigned int flags_value);
1193b4be Poul Sander 2025-02-03 21:28 563
    IMGUI_API bool          RadioButton(const char* label, bool active);                    // use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; }
1193b4be Poul Sander 2025-02-03 21:28 564
    IMGUI_API bool          RadioButton(const char* label, int* v, int v_button);           // shortcut to handle the above pattern when value is an integer
1193b4be Poul Sander 2025-02-03 21:28 565
    IMGUI_API void          ProgressBar(float fraction, const ImVec2& size_arg = ImVec2(-FLT_MIN, 0), const char* overlay = NULL);
1193b4be Poul Sander 2025-02-03 21:28 566
    IMGUI_API void          Bullet();                                                       // draw a small circle + keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses
1193b4be Poul Sander 2025-02-03 21:28 567
    IMGUI_API bool          TextLink(const char* label);                                    // hyperlink text button, return true when clicked
1193b4be Poul Sander 2025-02-03 21:28 568
    IMGUI_API void          TextLinkOpenURL(const char* label, const char* url = NULL);     // hyperlink text button, automatically open file/url when clicked
1193b4be Poul Sander 2025-02-03 21:28 569
1193b4be Poul Sander 2025-02-03 21:28 570
    // Widgets: Images
1193b4be Poul Sander 2025-02-03 21:28 571
    // - Read about ImTextureID here: https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples
1193b4be Poul Sander 2025-02-03 21:28 572
    // - 'uv0' and 'uv1' are texture coordinates. Read about them from the same link above.
1193b4be Poul Sander 2025-02-03 21:28 573
    // - Note that Image() may add +2.0f to provided size if a border is visible, ImageButton() adds style.FramePadding*2.0f to provided size.
1193b4be Poul Sander 2025-02-03 21:28 574
    IMGUI_API void          Image(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& tint_col = ImVec4(1, 1, 1, 1), const ImVec4& border_col = ImVec4(0, 0, 0, 0));
1193b4be Poul Sander 2025-02-03 21:28 575
    IMGUI_API bool          ImageButton(const char* str_id, ImTextureID user_texture_id, 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));
1193b4be Poul Sander 2025-02-03 21:28 576
1193b4be Poul Sander 2025-02-03 21:28 577
    // Widgets: Combo Box (Dropdown)
1193b4be Poul Sander 2025-02-03 21:28 578
    // - The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.
1193b4be Poul Sander 2025-02-03 21:28 579
    // - The old Combo() api are helpers over BeginCombo()/EndCombo() which are kept available for convenience purpose. This is analogous to how ListBox are created.
1193b4be Poul Sander 2025-02-03 21:28 580
    IMGUI_API bool          BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 581
    IMGUI_API void          EndCombo(); // only call EndCombo() if BeginCombo() returns true!
1193b4be Poul Sander 2025-02-03 21:28 582
    IMGUI_API bool          Combo(const char* label, int* current_item, const char* const items[], int items_count, int popup_max_height_in_items = -1);
1193b4be Poul Sander 2025-02-03 21:28 583
    IMGUI_API bool          Combo(const char* label, int* current_item, const char* items_separated_by_zeros, int popup_max_height_in_items = -1);      // Separate items with \0 within a string, end item-list with \0\0. e.g. "One\0Two\0Three\0"
1193b4be Poul Sander 2025-02-03 21:28 584
    IMGUI_API bool          Combo(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), void* user_data, int items_count, int popup_max_height_in_items = -1);
1193b4be Poul Sander 2025-02-03 21:28 585
1193b4be Poul Sander 2025-02-03 21:28 586
    // Widgets: Drag Sliders
1193b4be Poul Sander 2025-02-03 21:28 587
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 588
    // - 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',
1193b4be Poul Sander 2025-02-03 21:28 589
    //   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
1193b4be Poul Sander 2025-02-03 21:28 590
    // - Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs; "Biscuit: %.0f" -> Biscuit: 1; etc.
1193b4be Poul Sander 2025-02-03 21:28 591
    // - Format string may also be set to NULL or use the default format ("%f" or "%d").
1193b4be Poul Sander 2025-02-03 21:28 592
    // - Speed are per-pixel of mouse movement (v_speed=0.2f: 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).
1193b4be Poul Sander 2025-02-03 21:28 593
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 594
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 595
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 596
    // - Legacy: Pre-1.78 there are DragXXX() function signatures that take a final `float power=1.0f' argument instead of the `ImGuiSliderFlags flags=0' argument.
1193b4be Poul Sander 2025-02-03 21:28 597
    //   If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
1193b4be Poul Sander 2025-02-03 21:28 598
    IMGUI_API bool          DragFloat(const char* label, float* v, float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0);     // If v_min >= v_max we have no bound
1193b4be Poul Sander 2025-02-03 21:28 599
    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);
1193b4be Poul Sander 2025-02-03 21:28 600
    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);
1193b4be Poul Sander 2025-02-03 21:28 601
    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);
1193b4be Poul Sander 2025-02-03 21:28 602
    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);
1193b4be Poul Sander 2025-02-03 21:28 603
    IMGUI_API bool          DragInt(const char* label, int* v, float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0);  // If v_min >= v_max we have no bound
1193b4be Poul Sander 2025-02-03 21:28 604
    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);
1193b4be Poul Sander 2025-02-03 21:28 605
    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);
1193b4be Poul Sander 2025-02-03 21:28 606
    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);
1193b4be Poul Sander 2025-02-03 21:28 607
    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);
1193b4be Poul Sander 2025-02-03 21:28 608
    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);
1193b4be Poul Sander 2025-02-03 21:28 609
    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);
1193b4be Poul Sander 2025-02-03 21:28 610
1193b4be Poul Sander 2025-02-03 21:28 611
    // Widgets: Regular Sliders
1193b4be Poul Sander 2025-02-03 21:28 612
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 613
    // - Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs; "Biscuit: %.0f" -> Biscuit: 1; etc.
1193b4be Poul Sander 2025-02-03 21:28 614
    // - Format string may also be set to NULL or use the default format ("%f" or "%d").
1193b4be Poul Sander 2025-02-03 21:28 615
    // - Legacy: Pre-1.78 there are SliderXXX() function signatures that take a final `float power=1.0f' argument instead of the `ImGuiSliderFlags flags=0' argument.
1193b4be Poul Sander 2025-02-03 21:28 616
    //   If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
1193b4be Poul Sander 2025-02-03 21:28 617
    IMGUI_API bool          SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);     // adjust format to decorate the value with a prefix or a suffix for in-slider labels or unit display.
1193b4be Poul Sander 2025-02-03 21:28 618
    IMGUI_API bool          SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 619
    IMGUI_API bool          SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 620
    IMGUI_API bool          SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 621
    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);
1193b4be Poul Sander 2025-02-03 21:28 622
    IMGUI_API bool          SliderInt(const char* label, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 623
    IMGUI_API bool          SliderInt2(const char* label, int v[2], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 624
    IMGUI_API bool          SliderInt3(const char* label, int v[3], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 625
    IMGUI_API bool          SliderInt4(const char* label, int v[4], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 626
    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);
1193b4be Poul Sander 2025-02-03 21:28 627
    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);
1193b4be Poul Sander 2025-02-03 21:28 628
    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);
1193b4be Poul Sander 2025-02-03 21:28 629
    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);
1193b4be Poul Sander 2025-02-03 21:28 630
    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);
1193b4be Poul Sander 2025-02-03 21:28 631
1193b4be Poul Sander 2025-02-03 21:28 632
    // Widgets: Input with Keyboard
1193b4be Poul Sander 2025-02-03 21:28 633
    // - If you want to use InputText() with std::string or any custom dynamic string type, see misc/cpp/imgui_stdlib.h and comments in imgui_demo.cpp.
1193b4be Poul Sander 2025-02-03 21:28 634
    // - Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc.
1193b4be Poul Sander 2025-02-03 21:28 635
    IMGUI_API bool          InputText(const char* label, char* buf, size_t buf_size, ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL);
1193b4be Poul Sander 2025-02-03 21:28 636
    IMGUI_API bool          InputTextMultiline(const char* label, char* buf, size_t buf_size, const ImVec2& size = ImVec2(0, 0), ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL);
1193b4be Poul Sander 2025-02-03 21:28 637
    IMGUI_API bool          InputTextWithHint(const char* label, const char* hint, char* buf, size_t buf_size, ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL);
1193b4be Poul Sander 2025-02-03 21:28 638
    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);
1193b4be Poul Sander 2025-02-03 21:28 639
    IMGUI_API bool          InputFloat2(const char* label, float v[2], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 640
    IMGUI_API bool          InputFloat3(const char* label, float v[3], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 641
    IMGUI_API bool          InputFloat4(const char* label, float v[4], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 642
    IMGUI_API bool          InputInt(const char* label, int* v, int step = 1, int step_fast = 100, ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 643
    IMGUI_API bool          InputInt2(const char* label, int v[2], ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 644
    IMGUI_API bool          InputInt3(const char* label, int v[3], ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 645
    IMGUI_API bool          InputInt4(const char* label, int v[4], ImGuiInputTextFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 646
    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);
1193b4be Poul Sander 2025-02-03 21:28 647
    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);
1193b4be Poul Sander 2025-02-03 21:28 648
    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);
1193b4be Poul Sander 2025-02-03 21:28 649
1193b4be Poul Sander 2025-02-03 21:28 650
    // 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.)
1193b4be Poul Sander 2025-02-03 21:28 651
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 652
    // - You can pass the address of a first float element out of a contiguous structure, e.g. &myvector.x
1193b4be Poul Sander 2025-02-03 21:28 653
    IMGUI_API bool          ColorEdit3(const char* label, float col[3], ImGuiColorEditFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 654
    IMGUI_API bool          ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 655
    IMGUI_API bool          ColorPicker3(const char* label, float col[3], ImGuiColorEditFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 656
    IMGUI_API bool          ColorPicker4(const char* label, float col[4], ImGuiColorEditFlags flags = 0, const float* ref_col = NULL);
1193b4be Poul Sander 2025-02-03 21:28 657
    IMGUI_API bool          ColorButton(const char* desc_id, const ImVec4& col, ImGuiColorEditFlags flags = 0, const ImVec2& size = ImVec2(0, 0)); // display a color square/button, hover for details, return true when pressed.
1193b4be Poul Sander 2025-02-03 21:28 658
    IMGUI_API void          SetColorEditOptions(ImGuiColorEditFlags flags);                     // initialize current options (generally on application startup) if you want to select a default format, picker type, etc. User will be able to change many settings, unless you pass the _NoOptions flag to your calls.
1193b4be Poul Sander 2025-02-03 21:28 659
1193b4be Poul Sander 2025-02-03 21:28 660
    // Widgets: Trees
1193b4be Poul Sander 2025-02-03 21:28 661
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 662
    IMGUI_API bool          TreeNode(const char* label);
1193b4be Poul Sander 2025-02-03 21:28 663
    IMGUI_API bool          TreeNode(const char* str_id, const char* fmt, ...) IM_FMTARGS(2);   // helper variation to easily decorelate 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().
1193b4be Poul Sander 2025-02-03 21:28 664
    IMGUI_API bool          TreeNode(const void* ptr_id, const char* fmt, ...) IM_FMTARGS(2);   // "
1193b4be Poul Sander 2025-02-03 21:28 665
    IMGUI_API bool          TreeNodeV(const char* str_id, const char* fmt, va_list args) IM_FMTLIST(2);
1193b4be Poul Sander 2025-02-03 21:28 666
    IMGUI_API bool          TreeNodeV(const void* ptr_id, const char* fmt, va_list args) IM_FMTLIST(2);
1193b4be Poul Sander 2025-02-03 21:28 667
    IMGUI_API bool          TreeNodeEx(const char* label, ImGuiTreeNodeFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 668
    IMGUI_API bool          TreeNodeEx(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3);
1193b4be Poul Sander 2025-02-03 21:28 669
    IMGUI_API bool          TreeNodeEx(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3);
1193b4be Poul Sander 2025-02-03 21:28 670
    IMGUI_API bool          TreeNodeExV(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3);
1193b4be Poul Sander 2025-02-03 21:28 671
    IMGUI_API bool          TreeNodeExV(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3);
1193b4be Poul Sander 2025-02-03 21:28 672
    IMGUI_API void          TreePush(const char* str_id);                                       // ~ Indent()+PushID(). Already called by TreeNode() when returning true, but you can call TreePush/TreePop yourself if desired.
1193b4be Poul Sander 2025-02-03 21:28 673
    IMGUI_API void          TreePush(const void* ptr_id);                                       // "
1193b4be Poul Sander 2025-02-03 21:28 674
    IMGUI_API void          TreePop();                                                          // ~ Unindent()+PopID()
1193b4be Poul Sander 2025-02-03 21:28 675
    IMGUI_API float         GetTreeNodeToLabelSpacing();                                        // horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode
1193b4be Poul Sander 2025-02-03 21:28 676
    IMGUI_API bool          CollapsingHeader(const char* label, ImGuiTreeNodeFlags flags = 0);  // if returning 'true' the header is open. doesn't indent nor push on ID stack. user doesn't have to call TreePop().
1193b4be Poul Sander 2025-02-03 21:28 677
    IMGUI_API bool          CollapsingHeader(const char* label, bool* p_visible, ImGuiTreeNodeFlags flags = 0); // when 'p_visible != NULL': if '*p_visible==true' display an additional small close button on upper right of the header which will set the bool to false when clicked, if '*p_visible==false' don't display the header.
1193b4be Poul Sander 2025-02-03 21:28 678
    IMGUI_API void          SetNextItemOpen(bool is_open, ImGuiCond cond = 0);                  // set next TreeNode/CollapsingHeader open state.
1193b4be Poul Sander 2025-02-03 21:28 679
    IMGUI_API void          SetNextItemStorageID(ImGuiID storage_id);                           // set id to use for open/close storage (default to same as item id).
1193b4be Poul Sander 2025-02-03 21:28 680
1193b4be Poul Sander 2025-02-03 21:28 681
    // Widgets: Selectables
1193b4be Poul Sander 2025-02-03 21:28 682
    // - A selectable highlights when hovered, and can display another color when selected.
1193b4be Poul Sander 2025-02-03 21:28 683
    // - Neighbors selectable extend their highlight bounds in order to leave no gap between them. This is so a series of selected Selectable appear contiguous.
1193b4be Poul Sander 2025-02-03 21:28 684
    IMGUI_API bool          Selectable(const char* label, bool selected = false, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0, 0)); // "bool selected" carry the selection state (read-only). Selectable() is clicked is returns true so you can modify your selection state. size.x==0.0: use remaining width, size.x>0.0: specify width. size.y==0.0: use label height, size.y>0.0: specify height
1193b4be Poul Sander 2025-02-03 21:28 685
    IMGUI_API bool          Selectable(const char* label, bool* p_selected, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0, 0));      // "bool* p_selected" point to the selection state (read-write), as a convenient helper.
1193b4be Poul Sander 2025-02-03 21:28 686
1193b4be Poul Sander 2025-02-03 21:28 687
    // Multi-selection system for Selectable(), Checkbox(), TreeNode() functions [BETA]
1193b4be Poul Sander 2025-02-03 21:28 688
    // - 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.
1193b4be Poul Sander 2025-02-03 21:28 689
    // - ImGuiSelectionUserData is often used to store your item index within the current view (but may store something else).
1193b4be Poul Sander 2025-02-03 21:28 690
    // - Read comments near ImGuiMultiSelectIO for instructions/details and see 'Demo->Widgets->Selection State & Multi-Select' for demo.
1193b4be Poul Sander 2025-02-03 21:28 691
    // - TreeNode() is technically supported but... using this correctly is more complicated. You need some sort of linear/random access to your tree,
1193b4be Poul Sander 2025-02-03 21:28 692
    //   which is suited to advanced trees setups already implementing filters and clipper. We will work simplifying the current demo.
1193b4be Poul Sander 2025-02-03 21:28 693
    // - '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.
1193b4be Poul Sander 2025-02-03 21:28 694
    IMGUI_API ImGuiMultiSelectIO*   BeginMultiSelect(ImGuiMultiSelectFlags flags, int selection_size = -1, int items_count = -1);
1193b4be Poul Sander 2025-02-03 21:28 695
    IMGUI_API ImGuiMultiSelectIO*   EndMultiSelect();
1193b4be Poul Sander 2025-02-03 21:28 696
    IMGUI_API void                  SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data);
1193b4be Poul Sander 2025-02-03 21:28 697
    IMGUI_API bool                  IsItemToggledSelection();                                   // Was the last item selection state toggled? Useful if you need the per-item information _before_ reaching EndMultiSelect(). We only returns toggle _event_ in order to handle clipping correctly.
1193b4be Poul Sander 2025-02-03 21:28 698
1193b4be Poul Sander 2025-02-03 21:28 699
    // Widgets: List Boxes
1193b4be Poul Sander 2025-02-03 21:28 700
    // - This is essentially a thin wrapper to using BeginChild/EndChild with the ImGuiChildFlags_FrameStyle flag for stylistic changes + displaying a label.
1193b4be Poul Sander 2025-02-03 21:28 701
    // - You can submit contents and manage your selection state however you want it, by creating e.g. Selectable() or any other items.
1193b4be Poul Sander 2025-02-03 21:28 702
    // - The simplified/old ListBox() api are helpers over BeginListBox()/EndListBox() which are kept available for convenience purpose. This is analoguous to how Combos are created.
1193b4be Poul Sander 2025-02-03 21:28 703
    // - Choose frame width:   size.x > 0.0f: custom  /  size.x < 0.0f or -FLT_MIN: right-align   /  size.x = 0.0f (default): use current ItemWidth
1193b4be Poul Sander 2025-02-03 21:28 704
    // - Choose frame height:  size.y > 0.0f: custom  /  size.y < 0.0f or -FLT_MIN: bottom-align  /  size.y = 0.0f (default): arbitrary default height which can fit ~7 items
1193b4be Poul Sander 2025-02-03 21:28 705
    IMGUI_API bool          BeginListBox(const char* label, const ImVec2& size = ImVec2(0, 0)); // open a framed scrolling region
1193b4be Poul Sander 2025-02-03 21:28 706
    IMGUI_API void          EndListBox();                                                       // only call EndListBox() if BeginListBox() returned true!
1193b4be Poul Sander 2025-02-03 21:28 707
    IMGUI_API bool          ListBox(const char* label, int* current_item, const char* const items[], int items_count, int height_in_items = -1);
1193b4be Poul Sander 2025-02-03 21:28 708
    IMGUI_API bool          ListBox(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), void* user_data, int items_count, int height_in_items = -1);
1193b4be Poul Sander 2025-02-03 21:28 709
1193b4be Poul Sander 2025-02-03 21:28 710
    // Widgets: Data Plotting
1193b4be Poul Sander 2025-02-03 21:28 711
    // - Consider using ImPlot (https://github.com/epezent/implot) which is much better!
1193b4be Poul Sander 2025-02-03 21:28 712
    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));
1193b4be Poul Sander 2025-02-03 21:28 713
    IMGUI_API void          PlotLines(const char* label, float(*values_getter)(void* data, int idx), void* data, 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));
1193b4be Poul Sander 2025-02-03 21:28 714
    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));
1193b4be Poul Sander 2025-02-03 21:28 715
    IMGUI_API void          PlotHistogram(const char* label, float (*values_getter)(void* data, int idx), void* data, 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));
1193b4be Poul Sander 2025-02-03 21:28 716
1193b4be Poul Sander 2025-02-03 21:28 717
    // Widgets: Value() Helpers.
1193b4be Poul Sander 2025-02-03 21:28 718
    // - 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)
1193b4be Poul Sander 2025-02-03 21:28 719
    IMGUI_API void          Value(const char* prefix, bool b);
1193b4be Poul Sander 2025-02-03 21:28 720
    IMGUI_API void          Value(const char* prefix, int v);
1193b4be Poul Sander 2025-02-03 21:28 721
    IMGUI_API void          Value(const char* prefix, unsigned int v);
1193b4be Poul Sander 2025-02-03 21:28 722
    IMGUI_API void          Value(const char* prefix, float v, const char* float_format = NULL);
1193b4be Poul Sander 2025-02-03 21:28 723
1193b4be Poul Sander 2025-02-03 21:28 724
    // Widgets: Menus
1193b4be Poul Sander 2025-02-03 21:28 725
    // - Use BeginMenuBar() on a window ImGuiWindowFlags_MenuBar to append to its menu bar.
1193b4be Poul Sander 2025-02-03 21:28 726
    // - Use BeginMainMenuBar() to create a menu bar at the top of the screen and append to it.
1193b4be Poul Sander 2025-02-03 21:28 727
    // - Use BeginMenu() to create a menu. You can call BeginMenu() multiple time with the same identifier to append more items to it.
1193b4be Poul Sander 2025-02-03 21:28 728
    // - Not that MenuItem() keyboardshortcuts are displayed as a convenience but _not processed_ by Dear ImGui at the moment.
1193b4be Poul Sander 2025-02-03 21:28 729
    IMGUI_API bool          BeginMenuBar();                                                     // append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).
1193b4be Poul Sander 2025-02-03 21:28 730
    IMGUI_API void          EndMenuBar();                                                       // only call EndMenuBar() if BeginMenuBar() returns true!
1193b4be Poul Sander 2025-02-03 21:28 731
    IMGUI_API bool          BeginMainMenuBar();                                                 // create and append to a full screen menu-bar.
1193b4be Poul Sander 2025-02-03 21:28 732
    IMGUI_API void          EndMainMenuBar();                                                   // only call EndMainMenuBar() if BeginMainMenuBar() returns true!
1193b4be Poul Sander 2025-02-03 21:28 733
    IMGUI_API bool          BeginMenu(const char* label, bool enabled = true);                  // create a sub-menu entry. only call EndMenu() if this returns true!
1193b4be Poul Sander 2025-02-03 21:28 734
    IMGUI_API void          EndMenu();                                                          // only call EndMenu() if BeginMenu() returns true!
1193b4be Poul Sander 2025-02-03 21:28 735
    IMGUI_API bool          MenuItem(const char* label, const char* shortcut = NULL, bool selected = false, bool enabled = true);  // return true when activated.
1193b4be Poul Sander 2025-02-03 21:28 736
    IMGUI_API bool          MenuItem(const char* label, const char* shortcut, bool* p_selected, bool enabled = true);              // return true when activated + toggle (*p_selected) if p_selected != NULL
1193b4be Poul Sander 2025-02-03 21:28 737
1193b4be Poul Sander 2025-02-03 21:28 738
    // Tooltips
1193b4be Poul Sander 2025-02-03 21:28 739
    // - Tooltips are windows following the mouse. They do not take focus away.
1193b4be Poul Sander 2025-02-03 21:28 740
    // - A tooltip window can contain items of any types.
1193b4be Poul Sander 2025-02-03 21:28 741
    // - SetTooltip() is more or less a shortcut for the 'if (BeginTooltip()) { Text(...); EndTooltip(); }' idiom (with a subtlety that it discard any previously submitted tooltip)
1193b4be Poul Sander 2025-02-03 21:28 742
    IMGUI_API bool          BeginTooltip();                                                     // begin/append a tooltip window.
1193b4be Poul Sander 2025-02-03 21:28 743
    IMGUI_API void          EndTooltip();                                                       // only call EndTooltip() if BeginTooltip()/BeginItemTooltip() returns true!
1193b4be Poul Sander 2025-02-03 21:28 744
    IMGUI_API void          SetTooltip(const char* fmt, ...) IM_FMTARGS(1);                     // set a text-only tooltip. Often used after a ImGui::IsItemHovered() check. Override any previous call to SetTooltip().
1193b4be Poul Sander 2025-02-03 21:28 745
    IMGUI_API void          SetTooltipV(const char* fmt, va_list args) IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 746
1193b4be Poul Sander 2025-02-03 21:28 747
    // Tooltips: helpers for showing a tooltip when hovering an item
1193b4be Poul Sander 2025-02-03 21:28 748
    // - BeginItemTooltip() is a shortcut for the 'if (IsItemHovered(ImGuiHoveredFlags_ForTooltip) && BeginTooltip())' idiom.
1193b4be Poul Sander 2025-02-03 21:28 749
    // - SetItemTooltip() is a shortcut for the 'if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) { SetTooltip(...); }' idiom.
1193b4be Poul Sander 2025-02-03 21:28 750
    // - 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'.
1193b4be Poul Sander 2025-02-03 21:28 751
    IMGUI_API bool          BeginItemTooltip();                                                 // begin/append a tooltip window if preceding item was hovered.
1193b4be Poul Sander 2025-02-03 21:28 752
    IMGUI_API void          SetItemTooltip(const char* fmt, ...) IM_FMTARGS(1);                 // set a text-only tooltip if preceding item was hovered. override any previous call to SetTooltip().
1193b4be Poul Sander 2025-02-03 21:28 753
    IMGUI_API void          SetItemTooltipV(const char* fmt, va_list args) IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 754
1193b4be Poul Sander 2025-02-03 21:28 755
    // Popups, Modals
1193b4be Poul Sander 2025-02-03 21:28 756
    //  - They block normal mouse hovering detection (and therefore most mouse interactions) behind them.
1193b4be Poul Sander 2025-02-03 21:28 757
    //  - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
1193b4be Poul Sander 2025-02-03 21:28 758
    //  - Their visibility state (~bool) is held internally instead of being held by the programmer as we are used to with regular Begin*() calls.
1193b4be Poul Sander 2025-02-03 21:28 759
    //  - The 3 properties above are related: we need to retain popup visibility state in the library because popups may be closed as any time.
1193b4be Poul Sander 2025-02-03 21:28 760
    //  - You can bypass the hovering restriction by using ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered().
1193b4be Poul Sander 2025-02-03 21:28 761
    //  - 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.
1193b4be Poul Sander 2025-02-03 21:28 762
    //    This is sometimes leading to confusing mistakes. May rework this in the future.
1193b4be Poul Sander 2025-02-03 21:28 763
    //  - BeginPopup(): query popup state, if open start appending into the window. Call EndPopup() afterwards if returned true. ImGuiWindowFlags are forwarded to the window.
1193b4be Poul Sander 2025-02-03 21:28 764
    //  - BeginPopupModal(): block every interaction behind the window, cannot be closed by user, add a dimming background, has a title bar.
1193b4be Poul Sander 2025-02-03 21:28 765
    IMGUI_API bool          BeginPopup(const char* str_id, ImGuiWindowFlags flags = 0);                         // return true if the popup is open, and you can start outputting to it.
1193b4be Poul Sander 2025-02-03 21:28 766
    IMGUI_API bool          BeginPopupModal(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0); // return true if the modal is open, and you can start outputting to it.
1193b4be Poul Sander 2025-02-03 21:28 767
    IMGUI_API void          EndPopup();                                                                         // only call EndPopup() if BeginPopupXXX() returns true!
1193b4be Poul Sander 2025-02-03 21:28 768
1193b4be Poul Sander 2025-02-03 21:28 769
    // Popups: open/close functions
1193b4be Poul Sander 2025-02-03 21:28 770
    //  - OpenPopup(): set popup state to open. ImGuiPopupFlags are available for opening options.
1193b4be Poul Sander 2025-02-03 21:28 771
    //  - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
1193b4be Poul Sander 2025-02-03 21:28 772
    //  - CloseCurrentPopup(): use inside the BeginPopup()/EndPopup() scope to close manually.
1193b4be Poul Sander 2025-02-03 21:28 773
    //  - CloseCurrentPopup() is called by default by Selectable()/MenuItem() when activated (FIXME: need some options).
1193b4be Poul Sander 2025-02-03 21:28 774
    //  - 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().
1193b4be Poul Sander 2025-02-03 21:28 775
    //  - Use IsWindowAppearing() after BeginPopup() to tell if a window just opened.
1193b4be Poul Sander 2025-02-03 21:28 776
    //  - IMPORTANT: Notice that for OpenPopupOnItemClick() we exceptionally default flags to 1 (== ImGuiPopupFlags_MouseButtonRight) for backward compatibility with older API taking 'int mouse_button = 1' parameter
1193b4be Poul Sander 2025-02-03 21:28 777
    IMGUI_API void          OpenPopup(const char* str_id, ImGuiPopupFlags popup_flags = 0);                     // call to mark popup as open (don't call every frame!).
1193b4be Poul Sander 2025-02-03 21:28 778
    IMGUI_API void          OpenPopup(ImGuiID id, ImGuiPopupFlags popup_flags = 0);                             // id overload to facilitate calling from nested stacks
1193b4be Poul Sander 2025-02-03 21:28 779
    IMGUI_API void          OpenPopupOnItemClick(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);   // 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)
1193b4be Poul Sander 2025-02-03 21:28 780
    IMGUI_API void          CloseCurrentPopup();                                                                // manually close the popup we have begin-ed into.
1193b4be Poul Sander 2025-02-03 21:28 781
1193b4be Poul Sander 2025-02-03 21:28 782
    // Popups: open+begin combined functions helpers
1193b4be Poul Sander 2025-02-03 21:28 783
    //  - Helpers to do OpenPopup+BeginPopup where the Open action is triggered by e.g. hovering an item and right-clicking.
1193b4be Poul Sander 2025-02-03 21:28 784
    //  - They are convenient to easily create context menus, hence the name.
1193b4be Poul Sander 2025-02-03 21:28 785
    //  - 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.
1193b4be Poul Sander 2025-02-03 21:28 786
    //  - IMPORTANT: Notice that we exceptionally default their flags to 1 (== ImGuiPopupFlags_MouseButtonRight) for backward compatibility with older API taking 'int mouse_button = 1' parameter, so if you add other flags remember to re-add the ImGuiPopupFlags_MouseButtonRight.
1193b4be Poul Sander 2025-02-03 21:28 787
    IMGUI_API bool          BeginPopupContextItem(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);  // open+begin popup when clicked on last item. Use str_id==NULL 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!
1193b4be Poul Sander 2025-02-03 21:28 788
    IMGUI_API bool          BeginPopupContextWindow(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);// open+begin popup when clicked on current window.
1193b4be Poul Sander 2025-02-03 21:28 789
    IMGUI_API bool          BeginPopupContextVoid(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);  // open+begin popup when clicked in void (where there are no windows).
1193b4be Poul Sander 2025-02-03 21:28 790
1193b4be Poul Sander 2025-02-03 21:28 791
    // Popups: query functions
1193b4be Poul Sander 2025-02-03 21:28 792
    //  - IsPopupOpen(): return true if the popup is open at the current BeginPopup() level of the popup stack.
1193b4be Poul Sander 2025-02-03 21:28 793
    //  - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId: return true if any popup is open at the current BeginPopup() level of the popup stack.
1193b4be Poul Sander 2025-02-03 21:28 794
    //  - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId + ImGuiPopupFlags_AnyPopupLevel: return true if any popup is open.
1193b4be Poul Sander 2025-02-03 21:28 795
    IMGUI_API bool          IsPopupOpen(const char* str_id, ImGuiPopupFlags flags = 0);                         // return true if the popup is open.
1193b4be Poul Sander 2025-02-03 21:28 796
1193b4be Poul Sander 2025-02-03 21:28 797
    // Tables
1193b4be Poul Sander 2025-02-03 21:28 798
    // - Full-featured replacement for old Columns API.
1193b4be Poul Sander 2025-02-03 21:28 799
    // - See Demo->Tables for demo code. See top of imgui_tables.cpp for general commentary.
1193b4be Poul Sander 2025-02-03 21:28 800
    // - See ImGuiTableFlags_ and ImGuiTableColumnFlags_ enums for a description of available flags.
1193b4be Poul Sander 2025-02-03 21:28 801
    // The typical call flow is:
1193b4be Poul Sander 2025-02-03 21:28 802
    // - 1. Call BeginTable(), early out if returning false.
1193b4be Poul Sander 2025-02-03 21:28 803
    // - 2. Optionally call TableSetupColumn() to submit column name/flags/defaults.
1193b4be Poul Sander 2025-02-03 21:28 804
    // - 3. Optionally call TableSetupScrollFreeze() to request scroll freezing of columns/rows.
1193b4be Poul Sander 2025-02-03 21:28 805
    // - 4. Optionally call TableHeadersRow() to submit a header row. Names are pulled from TableSetupColumn() data.
1193b4be Poul Sander 2025-02-03 21:28 806
    // - 5. Populate contents:
1193b4be Poul Sander 2025-02-03 21:28 807
    //    - In most situations you can use TableNextRow() + TableSetColumnIndex(N) to start appending into a column.
1193b4be Poul Sander 2025-02-03 21:28 808
    //    - If you are using tables as a sort of grid, where every column is holding the same type of contents,
1193b4be Poul Sander 2025-02-03 21:28 809
    //      you may prefer using TableNextColumn() instead of TableNextRow() + TableSetColumnIndex().
1193b4be Poul Sander 2025-02-03 21:28 810
    //      TableNextColumn() will automatically wrap-around into the next row if needed.
1193b4be Poul Sander 2025-02-03 21:28 811
    //    - IMPORTANT: Comparatively to the old Columns() API, we need to call TableNextColumn() for the first column!
1193b4be Poul Sander 2025-02-03 21:28 812
    //    - Summary of possible call flow:
1193b4be Poul Sander 2025-02-03 21:28 813
    //        - TableNextRow() -> TableSetColumnIndex(0) -> Text("Hello 0") -> TableSetColumnIndex(1) -> Text("Hello 1")  // OK
1193b4be Poul Sander 2025-02-03 21:28 814
    //        - TableNextRow() -> TableNextColumn()      -> Text("Hello 0") -> TableNextColumn()      -> Text("Hello 1")  // OK
1193b4be Poul Sander 2025-02-03 21:28 815
    //        -                   TableNextColumn()      -> Text("Hello 0") -> TableNextColumn()      -> Text("Hello 1")  // OK: TableNextColumn() automatically gets to next row!
1193b4be Poul Sander 2025-02-03 21:28 816
    //        - TableNextRow()                           -> Text("Hello 0")                                               // Not OK! Missing TableSetColumnIndex() or TableNextColumn()! Text will not appear!
1193b4be Poul Sander 2025-02-03 21:28 817
    // - 5. Call EndTable()
1193b4be Poul Sander 2025-02-03 21:28 818
    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);
1193b4be Poul Sander 2025-02-03 21:28 819
    IMGUI_API void          EndTable();                                         // only call EndTable() if BeginTable() returns true!
1193b4be Poul Sander 2025-02-03 21:28 820
    IMGUI_API void          TableNextRow(ImGuiTableRowFlags row_flags = 0, float min_row_height = 0.0f); // append into the first cell of a new row.
1193b4be Poul Sander 2025-02-03 21:28 821
    IMGUI_API bool          TableNextColumn();                                  // append into the next column (or first column of next row if currently in last column). Return true when column is visible.
1193b4be Poul Sander 2025-02-03 21:28 822
    IMGUI_API bool          TableSetColumnIndex(int column_n);                  // append into the specified column. Return true when column is visible.
1193b4be Poul Sander 2025-02-03 21:28 823
1193b4be Poul Sander 2025-02-03 21:28 824
    // Tables: Headers & Columns declaration
1193b4be Poul Sander 2025-02-03 21:28 825
    // - Use TableSetupColumn() to specify label, resizing policy, default width/weight, id, various other flags etc.
1193b4be Poul Sander 2025-02-03 21:28 826
    // - Use TableHeadersRow() to create a header row and automatically submit a TableHeader() for each column.
1193b4be Poul Sander 2025-02-03 21:28 827
    //   Headers are required to perform: reordering, sorting, and opening the context menu.
1193b4be Poul Sander 2025-02-03 21:28 828
    //   The context menu can also be made available in columns body using ImGuiTableFlags_ContextMenuInBody.
1193b4be Poul Sander 2025-02-03 21:28 829
    // - You may manually submit headers using TableNextRow() + TableHeader() calls, but this is only useful in
1193b4be Poul Sander 2025-02-03 21:28 830
    //   some advanced use cases (e.g. adding custom widgets in header row).
1193b4be Poul Sander 2025-02-03 21:28 831
    // - Use TableSetupScrollFreeze() to lock columns/rows so they stay visible when scrolled.
1193b4be Poul Sander 2025-02-03 21:28 832
    IMGUI_API void          TableSetupColumn(const char* label, ImGuiTableColumnFlags flags = 0, float init_width_or_weight = 0.0f, ImGuiID user_id = 0);
1193b4be Poul Sander 2025-02-03 21:28 833
    IMGUI_API void          TableSetupScrollFreeze(int cols, int rows);         // lock columns/rows so they stay visible when scrolled.
1193b4be Poul Sander 2025-02-03 21:28 834
    IMGUI_API void          TableHeader(const char* label);                     // submit one header cell manually (rarely used)
1193b4be Poul Sander 2025-02-03 21:28 835
    IMGUI_API void          TableHeadersRow();                                  // submit a row with headers cells based on data provided to TableSetupColumn() + submit context menu
1193b4be Poul Sander 2025-02-03 21:28 836
    IMGUI_API void          TableAngledHeadersRow();                            // submit a row with angled headers for every column with the ImGuiTableColumnFlags_AngledHeader flag. MUST BE FIRST ROW.
1193b4be Poul Sander 2025-02-03 21:28 837
1193b4be Poul Sander 2025-02-03 21:28 838
    // Tables: Sorting & Miscellaneous functions
1193b4be Poul Sander 2025-02-03 21:28 839
    // - Sorting: call TableGetSortSpecs() to retrieve latest sort specs for the table. NULL when not sorting.
1193b4be Poul Sander 2025-02-03 21:28 840
    //   When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have
1193b4be Poul Sander 2025-02-03 21:28 841
    //   changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting,
1193b4be Poul Sander 2025-02-03 21:28 842
    //   else you may wastefully sort your data every frame!
1193b4be Poul Sander 2025-02-03 21:28 843
    // - Functions args 'int column_n' treat the default value of -1 as the same as passing the current column index.
1193b4be Poul Sander 2025-02-03 21:28 844
    IMGUI_API ImGuiTableSortSpecs*  TableGetSortSpecs();                        // get latest sort specs for the table (NULL if not sorting).  Lifetime: don't hold on this pointer over multiple frames or past any subsequent call to BeginTable().
1193b4be Poul Sander 2025-02-03 21:28 845
    IMGUI_API int                   TableGetColumnCount();                      // return number of columns (value passed to BeginTable)
1193b4be Poul Sander 2025-02-03 21:28 846
    IMGUI_API int                   TableGetColumnIndex();                      // return current column index.
1193b4be Poul Sander 2025-02-03 21:28 847
    IMGUI_API int                   TableGetRowIndex();                         // return current row index.
1193b4be Poul Sander 2025-02-03 21:28 848
    IMGUI_API const char*           TableGetColumnName(int column_n = -1);      // return "" if column didn't have a name declared by TableSetupColumn(). Pass -1 to use current column.
1193b4be Poul Sander 2025-02-03 21:28 849
    IMGUI_API ImGuiTableColumnFlags TableGetColumnFlags(int column_n = -1);     // return column flags so you can query their Enabled/Visible/Sorted/Hovered status flags. Pass -1 to use current column.
1193b4be Poul Sander 2025-02-03 21:28 850
    IMGUI_API void                  TableSetColumnEnabled(int column_n, bool v);// change user accessible enabled/disabled state of a column. Set to false to hide the column. User can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody)
1193b4be Poul Sander 2025-02-03 21:28 851
    IMGUI_API int                   TableGetHoveredColumn();                    // return hovered column. return -1 when table is not hovered. return columns_count if the unused space at the right of visible columns is hovered. Can also use (TableGetColumnFlags() & ImGuiTableColumnFlags_IsHovered) instead.
1193b4be Poul Sander 2025-02-03 21:28 852
    IMGUI_API void                  TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n = -1);  // change the color of a cell, row, or column. See ImGuiTableBgTarget_ flags for details.
1193b4be Poul Sander 2025-02-03 21:28 853
1193b4be Poul Sander 2025-02-03 21:28 854
    // Legacy Columns API (prefer using Tables!)
1193b4be Poul Sander 2025-02-03 21:28 855
    // - You can also use SameLine(pos_x) to mimic simplified columns.
1193b4be Poul Sander 2025-02-03 21:28 856
    IMGUI_API void          Columns(int count = 1, const char* id = NULL, bool borders = true);
1193b4be Poul Sander 2025-02-03 21:28 857
    IMGUI_API void          NextColumn();                                                       // next column, defaults to current row or next row if the current row is finished
1193b4be Poul Sander 2025-02-03 21:28 858
    IMGUI_API int           GetColumnIndex();                                                   // get current column index
1193b4be Poul Sander 2025-02-03 21:28 859
    IMGUI_API float         GetColumnWidth(int column_index = -1);                              // get column width (in pixels). pass -1 to use current column
1193b4be Poul Sander 2025-02-03 21:28 860
    IMGUI_API void          SetColumnWidth(int column_index, float width);                      // set column width (in pixels). pass -1 to use current column
1193b4be Poul Sander 2025-02-03 21:28 861
    IMGUI_API float         GetColumnOffset(int column_index = -1);                             // get position of column line (in pixels, from the left side of the contents region). pass -1 to use current column, otherwise 0..GetColumnsCount() inclusive. column 0 is typically 0.0f
1193b4be Poul Sander 2025-02-03 21:28 862
    IMGUI_API void          SetColumnOffset(int column_index, float offset_x);                  // set position of column line (in pixels, from the left side of the contents region). pass -1 to use current column
1193b4be Poul Sander 2025-02-03 21:28 863
    IMGUI_API int           GetColumnsCount();
1193b4be Poul Sander 2025-02-03 21:28 864
1193b4be Poul Sander 2025-02-03 21:28 865
    // Tab Bars, Tabs
1193b4be Poul Sander 2025-02-03 21:28 866
    // - Note: Tabs are automatically created by the docking system (when in 'docking' branch). Use this to create tab bars/tabs yourself.
1193b4be Poul Sander 2025-02-03 21:28 867
    IMGUI_API bool          BeginTabBar(const char* str_id, ImGuiTabBarFlags flags = 0);        // create and append into a TabBar
1193b4be Poul Sander 2025-02-03 21:28 868
    IMGUI_API void          EndTabBar();                                                        // only call EndTabBar() if BeginTabBar() returns true!
1193b4be Poul Sander 2025-02-03 21:28 869
    IMGUI_API bool          BeginTabItem(const char* label, bool* p_open = NULL, ImGuiTabItemFlags flags = 0); // create a Tab. Returns true if the Tab is selected.
1193b4be Poul Sander 2025-02-03 21:28 870
    IMGUI_API void          EndTabItem();                                                       // only call EndTabItem() if BeginTabItem() returns true!
1193b4be Poul Sander 2025-02-03 21:28 871
    IMGUI_API bool          TabItemButton(const char* label, ImGuiTabItemFlags flags = 0);      // create a Tab behaving like a button. return true when clicked. cannot be selected in the tab bar.
1193b4be Poul Sander 2025-02-03 21:28 872
    IMGUI_API void          SetTabItemClosed(const char* tab_or_docked_window_label);           // notify TabBar or Docking system of a closed tab/window ahead (useful to reduce visual flicker on reorderable tab bars). For tab-bar: call after BeginTabBar() and before Tab submissions. Otherwise call with a window name.
1193b4be Poul Sander 2025-02-03 21:28 873
1193b4be Poul Sander 2025-02-03 21:28 874
    // Docking
1193b4be Poul Sander 2025-02-03 21:28 875
    // [BETA API] Enable with io.ConfigFlags |= ImGuiConfigFlags_DockingEnable.
1193b4be Poul Sander 2025-02-03 21:28 876
    // Note: You can use most Docking facilities without calling any API. You DO NOT need to call DockSpace() to use Docking!
1193b4be Poul Sander 2025-02-03 21:28 877
    // - Drag from window title bar or their tab to dock/undock. Hold SHIFT to disable docking.
1193b4be Poul Sander 2025-02-03 21:28 878
    // - Drag from window menu button (upper-left button) to undock an entire node (all windows).
1193b4be Poul Sander 2025-02-03 21:28 879
    // - When io.ConfigDockingWithShift == true, you instead need to hold SHIFT to enable docking.
1193b4be Poul Sander 2025-02-03 21:28 880
    // About dockspaces:
1193b4be Poul Sander 2025-02-03 21:28 881
    // - Use DockSpaceOverViewport() to create a window covering the screen or a specific viewport + a dockspace inside it.
1193b4be Poul Sander 2025-02-03 21:28 882
    //   This is often used with ImGuiDockNodeFlags_PassthruCentralNode to make it transparent.
1193b4be Poul Sander 2025-02-03 21:28 883
    // - Use DockSpace() to create an explicit dock node _within_ an existing window. See Docking demo for details.
1193b4be Poul Sander 2025-02-03 21:28 884
    // - Important: Dockspaces need to be submitted _before_ any window they can host. Submit it early in your frame!
1193b4be Poul Sander 2025-02-03 21:28 885
    // - Important: Dockspaces need to be kept alive if hidden, otherwise windows docked into it will be undocked.
1193b4be Poul Sander 2025-02-03 21:28 886
    //   e.g. if you have multiple tabs with a dockspace inside each tab: submit the non-visible dockspaces with ImGuiDockNodeFlags_KeepAliveOnly.
1193b4be Poul Sander 2025-02-03 21:28 887
    IMGUI_API ImGuiID       DockSpace(ImGuiID dockspace_id, const ImVec2& size = ImVec2(0, 0), ImGuiDockNodeFlags flags = 0, const ImGuiWindowClass* window_class = NULL);
1193b4be Poul Sander 2025-02-03 21:28 888
    IMGUI_API ImGuiID       DockSpaceOverViewport(ImGuiID dockspace_id = 0, const ImGuiViewport* viewport = NULL, ImGuiDockNodeFlags flags = 0, const ImGuiWindowClass* window_class = NULL);
1193b4be Poul Sander 2025-02-03 21:28 889
    IMGUI_API void          SetNextWindowDockID(ImGuiID dock_id, ImGuiCond cond = 0);           // set next window dock id
1193b4be Poul Sander 2025-02-03 21:28 890
    IMGUI_API void          SetNextWindowClass(const ImGuiWindowClass* window_class);           // set next window class (control docking compatibility + provide hints to platform backend via custom viewport flags and platform parent/child relationship)
1193b4be Poul Sander 2025-02-03 21:28 891
    IMGUI_API ImGuiID       GetWindowDockID();
1193b4be Poul Sander 2025-02-03 21:28 892
    IMGUI_API bool          IsWindowDocked();                                                   // is current window docked into another window?
1193b4be Poul Sander 2025-02-03 21:28 893
1193b4be Poul Sander 2025-02-03 21:28 894
    // Logging/Capture
1193b4be Poul Sander 2025-02-03 21:28 895
    // - All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.
1193b4be Poul Sander 2025-02-03 21:28 896
    IMGUI_API void          LogToTTY(int auto_open_depth = -1);                                 // start logging to tty (stdout)
1193b4be Poul Sander 2025-02-03 21:28 897
    IMGUI_API void          LogToFile(int auto_open_depth = -1, const char* filename = NULL);   // start logging to file
1193b4be Poul Sander 2025-02-03 21:28 898
    IMGUI_API void          LogToClipboard(int auto_open_depth = -1);                           // start logging to OS clipboard
1193b4be Poul Sander 2025-02-03 21:28 899
    IMGUI_API void          LogFinish();                                                        // stop logging (close file, etc.)
1193b4be Poul Sander 2025-02-03 21:28 900
    IMGUI_API void          LogButtons();                                                       // helper to display buttons for logging to tty/file/clipboard
1193b4be Poul Sander 2025-02-03 21:28 901
    IMGUI_API void          LogText(const char* fmt, ...) IM_FMTARGS(1);                        // pass text data straight to log (without being displayed)
1193b4be Poul Sander 2025-02-03 21:28 902
    IMGUI_API void          LogTextV(const char* fmt, va_list args) IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 903
1193b4be Poul Sander 2025-02-03 21:28 904
    // Drag and Drop
1193b4be Poul Sander 2025-02-03 21:28 905
    // - On source items, call BeginDragDropSource(), if it returns true also call SetDragDropPayload() + EndDragDropSource().
1193b4be Poul Sander 2025-02-03 21:28 906
    // - On target candidates, call BeginDragDropTarget(), if it returns true also call AcceptDragDropPayload() + EndDragDropTarget().
1193b4be Poul Sander 2025-02-03 21:28 907
    // - If you stop calling BeginDragDropSource() the payload is preserved however it won't have a preview tooltip (we currently display a fallback "..." tooltip, see #1725)
1193b4be Poul Sander 2025-02-03 21:28 908
    // - An item can be both drag source and drop target.
1193b4be Poul Sander 2025-02-03 21:28 909
    IMGUI_API bool          BeginDragDropSource(ImGuiDragDropFlags flags = 0);                                      // call after submitting an item which may be dragged. when this return true, you can call SetDragDropPayload() + EndDragDropSource()
1193b4be Poul Sander 2025-02-03 21:28 910
    IMGUI_API bool          SetDragDropPayload(const char* type, const void* data, size_t sz, ImGuiCond cond = 0);  // type is a user defined string of maximum 32 characters. Strings starting with '_' are reserved for dear imgui internal types. Data is copied and held by imgui. Return true when payload has been accepted.
1193b4be Poul Sander 2025-02-03 21:28 911
    IMGUI_API void          EndDragDropSource();                                                                    // only call EndDragDropSource() if BeginDragDropSource() returns true!
1193b4be Poul Sander 2025-02-03 21:28 912
    IMGUI_API bool                  BeginDragDropTarget();                                                          // call after submitting an item that may receive a payload. If this returns true, you can call AcceptDragDropPayload() + EndDragDropTarget()
1193b4be Poul Sander 2025-02-03 21:28 913
    IMGUI_API const ImGuiPayload*   AcceptDragDropPayload(const char* type, ImGuiDragDropFlags flags = 0);          // accept contents of a given type. If ImGuiDragDropFlags_AcceptBeforeDelivery is set you can peek into the payload before the mouse button is released.
1193b4be Poul Sander 2025-02-03 21:28 914
    IMGUI_API void                  EndDragDropTarget();                                                            // only call EndDragDropTarget() if BeginDragDropTarget() returns true!
1193b4be Poul Sander 2025-02-03 21:28 915
    IMGUI_API const ImGuiPayload*   GetDragDropPayload();                                                           // peek directly into the current payload from anywhere. returns NULL when drag and drop is finished or inactive. use ImGuiPayload::IsDataType() to test for the payload type.
1193b4be Poul Sander 2025-02-03 21:28 916
1193b4be Poul Sander 2025-02-03 21:28 917
    // Disabling [BETA API]
1193b4be Poul Sander 2025-02-03 21:28 918
    // - Disable all user interactions and dim items visuals (applying style.DisabledAlpha over current colors)
1193b4be Poul Sander 2025-02-03 21:28 919
    // - Those can be nested but it cannot be used to enable an already disabled section (a single BeginDisabled(true) in the stack is enough to keep everything disabled)
1193b4be Poul Sander 2025-02-03 21:28 920
    // - Tooltips windows by exception are opted out of disabling.
1193b4be Poul Sander 2025-02-03 21:28 921
    // - BeginDisabled(false)/EndDisabled() essentially does nothing but is provided to facilitate use of boolean expressions (as a micro-optimization: if you have tens of thousands of BeginDisabled(false)/EndDisabled() pairs, you might want to reformulate your code to avoid making those calls)
1193b4be Poul Sander 2025-02-03 21:28 922
    IMGUI_API void          BeginDisabled(bool disabled = true);
1193b4be Poul Sander 2025-02-03 21:28 923
    IMGUI_API void          EndDisabled();
1193b4be Poul Sander 2025-02-03 21:28 924
1193b4be Poul Sander 2025-02-03 21:28 925
    // Clipping
1193b4be Poul Sander 2025-02-03 21:28 926
    // - Mouse hovering is affected by ImGui::PushClipRect() calls, unlike direct calls to ImDrawList::PushClipRect() which are render only.
1193b4be Poul Sander 2025-02-03 21:28 927
    IMGUI_API void          PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect);
1193b4be Poul Sander 2025-02-03 21:28 928
    IMGUI_API void          PopClipRect();
1193b4be Poul Sander 2025-02-03 21:28 929
1193b4be Poul Sander 2025-02-03 21:28 930
    // Focus, Activation
1193b4be Poul Sander 2025-02-03 21:28 931
    IMGUI_API void          SetItemDefaultFocus();                                              // make last item the default focused item of of a newly appearing window.
1193b4be Poul Sander 2025-02-03 21:28 932
    IMGUI_API void          SetKeyboardFocusHere(int offset = 0);                               // focus keyboard on the next widget. Use positive 'offset' to access sub components of a multiple component widget. Use -1 to access previous widget.
1193b4be Poul Sander 2025-02-03 21:28 933
1193b4be Poul Sander 2025-02-03 21:28 934
    // Keyboard/Gamepad Navigation
1193b4be Poul Sander 2025-02-03 21:28 935
    IMGUI_API void          SetNavCursorVisible(bool visible);                                  // alter visibility of keyboard/gamepad cursor. by default: show when using an arrow key, hide when clicking with mouse.
1193b4be Poul Sander 2025-02-03 21:28 936
1193b4be Poul Sander 2025-02-03 21:28 937
    // Overlapping mode
1193b4be Poul Sander 2025-02-03 21:28 938
    IMGUI_API void          SetNextItemAllowOverlap();                                          // allow next item to be overlapped by a subsequent item. Useful with invisible buttons, selectable, treenode covering an area where subsequent items may need to be added. Note that both Selectable() and TreeNode() have dedicated flags doing this.
1193b4be Poul Sander 2025-02-03 21:28 939
1193b4be Poul Sander 2025-02-03 21:28 940
    // Item/Widgets Utilities and Query Functions
1193b4be Poul Sander 2025-02-03 21:28 941
    // - Most of the functions are referring to the previous Item that has been submitted.
1193b4be Poul Sander 2025-02-03 21:28 942
    // - See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions.
1193b4be Poul Sander 2025-02-03 21:28 943
    IMGUI_API bool          IsItemHovered(ImGuiHoveredFlags flags = 0);                         // is the last item hovered? (and usable, aka not blocked by a popup, etc.). See ImGuiHoveredFlags for more options.
1193b4be Poul Sander 2025-02-03 21:28 944
    IMGUI_API bool          IsItemActive();                                                     // is the last item active? (e.g. button being held, text field being edited. This will continuously return true while holding mouse button on an item. Items that don't interact will always return false)
1193b4be Poul Sander 2025-02-03 21:28 945
    IMGUI_API bool          IsItemFocused();                                                    // is the last item focused for keyboard/gamepad navigation?
1193b4be Poul Sander 2025-02-03 21:28 946
    IMGUI_API bool          IsItemClicked(ImGuiMouseButton mouse_button = 0);                   // is the last item hovered and mouse clicked on? (**)  == IsMouseClicked(mouse_button) && IsItemHovered()Important. (**) this is NOT equivalent to the behavior of e.g. Button(). Read comments in function definition.
1193b4be Poul Sander 2025-02-03 21:28 947
    IMGUI_API bool          IsItemVisible();                                                    // is the last item visible? (items may be out of sight because of clipping/scrolling)
1193b4be Poul Sander 2025-02-03 21:28 948
    IMGUI_API bool          IsItemEdited();                                                     // did the last item modify its underlying value this frame? or was pressed? This is generally the same as the "bool" return value of many widgets.
1193b4be Poul Sander 2025-02-03 21:28 949
    IMGUI_API bool          IsItemActivated();                                                  // was the last item just made active (item was previously inactive).
1193b4be Poul Sander 2025-02-03 21:28 950
    IMGUI_API bool          IsItemDeactivated();                                                // was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that require continuous editing.
1193b4be Poul Sander 2025-02-03 21:28 951
    IMGUI_API bool          IsItemDeactivatedAfterEdit();                                       // was the last item just made inactive and made a value change when it was active? (e.g. Slider/Drag moved). Useful for Undo/Redo patterns with widgets that require continuous editing. Note that you may get false positives (some widgets such as Combo()/ListBox()/Selectable() will return true even when clicking an already selected item).
1193b4be Poul Sander 2025-02-03 21:28 952
    IMGUI_API bool          IsItemToggledOpen();                                                // was the last item open state toggled? set by TreeNode().
1193b4be Poul Sander 2025-02-03 21:28 953
    IMGUI_API bool          IsAnyItemHovered();                                                 // is any item hovered?
1193b4be Poul Sander 2025-02-03 21:28 954
    IMGUI_API bool          IsAnyItemActive();                                                  // is any item active?
1193b4be Poul Sander 2025-02-03 21:28 955
    IMGUI_API bool          IsAnyItemFocused();                                                 // is any item focused?
1193b4be Poul Sander 2025-02-03 21:28 956
    IMGUI_API ImGuiID       GetItemID();                                                        // get ID of last item (~~ often same ImGui::GetID(label) beforehand)
1193b4be Poul Sander 2025-02-03 21:28 957
    IMGUI_API ImVec2        GetItemRectMin();                                                   // get upper-left bounding rectangle of the last item (screen space)
1193b4be Poul Sander 2025-02-03 21:28 958
    IMGUI_API ImVec2        GetItemRectMax();                                                   // get lower-right bounding rectangle of the last item (screen space)
1193b4be Poul Sander 2025-02-03 21:28 959
    IMGUI_API ImVec2        GetItemRectSize();                                                  // get size of last item
1193b4be Poul Sander 2025-02-03 21:28 960
1193b4be Poul Sander 2025-02-03 21:28 961
    // Viewports
1193b4be Poul Sander 2025-02-03 21:28 962
    // - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.
1193b4be Poul Sander 2025-02-03 21:28 963
    // - In 'docking' branch with multi-viewport enabled, we extend this concept to have multiple active viewports.
1193b4be Poul Sander 2025-02-03 21:28 964
    // - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode.
1193b4be Poul Sander 2025-02-03 21:28 965
    IMGUI_API ImGuiViewport* GetMainViewport();                                                 // return primary/default viewport. This can never be NULL.
1193b4be Poul Sander 2025-02-03 21:28 966
1193b4be Poul Sander 2025-02-03 21:28 967
    // Background/Foreground Draw Lists
1193b4be Poul Sander 2025-02-03 21:28 968
    IMGUI_API ImDrawList*   GetBackgroundDrawList(ImGuiViewport* viewport = NULL);              // get background draw list for the given viewport or viewport associated to the current window. this draw list will be the first rendering one. Useful to quickly draw shapes/text behind dear imgui contents.
1193b4be Poul Sander 2025-02-03 21:28 969
    IMGUI_API ImDrawList*   GetForegroundDrawList(ImGuiViewport* viewport = NULL);              // get foreground draw list for the given viewport or viewport associated to the current window. this draw list will be the top-most rendered one. Useful to quickly draw shapes/text over dear imgui contents.
1193b4be Poul Sander 2025-02-03 21:28 970
1193b4be Poul Sander 2025-02-03 21:28 971
    // Miscellaneous Utilities
1193b4be Poul Sander 2025-02-03 21:28 972
    IMGUI_API bool          IsRectVisible(const ImVec2& size);                                  // test if rectangle (of given size, starting from cursor position) is visible / not clipped.
1193b4be Poul Sander 2025-02-03 21:28 973
    IMGUI_API bool          IsRectVisible(const ImVec2& rect_min, const ImVec2& rect_max);      // test if rectangle (in screen space) is visible / not clipped. to perform coarse clipping on user's side.
1193b4be Poul Sander 2025-02-03 21:28 974
    IMGUI_API double        GetTime();                                                          // get global imgui time. incremented by io.DeltaTime every frame.
1193b4be Poul Sander 2025-02-03 21:28 975
    IMGUI_API int           GetFrameCount();                                                    // get global imgui frame count. incremented by 1 every frame.
1193b4be Poul Sander 2025-02-03 21:28 976
    IMGUI_API ImDrawListSharedData* GetDrawListSharedData();                                    // you may use this when creating your own ImDrawList instances.
1193b4be Poul Sander 2025-02-03 21:28 977
    IMGUI_API const char*   GetStyleColorName(ImGuiCol idx);                                    // get a string corresponding to the enum value (for display, saving, etc.).
1193b4be Poul Sander 2025-02-03 21:28 978
    IMGUI_API void          SetStateStorage(ImGuiStorage* storage);                             // replace current window storage with our own (if you want to manipulate it yourself, typically clear subsection of it)
1193b4be Poul Sander 2025-02-03 21:28 979
    IMGUI_API ImGuiStorage* GetStateStorage();
1193b4be Poul Sander 2025-02-03 21:28 980
1193b4be Poul Sander 2025-02-03 21:28 981
    // Text Utilities
1193b4be Poul Sander 2025-02-03 21:28 982
    IMGUI_API ImVec2        CalcTextSize(const char* text, const char* text_end = NULL, bool hide_text_after_double_hash = false, float wrap_width = -1.0f);
1193b4be Poul Sander 2025-02-03 21:28 983
1193b4be Poul Sander 2025-02-03 21:28 984
    // Color Utilities
1193b4be Poul Sander 2025-02-03 21:28 985
    IMGUI_API ImVec4        ColorConvertU32ToFloat4(ImU32 in);
1193b4be Poul Sander 2025-02-03 21:28 986
    IMGUI_API ImU32         ColorConvertFloat4ToU32(const ImVec4& in);
1193b4be Poul Sander 2025-02-03 21:28 987
    IMGUI_API void          ColorConvertRGBtoHSV(float r, float g, float b, float& out_h, float& out_s, float& out_v);
1193b4be Poul Sander 2025-02-03 21:28 988
    IMGUI_API void          ColorConvertHSVtoRGB(float h, float s, float v, float& out_r, float& out_g, float& out_b);
1193b4be Poul Sander 2025-02-03 21:28 989
1193b4be Poul Sander 2025-02-03 21:28 990
    // Inputs Utilities: Keyboard/Mouse/Gamepad
1193b4be Poul Sander 2025-02-03 21:28 991
    // - the ImGuiKey enum contains all possible keyboard, mouse and gamepad inputs (e.g. ImGuiKey_A, ImGuiKey_MouseLeft, ImGuiKey_GamepadDpadUp...).
1193b4be Poul Sander 2025-02-03 21:28 992
    // - before v1.87, we used ImGuiKey to carry native/user indices as defined by each backends. About use of those legacy ImGuiKey values:
1193b4be Poul Sander 2025-02-03 21:28 993
    //  - without IMGUI_DISABLE_OBSOLETE_KEYIO (legacy support): you can still use your legacy native/user indices (< 512) according to how your backend/engine stored them in io.KeysDown[], but need to cast them to ImGuiKey.
1193b4be Poul Sander 2025-02-03 21:28 994
    //  - with    IMGUI_DISABLE_OBSOLETE_KEYIO (this is the way forward): any use of ImGuiKey will assert with key < 512. GetKeyIndex() is pass-through and therefore deprecated (gone if IMGUI_DISABLE_OBSOLETE_KEYIO is defined).
1193b4be Poul Sander 2025-02-03 21:28 995
    IMGUI_API bool          IsKeyDown(ImGuiKey key);                                            // is key being held.
1193b4be Poul Sander 2025-02-03 21:28 996
    IMGUI_API bool          IsKeyPressed(ImGuiKey key, bool repeat = true);                     // was key pressed (went from !Down to Down)? if repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate
1193b4be Poul Sander 2025-02-03 21:28 997
    IMGUI_API bool          IsKeyReleased(ImGuiKey key);                                        // was key released (went from Down to !Down)?
1193b4be Poul Sander 2025-02-03 21:28 998
    IMGUI_API bool          IsKeyChordPressed(ImGuiKeyChord key_chord);                         // was key chord (mods + key) pressed, e.g. you can pass 'ImGuiMod_Ctrl | ImGuiKey_S' as a key-chord. This doesn't do any routing or focus check, please consider using Shortcut() function instead.
1193b4be Poul Sander 2025-02-03 21:28 999
    IMGUI_API int           GetKeyPressedAmount(ImGuiKey key, float repeat_delay, float rate);  // uses provided repeat rate/delay. return a count, most often 0 or 1 but might be >1 if RepeatRate is small enough that DeltaTime > RepeatRate
1193b4be Poul Sander 2025-02-03 21:28 1000
    IMGUI_API const char*   GetKeyName(ImGuiKey key);                                           // [DEBUG] returns English name of the key. Those names a provided for debugging purpose and are not meant to be saved persistently not compared.
1193b4be Poul Sander 2025-02-03 21:28 1001
    IMGUI_API void          SetNextFrameWantCaptureKeyboard(bool want_capture_keyboard);        // Override io.WantCaptureKeyboard flag next frame (said flag is left for your application to handle, typically when true it instructs your app to ignore inputs). e.g. force capture keyboard when your widget is being hovered. This is equivalent to setting "io.WantCaptureKeyboard = want_capture_keyboard"; after the next NewFrame() call.
1193b4be Poul Sander 2025-02-03 21:28 1002
1193b4be Poul Sander 2025-02-03 21:28 1003
    // Inputs Utilities: Shortcut Testing & Routing [BETA]
1193b4be Poul Sander 2025-02-03 21:28 1004
    // - ImGuiKeyChord = a ImGuiKey + optional ImGuiMod_Alt/ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Super.
1193b4be Poul Sander 2025-02-03 21:28 1005
    //       ImGuiKey_C                          // Accepted by functions taking ImGuiKey or ImGuiKeyChord arguments)
1193b4be Poul Sander 2025-02-03 21:28 1006
    //       ImGuiMod_Ctrl | ImGuiKey_C          // Accepted by functions taking ImGuiKeyChord arguments)
1193b4be Poul Sander 2025-02-03 21:28 1007
    //   only ImGuiMod_XXX values are legal to combine with an ImGuiKey. You CANNOT combine two ImGuiKey values.
1193b4be Poul Sander 2025-02-03 21:28 1008
    // - The general idea is that several callers may register interest in a shortcut, and only one owner gets it.
1193b4be Poul Sander 2025-02-03 21:28 1009
    //      Parent   -> call Shortcut(Ctrl+S)    // When Parent is focused, Parent gets the shortcut.
1193b4be Poul Sander 2025-02-03 21:28 1010
    //        Child1 -> call Shortcut(Ctrl+S)    // When Child1 is focused, Child1 gets the shortcut (Child1 overrides Parent shortcuts)
1193b4be Poul Sander 2025-02-03 21:28 1011
    //        Child2 -> no call                  // When Child2 is focused, Parent gets the shortcut.
1193b4be Poul Sander 2025-02-03 21:28 1012
    //   The whole system is order independent, so if Child1 makes its calls before Parent, results will be identical.
1193b4be Poul Sander 2025-02-03 21:28 1013
    //   This is an important property as it facilitate working with foreign code or larger codebase.
1193b4be Poul Sander 2025-02-03 21:28 1014
    // - To understand the difference:
1193b4be Poul Sander 2025-02-03 21:28 1015
    //   - IsKeyChordPressed() compares mods and call IsKeyPressed() -> function has no side-effect.
1193b4be Poul Sander 2025-02-03 21:28 1016
    //   - Shortcut() submits a route, routes are resolved, if it currently can be routed it calls IsKeyChordPressed() -> function has (desirable) side-effects as it can prevents another call from getting the route.
1193b4be Poul Sander 2025-02-03 21:28 1017
    // - Visualize registered routes in 'Metrics/Debugger->Inputs'.
1193b4be Poul Sander 2025-02-03 21:28 1018
    IMGUI_API bool          Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 1019
    IMGUI_API void          SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 1020
1193b4be Poul Sander 2025-02-03 21:28 1021
    // Inputs Utilities: Key/Input Ownership [BETA]
1193b4be Poul Sander 2025-02-03 21:28 1022
    // - One common use case would be to allow your items to disable standard inputs behaviors such
1193b4be Poul Sander 2025-02-03 21:28 1023
    //   as Tab or Alt key handling, Mouse Wheel scrolling, etc.
1193b4be Poul Sander 2025-02-03 21:28 1024
    //   e.g. Button(...); SetItemKeyOwner(ImGuiKey_MouseWheelY); to make hovering/activating a button disable wheel for scrolling.
1193b4be Poul Sander 2025-02-03 21:28 1025
    // - Reminder ImGuiKey enum include access to mouse buttons and gamepad, so key ownership can apply to them.
1193b4be Poul Sander 2025-02-03 21:28 1026
    // - Many related features are still in imgui_internal.h. For instance, most IsKeyXXX()/IsMouseXXX() functions have an owner-id-aware version.
1193b4be Poul Sander 2025-02-03 21:28 1027
    IMGUI_API void          SetItemKeyOwner(ImGuiKey key);                                      // Set key owner to last item ID if it is hovered or active. Equivalent to 'if (IsItemHovered() || IsItemActive()) { SetKeyOwner(key, GetItemID());'.
1193b4be Poul Sander 2025-02-03 21:28 1028
1193b4be Poul Sander 2025-02-03 21:28 1029
    // Inputs Utilities: Mouse
1193b4be Poul Sander 2025-02-03 21:28 1030
    // - To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.
1193b4be Poul Sander 2025-02-03 21:28 1031
    // - You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.
1193b4be Poul Sander 2025-02-03 21:28 1032
    // - Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see 'lock_threshold' and 'io.MouseDraggingThreshold')
1193b4be Poul Sander 2025-02-03 21:28 1033
    IMGUI_API bool          IsMouseDown(ImGuiMouseButton button);                               // is mouse button held?
1193b4be Poul Sander 2025-02-03 21:28 1034
    IMGUI_API bool          IsMouseClicked(ImGuiMouseButton button, bool repeat = false);       // did mouse button clicked? (went from !Down to Down). Same as GetMouseClickedCount() == 1.
1193b4be Poul Sander 2025-02-03 21:28 1035
    IMGUI_API bool          IsMouseReleased(ImGuiMouseButton button);                           // did mouse button released? (went from Down to !Down)
1193b4be Poul Sander 2025-02-03 21:28 1036
    IMGUI_API bool          IsMouseDoubleClicked(ImGuiMouseButton button);                      // did mouse button double-clicked? Same as GetMouseClickedCount() == 2. (note that a double-click will also report IsMouseClicked() == true)
1193b4be Poul Sander 2025-02-03 21:28 1037
    IMGUI_API int           GetMouseClickedCount(ImGuiMouseButton button);                      // return the number of successive mouse-clicks at the time where a click happen (otherwise 0).
1193b4be Poul Sander 2025-02-03 21:28 1038
    IMGUI_API bool          IsMouseHoveringRect(const ImVec2& r_min, const ImVec2& r_max, bool clip = true);// is mouse hovering given bounding rect (in screen space). clipped by current clipping settings, but disregarding of other consideration of focus/window ordering/popup-block.
1193b4be Poul Sander 2025-02-03 21:28 1039
    IMGUI_API bool          IsMousePosValid(const ImVec2* mouse_pos = NULL);                    // by convention we use (-FLT_MAX,-FLT_MAX) to denote that there is no mouse available
1193b4be Poul Sander 2025-02-03 21:28 1040
    IMGUI_API bool          IsAnyMouseDown();                                                   // [WILL OBSOLETE] is any mouse button held? This was designed for backends, but prefer having backend maintain a mask of held mouse buttons, because upcoming input queue system will make this invalid.
1193b4be Poul Sander 2025-02-03 21:28 1041
    IMGUI_API ImVec2        GetMousePos();                                                      // shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls
1193b4be Poul Sander 2025-02-03 21:28 1042
    IMGUI_API ImVec2        GetMousePosOnOpeningCurrentPopup();                                 // retrieve mouse position at the time of opening popup we have BeginPopup() into (helper to avoid user backing that value themselves)
1193b4be Poul Sander 2025-02-03 21:28 1043
    IMGUI_API bool          IsMouseDragging(ImGuiMouseButton button, float lock_threshold = -1.0f);         // is mouse dragging? (uses io.MouseDraggingThreshold if lock_threshold < 0.0f)
1193b4be Poul Sander 2025-02-03 21:28 1044
    IMGUI_API ImVec2        GetMouseDragDelta(ImGuiMouseButton button = 0, float lock_threshold = -1.0f);   // return the delta from the initial clicking position while the mouse button is pressed or was just released. This is locked and return 0.0f until the mouse moves past a distance threshold at least once (uses io.MouseDraggingThreshold if lock_threshold < 0.0f)
1193b4be Poul Sander 2025-02-03 21:28 1045
    IMGUI_API void          ResetMouseDragDelta(ImGuiMouseButton button = 0);                   //
1193b4be Poul Sander 2025-02-03 21:28 1046
    IMGUI_API ImGuiMouseCursor GetMouseCursor();                                                // get desired mouse cursor shape. Important: reset in ImGui::NewFrame(), this is updated during the frame. valid before Render(). If you use software rendering by setting io.MouseDrawCursor ImGui will render those for you
1193b4be Poul Sander 2025-02-03 21:28 1047
    IMGUI_API void          SetMouseCursor(ImGuiMouseCursor cursor_type);                       // set desired mouse cursor shape
1193b4be Poul Sander 2025-02-03 21:28 1048
    IMGUI_API void          SetNextFrameWantCaptureMouse(bool want_capture_mouse);              // Override io.WantCaptureMouse flag next frame (said flag is left for your application to handle, typical when true it instucts your app to ignore inputs). This is equivalent to setting "io.WantCaptureMouse = want_capture_mouse;" after the next NewFrame() call.
1193b4be Poul Sander 2025-02-03 21:28 1049
1193b4be Poul Sander 2025-02-03 21:28 1050
    // Clipboard Utilities
1193b4be Poul Sander 2025-02-03 21:28 1051
    // - Also see the LogToClipboard() function to capture GUI into clipboard, or easily output text data to the clipboard.
1193b4be Poul Sander 2025-02-03 21:28 1052
    IMGUI_API const char*   GetClipboardText();
1193b4be Poul Sander 2025-02-03 21:28 1053
    IMGUI_API void          SetClipboardText(const char* text);
1193b4be Poul Sander 2025-02-03 21:28 1054
1193b4be Poul Sander 2025-02-03 21:28 1055
    // Settings/.Ini Utilities
1193b4be Poul Sander 2025-02-03 21:28 1056
    // - The disk functions are automatically called if io.IniFilename != NULL (default is "imgui.ini").
1193b4be Poul Sander 2025-02-03 21:28 1057
    // - Set io.IniFilename to NULL to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually.
1193b4be Poul Sander 2025-02-03 21:28 1058
    // - Important: default value "imgui.ini" is relative to current working dir! Most apps will want to lock this to an absolute path (e.g. same path as executables).
1193b4be Poul Sander 2025-02-03 21:28 1059
    IMGUI_API void          LoadIniSettingsFromDisk(const char* ini_filename);                  // call after CreateContext() and before the first call to NewFrame(). NewFrame() automatically calls LoadIniSettingsFromDisk(io.IniFilename).
1193b4be Poul Sander 2025-02-03 21:28 1060
    IMGUI_API void          LoadIniSettingsFromMemory(const char* ini_data, size_t ini_size=0); // call after CreateContext() and before the first call to NewFrame() to provide .ini data from your own data source.
1193b4be Poul Sander 2025-02-03 21:28 1061
    IMGUI_API void          SaveIniSettingsToDisk(const char* ini_filename);                    // this is automatically called (if io.IniFilename is not empty) a few seconds after any modification that should be reflected in the .ini file (and also by DestroyContext).
1193b4be Poul Sander 2025-02-03 21:28 1062
    IMGUI_API const char*   SaveIniSettingsToMemory(size_t* out_ini_size = NULL);               // return a zero-terminated string with the .ini data which you can save by your own mean. call when io.WantSaveIniSettings is set, then save data by your own mean and clear io.WantSaveIniSettings.
1193b4be Poul Sander 2025-02-03 21:28 1063
1193b4be Poul Sander 2025-02-03 21:28 1064
    // Debug Utilities
1193b4be Poul Sander 2025-02-03 21:28 1065
    // - Your main debugging friend is the ShowMetricsWindow() function, which is also accessible from Demo->Tools->Metrics Debugger
1193b4be Poul Sander 2025-02-03 21:28 1066
    IMGUI_API void          DebugTextEncoding(const char* text);
1193b4be Poul Sander 2025-02-03 21:28 1067
    IMGUI_API void          DebugFlashStyleColor(ImGuiCol idx);
1193b4be Poul Sander 2025-02-03 21:28 1068
    IMGUI_API void          DebugStartItemPicker();
1193b4be Poul Sander 2025-02-03 21:28 1069
    IMGUI_API bool          DebugCheckVersionAndDataLayout(const char* version_str, size_t sz_io, size_t sz_style, size_t sz_vec2, size_t sz_vec4, size_t sz_drawvert, size_t sz_drawidx); // This is called by IMGUI_CHECKVERSION() macro.
1193b4be Poul Sander 2025-02-03 21:28 1070
#ifndef IMGUI_DISABLE_DEBUG_TOOLS
1193b4be Poul Sander 2025-02-03 21:28 1071
    IMGUI_API void          DebugLog(const char* fmt, ...)           IM_FMTARGS(1); // Call via IMGUI_DEBUG_LOG() for maximum stripping in caller code!
1193b4be Poul Sander 2025-02-03 21:28 1072
    IMGUI_API void          DebugLogV(const char* fmt, va_list args) IM_FMTLIST(1);
1193b4be Poul Sander 2025-02-03 21:28 1073
#endif
1193b4be Poul Sander 2025-02-03 21:28 1074
1193b4be Poul Sander 2025-02-03 21:28 1075
    // Memory Allocators
1193b4be Poul Sander 2025-02-03 21:28 1076
    // - Those functions are not reliant on the current context.
1193b4be Poul Sander 2025-02-03 21:28 1077
    // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
1193b4be Poul Sander 2025-02-03 21:28 1078
    //   for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details.
1193b4be Poul Sander 2025-02-03 21:28 1079
    IMGUI_API void          SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void* user_data = NULL);
1193b4be Poul Sander 2025-02-03 21:28 1080
    IMGUI_API void          GetAllocatorFunctions(ImGuiMemAllocFunc* p_alloc_func, ImGuiMemFreeFunc* p_free_func, void** p_user_data);
1193b4be Poul Sander 2025-02-03 21:28 1081
    IMGUI_API void*         MemAlloc(size_t size);
1193b4be Poul Sander 2025-02-03 21:28 1082
    IMGUI_API void          MemFree(void* ptr);
1193b4be Poul Sander 2025-02-03 21:28 1083
1193b4be Poul Sander 2025-02-03 21:28 1084
    // (Optional) Platform/OS interface for multi-viewport support
1193b4be Poul Sander 2025-02-03 21:28 1085
    // Read comments around the ImGuiPlatformIO structure for more details.
1193b4be Poul Sander 2025-02-03 21:28 1086
    // Note: You may use GetWindowViewport() to get the current viewport of the current window.
1193b4be Poul Sander 2025-02-03 21:28 1087
    IMGUI_API void              UpdatePlatformWindows();                                        // call in main loop. will call CreateWindow/ResizeWindow/etc. platform functions for each secondary viewport, and DestroyWindow for each inactive viewport.
1193b4be Poul Sander 2025-02-03 21:28 1088
    IMGUI_API void              RenderPlatformWindowsDefault(void* platform_render_arg = NULL, void* renderer_render_arg = NULL); // call in main loop. will call RenderWindow/SwapBuffers platform functions for each secondary viewport which doesn't have the ImGuiViewportFlags_Minimized flag set. May be reimplemented by user for custom rendering needs.
1193b4be Poul Sander 2025-02-03 21:28 1089
    IMGUI_API void              DestroyPlatformWindows();                                       // call DestroyWindow platform functions for all viewports. call from backend Shutdown() if you need to close platform windows before imgui shutdown. otherwise will be called by DestroyContext().
1193b4be Poul Sander 2025-02-03 21:28 1090
    IMGUI_API ImGuiViewport*    FindViewportByID(ImGuiID id);                                   // this is a helper for backends.
1193b4be Poul Sander 2025-02-03 21:28 1091
    IMGUI_API ImGuiViewport*    FindViewportByPlatformHandle(void* platform_handle);            // this is a helper for backends. the type platform_handle is decided by the backend (e.g. HWND, MyWindow*, GLFWwindow* etc.)
1193b4be Poul Sander 2025-02-03 21:28 1092
1193b4be Poul Sander 2025-02-03 21:28 1093
} // namespace ImGui
1193b4be Poul Sander 2025-02-03 21:28 1094
1193b4be Poul Sander 2025-02-03 21:28 1095
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 1096
// [SECTION] Flags & Enumerations
1193b4be Poul Sander 2025-02-03 21:28 1097
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 1098
1193b4be Poul Sander 2025-02-03 21:28 1099
// Flags for ImGui::Begin()
1193b4be Poul Sander 2025-02-03 21:28 1100
// (Those are per-window flags. There are shared flags in ImGuiIO: io.ConfigWindowsResizeFromEdges and io.ConfigWindowsMoveFromTitleBarOnly)
1193b4be Poul Sander 2025-02-03 21:28 1101
enum ImGuiWindowFlags_
1193b4be Poul Sander 2025-02-03 21:28 1102
{
1193b4be Poul Sander 2025-02-03 21:28 1103
    ImGuiWindowFlags_None                   = 0,
1193b4be Poul Sander 2025-02-03 21:28 1104
    ImGuiWindowFlags_NoTitleBar             = 1 << 0,   // Disable title-bar
1193b4be Poul Sander 2025-02-03 21:28 1105
    ImGuiWindowFlags_NoResize               = 1 << 1,   // Disable user resizing with the lower-right grip
1193b4be Poul Sander 2025-02-03 21:28 1106
    ImGuiWindowFlags_NoMove                 = 1 << 2,   // Disable user moving the window
1193b4be Poul Sander 2025-02-03 21:28 1107
    ImGuiWindowFlags_NoScrollbar            = 1 << 3,   // Disable scrollbars (window can still scroll with mouse or programmatically)
1193b4be Poul Sander 2025-02-03 21:28 1108
    ImGuiWindowFlags_NoScrollWithMouse      = 1 << 4,   // Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set.
1193b4be Poul Sander 2025-02-03 21:28 1109
    ImGuiWindowFlags_NoCollapse             = 1 << 5,   // Disable user collapsing window by double-clicking on it. Also referred to as Window Menu Button (e.g. within a docking node).
1193b4be Poul Sander 2025-02-03 21:28 1110
    ImGuiWindowFlags_AlwaysAutoResize       = 1 << 6,   // Resize every window to its content every frame
1193b4be Poul Sander 2025-02-03 21:28 1111
    ImGuiWindowFlags_NoBackground           = 1 << 7,   // Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
1193b4be Poul Sander 2025-02-03 21:28 1112
    ImGuiWindowFlags_NoSavedSettings        = 1 << 8,   // Never load/save settings in .ini file
1193b4be Poul Sander 2025-02-03 21:28 1113
    ImGuiWindowFlags_NoMouseInputs          = 1 << 9,   // Disable catching mouse, hovering test with pass through.
1193b4be Poul Sander 2025-02-03 21:28 1114
    ImGuiWindowFlags_MenuBar                = 1 << 10,  // Has a menu-bar
1193b4be Poul Sander 2025-02-03 21:28 1115
    ImGuiWindowFlags_HorizontalScrollbar    = 1 << 11,  // Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the "Horizontal Scrolling" section.
1193b4be Poul Sander 2025-02-03 21:28 1116
    ImGuiWindowFlags_NoFocusOnAppearing     = 1 << 12,  // Disable taking focus when transitioning from hidden to visible state
1193b4be Poul Sander 2025-02-03 21:28 1117
    ImGuiWindowFlags_NoBringToFrontOnFocus  = 1 << 13,  // Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)
1193b4be Poul Sander 2025-02-03 21:28 1118
    ImGuiWindowFlags_AlwaysVerticalScrollbar= 1 << 14,  // Always show vertical scrollbar (even if ContentSize.y < Size.y)
1193b4be Poul Sander 2025-02-03 21:28 1119
    ImGuiWindowFlags_AlwaysHorizontalScrollbar=1<< 15,  // Always show horizontal scrollbar (even if ContentSize.x < Size.x)
1193b4be Poul Sander 2025-02-03 21:28 1120
    ImGuiWindowFlags_NoNavInputs            = 1 << 16,  // No keyboard/gamepad navigation within the window
1193b4be Poul Sander 2025-02-03 21:28 1121
    ImGuiWindowFlags_NoNavFocus             = 1 << 17,  // No focusing toward this window with keyboard/gamepad navigation (e.g. skipped by CTRL+TAB)
1193b4be Poul Sander 2025-02-03 21:28 1122
    ImGuiWindowFlags_UnsavedDocument        = 1 << 18,  // Display a dot next to the title. When used in a tab/docking context, tab is selected when clicking the X + closure is not assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar.
1193b4be Poul Sander 2025-02-03 21:28 1123
    ImGuiWindowFlags_NoDocking              = 1 << 19,  // Disable docking of this window
1193b4be Poul Sander 2025-02-03 21:28 1124
    ImGuiWindowFlags_NoNav                  = ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,
1193b4be Poul Sander 2025-02-03 21:28 1125
    ImGuiWindowFlags_NoDecoration           = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoCollapse,
1193b4be Poul Sander 2025-02-03 21:28 1126
    ImGuiWindowFlags_NoInputs               = ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,
1193b4be Poul Sander 2025-02-03 21:28 1127
1193b4be Poul Sander 2025-02-03 21:28 1128
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 1129
    ImGuiWindowFlags_ChildWindow            = 1 << 24,  // Don't use! For internal use by BeginChild()
1193b4be Poul Sander 2025-02-03 21:28 1130
    ImGuiWindowFlags_Tooltip                = 1 << 25,  // Don't use! For internal use by BeginTooltip()
1193b4be Poul Sander 2025-02-03 21:28 1131
    ImGuiWindowFlags_Popup                  = 1 << 26,  // Don't use! For internal use by BeginPopup()
1193b4be Poul Sander 2025-02-03 21:28 1132
    ImGuiWindowFlags_Modal                  = 1 << 27,  // Don't use! For internal use by BeginPopupModal()
1193b4be Poul Sander 2025-02-03 21:28 1133
    ImGuiWindowFlags_ChildMenu              = 1 << 28,  // Don't use! For internal use by BeginMenu()
1193b4be Poul Sander 2025-02-03 21:28 1134
    ImGuiWindowFlags_DockNodeHost           = 1 << 29,  // Don't use! For internal use by Begin()/NewFrame()
1193b4be Poul Sander 2025-02-03 21:28 1135
1193b4be Poul Sander 2025-02-03 21:28 1136
    // Obsolete names
1193b4be Poul Sander 2025-02-03 21:28 1137
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1138
    ImGuiWindowFlags_AlwaysUseWindowPadding = 1 << 30,  // Obsoleted in 1.90.0: Use ImGuiChildFlags_AlwaysUseWindowPadding in BeginChild() call.
1193b4be Poul Sander 2025-02-03 21:28 1139
    ImGuiWindowFlags_NavFlattened           = 1 << 31,  // Obsoleted in 1.90.9: Use ImGuiChildFlags_NavFlattened in BeginChild() call.
1193b4be Poul Sander 2025-02-03 21:28 1140
#endif
1193b4be Poul Sander 2025-02-03 21:28 1141
};
1193b4be Poul Sander 2025-02-03 21:28 1142
1193b4be Poul Sander 2025-02-03 21:28 1143
// Flags for ImGui::BeginChild()
1193b4be Poul Sander 2025-02-03 21:28 1144
// (Legacy: bit 0 must always correspond to ImGuiChildFlags_Borders to be backward compatible with old API using 'bool border = false'.
1193b4be Poul Sander 2025-02-03 21:28 1145
// About using AutoResizeX/AutoResizeY flags:
1193b4be Poul Sander 2025-02-03 21:28 1146
// - May be combined with SetNextWindowSizeConstraints() to set a min/max size for each axis (see "Demo->Child->Auto-resize with Constraints").
1193b4be Poul Sander 2025-02-03 21:28 1147
// - Size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing.
1193b4be Poul Sander 2025-02-03 21:28 1148
//   - This allows BeginChild() to return false when not within boundaries (e.g. when scrolling), which is more optimal. BUT it won't update its auto-size while clipped.
1193b4be Poul Sander 2025-02-03 21:28 1149
//     While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional "resizing after becoming visible again" glitch.
1193b4be Poul Sander 2025-02-03 21:28 1150
//   - You may also use ImGuiChildFlags_AlwaysAutoResize to force an update even when child window is not in view.
1193b4be Poul Sander 2025-02-03 21:28 1151
//     HOWEVER PLEASE UNDERSTAND THAT DOING SO WILL PREVENT BeginChild() FROM EVER RETURNING FALSE, disabling benefits of coarse clipping.
1193b4be Poul Sander 2025-02-03 21:28 1152
enum ImGuiChildFlags_
1193b4be Poul Sander 2025-02-03 21:28 1153
{
1193b4be Poul Sander 2025-02-03 21:28 1154
    ImGuiChildFlags_None                    = 0,
1193b4be Poul Sander 2025-02-03 21:28 1155
    ImGuiChildFlags_Borders                 = 1 << 0,   // Show an outer border and enable WindowPadding. (IMPORTANT: this is always == 1 == true for legacy reason)
1193b4be Poul Sander 2025-02-03 21:28 1156
    ImGuiChildFlags_AlwaysUseWindowPadding  = 1 << 1,   // Pad with style.WindowPadding even if no border are drawn (no padding by default for non-bordered child windows because it makes more sense)
1193b4be Poul Sander 2025-02-03 21:28 1157
    ImGuiChildFlags_ResizeX                 = 1 << 2,   // Allow resize from right border (layout direction). Enable .ini saving (unless ImGuiWindowFlags_NoSavedSettings passed to window flags)
1193b4be Poul Sander 2025-02-03 21:28 1158
    ImGuiChildFlags_ResizeY                 = 1 << 3,   // Allow resize from bottom border (layout direction). "
1193b4be Poul Sander 2025-02-03 21:28 1159
    ImGuiChildFlags_AutoResizeX             = 1 << 4,   // Enable auto-resizing width. Read "IMPORTANT: Size measurement" details above.
1193b4be Poul Sander 2025-02-03 21:28 1160
    ImGuiChildFlags_AutoResizeY             = 1 << 5,   // Enable auto-resizing height. Read "IMPORTANT: Size measurement" details above.
1193b4be Poul Sander 2025-02-03 21:28 1161
    ImGuiChildFlags_AlwaysAutoResize        = 1 << 6,   // Combined with AutoResizeX/AutoResizeY. Always measure size even when child is hidden, always return true, always disable clipping optimization! NOT RECOMMENDED.
1193b4be Poul Sander 2025-02-03 21:28 1162
    ImGuiChildFlags_FrameStyle              = 1 << 7,   // Style the child window like a framed item: use FrameBg, FrameRounding, FrameBorderSize, FramePadding instead of ChildBg, ChildRounding, ChildBorderSize, WindowPadding.
1193b4be Poul Sander 2025-02-03 21:28 1163
    ImGuiChildFlags_NavFlattened            = 1 << 8,   // [BETA] Share focus scope, allow keyboard/gamepad navigation to cross over parent border to this child or between sibling child windows.
1193b4be Poul Sander 2025-02-03 21:28 1164
1193b4be Poul Sander 2025-02-03 21:28 1165
    // Obsolete names
1193b4be Poul Sander 2025-02-03 21:28 1166
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1167
    ImGuiChildFlags_Border                  = ImGuiChildFlags_Borders,  // Renamed in 1.91.1 (August 2024) for consistency.
1193b4be Poul Sander 2025-02-03 21:28 1168
#endif
1193b4be Poul Sander 2025-02-03 21:28 1169
};
1193b4be Poul Sander 2025-02-03 21:28 1170
1193b4be Poul Sander 2025-02-03 21:28 1171
// Flags for ImGui::PushItemFlag()
1193b4be Poul Sander 2025-02-03 21:28 1172
// (Those are shared by all items)
1193b4be Poul Sander 2025-02-03 21:28 1173
enum ImGuiItemFlags_
1193b4be Poul Sander 2025-02-03 21:28 1174
{
1193b4be Poul Sander 2025-02-03 21:28 1175
    ImGuiItemFlags_None                     = 0,        // (Default)
1193b4be Poul Sander 2025-02-03 21:28 1176
    ImGuiItemFlags_NoTabStop                = 1 << 0,   // false    // Disable keyboard tabbing. This is a "lighter" version of ImGuiItemFlags_NoNav.
1193b4be Poul Sander 2025-02-03 21:28 1177
    ImGuiItemFlags_NoNav                    = 1 << 1,   // false    // Disable any form of focusing (keyboard/gamepad directional navigation and SetKeyboardFocusHere() calls).
1193b4be Poul Sander 2025-02-03 21:28 1178
    ImGuiItemFlags_NoNavDefaultFocus        = 1 << 2,   // false    // Disable item being a candidate for default focus (e.g. used by title bar items).
1193b4be Poul Sander 2025-02-03 21:28 1179
    ImGuiItemFlags_ButtonRepeat             = 1 << 3,   // false    // Any button-like behavior will have repeat mode enabled (based on io.KeyRepeatDelay and io.KeyRepeatRate values). Note that you can also call IsItemActive() after any button to tell if it is being held.
1193b4be Poul Sander 2025-02-03 21:28 1180
    ImGuiItemFlags_AutoClosePopups          = 1 << 4,   // true     // MenuItem()/Selectable() automatically close their parent popup window.
1193b4be Poul Sander 2025-02-03 21:28 1181
    ImGuiItemFlags_AllowDuplicateId         = 1 << 5,   // false    // Allow submitting an item with the same identifier as an item already submitted this frame without triggering a warning tooltip if io.ConfigDebugHighlightIdConflicts is set.
1193b4be Poul Sander 2025-02-03 21:28 1182
};
1193b4be Poul Sander 2025-02-03 21:28 1183
1193b4be Poul Sander 2025-02-03 21:28 1184
// Flags for ImGui::InputText()
1193b4be Poul Sander 2025-02-03 21:28 1185
// (Those are per-item flags. There are shared flags in ImGuiIO: io.ConfigInputTextCursorBlink and io.ConfigInputTextEnterKeepActive)
1193b4be Poul Sander 2025-02-03 21:28 1186
enum ImGuiInputTextFlags_
1193b4be Poul Sander 2025-02-03 21:28 1187
{
1193b4be Poul Sander 2025-02-03 21:28 1188
    // Basic filters (also see ImGuiInputTextFlags_CallbackCharFilter)
1193b4be Poul Sander 2025-02-03 21:28 1189
    ImGuiInputTextFlags_None                = 0,
1193b4be Poul Sander 2025-02-03 21:28 1190
    ImGuiInputTextFlags_CharsDecimal        = 1 << 0,   // Allow 0123456789.+-*/
1193b4be Poul Sander 2025-02-03 21:28 1191
    ImGuiInputTextFlags_CharsHexadecimal    = 1 << 1,   // Allow 0123456789ABCDEFabcdef
1193b4be Poul Sander 2025-02-03 21:28 1192
    ImGuiInputTextFlags_CharsScientific     = 1 << 2,   // Allow 0123456789.+-*/eE (Scientific notation input)
1193b4be Poul Sander 2025-02-03 21:28 1193
    ImGuiInputTextFlags_CharsUppercase      = 1 << 3,   // Turn a..z into A..Z
1193b4be Poul Sander 2025-02-03 21:28 1194
    ImGuiInputTextFlags_CharsNoBlank        = 1 << 4,   // Filter out spaces, tabs
1193b4be Poul Sander 2025-02-03 21:28 1195
1193b4be Poul Sander 2025-02-03 21:28 1196
    // Inputs
1193b4be Poul Sander 2025-02-03 21:28 1197
    ImGuiInputTextFlags_AllowTabInput       = 1 << 5,   // Pressing TAB input a '\t' character into the text field
1193b4be Poul Sander 2025-02-03 21:28 1198
    ImGuiInputTextFlags_EnterReturnsTrue    = 1 << 6,   // Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider using IsItemDeactivatedAfterEdit() instead!
1193b4be Poul Sander 2025-02-03 21:28 1199
    ImGuiInputTextFlags_EscapeClearsAll     = 1 << 7,   // Escape key clears content if not empty, and deactivate otherwise (contrast to default behavior of Escape to revert)
1193b4be Poul Sander 2025-02-03 21:28 1200
    ImGuiInputTextFlags_CtrlEnterForNewLine = 1 << 8,   // In multi-line mode, validate with Enter, add new line with Ctrl+Enter (default is opposite: validate with Ctrl+Enter, add line with Enter).
1193b4be Poul Sander 2025-02-03 21:28 1201
1193b4be Poul Sander 2025-02-03 21:28 1202
    // Other options
1193b4be Poul Sander 2025-02-03 21:28 1203
    ImGuiInputTextFlags_ReadOnly            = 1 << 9,   // Read-only mode
1193b4be Poul Sander 2025-02-03 21:28 1204
    ImGuiInputTextFlags_Password            = 1 << 10,  // Password mode, display all characters as '*', disable copy
1193b4be Poul Sander 2025-02-03 21:28 1205
    ImGuiInputTextFlags_AlwaysOverwrite     = 1 << 11,  // Overwrite mode
1193b4be Poul Sander 2025-02-03 21:28 1206
    ImGuiInputTextFlags_AutoSelectAll       = 1 << 12,  // Select entire text when first taking mouse focus
1193b4be Poul Sander 2025-02-03 21:28 1207
    ImGuiInputTextFlags_ParseEmptyRefVal    = 1 << 13,  // InputFloat(), InputInt(), InputScalar() etc. only: parse empty string as zero value.
1193b4be Poul Sander 2025-02-03 21:28 1208
    ImGuiInputTextFlags_DisplayEmptyRefVal  = 1 << 14,  // InputFloat(), InputInt(), InputScalar() etc. only: when value is zero, do not display it. Generally used with ImGuiInputTextFlags_ParseEmptyRefVal.
1193b4be Poul Sander 2025-02-03 21:28 1209
    ImGuiInputTextFlags_NoHorizontalScroll  = 1 << 15,  // Disable following the cursor horizontally
1193b4be Poul Sander 2025-02-03 21:28 1210
    ImGuiInputTextFlags_NoUndoRedo          = 1 << 16,  // Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().
1193b4be Poul Sander 2025-02-03 21:28 1211
1193b4be Poul Sander 2025-02-03 21:28 1212
    // Callback features
1193b4be Poul Sander 2025-02-03 21:28 1213
    ImGuiInputTextFlags_CallbackCompletion  = 1 << 17,  // Callback on pressing TAB (for completion handling)
1193b4be Poul Sander 2025-02-03 21:28 1214
    ImGuiInputTextFlags_CallbackHistory     = 1 << 18,  // Callback on pressing Up/Down arrows (for history handling)
1193b4be Poul Sander 2025-02-03 21:28 1215
    ImGuiInputTextFlags_CallbackAlways      = 1 << 19,  // Callback on each iteration. User code may query cursor position, modify text buffer.
1193b4be Poul Sander 2025-02-03 21:28 1216
    ImGuiInputTextFlags_CallbackCharFilter  = 1 << 20,  // Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
1193b4be Poul Sander 2025-02-03 21:28 1217
    ImGuiInputTextFlags_CallbackResize      = 1 << 21,  // Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow. Notify when the string wants to be resized (for string types which hold a cache of their Size). You will be provided a new BufSize in the callback and NEED to honor it. (see misc/cpp/imgui_stdlib.h for an example of using this)
1193b4be Poul Sander 2025-02-03 21:28 1218
    ImGuiInputTextFlags_CallbackEdit        = 1 << 22,  // Callback on any edit (note that InputText() already returns true on edit, the callback is useful mainly to manipulate the underlying buffer while focus is active)
1193b4be Poul Sander 2025-02-03 21:28 1219
1193b4be Poul Sander 2025-02-03 21:28 1220
    // Obsolete names
1193b4be Poul Sander 2025-02-03 21:28 1221
    //ImGuiInputTextFlags_AlwaysInsertMode  = ImGuiInputTextFlags_AlwaysOverwrite   // [renamed in 1.82] name was not matching behavior
1193b4be Poul Sander 2025-02-03 21:28 1222
};
1193b4be Poul Sander 2025-02-03 21:28 1223
1193b4be Poul Sander 2025-02-03 21:28 1224
// Flags for ImGui::TreeNodeEx(), ImGui::CollapsingHeader*()
1193b4be Poul Sander 2025-02-03 21:28 1225
enum ImGuiTreeNodeFlags_
1193b4be Poul Sander 2025-02-03 21:28 1226
{
1193b4be Poul Sander 2025-02-03 21:28 1227
    ImGuiTreeNodeFlags_None                 = 0,
1193b4be Poul Sander 2025-02-03 21:28 1228
    ImGuiTreeNodeFlags_Selected             = 1 << 0,   // Draw as selected
1193b4be Poul Sander 2025-02-03 21:28 1229
    ImGuiTreeNodeFlags_Framed               = 1 << 1,   // Draw frame with background (e.g. for CollapsingHeader)
1193b4be Poul Sander 2025-02-03 21:28 1230
    ImGuiTreeNodeFlags_AllowOverlap         = 1 << 2,   // Hit testing to allow subsequent widgets to overlap this one
1193b4be Poul Sander 2025-02-03 21:28 1231
    ImGuiTreeNodeFlags_NoTreePushOnOpen     = 1 << 3,   // Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack
1193b4be Poul Sander 2025-02-03 21:28 1232
    ImGuiTreeNodeFlags_NoAutoOpenOnLog      = 1 << 4,   // Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)
1193b4be Poul Sander 2025-02-03 21:28 1233
    ImGuiTreeNodeFlags_DefaultOpen          = 1 << 5,   // Default node to be open
1193b4be Poul Sander 2025-02-03 21:28 1234
    ImGuiTreeNodeFlags_OpenOnDoubleClick    = 1 << 6,   // Open on double-click instead of simple click (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined.
1193b4be Poul Sander 2025-02-03 21:28 1235
    ImGuiTreeNodeFlags_OpenOnArrow          = 1 << 7,   // Open when clicking on the arrow part (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined.
1193b4be Poul Sander 2025-02-03 21:28 1236
    ImGuiTreeNodeFlags_Leaf                 = 1 << 8,   // No collapsing, no arrow (use as a convenience for leaf nodes).
1193b4be Poul Sander 2025-02-03 21:28 1237
    ImGuiTreeNodeFlags_Bullet               = 1 << 9,   // Display a bullet instead of arrow. IMPORTANT: node can still be marked open/close if you don't set the _Leaf flag!
1193b4be Poul Sander 2025-02-03 21:28 1238
    ImGuiTreeNodeFlags_FramePadding         = 1 << 10,  // Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding() before the node.
1193b4be Poul Sander 2025-02-03 21:28 1239
    ImGuiTreeNodeFlags_SpanAvailWidth       = 1 << 11,  // Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line without using AllowOverlap mode.
1193b4be Poul Sander 2025-02-03 21:28 1240
    ImGuiTreeNodeFlags_SpanFullWidth        = 1 << 12,  // Extend hit box to the left-most and right-most edges (cover the indent area).
1193b4be Poul Sander 2025-02-03 21:28 1241
    ImGuiTreeNodeFlags_SpanTextWidth        = 1 << 13,  // Narrow hit box + narrow hovering highlight, will only cover the label text.
1193b4be Poul Sander 2025-02-03 21:28 1242
    ImGuiTreeNodeFlags_SpanAllColumns       = 1 << 14,  // Frame will span all columns of its container table (text will still fit in current column)
1193b4be Poul Sander 2025-02-03 21:28 1243
    ImGuiTreeNodeFlags_NavLeftJumpsBackHere = 1 << 15,  // (WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)
1193b4be Poul Sander 2025-02-03 21:28 1244
    //ImGuiTreeNodeFlags_NoScrollOnOpen     = 1 << 16,  // FIXME: TODO: Disable automatic scroll on TreePop() if node got just open and contents is not visible
1193b4be Poul Sander 2025-02-03 21:28 1245
    ImGuiTreeNodeFlags_CollapsingHeader     = ImGuiTreeNodeFlags_Framed | ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_NoAutoOpenOnLog,
1193b4be Poul Sander 2025-02-03 21:28 1246
1193b4be Poul Sander 2025-02-03 21:28 1247
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1248
    ImGuiTreeNodeFlags_AllowItemOverlap     = ImGuiTreeNodeFlags_AllowOverlap,  // Renamed in 1.89.7
1193b4be Poul Sander 2025-02-03 21:28 1249
#endif
1193b4be Poul Sander 2025-02-03 21:28 1250
};
1193b4be Poul Sander 2025-02-03 21:28 1251
1193b4be Poul Sander 2025-02-03 21:28 1252
// Flags for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() functions.
1193b4be Poul Sander 2025-02-03 21:28 1253
// - To be backward compatible with older API which took an 'int mouse_button = 1' argument instead of 'ImGuiPopupFlags flags',
1193b4be Poul Sander 2025-02-03 21:28 1254
//   we need to treat small flags values as a mouse button index, so we encode the mouse button in the first few bits of the flags.
1193b4be Poul Sander 2025-02-03 21:28 1255
//   It is therefore guaranteed to be legal to pass a mouse button index in ImGuiPopupFlags.
1193b4be Poul Sander 2025-02-03 21:28 1256
// - For the same reason, we exceptionally default the ImGuiPopupFlags argument of BeginPopupContextXXX functions to 1 instead of 0.
1193b4be Poul Sander 2025-02-03 21:28 1257
//   IMPORTANT: because the default parameter is 1 (==ImGuiPopupFlags_MouseButtonRight), if you rely on the default parameter
1193b4be Poul Sander 2025-02-03 21:28 1258
//   and want to use another flag, you need to pass in the ImGuiPopupFlags_MouseButtonRight flag explicitly.
1193b4be Poul Sander 2025-02-03 21:28 1259
// - Multiple buttons currently cannot be combined/or-ed in those functions (we could allow it later).
1193b4be Poul Sander 2025-02-03 21:28 1260
enum ImGuiPopupFlags_
1193b4be Poul Sander 2025-02-03 21:28 1261
{
1193b4be Poul Sander 2025-02-03 21:28 1262
    ImGuiPopupFlags_None                    = 0,
1193b4be Poul Sander 2025-02-03 21:28 1263
    ImGuiPopupFlags_MouseButtonLeft         = 0,        // For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left)
1193b4be Poul Sander 2025-02-03 21:28 1264
    ImGuiPopupFlags_MouseButtonRight        = 1,        // For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right)
1193b4be Poul Sander 2025-02-03 21:28 1265
    ImGuiPopupFlags_MouseButtonMiddle       = 2,        // For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle)
1193b4be Poul Sander 2025-02-03 21:28 1266
    ImGuiPopupFlags_MouseButtonMask_        = 0x1F,
1193b4be Poul Sander 2025-02-03 21:28 1267
    ImGuiPopupFlags_MouseButtonDefault_     = 1,
1193b4be Poul Sander 2025-02-03 21:28 1268
    ImGuiPopupFlags_NoReopen                = 1 << 5,   // For OpenPopup*(), BeginPopupContext*(): don't reopen same popup if already open (won't reposition, won't reinitialize navigation)
1193b4be Poul Sander 2025-02-03 21:28 1269
    //ImGuiPopupFlags_NoReopenAlwaysNavInit = 1 << 6,   // For OpenPopup*(), BeginPopupContext*(): focus and initialize navigation even when not reopening.
1193b4be Poul Sander 2025-02-03 21:28 1270
    ImGuiPopupFlags_NoOpenOverExistingPopup = 1 << 7,   // For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack
1193b4be Poul Sander 2025-02-03 21:28 1271
    ImGuiPopupFlags_NoOpenOverItems         = 1 << 8,   // For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space
1193b4be Poul Sander 2025-02-03 21:28 1272
    ImGuiPopupFlags_AnyPopupId              = 1 << 10,  // For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.
1193b4be Poul Sander 2025-02-03 21:28 1273
    ImGuiPopupFlags_AnyPopupLevel           = 1 << 11,  // For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)
1193b4be Poul Sander 2025-02-03 21:28 1274
    ImGuiPopupFlags_AnyPopup                = ImGuiPopupFlags_AnyPopupId | ImGuiPopupFlags_AnyPopupLevel,
1193b4be Poul Sander 2025-02-03 21:28 1275
};
1193b4be Poul Sander 2025-02-03 21:28 1276
1193b4be Poul Sander 2025-02-03 21:28 1277
// Flags for ImGui::Selectable()
1193b4be Poul Sander 2025-02-03 21:28 1278
enum ImGuiSelectableFlags_
1193b4be Poul Sander 2025-02-03 21:28 1279
{
1193b4be Poul Sander 2025-02-03 21:28 1280
    ImGuiSelectableFlags_None               = 0,
1193b4be Poul Sander 2025-02-03 21:28 1281
    ImGuiSelectableFlags_NoAutoClosePopups  = 1 << 0,   // Clicking this doesn't close parent popup window (overrides ImGuiItemFlags_AutoClosePopups)
1193b4be Poul Sander 2025-02-03 21:28 1282
    ImGuiSelectableFlags_SpanAllColumns     = 1 << 1,   // Frame will span all columns of its container table (text will still fit in current column)
1193b4be Poul Sander 2025-02-03 21:28 1283
    ImGuiSelectableFlags_AllowDoubleClick   = 1 << 2,   // Generate press events on double clicks too
1193b4be Poul Sander 2025-02-03 21:28 1284
    ImGuiSelectableFlags_Disabled           = 1 << 3,   // Cannot be selected, display grayed out text
1193b4be Poul Sander 2025-02-03 21:28 1285
    ImGuiSelectableFlags_AllowOverlap       = 1 << 4,   // (WIP) Hit testing to allow subsequent widgets to overlap this one
1193b4be Poul Sander 2025-02-03 21:28 1286
    ImGuiSelectableFlags_Highlight          = 1 << 5,   // Make the item be displayed as if it is hovered
1193b4be Poul Sander 2025-02-03 21:28 1287
1193b4be Poul Sander 2025-02-03 21:28 1288
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1289
    ImGuiSelectableFlags_DontClosePopups    = ImGuiSelectableFlags_NoAutoClosePopups,   // Renamed in 1.91.0
1193b4be Poul Sander 2025-02-03 21:28 1290
    ImGuiSelectableFlags_AllowItemOverlap   = ImGuiSelectableFlags_AllowOverlap,        // Renamed in 1.89.7
1193b4be Poul Sander 2025-02-03 21:28 1291
#endif
1193b4be Poul Sander 2025-02-03 21:28 1292
};
1193b4be Poul Sander 2025-02-03 21:28 1293
1193b4be Poul Sander 2025-02-03 21:28 1294
// Flags for ImGui::BeginCombo()
1193b4be Poul Sander 2025-02-03 21:28 1295
enum ImGuiComboFlags_
1193b4be Poul Sander 2025-02-03 21:28 1296
{
1193b4be Poul Sander 2025-02-03 21:28 1297
    ImGuiComboFlags_None                    = 0,
1193b4be Poul Sander 2025-02-03 21:28 1298
    ImGuiComboFlags_PopupAlignLeft          = 1 << 0,   // Align the popup toward the left by default
1193b4be Poul Sander 2025-02-03 21:28 1299
    ImGuiComboFlags_HeightSmall             = 1 << 1,   // Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()
1193b4be Poul Sander 2025-02-03 21:28 1300
    ImGuiComboFlags_HeightRegular           = 1 << 2,   // Max ~8 items visible (default)
1193b4be Poul Sander 2025-02-03 21:28 1301
    ImGuiComboFlags_HeightLarge             = 1 << 3,   // Max ~20 items visible
1193b4be Poul Sander 2025-02-03 21:28 1302
    ImGuiComboFlags_HeightLargest           = 1 << 4,   // As many fitting items as possible
1193b4be Poul Sander 2025-02-03 21:28 1303
    ImGuiComboFlags_NoArrowButton           = 1 << 5,   // Display on the preview box without the square arrow button
1193b4be Poul Sander 2025-02-03 21:28 1304
    ImGuiComboFlags_NoPreview               = 1 << 6,   // Display only a square arrow button
1193b4be Poul Sander 2025-02-03 21:28 1305
    ImGuiComboFlags_WidthFitPreview         = 1 << 7,   // Width dynamically calculated from preview contents
1193b4be Poul Sander 2025-02-03 21:28 1306
    ImGuiComboFlags_HeightMask_             = ImGuiComboFlags_HeightSmall | ImGuiComboFlags_HeightRegular | ImGuiComboFlags_HeightLarge | ImGuiComboFlags_HeightLargest,
1193b4be Poul Sander 2025-02-03 21:28 1307
};
1193b4be Poul Sander 2025-02-03 21:28 1308
1193b4be Poul Sander 2025-02-03 21:28 1309
// Flags for ImGui::BeginTabBar()
1193b4be Poul Sander 2025-02-03 21:28 1310
enum ImGuiTabBarFlags_
1193b4be Poul Sander 2025-02-03 21:28 1311
{
1193b4be Poul Sander 2025-02-03 21:28 1312
    ImGuiTabBarFlags_None                           = 0,
1193b4be Poul Sander 2025-02-03 21:28 1313
    ImGuiTabBarFlags_Reorderable                    = 1 << 0,   // Allow manually dragging tabs to re-order them + New tabs are appended at the end of list
1193b4be Poul Sander 2025-02-03 21:28 1314
    ImGuiTabBarFlags_AutoSelectNewTabs              = 1 << 1,   // Automatically select new tabs when they appear
1193b4be Poul Sander 2025-02-03 21:28 1315
    ImGuiTabBarFlags_TabListPopupButton             = 1 << 2,   // Disable buttons to open the tab list popup
1193b4be Poul Sander 2025-02-03 21:28 1316
    ImGuiTabBarFlags_NoCloseWithMiddleMouseButton   = 1 << 3,   // Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
1193b4be Poul Sander 2025-02-03 21:28 1317
    ImGuiTabBarFlags_NoTabListScrollingButtons      = 1 << 4,   // Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)
1193b4be Poul Sander 2025-02-03 21:28 1318
    ImGuiTabBarFlags_NoTooltip                      = 1 << 5,   // Disable tooltips when hovering a tab
1193b4be Poul Sander 2025-02-03 21:28 1319
    ImGuiTabBarFlags_DrawSelectedOverline           = 1 << 6,   // Draw selected overline markers over selected tab
1193b4be Poul Sander 2025-02-03 21:28 1320
    ImGuiTabBarFlags_FittingPolicyResizeDown        = 1 << 7,   // Resize tabs when they don't fit
1193b4be Poul Sander 2025-02-03 21:28 1321
    ImGuiTabBarFlags_FittingPolicyScroll            = 1 << 8,   // Add scroll buttons when tabs don't fit
1193b4be Poul Sander 2025-02-03 21:28 1322
    ImGuiTabBarFlags_FittingPolicyMask_             = ImGuiTabBarFlags_FittingPolicyResizeDown | ImGuiTabBarFlags_FittingPolicyScroll,
1193b4be Poul Sander 2025-02-03 21:28 1323
    ImGuiTabBarFlags_FittingPolicyDefault_          = ImGuiTabBarFlags_FittingPolicyResizeDown,
1193b4be Poul Sander 2025-02-03 21:28 1324
};
1193b4be Poul Sander 2025-02-03 21:28 1325
1193b4be Poul Sander 2025-02-03 21:28 1326
// Flags for ImGui::BeginTabItem()
1193b4be Poul Sander 2025-02-03 21:28 1327
enum ImGuiTabItemFlags_
1193b4be Poul Sander 2025-02-03 21:28 1328
{
1193b4be Poul Sander 2025-02-03 21:28 1329
    ImGuiTabItemFlags_None                          = 0,
1193b4be Poul Sander 2025-02-03 21:28 1330
    ImGuiTabItemFlags_UnsavedDocument               = 1 << 0,   // Display a dot next to the title + set ImGuiTabItemFlags_NoAssumedClosure.
1193b4be Poul Sander 2025-02-03 21:28 1331
    ImGuiTabItemFlags_SetSelected                   = 1 << 1,   // Trigger flag to programmatically make the tab selected when calling BeginTabItem()
1193b4be Poul Sander 2025-02-03 21:28 1332
    ImGuiTabItemFlags_NoCloseWithMiddleMouseButton  = 1 << 2,   // Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
1193b4be Poul Sander 2025-02-03 21:28 1333
    ImGuiTabItemFlags_NoPushId                      = 1 << 3,   // Don't call PushID()/PopID() on BeginTabItem()/EndTabItem()
1193b4be Poul Sander 2025-02-03 21:28 1334
    ImGuiTabItemFlags_NoTooltip                     = 1 << 4,   // Disable tooltip for the given tab
1193b4be Poul Sander 2025-02-03 21:28 1335
    ImGuiTabItemFlags_NoReorder                     = 1 << 5,   // Disable reordering this tab or having another tab cross over this tab
1193b4be Poul Sander 2025-02-03 21:28 1336
    ImGuiTabItemFlags_Leading                       = 1 << 6,   // Enforce the tab position to the left of the tab bar (after the tab list popup button)
1193b4be Poul Sander 2025-02-03 21:28 1337
    ImGuiTabItemFlags_Trailing                      = 1 << 7,   // Enforce the tab position to the right of the tab bar (before the scrolling buttons)
1193b4be Poul Sander 2025-02-03 21:28 1338
    ImGuiTabItemFlags_NoAssumedClosure              = 1 << 8,   // Tab is selected when trying to close + closure is not immediately assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar.
1193b4be Poul Sander 2025-02-03 21:28 1339
};
1193b4be Poul Sander 2025-02-03 21:28 1340
1193b4be Poul Sander 2025-02-03 21:28 1341
// Flags for ImGui::IsWindowFocused()
1193b4be Poul Sander 2025-02-03 21:28 1342
enum ImGuiFocusedFlags_
1193b4be Poul Sander 2025-02-03 21:28 1343
{
1193b4be Poul Sander 2025-02-03 21:28 1344
    ImGuiFocusedFlags_None                          = 0,
1193b4be Poul Sander 2025-02-03 21:28 1345
    ImGuiFocusedFlags_ChildWindows                  = 1 << 0,   // Return true if any children of the window is focused
1193b4be Poul Sander 2025-02-03 21:28 1346
    ImGuiFocusedFlags_RootWindow                    = 1 << 1,   // Test from root window (top most parent of the current hierarchy)
1193b4be Poul Sander 2025-02-03 21:28 1347
    ImGuiFocusedFlags_AnyWindow                     = 1 << 2,   // Return true if any window is focused. Important: If you are trying to tell how to dispatch your low-level inputs, do NOT use this. Use 'io.WantCaptureMouse' instead! Please read the FAQ!
1193b4be Poul Sander 2025-02-03 21:28 1348
    ImGuiFocusedFlags_NoPopupHierarchy              = 1 << 3,   // Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow)
1193b4be Poul Sander 2025-02-03 21:28 1349
    ImGuiFocusedFlags_DockHierarchy                 = 1 << 4,   // Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow)
1193b4be Poul Sander 2025-02-03 21:28 1350
    ImGuiFocusedFlags_RootAndChildWindows           = ImGuiFocusedFlags_RootWindow | ImGuiFocusedFlags_ChildWindows,
1193b4be Poul Sander 2025-02-03 21:28 1351
};
1193b4be Poul Sander 2025-02-03 21:28 1352
1193b4be Poul Sander 2025-02-03 21:28 1353
// Flags for ImGui::IsItemHovered(), ImGui::IsWindowHovered()
1193b4be Poul Sander 2025-02-03 21:28 1354
// Note: if you are trying to check whether your mouse should be dispatched to Dear ImGui or to your app, you should use 'io.WantCaptureMouse' instead! Please read the FAQ!
1193b4be Poul Sander 2025-02-03 21:28 1355
// Note: windows with the ImGuiWindowFlags_NoInputs flag are ignored by IsWindowHovered() calls.
1193b4be Poul Sander 2025-02-03 21:28 1356
enum ImGuiHoveredFlags_
1193b4be Poul Sander 2025-02-03 21:28 1357
{
1193b4be Poul Sander 2025-02-03 21:28 1358
    ImGuiHoveredFlags_None                          = 0,        // Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them.
1193b4be Poul Sander 2025-02-03 21:28 1359
    ImGuiHoveredFlags_ChildWindows                  = 1 << 0,   // IsWindowHovered() only: Return true if any children of the window is hovered
1193b4be Poul Sander 2025-02-03 21:28 1360
    ImGuiHoveredFlags_RootWindow                    = 1 << 1,   // IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)
1193b4be Poul Sander 2025-02-03 21:28 1361
    ImGuiHoveredFlags_AnyWindow                     = 1 << 2,   // IsWindowHovered() only: Return true if any window is hovered
1193b4be Poul Sander 2025-02-03 21:28 1362
    ImGuiHoveredFlags_NoPopupHierarchy              = 1 << 3,   // IsWindowHovered() only: Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow)
1193b4be Poul Sander 2025-02-03 21:28 1363
    ImGuiHoveredFlags_DockHierarchy                 = 1 << 4,   // IsWindowHovered() only: Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow)
1193b4be Poul Sander 2025-02-03 21:28 1364
    ImGuiHoveredFlags_AllowWhenBlockedByPopup       = 1 << 5,   // Return true even if a popup window is normally blocking access to this item/window
1193b4be Poul Sander 2025-02-03 21:28 1365
    //ImGuiHoveredFlags_AllowWhenBlockedByModal     = 1 << 6,   // Return true even if a modal popup window is normally blocking access to this item/window. FIXME-TODO: Unavailable yet.
1193b4be Poul Sander 2025-02-03 21:28 1366
    ImGuiHoveredFlags_AllowWhenBlockedByActiveItem  = 1 << 7,   // Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
1193b4be Poul Sander 2025-02-03 21:28 1367
    ImGuiHoveredFlags_AllowWhenOverlappedByItem     = 1 << 8,   // IsItemHovered() only: Return true even if the item uses AllowOverlap mode and is overlapped by another hoverable item.
1193b4be Poul Sander 2025-02-03 21:28 1368
    ImGuiHoveredFlags_AllowWhenOverlappedByWindow   = 1 << 9,   // IsItemHovered() only: Return true even if the position is obstructed or overlapped by another window.
1193b4be Poul Sander 2025-02-03 21:28 1369
    ImGuiHoveredFlags_AllowWhenDisabled             = 1 << 10,  // IsItemHovered() only: Return true even if the item is disabled
1193b4be Poul Sander 2025-02-03 21:28 1370
    ImGuiHoveredFlags_NoNavOverride                 = 1 << 11,  // IsItemHovered() only: Disable using keyboard/gamepad navigation state when active, always query mouse
1193b4be Poul Sander 2025-02-03 21:28 1371
    ImGuiHoveredFlags_AllowWhenOverlapped           = ImGuiHoveredFlags_AllowWhenOverlappedByItem | ImGuiHoveredFlags_AllowWhenOverlappedByWindow,
1193b4be Poul Sander 2025-02-03 21:28 1372
    ImGuiHoveredFlags_RectOnly                      = ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenOverlapped,
1193b4be Poul Sander 2025-02-03 21:28 1373
    ImGuiHoveredFlags_RootAndChildWindows           = ImGuiHoveredFlags_RootWindow | ImGuiHoveredFlags_ChildWindows,
1193b4be Poul Sander 2025-02-03 21:28 1374
1193b4be Poul Sander 2025-02-03 21:28 1375
    // Tooltips mode
1193b4be Poul Sander 2025-02-03 21:28 1376
    // - typically used in IsItemHovered() + SetTooltip() sequence.
1193b4be Poul Sander 2025-02-03 21:28 1377
    // - this is a shortcut to pull flags from 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav' where you can reconfigure desired behavior.
1193b4be Poul Sander 2025-02-03 21:28 1378
    //   e.g. 'TooltipHoveredFlagsForMouse' defaults to 'ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort'.
1193b4be Poul Sander 2025-02-03 21:28 1379
    // - for frequently actioned or hovered items providing a tooltip, you want may to use ImGuiHoveredFlags_ForTooltip (stationary + delay) so the tooltip doesn't show too often.
1193b4be Poul Sander 2025-02-03 21:28 1380
    // - for items which main purpose is to be hovered, or items with low affordance, or in less consistent apps, prefer no delay or shorter delay.
1193b4be Poul Sander 2025-02-03 21:28 1381
    ImGuiHoveredFlags_ForTooltip                    = 1 << 12,  // Shortcut for standard flags when using IsItemHovered() + SetTooltip() sequence.
1193b4be Poul Sander 2025-02-03 21:28 1382
1193b4be Poul Sander 2025-02-03 21:28 1383
    // (Advanced) Mouse Hovering delays.
1193b4be Poul Sander 2025-02-03 21:28 1384
    // - generally you can use ImGuiHoveredFlags_ForTooltip to use application-standardized flags.
1193b4be Poul Sander 2025-02-03 21:28 1385
    // - use those if you need specific overrides.
1193b4be Poul Sander 2025-02-03 21:28 1386
    ImGuiHoveredFlags_Stationary                    = 1 << 13,  // Require mouse to be stationary for style.HoverStationaryDelay (~0.15 sec) _at least one time_. After this, can move on same item/window. Using the stationary test tends to reduces the need for a long delay.
1193b4be Poul Sander 2025-02-03 21:28 1387
    ImGuiHoveredFlags_DelayNone                     = 1 << 14,  // IsItemHovered() only: Return true immediately (default). As this is the default you generally ignore this.
1193b4be Poul Sander 2025-02-03 21:28 1388
    ImGuiHoveredFlags_DelayShort                    = 1 << 15,  // IsItemHovered() only: Return true after style.HoverDelayShort elapsed (~0.15 sec) (shared between items) + requires mouse to be stationary for style.HoverStationaryDelay (once per item).
1193b4be Poul Sander 2025-02-03 21:28 1389
    ImGuiHoveredFlags_DelayNormal                   = 1 << 16,  // IsItemHovered() only: Return true after style.HoverDelayNormal elapsed (~0.40 sec) (shared between items) + requires mouse to be stationary for style.HoverStationaryDelay (once per item).
1193b4be Poul Sander 2025-02-03 21:28 1390
    ImGuiHoveredFlags_NoSharedDelay                 = 1 << 17,  // IsItemHovered() only: Disable shared delay system where moving from one item to the next keeps the previous timer for a short time (standard for tooltips with long delays)
1193b4be Poul Sander 2025-02-03 21:28 1391
};
1193b4be Poul Sander 2025-02-03 21:28 1392
1193b4be Poul Sander 2025-02-03 21:28 1393
// Flags for ImGui::DockSpace(), shared/inherited by child nodes.
1193b4be Poul Sander 2025-02-03 21:28 1394
// (Some flags can be applied to individual nodes directly)
1193b4be Poul Sander 2025-02-03 21:28 1395
// FIXME-DOCK: Also see ImGuiDockNodeFlagsPrivate_ which may involve using the WIP and internal DockBuilder api.
1193b4be Poul Sander 2025-02-03 21:28 1396
enum ImGuiDockNodeFlags_
1193b4be Poul Sander 2025-02-03 21:28 1397
{
1193b4be Poul Sander 2025-02-03 21:28 1398
    ImGuiDockNodeFlags_None                         = 0,
1193b4be Poul Sander 2025-02-03 21:28 1399
    ImGuiDockNodeFlags_KeepAliveOnly                = 1 << 0,   //       // Don't display the dockspace node but keep it alive. Windows docked into this dockspace node won't be undocked.
1193b4be Poul Sander 2025-02-03 21:28 1400
    //ImGuiDockNodeFlags_NoCentralNode              = 1 << 1,   //       // Disable Central Node (the node which can stay empty)
1193b4be Poul Sander 2025-02-03 21:28 1401
    ImGuiDockNodeFlags_NoDockingOverCentralNode     = 1 << 2,   //       // Disable docking over the Central Node, which will be always kept empty.
1193b4be Poul Sander 2025-02-03 21:28 1402
    ImGuiDockNodeFlags_PassthruCentralNode          = 1 << 3,   //       // Enable passthru dockspace: 1) DockSpace() will render a ImGuiCol_WindowBg background covering everything excepted the Central Node when empty. Meaning the host window should probably use SetNextWindowBgAlpha(0.0f) prior to Begin() when using this. 2) When Central Node is empty: let inputs pass-through + won't display a DockingEmptyBg background. See demo for details.
1193b4be Poul Sander 2025-02-03 21:28 1403
    ImGuiDockNodeFlags_NoDockingSplit               = 1 << 4,   //       // Disable other windows/nodes from splitting this node.
1193b4be Poul Sander 2025-02-03 21:28 1404
    ImGuiDockNodeFlags_NoResize                     = 1 << 5,   // Saved // Disable resizing node using the splitter/separators. Useful with programmatically setup dockspaces.
1193b4be Poul Sander 2025-02-03 21:28 1405
    ImGuiDockNodeFlags_AutoHideTabBar               = 1 << 6,   //       // Tab bar will automatically hide when there is a single window in the dock node.
1193b4be Poul Sander 2025-02-03 21:28 1406
    ImGuiDockNodeFlags_NoUndocking                  = 1 << 7,   //       // Disable undocking this node.
1193b4be Poul Sander 2025-02-03 21:28 1407
1193b4be Poul Sander 2025-02-03 21:28 1408
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1409
    ImGuiDockNodeFlags_NoSplit                      = ImGuiDockNodeFlags_NoDockingSplit, // Renamed in 1.90
1193b4be Poul Sander 2025-02-03 21:28 1410
    ImGuiDockNodeFlags_NoDockingInCentralNode       = ImGuiDockNodeFlags_NoDockingOverCentralNode, // Renamed in 1.90
1193b4be Poul Sander 2025-02-03 21:28 1411
#endif
1193b4be Poul Sander 2025-02-03 21:28 1412
};
1193b4be Poul Sander 2025-02-03 21:28 1413
1193b4be Poul Sander 2025-02-03 21:28 1414
// Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload()
1193b4be Poul Sander 2025-02-03 21:28 1415
enum ImGuiDragDropFlags_
1193b4be Poul Sander 2025-02-03 21:28 1416
{
1193b4be Poul Sander 2025-02-03 21:28 1417
    ImGuiDragDropFlags_None                         = 0,
1193b4be Poul Sander 2025-02-03 21:28 1418
    // BeginDragDropSource() flags
1193b4be Poul Sander 2025-02-03 21:28 1419
    ImGuiDragDropFlags_SourceNoPreviewTooltip       = 1 << 0,   // Disable preview tooltip. By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disables this behavior.
1193b4be Poul Sander 2025-02-03 21:28 1420
    ImGuiDragDropFlags_SourceNoDisableHover         = 1 << 1,   // By default, when dragging we clear data so that IsItemHovered() will return false, to avoid subsequent user code submitting tooltips. This flag disables this behavior so you can still call IsItemHovered() on the source item.
1193b4be Poul Sander 2025-02-03 21:28 1421
    ImGuiDragDropFlags_SourceNoHoldToOpenOthers     = 1 << 2,   // Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
1193b4be Poul Sander 2025-02-03 21:28 1422
    ImGuiDragDropFlags_SourceAllowNullID            = 1 << 3,   // Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the dear imgui ecosystem and so we made it explicit.
1193b4be Poul Sander 2025-02-03 21:28 1423
    ImGuiDragDropFlags_SourceExtern                 = 1 << 4,   // External source (from outside of dear imgui), won't attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.
1193b4be Poul Sander 2025-02-03 21:28 1424
    ImGuiDragDropFlags_PayloadAutoExpire            = 1 << 5,   // Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
1193b4be Poul Sander 2025-02-03 21:28 1425
    ImGuiDragDropFlags_PayloadNoCrossContext        = 1 << 6,   // Hint to specify that the payload may not be copied outside current dear imgui context.
1193b4be Poul Sander 2025-02-03 21:28 1426
    ImGuiDragDropFlags_PayloadNoCrossProcess        = 1 << 7,   // Hint to specify that the payload may not be copied outside current process.
1193b4be Poul Sander 2025-02-03 21:28 1427
    // AcceptDragDropPayload() flags
1193b4be Poul Sander 2025-02-03 21:28 1428
    ImGuiDragDropFlags_AcceptBeforeDelivery         = 1 << 10,  // AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered.
1193b4be Poul Sander 2025-02-03 21:28 1429
    ImGuiDragDropFlags_AcceptNoDrawDefaultRect      = 1 << 11,  // Do not draw the default highlight rectangle when hovering over target.
1193b4be Poul Sander 2025-02-03 21:28 1430
    ImGuiDragDropFlags_AcceptNoPreviewTooltip       = 1 << 12,  // Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
1193b4be Poul Sander 2025-02-03 21:28 1431
    ImGuiDragDropFlags_AcceptPeekOnly               = ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoDrawDefaultRect, // For peeking ahead and inspecting the payload before delivery.
1193b4be Poul Sander 2025-02-03 21:28 1432
1193b4be Poul Sander 2025-02-03 21:28 1433
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1434
    ImGuiDragDropFlags_SourceAutoExpirePayload = ImGuiDragDropFlags_PayloadAutoExpire, // Renamed in 1.90.9
1193b4be Poul Sander 2025-02-03 21:28 1435
#endif
1193b4be Poul Sander 2025-02-03 21:28 1436
};
1193b4be Poul Sander 2025-02-03 21:28 1437
1193b4be Poul Sander 2025-02-03 21:28 1438
// Standard Drag and Drop payload types. You can define you own payload types using short strings. Types starting with '_' are defined by Dear ImGui.
1193b4be Poul Sander 2025-02-03 21:28 1439
#define IMGUI_PAYLOAD_TYPE_COLOR_3F     "_COL3F"    // float[3]: Standard type for colors, without alpha. User code may use this type.
1193b4be Poul Sander 2025-02-03 21:28 1440
#define IMGUI_PAYLOAD_TYPE_COLOR_4F     "_COL4F"    // float[4]: Standard type for colors. User code may use this type.
1193b4be Poul Sander 2025-02-03 21:28 1441
1193b4be Poul Sander 2025-02-03 21:28 1442
// A primary data type
1193b4be Poul Sander 2025-02-03 21:28 1443
enum ImGuiDataType_
1193b4be Poul Sander 2025-02-03 21:28 1444
{
1193b4be Poul Sander 2025-02-03 21:28 1445
    ImGuiDataType_S8,       // signed char / char (with sensible compilers)
1193b4be Poul Sander 2025-02-03 21:28 1446
    ImGuiDataType_U8,       // unsigned char
1193b4be Poul Sander 2025-02-03 21:28 1447
    ImGuiDataType_S16,      // short
1193b4be Poul Sander 2025-02-03 21:28 1448
    ImGuiDataType_U16,      // unsigned short
1193b4be Poul Sander 2025-02-03 21:28 1449
    ImGuiDataType_S32,      // int
1193b4be Poul Sander 2025-02-03 21:28 1450
    ImGuiDataType_U32,      // unsigned int
1193b4be Poul Sander 2025-02-03 21:28 1451
    ImGuiDataType_S64,      // long long / __int64
1193b4be Poul Sander 2025-02-03 21:28 1452
    ImGuiDataType_U64,      // unsigned long long / unsigned __int64
1193b4be Poul Sander 2025-02-03 21:28 1453
    ImGuiDataType_Float,    // float
1193b4be Poul Sander 2025-02-03 21:28 1454
    ImGuiDataType_Double,   // double
1193b4be Poul Sander 2025-02-03 21:28 1455
    ImGuiDataType_Bool,     // bool (provided for user convenience, not supported by scalar widgets)
1193b4be Poul Sander 2025-02-03 21:28 1456
    ImGuiDataType_COUNT
1193b4be Poul Sander 2025-02-03 21:28 1457
};
1193b4be Poul Sander 2025-02-03 21:28 1458
1193b4be Poul Sander 2025-02-03 21:28 1459
// A cardinal direction
1193b4be Poul Sander 2025-02-03 21:28 1460
enum ImGuiDir : int
1193b4be Poul Sander 2025-02-03 21:28 1461
{
1193b4be Poul Sander 2025-02-03 21:28 1462
    ImGuiDir_None    = -1,
1193b4be Poul Sander 2025-02-03 21:28 1463
    ImGuiDir_Left    = 0,
1193b4be Poul Sander 2025-02-03 21:28 1464
    ImGuiDir_Right   = 1,
1193b4be Poul Sander 2025-02-03 21:28 1465
    ImGuiDir_Up      = 2,
1193b4be Poul Sander 2025-02-03 21:28 1466
    ImGuiDir_Down    = 3,
1193b4be Poul Sander 2025-02-03 21:28 1467
    ImGuiDir_COUNT
1193b4be Poul Sander 2025-02-03 21:28 1468
};
1193b4be Poul Sander 2025-02-03 21:28 1469
1193b4be Poul Sander 2025-02-03 21:28 1470
// A sorting direction
1193b4be Poul Sander 2025-02-03 21:28 1471
enum ImGuiSortDirection : ImU8
1193b4be Poul Sander 2025-02-03 21:28 1472
{
1193b4be Poul Sander 2025-02-03 21:28 1473
    ImGuiSortDirection_None         = 0,
1193b4be Poul Sander 2025-02-03 21:28 1474
    ImGuiSortDirection_Ascending    = 1,    // Ascending = 0->9, A->Z etc.
1193b4be Poul Sander 2025-02-03 21:28 1475
    ImGuiSortDirection_Descending   = 2     // Descending = 9->0, Z->A etc.
1193b4be Poul Sander 2025-02-03 21:28 1476
};
1193b4be Poul Sander 2025-02-03 21:28 1477
1193b4be Poul Sander 2025-02-03 21:28 1478
// Since 1.90, defining IMGUI_DISABLE_OBSOLETE_FUNCTIONS automatically defines IMGUI_DISABLE_OBSOLETE_KEYIO as well.
1193b4be Poul Sander 2025-02-03 21:28 1479
#if defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS) && !defined(IMGUI_DISABLE_OBSOLETE_KEYIO)
1193b4be Poul Sander 2025-02-03 21:28 1480
#define IMGUI_DISABLE_OBSOLETE_KEYIO
1193b4be Poul Sander 2025-02-03 21:28 1481
#endif
1193b4be Poul Sander 2025-02-03 21:28 1482
1193b4be Poul Sander 2025-02-03 21:28 1483
// A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value): can represent Keyboard, Mouse and Gamepad values.
1193b4be Poul Sander 2025-02-03 21:28 1484
// All our named keys are >= 512. Keys value 0 to 511 are left unused as legacy native/opaque key values (< 1.87).
1193b4be Poul Sander 2025-02-03 21:28 1485
// Since >= 1.89 we increased typing (went from int to enum), some legacy code may need a cast to ImGuiKey.
1193b4be Poul Sander 2025-02-03 21:28 1486
// Read details about the 1.87 and 1.89 transition : https://github.com/ocornut/imgui/issues/4921
1193b4be Poul Sander 2025-02-03 21:28 1487
// Note that "Keys" related to physical keys and are not the same concept as input "Characters", the later are submitted via io.AddInputCharacter().
1193b4be Poul Sander 2025-02-03 21:28 1488
// The keyboard key enum values are named after the keys on a standard US keyboard, and on other keyboard types the keys reported may not match the keycaps.
1193b4be Poul Sander 2025-02-03 21:28 1489
enum ImGuiKey : int
1193b4be Poul Sander 2025-02-03 21:28 1490
{
1193b4be Poul Sander 2025-02-03 21:28 1491
    // Keyboard
1193b4be Poul Sander 2025-02-03 21:28 1492
    ImGuiKey_None = 0,
1193b4be Poul Sander 2025-02-03 21:28 1493
    ImGuiKey_Tab = 512,             // == ImGuiKey_NamedKey_BEGIN
1193b4be Poul Sander 2025-02-03 21:28 1494
    ImGuiKey_LeftArrow,
1193b4be Poul Sander 2025-02-03 21:28 1495
    ImGuiKey_RightArrow,
1193b4be Poul Sander 2025-02-03 21:28 1496
    ImGuiKey_UpArrow,
1193b4be Poul Sander 2025-02-03 21:28 1497
    ImGuiKey_DownArrow,
1193b4be Poul Sander 2025-02-03 21:28 1498
    ImGuiKey_PageUp,
1193b4be Poul Sander 2025-02-03 21:28 1499
    ImGuiKey_PageDown,
1193b4be Poul Sander 2025-02-03 21:28 1500
    ImGuiKey_Home,
1193b4be Poul Sander 2025-02-03 21:28 1501
    ImGuiKey_End,
1193b4be Poul Sander 2025-02-03 21:28 1502
    ImGuiKey_Insert,
1193b4be Poul Sander 2025-02-03 21:28 1503
    ImGuiKey_Delete,
1193b4be Poul Sander 2025-02-03 21:28 1504
    ImGuiKey_Backspace,
1193b4be Poul Sander 2025-02-03 21:28 1505
    ImGuiKey_Space,
1193b4be Poul Sander 2025-02-03 21:28 1506
    ImGuiKey_Enter,
1193b4be Poul Sander 2025-02-03 21:28 1507
    ImGuiKey_Escape,
1193b4be Poul Sander 2025-02-03 21:28 1508
    ImGuiKey_LeftCtrl, ImGuiKey_LeftShift, ImGuiKey_LeftAlt, ImGuiKey_LeftSuper,
1193b4be Poul Sander 2025-02-03 21:28 1509
    ImGuiKey_RightCtrl, ImGuiKey_RightShift, ImGuiKey_RightAlt, ImGuiKey_RightSuper,
1193b4be Poul Sander 2025-02-03 21:28 1510
    ImGuiKey_Menu,
1193b4be Poul Sander 2025-02-03 21:28 1511
    ImGuiKey_0, ImGuiKey_1, ImGuiKey_2, ImGuiKey_3, ImGuiKey_4, ImGuiKey_5, ImGuiKey_6, ImGuiKey_7, ImGuiKey_8, ImGuiKey_9,
1193b4be Poul Sander 2025-02-03 21:28 1512
    ImGuiKey_A, ImGuiKey_B, ImGuiKey_C, ImGuiKey_D, ImGuiKey_E, ImGuiKey_F, ImGuiKey_G, ImGuiKey_H, ImGuiKey_I, ImGuiKey_J,
1193b4be Poul Sander 2025-02-03 21:28 1513
    ImGuiKey_K, ImGuiKey_L, ImGuiKey_M, ImGuiKey_N, ImGuiKey_O, ImGuiKey_P, ImGuiKey_Q, ImGuiKey_R, ImGuiKey_S, ImGuiKey_T,
1193b4be Poul Sander 2025-02-03 21:28 1514
    ImGuiKey_U, ImGuiKey_V, ImGuiKey_W, ImGuiKey_X, ImGuiKey_Y, ImGuiKey_Z,
1193b4be Poul Sander 2025-02-03 21:28 1515
    ImGuiKey_F1, ImGuiKey_F2, ImGuiKey_F3, ImGuiKey_F4, ImGuiKey_F5, ImGuiKey_F6,
1193b4be Poul Sander 2025-02-03 21:28 1516
    ImGuiKey_F7, ImGuiKey_F8, ImGuiKey_F9, ImGuiKey_F10, ImGuiKey_F11, ImGuiKey_F12,
1193b4be Poul Sander 2025-02-03 21:28 1517
    ImGuiKey_F13, ImGuiKey_F14, ImGuiKey_F15, ImGuiKey_F16, ImGuiKey_F17, ImGuiKey_F18,
1193b4be Poul Sander 2025-02-03 21:28 1518
    ImGuiKey_F19, ImGuiKey_F20, ImGuiKey_F21, ImGuiKey_F22, ImGuiKey_F23, ImGuiKey_F24,
1193b4be Poul Sander 2025-02-03 21:28 1519
    ImGuiKey_Apostrophe,        // '
1193b4be Poul Sander 2025-02-03 21:28 1520
    ImGuiKey_Comma,             // ,
1193b4be Poul Sander 2025-02-03 21:28 1521
    ImGuiKey_Minus,             // -
1193b4be Poul Sander 2025-02-03 21:28 1522
    ImGuiKey_Period,            // .
1193b4be Poul Sander 2025-02-03 21:28 1523
    ImGuiKey_Slash,             // /
1193b4be Poul Sander 2025-02-03 21:28 1524
    ImGuiKey_Semicolon,         // ;
1193b4be Poul Sander 2025-02-03 21:28 1525
    ImGuiKey_Equal,             // =
1193b4be Poul Sander 2025-02-03 21:28 1526
    ImGuiKey_LeftBracket,       // [
1193b4be Poul Sander 2025-02-03 21:28 1527
    ImGuiKey_Backslash,         // \ (this text inhibit multiline comment caused by backslash)
1193b4be Poul Sander 2025-02-03 21:28 1528
    ImGuiKey_RightBracket,      // ]
1193b4be Poul Sander 2025-02-03 21:28 1529
    ImGuiKey_GraveAccent,       // `
1193b4be Poul Sander 2025-02-03 21:28 1530
    ImGuiKey_CapsLock,
1193b4be Poul Sander 2025-02-03 21:28 1531
    ImGuiKey_ScrollLock,
1193b4be Poul Sander 2025-02-03 21:28 1532
    ImGuiKey_NumLock,
1193b4be Poul Sander 2025-02-03 21:28 1533
    ImGuiKey_PrintScreen,
1193b4be Poul Sander 2025-02-03 21:28 1534
    ImGuiKey_Pause,
1193b4be Poul Sander 2025-02-03 21:28 1535
    ImGuiKey_Keypad0, ImGuiKey_Keypad1, ImGuiKey_Keypad2, ImGuiKey_Keypad3, ImGuiKey_Keypad4,
1193b4be Poul Sander 2025-02-03 21:28 1536
    ImGuiKey_Keypad5, ImGuiKey_Keypad6, ImGuiKey_Keypad7, ImGuiKey_Keypad8, ImGuiKey_Keypad9,
1193b4be Poul Sander 2025-02-03 21:28 1537
    ImGuiKey_KeypadDecimal,
1193b4be Poul Sander 2025-02-03 21:28 1538
    ImGuiKey_KeypadDivide,
1193b4be Poul Sander 2025-02-03 21:28 1539
    ImGuiKey_KeypadMultiply,
1193b4be Poul Sander 2025-02-03 21:28 1540
    ImGuiKey_KeypadSubtract,
1193b4be Poul Sander 2025-02-03 21:28 1541
    ImGuiKey_KeypadAdd,
1193b4be Poul Sander 2025-02-03 21:28 1542
    ImGuiKey_KeypadEnter,
1193b4be Poul Sander 2025-02-03 21:28 1543
    ImGuiKey_KeypadEqual,
1193b4be Poul Sander 2025-02-03 21:28 1544
    ImGuiKey_AppBack,               // Available on some keyboard/mouses. Often referred as "Browser Back"
1193b4be Poul Sander 2025-02-03 21:28 1545
    ImGuiKey_AppForward,
1193b4be Poul Sander 2025-02-03 21:28 1546
1193b4be Poul Sander 2025-02-03 21:28 1547
    // Gamepad (some of those are analog values, 0.0f to 1.0f)                          // NAVIGATION ACTION
1193b4be Poul Sander 2025-02-03 21:28 1548
    // (download controller mapping PNG/PSD at http://dearimgui.com/controls_sheets)
1193b4be Poul Sander 2025-02-03 21:28 1549
    ImGuiKey_GamepadStart,          // Menu (Xbox)      + (Switch)   Start/Options (PS)
1193b4be Poul Sander 2025-02-03 21:28 1550
    ImGuiKey_GamepadBack,           // View (Xbox)      - (Switch)   Share (PS)
1193b4be Poul Sander 2025-02-03 21:28 1551
    ImGuiKey_GamepadFaceLeft,       // X (Xbox)         Y (Switch)   Square (PS)        // Tap: Toggle Menu. Hold: Windowing mode (Focus/Move/Resize windows)
1193b4be Poul Sander 2025-02-03 21:28 1552
    ImGuiKey_GamepadFaceRight,      // B (Xbox)         A (Switch)   Circle (PS)        // Cancel / Close / Exit
1193b4be Poul Sander 2025-02-03 21:28 1553
    ImGuiKey_GamepadFaceUp,         // Y (Xbox)         X (Switch)   Triangle (PS)      // Text Input / On-screen Keyboard
1193b4be Poul Sander 2025-02-03 21:28 1554
    ImGuiKey_GamepadFaceDown,       // A (Xbox)         B (Switch)   Cross (PS)         // Activate / Open / Toggle / Tweak
1193b4be Poul Sander 2025-02-03 21:28 1555
    ImGuiKey_GamepadDpadLeft,       // D-pad Left                                       // Move / Tweak / Resize Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1556
    ImGuiKey_GamepadDpadRight,      // D-pad Right                                      // Move / Tweak / Resize Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1557
    ImGuiKey_GamepadDpadUp,         // D-pad Up                                         // Move / Tweak / Resize Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1558
    ImGuiKey_GamepadDpadDown,       // D-pad Down                                       // Move / Tweak / Resize Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1559
    ImGuiKey_GamepadL1,             // L Bumper (Xbox)  L (Switch)   L1 (PS)            // Tweak Slower / Focus Previous (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1560
    ImGuiKey_GamepadR1,             // R Bumper (Xbox)  R (Switch)   R1 (PS)            // Tweak Faster / Focus Next (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1561
    ImGuiKey_GamepadL2,             // L Trig. (Xbox)   ZL (Switch)  L2 (PS) [Analog]
1193b4be Poul Sander 2025-02-03 21:28 1562
    ImGuiKey_GamepadR2,             // R Trig. (Xbox)   ZR (Switch)  R2 (PS) [Analog]
1193b4be Poul Sander 2025-02-03 21:28 1563
    ImGuiKey_GamepadL3,             // L Stick (Xbox)   L3 (Switch)  L3 (PS)
1193b4be Poul Sander 2025-02-03 21:28 1564
    ImGuiKey_GamepadR3,             // R Stick (Xbox)   R3 (Switch)  R3 (PS)
1193b4be Poul Sander 2025-02-03 21:28 1565
    ImGuiKey_GamepadLStickLeft,     // [Analog]                                         // Move Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1566
    ImGuiKey_GamepadLStickRight,    // [Analog]                                         // Move Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1567
    ImGuiKey_GamepadLStickUp,       // [Analog]                                         // Move Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1568
    ImGuiKey_GamepadLStickDown,     // [Analog]                                         // Move Window (in Windowing mode)
1193b4be Poul Sander 2025-02-03 21:28 1569
    ImGuiKey_GamepadRStickLeft,     // [Analog]
1193b4be Poul Sander 2025-02-03 21:28 1570
    ImGuiKey_GamepadRStickRight,    // [Analog]
1193b4be Poul Sander 2025-02-03 21:28 1571
    ImGuiKey_GamepadRStickUp,       // [Analog]
1193b4be Poul Sander 2025-02-03 21:28 1572
    ImGuiKey_GamepadRStickDown,     // [Analog]
1193b4be Poul Sander 2025-02-03 21:28 1573
1193b4be Poul Sander 2025-02-03 21:28 1574
    // Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls)
1193b4be Poul Sander 2025-02-03 21:28 1575
    // - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
1193b4be Poul Sander 2025-02-03 21:28 1576
    ImGuiKey_MouseLeft, ImGuiKey_MouseRight, ImGuiKey_MouseMiddle, ImGuiKey_MouseX1, ImGuiKey_MouseX2, ImGuiKey_MouseWheelX, ImGuiKey_MouseWheelY,
1193b4be Poul Sander 2025-02-03 21:28 1577
1193b4be Poul Sander 2025-02-03 21:28 1578
    // [Internal] Reserved for mod storage
1193b4be Poul Sander 2025-02-03 21:28 1579
    ImGuiKey_ReservedForModCtrl, ImGuiKey_ReservedForModShift, ImGuiKey_ReservedForModAlt, ImGuiKey_ReservedForModSuper,
1193b4be Poul Sander 2025-02-03 21:28 1580
    ImGuiKey_COUNT,
1193b4be Poul Sander 2025-02-03 21:28 1581
1193b4be Poul Sander 2025-02-03 21:28 1582
    // Keyboard Modifiers (explicitly submitted by backend via AddKeyEvent() calls)
1193b4be Poul Sander 2025-02-03 21:28 1583
    // - This is mirroring the data also written to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper, in a format allowing
1193b4be Poul Sander 2025-02-03 21:28 1584
    //   them to be accessed via standard key API, allowing calls such as IsKeyPressed(), IsKeyReleased(), querying duration etc.
1193b4be Poul Sander 2025-02-03 21:28 1585
    // - Code polling every key (e.g. an interface to detect a key press for input mapping) might want to ignore those
1193b4be Poul Sander 2025-02-03 21:28 1586
    //   and prefer using the real keys (e.g. ImGuiKey_LeftCtrl, ImGuiKey_RightCtrl instead of ImGuiMod_Ctrl).
1193b4be Poul Sander 2025-02-03 21:28 1587
    // - In theory the value of keyboard modifiers should be roughly equivalent to a logical or of the equivalent left/right keys.
1193b4be Poul Sander 2025-02-03 21:28 1588
    //   In practice: it's complicated; mods are often provided from different sources. Keyboard layout, IME, sticky keys and
1193b4be Poul Sander 2025-02-03 21:28 1589
    //   backends tend to interfere and break that equivalence. The safer decision is to relay that ambiguity down to the end-user...
1193b4be Poul Sander 2025-02-03 21:28 1590
    // - On macOS, we swap Cmd(Super) and Ctrl keys at the time of the io.AddKeyEvent() call.
1193b4be Poul Sander 2025-02-03 21:28 1591
    ImGuiMod_None                   = 0,
1193b4be Poul Sander 2025-02-03 21:28 1592
    ImGuiMod_Ctrl                   = 1 << 12, // Ctrl (non-macOS), Cmd (macOS)
1193b4be Poul Sander 2025-02-03 21:28 1593
    ImGuiMod_Shift                  = 1 << 13, // Shift
1193b4be Poul Sander 2025-02-03 21:28 1594
    ImGuiMod_Alt                    = 1 << 14, // Option/Menu
1193b4be Poul Sander 2025-02-03 21:28 1595
    ImGuiMod_Super                  = 1 << 15, // Windows/Super (non-macOS), Ctrl (macOS)
1193b4be Poul Sander 2025-02-03 21:28 1596
    ImGuiMod_Mask_                  = 0xF000,  // 4-bits
1193b4be Poul Sander 2025-02-03 21:28 1597
1193b4be Poul Sander 2025-02-03 21:28 1598
    // [Internal] Prior to 1.87 we required user to fill io.KeysDown[512] using their own native index + the io.KeyMap[] array.
1193b4be Poul Sander 2025-02-03 21:28 1599
    // We are ditching this method but keeping a legacy path for user code doing e.g. IsKeyPressed(MY_NATIVE_KEY_CODE)
1193b4be Poul Sander 2025-02-03 21:28 1600
    // If you need to iterate all keys (for e.g. an input mapper) you may use ImGuiKey_NamedKey_BEGIN..ImGuiKey_NamedKey_END.
1193b4be Poul Sander 2025-02-03 21:28 1601
    ImGuiKey_NamedKey_BEGIN         = 512,
1193b4be Poul Sander 2025-02-03 21:28 1602
    ImGuiKey_NamedKey_END           = ImGuiKey_COUNT,
1193b4be Poul Sander 2025-02-03 21:28 1603
    ImGuiKey_NamedKey_COUNT         = ImGuiKey_NamedKey_END - ImGuiKey_NamedKey_BEGIN,
1193b4be Poul Sander 2025-02-03 21:28 1604
#ifdef IMGUI_DISABLE_OBSOLETE_KEYIO
1193b4be Poul Sander 2025-02-03 21:28 1605
    ImGuiKey_KeysData_SIZE          = ImGuiKey_NamedKey_COUNT,  // Size of KeysData[]: only hold named keys
1193b4be Poul Sander 2025-02-03 21:28 1606
    ImGuiKey_KeysData_OFFSET        = ImGuiKey_NamedKey_BEGIN,  // Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET) index.
1193b4be Poul Sander 2025-02-03 21:28 1607
#else
1193b4be Poul Sander 2025-02-03 21:28 1608
    ImGuiKey_KeysData_SIZE          = ImGuiKey_COUNT,           // Size of KeysData[]: hold legacy 0..512 keycodes + named keys
1193b4be Poul Sander 2025-02-03 21:28 1609
    ImGuiKey_KeysData_OFFSET        = 0,                        // Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET) index.
1193b4be Poul Sander 2025-02-03 21:28 1610
#endif
1193b4be Poul Sander 2025-02-03 21:28 1611
1193b4be Poul Sander 2025-02-03 21:28 1612
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1613
    ImGuiMod_Shortcut               = ImGuiMod_Ctrl,            // Removed in 1.90.7, you can now simply use ImGuiMod_Ctrl
1193b4be Poul Sander 2025-02-03 21:28 1614
    ImGuiKey_ModCtrl = ImGuiMod_Ctrl, ImGuiKey_ModShift = ImGuiMod_Shift, ImGuiKey_ModAlt = ImGuiMod_Alt, ImGuiKey_ModSuper = ImGuiMod_Super, // Renamed in 1.89
1193b4be Poul Sander 2025-02-03 21:28 1615
    //ImGuiKey_KeyPadEnter = ImGuiKey_KeypadEnter,              // Renamed in 1.87
1193b4be Poul Sander 2025-02-03 21:28 1616
#endif
1193b4be Poul Sander 2025-02-03 21:28 1617
};
1193b4be Poul Sander 2025-02-03 21:28 1618
1193b4be Poul Sander 2025-02-03 21:28 1619
// Flags for Shortcut(), SetNextItemShortcut(),
1193b4be Poul Sander 2025-02-03 21:28 1620
// (and for upcoming extended versions of IsKeyPressed(), IsMouseClicked(), Shortcut(), SetKeyOwner(), SetItemKeyOwner() that are still in imgui_internal.h)
1193b4be Poul Sander 2025-02-03 21:28 1621
// Don't mistake with ImGuiInputTextFlags! (which is for ImGui::InputText() function)
1193b4be Poul Sander 2025-02-03 21:28 1622
enum ImGuiInputFlags_
1193b4be Poul Sander 2025-02-03 21:28 1623
{
1193b4be Poul Sander 2025-02-03 21:28 1624
    ImGuiInputFlags_None                    = 0,
1193b4be Poul Sander 2025-02-03 21:28 1625
    ImGuiInputFlags_Repeat                  = 1 << 0,   // Enable repeat. Return true on successive repeats. Default for legacy IsKeyPressed(). NOT Default for legacy IsMouseClicked(). MUST BE == 1.
1193b4be Poul Sander 2025-02-03 21:28 1626
1193b4be Poul Sander 2025-02-03 21:28 1627
    // Flags for Shortcut(), SetNextItemShortcut()
1193b4be Poul Sander 2025-02-03 21:28 1628
    // - Routing policies: RouteGlobal+OverActive >> RouteActive or RouteFocused (if owner is active item) >> RouteGlobal+OverFocused >> RouteFocused (if in focused window stack) >> RouteGlobal.
1193b4be Poul Sander 2025-02-03 21:28 1629
    // - Default policy is RouteFocused. Can select only 1 policy among all available.
1193b4be Poul Sander 2025-02-03 21:28 1630
    ImGuiInputFlags_RouteActive             = 1 << 10,  // Route to active item only.
1193b4be Poul Sander 2025-02-03 21:28 1631
    ImGuiInputFlags_RouteFocused            = 1 << 11,  // Route to windows in the focus stack (DEFAULT). Deep-most focused window takes inputs. Active item takes inputs over deep-most focused window.
1193b4be Poul Sander 2025-02-03 21:28 1632
    ImGuiInputFlags_RouteGlobal             = 1 << 12,  // Global route (unless a focused window or active item registered the route).
1193b4be Poul Sander 2025-02-03 21:28 1633
    ImGuiInputFlags_RouteAlways             = 1 << 13,  // Do not register route, poll keys directly.
1193b4be Poul Sander 2025-02-03 21:28 1634
    // - Routing options
1193b4be Poul Sander 2025-02-03 21:28 1635
    ImGuiInputFlags_RouteOverFocused        = 1 << 14,  // Option: global route: higher priority than focused route (unless active item in focused route).
1193b4be Poul Sander 2025-02-03 21:28 1636
    ImGuiInputFlags_RouteOverActive         = 1 << 15,  // Option: global route: higher priority than active item. Unlikely you need to use that: will interfere with every active items, e.g. CTRL+A registered by InputText will be overridden by this. May not be fully honored as user/internal code is likely to always assume they can access keys when active.
1193b4be Poul Sander 2025-02-03 21:28 1637
    ImGuiInputFlags_RouteUnlessBgFocused    = 1 << 16,  // Option: global route: will not be applied if underlying background/void is focused (== no Dear ImGui windows are focused). Useful for overlay applications.
1193b4be Poul Sander 2025-02-03 21:28 1638
    ImGuiInputFlags_RouteFromRootWindow     = 1 << 17,  // Option: route evaluated from the point of view of root window rather than current window.
1193b4be Poul Sander 2025-02-03 21:28 1639
1193b4be Poul Sander 2025-02-03 21:28 1640
    // Flags for SetNextItemShortcut()
1193b4be Poul Sander 2025-02-03 21:28 1641
    ImGuiInputFlags_Tooltip                 = 1 << 18,  // Automatically display a tooltip when hovering item [BETA] Unsure of right api (opt-in/opt-out)
1193b4be Poul Sander 2025-02-03 21:28 1642
};
1193b4be Poul Sander 2025-02-03 21:28 1643
1193b4be Poul Sander 2025-02-03 21:28 1644
#ifndef IMGUI_DISABLE_OBSOLETE_KEYIO
1193b4be Poul Sander 2025-02-03 21:28 1645
// OBSOLETED in 1.88 (from July 2022): ImGuiNavInput and io.NavInputs[].
1193b4be Poul Sander 2025-02-03 21:28 1646
// Official backends between 1.60 and 1.86: will keep working and feed gamepad inputs as long as IMGUI_DISABLE_OBSOLETE_KEYIO is not set.
1193b4be Poul Sander 2025-02-03 21:28 1647
// Custom backends: feed gamepad inputs via io.AddKeyEvent() and ImGuiKey_GamepadXXX enums.
1193b4be Poul Sander 2025-02-03 21:28 1648
enum ImGuiNavInput
1193b4be Poul Sander 2025-02-03 21:28 1649
{
1193b4be Poul Sander 2025-02-03 21:28 1650
    ImGuiNavInput_Activate, ImGuiNavInput_Cancel, ImGuiNavInput_Input, ImGuiNavInput_Menu, ImGuiNavInput_DpadLeft, ImGuiNavInput_DpadRight, ImGuiNavInput_DpadUp, ImGuiNavInput_DpadDown,
1193b4be Poul Sander 2025-02-03 21:28 1651
    ImGuiNavInput_LStickLeft, ImGuiNavInput_LStickRight, ImGuiNavInput_LStickUp, ImGuiNavInput_LStickDown, ImGuiNavInput_FocusPrev, ImGuiNavInput_FocusNext, ImGuiNavInput_TweakSlow, ImGuiNavInput_TweakFast,
1193b4be Poul Sander 2025-02-03 21:28 1652
    ImGuiNavInput_COUNT,
1193b4be Poul Sander 2025-02-03 21:28 1653
};
1193b4be Poul Sander 2025-02-03 21:28 1654
#endif
1193b4be Poul Sander 2025-02-03 21:28 1655
1193b4be Poul Sander 2025-02-03 21:28 1656
// Configuration flags stored in io.ConfigFlags. Set by user/application.
1193b4be Poul Sander 2025-02-03 21:28 1657
enum ImGuiConfigFlags_
1193b4be Poul Sander 2025-02-03 21:28 1658
{
1193b4be Poul Sander 2025-02-03 21:28 1659
    ImGuiConfigFlags_None                   = 0,
1193b4be Poul Sander 2025-02-03 21:28 1660
    ImGuiConfigFlags_NavEnableKeyboard      = 1 << 0,   // Master keyboard navigation enable flag. Enable full Tabbing + directional arrows + space/enter to activate.
1193b4be Poul Sander 2025-02-03 21:28 1661
    ImGuiConfigFlags_NavEnableGamepad       = 1 << 1,   // Master gamepad navigation enable flag. Backend also needs to set ImGuiBackendFlags_HasGamepad.
1193b4be Poul Sander 2025-02-03 21:28 1662
    ImGuiConfigFlags_NoMouse                = 1 << 4,   // Instruct dear imgui to disable mouse inputs and interactions.
1193b4be Poul Sander 2025-02-03 21:28 1663
    ImGuiConfigFlags_NoMouseCursorChange    = 1 << 5,   // Instruct backend to not alter mouse cursor shape and visibility. Use if the backend cursor changes are interfering with yours and you don't want to use SetMouseCursor() to change mouse cursor. You may want to honor requests from imgui by reading GetMouseCursor() yourself instead.
1193b4be Poul Sander 2025-02-03 21:28 1664
    ImGuiConfigFlags_NoKeyboard             = 1 << 6,   // Instruct dear imgui to disable keyboard inputs and interactions. This is done by ignoring keyboard events and clearing existing states.
1193b4be Poul Sander 2025-02-03 21:28 1665
1193b4be Poul Sander 2025-02-03 21:28 1666
    // [BETA] Docking
1193b4be Poul Sander 2025-02-03 21:28 1667
    ImGuiConfigFlags_DockingEnable          = 1 << 7,   // Docking enable flags.
1193b4be Poul Sander 2025-02-03 21:28 1668
1193b4be Poul Sander 2025-02-03 21:28 1669
    // [BETA] Viewports
1193b4be Poul Sander 2025-02-03 21:28 1670
    // When using viewports it is recommended that your default value for ImGuiCol_WindowBg is opaque (Alpha=1.0) so transition to a viewport won't be noticeable.
1193b4be Poul Sander 2025-02-03 21:28 1671
    ImGuiConfigFlags_ViewportsEnable        = 1 << 10,  // Viewport enable flags (require both ImGuiBackendFlags_PlatformHasViewports + ImGuiBackendFlags_RendererHasViewports set by the respective backends)
1193b4be Poul Sander 2025-02-03 21:28 1672
    ImGuiConfigFlags_DpiEnableScaleViewports= 1 << 14,  // [BETA: Don't use] FIXME-DPI: Reposition and resize imgui windows when the DpiScale of a viewport changed (mostly useful for the main viewport hosting other window). Note that resizing the main window itself is up to your application.
1193b4be Poul Sander 2025-02-03 21:28 1673
    ImGuiConfigFlags_DpiEnableScaleFonts    = 1 << 15,  // [BETA: Don't use] FIXME-DPI: Request bitmap-scaled fonts to match DpiScale. This is a very low-quality workaround. The correct way to handle DPI is _currently_ to replace the atlas and/or fonts in the Platform_OnChangedViewport callback, but this is all early work in progress.
1193b4be Poul Sander 2025-02-03 21:28 1674
1193b4be Poul Sander 2025-02-03 21:28 1675
    // User storage (to allow your backend/engine to communicate to code that may be shared between multiple projects. Those flags are NOT used by core Dear ImGui)
1193b4be Poul Sander 2025-02-03 21:28 1676
    ImGuiConfigFlags_IsSRGB                 = 1 << 20,  // Application is SRGB-aware.
1193b4be Poul Sander 2025-02-03 21:28 1677
    ImGuiConfigFlags_IsTouchScreen          = 1 << 21,  // Application is using a touch screen instead of a mouse.
1193b4be Poul Sander 2025-02-03 21:28 1678
1193b4be Poul Sander 2025-02-03 21:28 1679
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1680
    ImGuiConfigFlags_NavEnableSetMousePos   = 1 << 2,   // [moved/renamed in 1.91.4] -> use bool io.ConfigNavMoveSetMousePos
1193b4be Poul Sander 2025-02-03 21:28 1681
    ImGuiConfigFlags_NavNoCaptureKeyboard   = 1 << 3,   // [moved/renamed in 1.91.4] -> use bool io.ConfigNavCaptureKeyboard
1193b4be Poul Sander 2025-02-03 21:28 1682
#endif
1193b4be Poul Sander 2025-02-03 21:28 1683
};
1193b4be Poul Sander 2025-02-03 21:28 1684
1193b4be Poul Sander 2025-02-03 21:28 1685
// Backend capabilities flags stored in io.BackendFlags. Set by imgui_impl_xxx or custom backend.
1193b4be Poul Sander 2025-02-03 21:28 1686
enum ImGuiBackendFlags_
1193b4be Poul Sander 2025-02-03 21:28 1687
{
1193b4be Poul Sander 2025-02-03 21:28 1688
    ImGuiBackendFlags_None                  = 0,
1193b4be Poul Sander 2025-02-03 21:28 1689
    ImGuiBackendFlags_HasGamepad            = 1 << 0,   // Backend Platform supports gamepad and currently has one connected.
1193b4be Poul Sander 2025-02-03 21:28 1690
    ImGuiBackendFlags_HasMouseCursors       = 1 << 1,   // Backend Platform supports honoring GetMouseCursor() value to change the OS cursor shape.
1193b4be Poul Sander 2025-02-03 21:28 1691
    ImGuiBackendFlags_HasSetMousePos        = 1 << 2,   // Backend Platform supports io.WantSetMousePos requests to reposition the OS mouse position (only used if io.ConfigNavMoveSetMousePos is set).
1193b4be Poul Sander 2025-02-03 21:28 1692
    ImGuiBackendFlags_RendererHasVtxOffset  = 1 << 3,   // Backend Renderer supports ImDrawCmd::VtxOffset. This enables output of large meshes (64K+ vertices) while still using 16-bit indices.
1193b4be Poul Sander 2025-02-03 21:28 1693
1193b4be Poul Sander 2025-02-03 21:28 1694
    // [BETA] Viewports
1193b4be Poul Sander 2025-02-03 21:28 1695
    ImGuiBackendFlags_PlatformHasViewports  = 1 << 10,  // Backend Platform supports multiple viewports.
1193b4be Poul Sander 2025-02-03 21:28 1696
    ImGuiBackendFlags_HasMouseHoveredViewport=1 << 11,  // Backend Platform supports calling io.AddMouseViewportEvent() with the viewport under the mouse. IF POSSIBLE, ignore viewports with the ImGuiViewportFlags_NoInputs flag (Win32 backend, GLFW 3.30+ backend can do this, SDL backend cannot). If this cannot be done, Dear ImGui needs to use a flawed heuristic to find the viewport under.
1193b4be Poul Sander 2025-02-03 21:28 1697
    ImGuiBackendFlags_RendererHasViewports  = 1 << 12,  // Backend Renderer supports multiple viewports.
1193b4be Poul Sander 2025-02-03 21:28 1698
};
1193b4be Poul Sander 2025-02-03 21:28 1699
1193b4be Poul Sander 2025-02-03 21:28 1700
// Enumeration for PushStyleColor() / PopStyleColor()
1193b4be Poul Sander 2025-02-03 21:28 1701
enum ImGuiCol_
1193b4be Poul Sander 2025-02-03 21:28 1702
{
1193b4be Poul Sander 2025-02-03 21:28 1703
    ImGuiCol_Text,
1193b4be Poul Sander 2025-02-03 21:28 1704
    ImGuiCol_TextDisabled,
1193b4be Poul Sander 2025-02-03 21:28 1705
    ImGuiCol_WindowBg,              // Background of normal windows
1193b4be Poul Sander 2025-02-03 21:28 1706
    ImGuiCol_ChildBg,               // Background of child windows
1193b4be Poul Sander 2025-02-03 21:28 1707
    ImGuiCol_PopupBg,               // Background of popups, menus, tooltips windows
1193b4be Poul Sander 2025-02-03 21:28 1708
    ImGuiCol_Border,
1193b4be Poul Sander 2025-02-03 21:28 1709
    ImGuiCol_BorderShadow,
1193b4be Poul Sander 2025-02-03 21:28 1710
    ImGuiCol_FrameBg,               // Background of checkbox, radio button, plot, slider, text input
1193b4be Poul Sander 2025-02-03 21:28 1711
    ImGuiCol_FrameBgHovered,
1193b4be Poul Sander 2025-02-03 21:28 1712
    ImGuiCol_FrameBgActive,
1193b4be Poul Sander 2025-02-03 21:28 1713
    ImGuiCol_TitleBg,               // Title bar
1193b4be Poul Sander 2025-02-03 21:28 1714
    ImGuiCol_TitleBgActive,         // Title bar when focused
1193b4be Poul Sander 2025-02-03 21:28 1715
    ImGuiCol_TitleBgCollapsed,      // Title bar when collapsed
1193b4be Poul Sander 2025-02-03 21:28 1716
    ImGuiCol_MenuBarBg,
1193b4be Poul Sander 2025-02-03 21:28 1717
    ImGuiCol_ScrollbarBg,
1193b4be Poul Sander 2025-02-03 21:28 1718
    ImGuiCol_ScrollbarGrab,
1193b4be Poul Sander 2025-02-03 21:28 1719
    ImGuiCol_ScrollbarGrabHovered,
1193b4be Poul Sander 2025-02-03 21:28 1720
    ImGuiCol_ScrollbarGrabActive,
1193b4be Poul Sander 2025-02-03 21:28 1721
    ImGuiCol_CheckMark,             // Checkbox tick and RadioButton circle
1193b4be Poul Sander 2025-02-03 21:28 1722
    ImGuiCol_SliderGrab,
1193b4be Poul Sander 2025-02-03 21:28 1723
    ImGuiCol_SliderGrabActive,
1193b4be Poul Sander 2025-02-03 21:28 1724
    ImGuiCol_Button,
1193b4be Poul Sander 2025-02-03 21:28 1725
    ImGuiCol_ButtonHovered,
1193b4be Poul Sander 2025-02-03 21:28 1726
    ImGuiCol_ButtonActive,
1193b4be Poul Sander 2025-02-03 21:28 1727
    ImGuiCol_Header,                // Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem
1193b4be Poul Sander 2025-02-03 21:28 1728
    ImGuiCol_HeaderHovered,
1193b4be Poul Sander 2025-02-03 21:28 1729
    ImGuiCol_HeaderActive,
1193b4be Poul Sander 2025-02-03 21:28 1730
    ImGuiCol_Separator,
1193b4be Poul Sander 2025-02-03 21:28 1731
    ImGuiCol_SeparatorHovered,
1193b4be Poul Sander 2025-02-03 21:28 1732
    ImGuiCol_SeparatorActive,
1193b4be Poul Sander 2025-02-03 21:28 1733
    ImGuiCol_ResizeGrip,            // Resize grip in lower-right and lower-left corners of windows.
1193b4be Poul Sander 2025-02-03 21:28 1734
    ImGuiCol_ResizeGripHovered,
1193b4be Poul Sander 2025-02-03 21:28 1735
    ImGuiCol_ResizeGripActive,
1193b4be Poul Sander 2025-02-03 21:28 1736
    ImGuiCol_TabHovered,            // Tab background, when hovered
1193b4be Poul Sander 2025-02-03 21:28 1737
    ImGuiCol_Tab,                   // Tab background, when tab-bar is focused & tab is unselected
1193b4be Poul Sander 2025-02-03 21:28 1738
    ImGuiCol_TabSelected,           // Tab background, when tab-bar is focused & tab is selected
1193b4be Poul Sander 2025-02-03 21:28 1739
    ImGuiCol_TabSelectedOverline,   // Tab horizontal overline, when tab-bar is focused & tab is selected
1193b4be Poul Sander 2025-02-03 21:28 1740
    ImGuiCol_TabDimmed,             // Tab background, when tab-bar is unfocused & tab is unselected
1193b4be Poul Sander 2025-02-03 21:28 1741
    ImGuiCol_TabDimmedSelected,     // Tab background, when tab-bar is unfocused & tab is selected
1193b4be Poul Sander 2025-02-03 21:28 1742
    ImGuiCol_TabDimmedSelectedOverline,//..horizontal overline, when tab-bar is unfocused & tab is selected
1193b4be Poul Sander 2025-02-03 21:28 1743
    ImGuiCol_DockingPreview,        // Preview overlay color when about to docking something
1193b4be Poul Sander 2025-02-03 21:28 1744
    ImGuiCol_DockingEmptyBg,        // Background color for empty node (e.g. CentralNode with no window docked into it)
1193b4be Poul Sander 2025-02-03 21:28 1745
    ImGuiCol_PlotLines,
1193b4be Poul Sander 2025-02-03 21:28 1746
    ImGuiCol_PlotLinesHovered,
1193b4be Poul Sander 2025-02-03 21:28 1747
    ImGuiCol_PlotHistogram,
1193b4be Poul Sander 2025-02-03 21:28 1748
    ImGuiCol_PlotHistogramHovered,
1193b4be Poul Sander 2025-02-03 21:28 1749
    ImGuiCol_TableHeaderBg,         // Table header background
1193b4be Poul Sander 2025-02-03 21:28 1750
    ImGuiCol_TableBorderStrong,     // Table outer and header borders (prefer using Alpha=1.0 here)
1193b4be Poul Sander 2025-02-03 21:28 1751
    ImGuiCol_TableBorderLight,      // Table inner borders (prefer using Alpha=1.0 here)
1193b4be Poul Sander 2025-02-03 21:28 1752
    ImGuiCol_TableRowBg,            // Table row background (even rows)
1193b4be Poul Sander 2025-02-03 21:28 1753
    ImGuiCol_TableRowBgAlt,         // Table row background (odd rows)
1193b4be Poul Sander 2025-02-03 21:28 1754
    ImGuiCol_TextLink,              // Hyperlink color
1193b4be Poul Sander 2025-02-03 21:28 1755
    ImGuiCol_TextSelectedBg,
1193b4be Poul Sander 2025-02-03 21:28 1756
    ImGuiCol_DragDropTarget,        // Rectangle highlighting a drop target
1193b4be Poul Sander 2025-02-03 21:28 1757
    ImGuiCol_NavCursor,             // Color of keyboard/gamepad navigation cursor/rectangle, when visible
1193b4be Poul Sander 2025-02-03 21:28 1758
    ImGuiCol_NavWindowingHighlight, // Highlight window when using CTRL+TAB
1193b4be Poul Sander 2025-02-03 21:28 1759
    ImGuiCol_NavWindowingDimBg,     // Darken/colorize entire screen behind the CTRL+TAB window list, when active
1193b4be Poul Sander 2025-02-03 21:28 1760
    ImGuiCol_ModalWindowDimBg,      // Darken/colorize entire screen behind a modal window, when one is active
1193b4be Poul Sander 2025-02-03 21:28 1761
    ImGuiCol_COUNT,
1193b4be Poul Sander 2025-02-03 21:28 1762
1193b4be Poul Sander 2025-02-03 21:28 1763
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 1764
    ImGuiCol_TabActive = ImGuiCol_TabSelected,                  // [renamed in 1.90.9]
1193b4be Poul Sander 2025-02-03 21:28 1765
    ImGuiCol_TabUnfocused = ImGuiCol_TabDimmed,                 // [renamed in 1.90.9]
1193b4be Poul Sander 2025-02-03 21:28 1766
    ImGuiCol_TabUnfocusedActive = ImGuiCol_TabDimmedSelected,   // [renamed in 1.90.9]
1193b4be Poul Sander 2025-02-03 21:28 1767
    ImGuiCol_NavHighlight = ImGuiCol_NavCursor,                 // [renamed in 1.91.4]
1193b4be Poul Sander 2025-02-03 21:28 1768
#endif
1193b4be Poul Sander 2025-02-03 21:28 1769
};
1193b4be Poul Sander 2025-02-03 21:28 1770
1193b4be Poul Sander 2025-02-03 21:28 1771
// Enumeration for PushStyleVar() / PopStyleVar() to temporarily modify the ImGuiStyle structure.
1193b4be Poul Sander 2025-02-03 21:28 1772
// - The enum only refers to fields of ImGuiStyle which makes sense to be pushed/popped inside UI code.
1193b4be Poul Sander 2025-02-03 21:28 1773
//   During initialization or between frames, feel free to just poke into ImGuiStyle directly.
1193b4be Poul Sander 2025-02-03 21:28 1774
// - Tip: Use your programming IDE navigation facilities on the names in the _second column_ below to find the actual members and their description.
1193b4be Poul Sander 2025-02-03 21:28 1775
//   - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
1193b4be Poul Sander 2025-02-03 21:28 1776
//   - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
1193b4be Poul Sander 2025-02-03 21:28 1777
//   - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
1193b4be Poul Sander 2025-02-03 21:28 1778
// - When changing this enum, you need to update the associated internal table GStyleVarInfo[] accordingly. This is where we link enum values to members offset/type.
1193b4be Poul Sander 2025-02-03 21:28 1779
enum ImGuiStyleVar_
1193b4be Poul Sander 2025-02-03 21:28 1780
{
1193b4be Poul Sander 2025-02-03 21:28 1781
    // Enum name -------------------------- // Member in ImGuiStyle structure (see ImGuiStyle for descriptions)
1193b4be Poul Sander 2025-02-03 21:28 1782
    ImGuiStyleVar_Alpha,                    // float     Alpha
1193b4be Poul Sander 2025-02-03 21:28 1783
    ImGuiStyleVar_DisabledAlpha,            // float     DisabledAlpha
1193b4be Poul Sander 2025-02-03 21:28 1784
    ImGuiStyleVar_WindowPadding,            // ImVec2    WindowPadding
1193b4be Poul Sander 2025-02-03 21:28 1785
    ImGuiStyleVar_WindowRounding,           // float     WindowRounding
1193b4be Poul Sander 2025-02-03 21:28 1786
    ImGuiStyleVar_WindowBorderSize,         // float     WindowBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1787
    ImGuiStyleVar_WindowMinSize,            // ImVec2    WindowMinSize
1193b4be Poul Sander 2025-02-03 21:28 1788
    ImGuiStyleVar_WindowTitleAlign,         // ImVec2    WindowTitleAlign
1193b4be Poul Sander 2025-02-03 21:28 1789
    ImGuiStyleVar_ChildRounding,            // float     ChildRounding
1193b4be Poul Sander 2025-02-03 21:28 1790
    ImGuiStyleVar_ChildBorderSize,          // float     ChildBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1791
    ImGuiStyleVar_PopupRounding,            // float     PopupRounding
1193b4be Poul Sander 2025-02-03 21:28 1792
    ImGuiStyleVar_PopupBorderSize,          // float     PopupBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1793
    ImGuiStyleVar_FramePadding,             // ImVec2    FramePadding
1193b4be Poul Sander 2025-02-03 21:28 1794
    ImGuiStyleVar_FrameRounding,            // float     FrameRounding
1193b4be Poul Sander 2025-02-03 21:28 1795
    ImGuiStyleVar_FrameBorderSize,          // float     FrameBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1796
    ImGuiStyleVar_ItemSpacing,              // ImVec2    ItemSpacing
1193b4be Poul Sander 2025-02-03 21:28 1797
    ImGuiStyleVar_ItemInnerSpacing,         // ImVec2    ItemInnerSpacing
1193b4be Poul Sander 2025-02-03 21:28 1798
    ImGuiStyleVar_IndentSpacing,            // float     IndentSpacing
1193b4be Poul Sander 2025-02-03 21:28 1799
    ImGuiStyleVar_CellPadding,              // ImVec2    CellPadding
1193b4be Poul Sander 2025-02-03 21:28 1800
    ImGuiStyleVar_ScrollbarSize,            // float     ScrollbarSize
1193b4be Poul Sander 2025-02-03 21:28 1801
    ImGuiStyleVar_ScrollbarRounding,        // float     ScrollbarRounding
1193b4be Poul Sander 2025-02-03 21:28 1802
    ImGuiStyleVar_GrabMinSize,              // float     GrabMinSize
1193b4be Poul Sander 2025-02-03 21:28 1803
    ImGuiStyleVar_GrabRounding,             // float     GrabRounding
1193b4be Poul Sander 2025-02-03 21:28 1804
    ImGuiStyleVar_TabRounding,              // float     TabRounding
1193b4be Poul Sander 2025-02-03 21:28 1805
    ImGuiStyleVar_TabBorderSize,            // float     TabBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1806
    ImGuiStyleVar_TabBarBorderSize,         // float     TabBarBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1807
    ImGuiStyleVar_TabBarOverlineSize,       // float     TabBarOverlineSize
1193b4be Poul Sander 2025-02-03 21:28 1808
    ImGuiStyleVar_TableAngledHeadersAngle,  // float     TableAngledHeadersAngle
1193b4be Poul Sander 2025-02-03 21:28 1809
    ImGuiStyleVar_TableAngledHeadersTextAlign,// ImVec2  TableAngledHeadersTextAlign
1193b4be Poul Sander 2025-02-03 21:28 1810
    ImGuiStyleVar_ButtonTextAlign,          // ImVec2    ButtonTextAlign
1193b4be Poul Sander 2025-02-03 21:28 1811
    ImGuiStyleVar_SelectableTextAlign,      // ImVec2    SelectableTextAlign
1193b4be Poul Sander 2025-02-03 21:28 1812
    ImGuiStyleVar_SeparatorTextBorderSize,  // float     SeparatorTextBorderSize
1193b4be Poul Sander 2025-02-03 21:28 1813
    ImGuiStyleVar_SeparatorTextAlign,       // ImVec2    SeparatorTextAlign
1193b4be Poul Sander 2025-02-03 21:28 1814
    ImGuiStyleVar_SeparatorTextPadding,     // ImVec2    SeparatorTextPadding
1193b4be Poul Sander 2025-02-03 21:28 1815
    ImGuiStyleVar_DockingSeparatorSize,     // float     DockingSeparatorSize
1193b4be Poul Sander 2025-02-03 21:28 1816
    ImGuiStyleVar_COUNT
1193b4be Poul Sander 2025-02-03 21:28 1817
};
1193b4be Poul Sander 2025-02-03 21:28 1818
1193b4be Poul Sander 2025-02-03 21:28 1819
// Flags for InvisibleButton() [extended in imgui_internal.h]
1193b4be Poul Sander 2025-02-03 21:28 1820
enum ImGuiButtonFlags_
1193b4be Poul Sander 2025-02-03 21:28 1821
{
1193b4be Poul Sander 2025-02-03 21:28 1822
    ImGuiButtonFlags_None                   = 0,
1193b4be Poul Sander 2025-02-03 21:28 1823
    ImGuiButtonFlags_MouseButtonLeft        = 1 << 0,   // React on left mouse button (default)
1193b4be Poul Sander 2025-02-03 21:28 1824
    ImGuiButtonFlags_MouseButtonRight       = 1 << 1,   // React on right mouse button
1193b4be Poul Sander 2025-02-03 21:28 1825
    ImGuiButtonFlags_MouseButtonMiddle      = 1 << 2,   // React on center mouse button
1193b4be Poul Sander 2025-02-03 21:28 1826
    ImGuiButtonFlags_MouseButtonMask_       = ImGuiButtonFlags_MouseButtonLeft | ImGuiButtonFlags_MouseButtonRight | ImGuiButtonFlags_MouseButtonMiddle, // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 1827
    ImGuiButtonFlags_EnableNav              = 1 << 3,   // InvisibleButton(): do not disable navigation/tabbing. Otherwise disabled by default.
1193b4be Poul Sander 2025-02-03 21:28 1828
};
1193b4be Poul Sander 2025-02-03 21:28 1829
1193b4be Poul Sander 2025-02-03 21:28 1830
// Flags for ColorEdit3() / ColorEdit4() / ColorPicker3() / ColorPicker4() / ColorButton()
1193b4be Poul Sander 2025-02-03 21:28 1831
enum ImGuiColorEditFlags_
1193b4be Poul Sander 2025-02-03 21:28 1832
{
1193b4be Poul Sander 2025-02-03 21:28 1833
    ImGuiColorEditFlags_None            = 0,
1193b4be Poul Sander 2025-02-03 21:28 1834
    ImGuiColorEditFlags_NoAlpha         = 1 << 1,   //              // ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer).
1193b4be Poul Sander 2025-02-03 21:28 1835
    ImGuiColorEditFlags_NoPicker        = 1 << 2,   //              // ColorEdit: disable picker when clicking on color square.
1193b4be Poul Sander 2025-02-03 21:28 1836
    ImGuiColorEditFlags_NoOptions       = 1 << 3,   //              // ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
1193b4be Poul Sander 2025-02-03 21:28 1837
    ImGuiColorEditFlags_NoSmallPreview  = 1 << 4,   //              // ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs)
1193b4be Poul Sander 2025-02-03 21:28 1838
    ImGuiColorEditFlags_NoInputs        = 1 << 5,   //              // ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square).
1193b4be Poul Sander 2025-02-03 21:28 1839
    ImGuiColorEditFlags_NoTooltip       = 1 << 6,   //              // ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
1193b4be Poul Sander 2025-02-03 21:28 1840
    ImGuiColorEditFlags_NoLabel         = 1 << 7,   //              // ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).
1193b4be Poul Sander 2025-02-03 21:28 1841
    ImGuiColorEditFlags_NoSidePreview   = 1 << 8,   //              // ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead.
1193b4be Poul Sander 2025-02-03 21:28 1842
    ImGuiColorEditFlags_NoDragDrop      = 1 << 9,   //              // ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.
1193b4be Poul Sander 2025-02-03 21:28 1843
    ImGuiColorEditFlags_NoBorder        = 1 << 10,  //              // ColorButton: disable border (which is enforced by default)
1193b4be Poul Sander 2025-02-03 21:28 1844
1193b4be Poul Sander 2025-02-03 21:28 1845
    // User Options (right-click on widget to change some of them).
1193b4be Poul Sander 2025-02-03 21:28 1846
    ImGuiColorEditFlags_AlphaBar        = 1 << 16,  //              // ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
1193b4be Poul Sander 2025-02-03 21:28 1847
    ImGuiColorEditFlags_AlphaPreview    = 1 << 17,  //              // ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.
1193b4be Poul Sander 2025-02-03 21:28 1848
    ImGuiColorEditFlags_AlphaPreviewHalf= 1 << 18,  //              // ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.
1193b4be Poul Sander 2025-02-03 21:28 1849
    ImGuiColorEditFlags_HDR             = 1 << 19,  //              // (WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well).
1193b4be Poul Sander 2025-02-03 21:28 1850
    ImGuiColorEditFlags_DisplayRGB      = 1 << 20,  // [Display]    // ColorEdit: override _display_ type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
1193b4be Poul Sander 2025-02-03 21:28 1851
    ImGuiColorEditFlags_DisplayHSV      = 1 << 21,  // [Display]    // "
1193b4be Poul Sander 2025-02-03 21:28 1852
    ImGuiColorEditFlags_DisplayHex      = 1 << 22,  // [Display]    // "
1193b4be Poul Sander 2025-02-03 21:28 1853
    ImGuiColorEditFlags_Uint8           = 1 << 23,  // [DataType]   // ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255.
1193b4be Poul Sander 2025-02-03 21:28 1854
    ImGuiColorEditFlags_Float           = 1 << 24,  // [DataType]   // ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.
1193b4be Poul Sander 2025-02-03 21:28 1855
    ImGuiColorEditFlags_PickerHueBar    = 1 << 25,  // [Picker]     // ColorPicker: bar for Hue, rectangle for Sat/Value.
1193b4be Poul Sander 2025-02-03 21:28 1856
    ImGuiColorEditFlags_PickerHueWheel  = 1 << 26,  // [Picker]     // ColorPicker: wheel for Hue, triangle for Sat/Value.
1193b4be Poul Sander 2025-02-03 21:28 1857
    ImGuiColorEditFlags_InputRGB        = 1 << 27,  // [Input]      // ColorEdit, ColorPicker: input and output data in RGB format.
1193b4be Poul Sander 2025-02-03 21:28 1858
    ImGuiColorEditFlags_InputHSV        = 1 << 28,  // [Input]      // ColorEdit, ColorPicker: input and output data in HSV format.
1193b4be Poul Sander 2025-02-03 21:28 1859
1193b4be Poul Sander 2025-02-03 21:28 1860
    // Defaults Options. You can set application defaults using SetColorEditOptions(). The intent is that you probably don't want to
1193b4be Poul Sander 2025-02-03 21:28 1861
    // override them in most of your calls. Let the user choose via the option menu and/or call SetColorEditOptions() once during startup.
1193b4be Poul Sander 2025-02-03 21:28 1862
    ImGuiColorEditFlags_DefaultOptions_ = ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_InputRGB | ImGuiColorEditFlags_PickerHueBar,
1193b4be Poul Sander 2025-02-03 21:28 1863
1193b4be Poul Sander 2025-02-03 21:28 1864
    // [Internal] Masks
1193b4be Poul Sander 2025-02-03 21:28 1865
    ImGuiColorEditFlags_DisplayMask_    = ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_DisplayHSV | ImGuiColorEditFlags_DisplayHex,
1193b4be Poul Sander 2025-02-03 21:28 1866
    ImGuiColorEditFlags_DataTypeMask_   = ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_Float,
1193b4be Poul Sander 2025-02-03 21:28 1867
    ImGuiColorEditFlags_PickerMask_     = ImGuiColorEditFlags_PickerHueWheel | ImGuiColorEditFlags_PickerHueBar,
1193b4be Poul Sander 2025-02-03 21:28 1868
    ImGuiColorEditFlags_InputMask_      = ImGuiColorEditFlags_InputRGB | ImGuiColorEditFlags_InputHSV,
1193b4be Poul Sander 2025-02-03 21:28 1869
1193b4be Poul Sander 2025-02-03 21:28 1870
    // Obsolete names
1193b4be Poul Sander 2025-02-03 21:28 1871
    //ImGuiColorEditFlags_RGB = ImGuiColorEditFlags_DisplayRGB, ImGuiColorEditFlags_HSV = ImGuiColorEditFlags_DisplayHSV, ImGuiColorEditFlags_HEX = ImGuiColorEditFlags_DisplayHex  // [renamed in 1.69]
1193b4be Poul Sander 2025-02-03 21:28 1872
};
1193b4be Poul Sander 2025-02-03 21:28 1873
1193b4be Poul Sander 2025-02-03 21:28 1874
// Flags for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
1193b4be Poul Sander 2025-02-03 21:28 1875
// 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.
1193b4be Poul Sander 2025-02-03 21:28 1876
// (Those are per-item flags. There is shared behavior flag too: ImGuiIO: io.ConfigDragClickToInputText)
1193b4be Poul Sander 2025-02-03 21:28 1877
enum ImGuiSliderFlags_
1193b4be Poul Sander 2025-02-03 21:28 1878
{
1193b4be Poul Sander 2025-02-03 21:28 1879
    ImGuiSliderFlags_None               = 0,
1193b4be Poul Sander 2025-02-03 21:28 1880
    ImGuiSliderFlags_Logarithmic        = 1 << 5,       // Make the widget logarithmic (linear otherwise). Consider using ImGuiSliderFlags_NoRoundToFormat with this if using a format-string with small amount of digits.
1193b4be Poul Sander 2025-02-03 21:28 1881
    ImGuiSliderFlags_NoRoundToFormat    = 1 << 6,       // Disable rounding underlying value to match precision of the display format string (e.g. %.3f values are rounded to those 3 digits).
1193b4be Poul Sander 2025-02-03 21:28 1882
    ImGuiSliderFlags_NoInput            = 1 << 7,       // Disable CTRL+Click or Enter key allowing to input text directly into the widget.
1193b4be Poul Sander 2025-02-03 21:28 1883
    ImGuiSliderFlags_WrapAround         = 1 << 8,       // Enable wrapping around from max to min and from min to max. Only supported by DragXXX() functions for now.
1193b4be Poul Sander 2025-02-03 21:28 1884
    ImGuiSliderFlags_ClampOnInput       = 1 << 9,       // Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.
1193b4be Poul Sander 2025-02-03 21:28 1885
    ImGuiSliderFlags_ClampZeroRange     = 1 << 10,      // Clamp even if min==max==0.0f. Otherwise due to legacy reason DragXXX functions don't clamp with those values. When your clamping limits are dynamic you almost always want to use it.
1193b4be Poul Sander 2025-02-03 21:28 1886
    ImGuiSliderFlags_AlwaysClamp        = ImGuiSliderFlags_ClampOnInput | ImGuiSliderFlags_ClampZeroRange,
1193b4be Poul Sander 2025-02-03 21:28 1887
    ImGuiSliderFlags_InvalidMask_       = 0x7000000F,   // [Internal] We treat using those bits as being potentially a 'float power' argument from the previous API that has got miscast to this enum, and will trigger an assert if needed.
1193b4be Poul Sander 2025-02-03 21:28 1888
};
1193b4be Poul Sander 2025-02-03 21:28 1889
1193b4be Poul Sander 2025-02-03 21:28 1890
// Identify a mouse button.
1193b4be Poul Sander 2025-02-03 21:28 1891
// Those values are guaranteed to be stable and we frequently use 0/1 directly. Named enums provided for convenience.
1193b4be Poul Sander 2025-02-03 21:28 1892
enum ImGuiMouseButton_
1193b4be Poul Sander 2025-02-03 21:28 1893
{
1193b4be Poul Sander 2025-02-03 21:28 1894
    ImGuiMouseButton_Left = 0,
1193b4be Poul Sander 2025-02-03 21:28 1895
    ImGuiMouseButton_Right = 1,
1193b4be Poul Sander 2025-02-03 21:28 1896
    ImGuiMouseButton_Middle = 2,
1193b4be Poul Sander 2025-02-03 21:28 1897
    ImGuiMouseButton_COUNT = 5
1193b4be Poul Sander 2025-02-03 21:28 1898
};
1193b4be Poul Sander 2025-02-03 21:28 1899
1193b4be Poul Sander 2025-02-03 21:28 1900
// Enumeration for GetMouseCursor()
1193b4be Poul Sander 2025-02-03 21:28 1901
// User code may request backend to display given cursor by calling SetMouseCursor(), which is why we have some cursors that are marked unused here
1193b4be Poul Sander 2025-02-03 21:28 1902
enum ImGuiMouseCursor_
1193b4be Poul Sander 2025-02-03 21:28 1903
{
1193b4be Poul Sander 2025-02-03 21:28 1904
    ImGuiMouseCursor_None = -1,
1193b4be Poul Sander 2025-02-03 21:28 1905
    ImGuiMouseCursor_Arrow = 0,
1193b4be Poul Sander 2025-02-03 21:28 1906
    ImGuiMouseCursor_TextInput,         // When hovering over InputText, etc.
1193b4be Poul Sander 2025-02-03 21:28 1907
    ImGuiMouseCursor_ResizeAll,         // (Unused by Dear ImGui functions)
1193b4be Poul Sander 2025-02-03 21:28 1908
    ImGuiMouseCursor_ResizeNS,          // When hovering over a horizontal border
1193b4be Poul Sander 2025-02-03 21:28 1909
    ImGuiMouseCursor_ResizeEW,          // When hovering over a vertical border or a column
1193b4be Poul Sander 2025-02-03 21:28 1910
    ImGuiMouseCursor_ResizeNESW,        // When hovering over the bottom-left corner of a window
1193b4be Poul Sander 2025-02-03 21:28 1911
    ImGuiMouseCursor_ResizeNWSE,        // When hovering over the bottom-right corner of a window
1193b4be Poul Sander 2025-02-03 21:28 1912
    ImGuiMouseCursor_Hand,              // (Unused by Dear ImGui functions. Use for e.g. hyperlinks)
1193b4be Poul Sander 2025-02-03 21:28 1913
    ImGuiMouseCursor_NotAllowed,        // When hovering something with disallowed interaction. Usually a crossed circle.
1193b4be Poul Sander 2025-02-03 21:28 1914
    ImGuiMouseCursor_COUNT
1193b4be Poul Sander 2025-02-03 21:28 1915
};
1193b4be Poul Sander 2025-02-03 21:28 1916
1193b4be Poul Sander 2025-02-03 21:28 1917
// Enumeration for AddMouseSourceEvent() actual source of Mouse Input data.
1193b4be Poul Sander 2025-02-03 21:28 1918
// Historically we use "Mouse" terminology everywhere to indicate pointer data, e.g. MousePos, IsMousePressed(), io.AddMousePosEvent()
1193b4be Poul Sander 2025-02-03 21:28 1919
// But that "Mouse" data can come from different source which occasionally may be useful for application to know about.
1193b4be Poul Sander 2025-02-03 21:28 1920
// You can submit a change of pointer type using io.AddMouseSourceEvent().
1193b4be Poul Sander 2025-02-03 21:28 1921
enum ImGuiMouseSource : int
1193b4be Poul Sander 2025-02-03 21:28 1922
{
1193b4be Poul Sander 2025-02-03 21:28 1923
    ImGuiMouseSource_Mouse = 0,         // Input is coming from an actual mouse.
1193b4be Poul Sander 2025-02-03 21:28 1924
    ImGuiMouseSource_TouchScreen,       // Input is coming from a touch screen (no hovering prior to initial press, less precise initial press aiming, dual-axis wheeling possible).
1193b4be Poul Sander 2025-02-03 21:28 1925
    ImGuiMouseSource_Pen,               // Input is coming from a pressure/magnetic pen (often used in conjunction with high-sampling rates).
1193b4be Poul Sander 2025-02-03 21:28 1926
    ImGuiMouseSource_COUNT
1193b4be Poul Sander 2025-02-03 21:28 1927
};
1193b4be Poul Sander 2025-02-03 21:28 1928
1193b4be Poul Sander 2025-02-03 21:28 1929
// Enumeration for ImGui::SetNextWindow***(), SetWindow***(), SetNextItem***() functions
1193b4be Poul Sander 2025-02-03 21:28 1930
// Represent a condition.
1193b4be Poul Sander 2025-02-03 21:28 1931
// Important: Treat as a regular enum! Do NOT combine multiple values using binary operators! All the functions above treat 0 as a shortcut to ImGuiCond_Always.
1193b4be Poul Sander 2025-02-03 21:28 1932
enum ImGuiCond_
1193b4be Poul Sander 2025-02-03 21:28 1933
{
1193b4be Poul Sander 2025-02-03 21:28 1934
    ImGuiCond_None          = 0,        // No condition (always set the variable), same as _Always
1193b4be Poul Sander 2025-02-03 21:28 1935
    ImGuiCond_Always        = 1 << 0,   // No condition (always set the variable), same as _None
1193b4be Poul Sander 2025-02-03 21:28 1936
    ImGuiCond_Once          = 1 << 1,   // Set the variable once per runtime session (only the first call will succeed)
1193b4be Poul Sander 2025-02-03 21:28 1937
    ImGuiCond_FirstUseEver  = 1 << 2,   // Set the variable if the object/window has no persistently saved data (no entry in .ini file)
1193b4be Poul Sander 2025-02-03 21:28 1938
    ImGuiCond_Appearing     = 1 << 3,   // Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
1193b4be Poul Sander 2025-02-03 21:28 1939
};
1193b4be Poul Sander 2025-02-03 21:28 1940
1193b4be Poul Sander 2025-02-03 21:28 1941
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 1942
// [SECTION] Tables API flags and structures (ImGuiTableFlags, ImGuiTableColumnFlags, ImGuiTableRowFlags, ImGuiTableBgTarget, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs)
1193b4be Poul Sander 2025-02-03 21:28 1943
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 1944
1193b4be Poul Sander 2025-02-03 21:28 1945
// Flags for ImGui::BeginTable()
1193b4be Poul Sander 2025-02-03 21:28 1946
// - Important! Sizing policies have complex and subtle side effects, much more so than you would expect.
1193b4be Poul Sander 2025-02-03 21:28 1947
//   Read comments/demos carefully + experiment with live demos to get acquainted with them.
1193b4be Poul Sander 2025-02-03 21:28 1948
// - The DEFAULT sizing policies are:
1193b4be Poul Sander 2025-02-03 21:28 1949
//    - Default to ImGuiTableFlags_SizingFixedFit    if ScrollX is on, or if host window has ImGuiWindowFlags_AlwaysAutoResize.
1193b4be Poul Sander 2025-02-03 21:28 1950
//    - Default to ImGuiTableFlags_SizingStretchSame if ScrollX is off.
1193b4be Poul Sander 2025-02-03 21:28 1951
// - When ScrollX is off:
1193b4be Poul Sander 2025-02-03 21:28 1952
//    - Table defaults to ImGuiTableFlags_SizingStretchSame -> all Columns defaults to ImGuiTableColumnFlags_WidthStretch with same weight.
1193b4be Poul Sander 2025-02-03 21:28 1953
//    - Columns sizing policy allowed: Stretch (default), Fixed/Auto.
1193b4be Poul Sander 2025-02-03 21:28 1954
//    - Fixed Columns (if any) will generally obtain their requested width (unless the table cannot fit them all).
1193b4be Poul Sander 2025-02-03 21:28 1955
//    - Stretch Columns will share the remaining width according to their respective weight.
1193b4be Poul Sander 2025-02-03 21:28 1956
//    - Mixed Fixed/Stretch columns is possible but has various side-effects on resizing behaviors.
1193b4be Poul Sander 2025-02-03 21:28 1957
//      The typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns.
1193b4be Poul Sander 2025-02-03 21:28 1958
//      (this is because the visible order of columns have subtle but necessary effects on how they react to manual resizing).
1193b4be Poul Sander 2025-02-03 21:28 1959
// - When ScrollX is on:
1193b4be Poul Sander 2025-02-03 21:28 1960
//    - Table defaults to ImGuiTableFlags_SizingFixedFit -> all Columns defaults to ImGuiTableColumnFlags_WidthFixed
1193b4be Poul Sander 2025-02-03 21:28 1961
//    - Columns sizing policy allowed: Fixed/Auto mostly.
1193b4be Poul Sander 2025-02-03 21:28 1962
//    - Fixed Columns can be enlarged as needed. Table will show a horizontal scrollbar if needed.
1193b4be Poul Sander 2025-02-03 21:28 1963
//    - When using auto-resizing (non-resizable) fixed columns, querying the content width to use item right-alignment e.g. SetNextItemWidth(-FLT_MIN) doesn't make sense, would create a feedback loop.
1193b4be Poul Sander 2025-02-03 21:28 1964
//    - Using Stretch columns OFTEN DOES NOT MAKE SENSE if ScrollX is on, UNLESS you have specified a value for 'inner_width' in BeginTable().
1193b4be Poul Sander 2025-02-03 21:28 1965
//      If you specify a value for 'inner_width' then effectively the scrolling space is known and Stretch or mixed Fixed/Stretch columns become meaningful again.
1193b4be Poul Sander 2025-02-03 21:28 1966
// - Read on documentation at the top of imgui_tables.cpp for details.
1193b4be Poul Sander 2025-02-03 21:28 1967
enum ImGuiTableFlags_
1193b4be Poul Sander 2025-02-03 21:28 1968
{
1193b4be Poul Sander 2025-02-03 21:28 1969
    // Features
1193b4be Poul Sander 2025-02-03 21:28 1970
    ImGuiTableFlags_None                       = 0,
1193b4be Poul Sander 2025-02-03 21:28 1971
    ImGuiTableFlags_Resizable                  = 1 << 0,   // Enable resizing columns.
1193b4be Poul Sander 2025-02-03 21:28 1972
    ImGuiTableFlags_Reorderable                = 1 << 1,   // Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)
1193b4be Poul Sander 2025-02-03 21:28 1973
    ImGuiTableFlags_Hideable                   = 1 << 2,   // Enable hiding/disabling columns in context menu.
1193b4be Poul Sander 2025-02-03 21:28 1974
    ImGuiTableFlags_Sortable                   = 1 << 3,   // Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.
1193b4be Poul Sander 2025-02-03 21:28 1975
    ImGuiTableFlags_NoSavedSettings            = 1 << 4,   // Disable persisting columns order, width and sort settings in the .ini file.
1193b4be Poul Sander 2025-02-03 21:28 1976
    ImGuiTableFlags_ContextMenuInBody          = 1 << 5,   // Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().
1193b4be Poul Sander 2025-02-03 21:28 1977
    // Decorations
1193b4be Poul Sander 2025-02-03 21:28 1978
    ImGuiTableFlags_RowBg                      = 1 << 6,   // Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)
1193b4be Poul Sander 2025-02-03 21:28 1979
    ImGuiTableFlags_BordersInnerH              = 1 << 7,   // Draw horizontal borders between rows.
1193b4be Poul Sander 2025-02-03 21:28 1980
    ImGuiTableFlags_BordersOuterH              = 1 << 8,   // Draw horizontal borders at the top and bottom.
1193b4be Poul Sander 2025-02-03 21:28 1981
    ImGuiTableFlags_BordersInnerV              = 1 << 9,   // Draw vertical borders between columns.
1193b4be Poul Sander 2025-02-03 21:28 1982
    ImGuiTableFlags_BordersOuterV              = 1 << 10,  // Draw vertical borders on the left and right sides.
1193b4be Poul Sander 2025-02-03 21:28 1983
    ImGuiTableFlags_BordersH                   = ImGuiTableFlags_BordersInnerH | ImGuiTableFlags_BordersOuterH, // Draw horizontal borders.
1193b4be Poul Sander 2025-02-03 21:28 1984
    ImGuiTableFlags_BordersV                   = ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_BordersOuterV, // Draw vertical borders.
1193b4be Poul Sander 2025-02-03 21:28 1985
    ImGuiTableFlags_BordersInner               = ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_BordersInnerH, // Draw inner borders.
1193b4be Poul Sander 2025-02-03 21:28 1986
    ImGuiTableFlags_BordersOuter               = ImGuiTableFlags_BordersOuterV | ImGuiTableFlags_BordersOuterH, // Draw outer borders.
1193b4be Poul Sander 2025-02-03 21:28 1987
    ImGuiTableFlags_Borders                    = ImGuiTableFlags_BordersInner | ImGuiTableFlags_BordersOuter,   // Draw all borders.
1193b4be Poul Sander 2025-02-03 21:28 1988
    ImGuiTableFlags_NoBordersInBody            = 1 << 11,  // [ALPHA] Disable vertical borders in columns Body (borders will always appear in Headers). -> May move to style
1193b4be Poul Sander 2025-02-03 21:28 1989
    ImGuiTableFlags_NoBordersInBodyUntilResize = 1 << 12,  // [ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appear in Headers). -> May move to style
1193b4be Poul Sander 2025-02-03 21:28 1990
    // Sizing Policy (read above for defaults)
1193b4be Poul Sander 2025-02-03 21:28 1991
    ImGuiTableFlags_SizingFixedFit             = 1 << 13,  // Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width.
1193b4be Poul Sander 2025-02-03 21:28 1992
    ImGuiTableFlags_SizingFixedSame            = 2 << 13,  // Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible.
1193b4be Poul Sander 2025-02-03 21:28 1993
    ImGuiTableFlags_SizingStretchProp          = 3 << 13,  // Columns default to _WidthStretch with default weights proportional to each columns contents widths.
1193b4be Poul Sander 2025-02-03 21:28 1994
    ImGuiTableFlags_SizingStretchSame          = 4 << 13,  // Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn().
1193b4be Poul Sander 2025-02-03 21:28 1995
    // Sizing Extra Options
1193b4be Poul Sander 2025-02-03 21:28 1996
    ImGuiTableFlags_NoHostExtendX              = 1 << 16,  // Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.
1193b4be Poul Sander 2025-02-03 21:28 1997
    ImGuiTableFlags_NoHostExtendY              = 1 << 17,  // Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.
1193b4be Poul Sander 2025-02-03 21:28 1998
    ImGuiTableFlags_NoKeepColumnsVisible       = 1 << 18,  // Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable.
1193b4be Poul Sander 2025-02-03 21:28 1999
    ImGuiTableFlags_PreciseWidths              = 1 << 19,  // Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.
1193b4be Poul Sander 2025-02-03 21:28 2000
    // Clipping
1193b4be Poul Sander 2025-02-03 21:28 2001
    ImGuiTableFlags_NoClip                     = 1 << 20,  // Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze().
1193b4be Poul Sander 2025-02-03 21:28 2002
    // Padding
1193b4be Poul Sander 2025-02-03 21:28 2003
    ImGuiTableFlags_PadOuterX                  = 1 << 21,  // Default if BordersOuterV is on. Enable outermost padding. Generally desirable if you have headers.
1193b4be Poul Sander 2025-02-03 21:28 2004
    ImGuiTableFlags_NoPadOuterX                = 1 << 22,  // Default if BordersOuterV is off. Disable outermost padding.
1193b4be Poul Sander 2025-02-03 21:28 2005
    ImGuiTableFlags_NoPadInnerX                = 1 << 23,  // Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).
1193b4be Poul Sander 2025-02-03 21:28 2006
    // Scrolling
1193b4be Poul Sander 2025-02-03 21:28 2007
    ImGuiTableFlags_ScrollX                    = 1 << 24,  // Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this creates a child window, ScrollY is currently generally recommended when using ScrollX.
1193b4be Poul Sander 2025-02-03 21:28 2008
    ImGuiTableFlags_ScrollY                    = 1 << 25,  // Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size.
1193b4be Poul Sander 2025-02-03 21:28 2009
    // Sorting
1193b4be Poul Sander 2025-02-03 21:28 2010
    ImGuiTableFlags_SortMulti                  = 1 << 26,  // Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).
1193b4be Poul Sander 2025-02-03 21:28 2011
    ImGuiTableFlags_SortTristate               = 1 << 27,  // Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).
1193b4be Poul Sander 2025-02-03 21:28 2012
    // Miscellaneous
1193b4be Poul Sander 2025-02-03 21:28 2013
    ImGuiTableFlags_HighlightHoveredColumn     = 1 << 28,  // Highlight column headers when hovered (may evolve into a fuller highlight)
1193b4be Poul Sander 2025-02-03 21:28 2014
1193b4be Poul Sander 2025-02-03 21:28 2015
    // [Internal] Combinations and masks
1193b4be Poul Sander 2025-02-03 21:28 2016
    ImGuiTableFlags_SizingMask_                = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_SizingFixedSame | ImGuiTableFlags_SizingStretchProp | ImGuiTableFlags_SizingStretchSame,
1193b4be Poul Sander 2025-02-03 21:28 2017
};
1193b4be Poul Sander 2025-02-03 21:28 2018
1193b4be Poul Sander 2025-02-03 21:28 2019
// Flags for ImGui::TableSetupColumn()
1193b4be Poul Sander 2025-02-03 21:28 2020
enum ImGuiTableColumnFlags_
1193b4be Poul Sander 2025-02-03 21:28 2021
{
1193b4be Poul Sander 2025-02-03 21:28 2022
    // Input configuration flags
1193b4be Poul Sander 2025-02-03 21:28 2023
    ImGuiTableColumnFlags_None                  = 0,
1193b4be Poul Sander 2025-02-03 21:28 2024
    ImGuiTableColumnFlags_Disabled              = 1 << 0,   // Overriding/master disable flag: hide column, won't show in context menu (unlike calling TableSetColumnEnabled() which manipulates the user accessible state)
1193b4be Poul Sander 2025-02-03 21:28 2025
    ImGuiTableColumnFlags_DefaultHide           = 1 << 1,   // Default as a hidden/disabled column.
1193b4be Poul Sander 2025-02-03 21:28 2026
    ImGuiTableColumnFlags_DefaultSort           = 1 << 2,   // Default as a sorting column.
1193b4be Poul Sander 2025-02-03 21:28 2027
    ImGuiTableColumnFlags_WidthStretch          = 1 << 3,   // Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
1193b4be Poul Sander 2025-02-03 21:28 2028
    ImGuiTableColumnFlags_WidthFixed            = 1 << 4,   // Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).
1193b4be Poul Sander 2025-02-03 21:28 2029
    ImGuiTableColumnFlags_NoResize              = 1 << 5,   // Disable manual resizing.
1193b4be Poul Sander 2025-02-03 21:28 2030
    ImGuiTableColumnFlags_NoReorder             = 1 << 6,   // Disable manual reordering this column, this will also prevent other columns from crossing over this column.
1193b4be Poul Sander 2025-02-03 21:28 2031
    ImGuiTableColumnFlags_NoHide                = 1 << 7,   // Disable ability to hide/disable this column.
1193b4be Poul Sander 2025-02-03 21:28 2032
    ImGuiTableColumnFlags_NoClip                = 1 << 8,   // Disable clipping for this column (all NoClip columns will render in a same draw command).
1193b4be Poul Sander 2025-02-03 21:28 2033
    ImGuiTableColumnFlags_NoSort                = 1 << 9,   // Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table).
1193b4be Poul Sander 2025-02-03 21:28 2034
    ImGuiTableColumnFlags_NoSortAscending       = 1 << 10,  // Disable ability to sort in the ascending direction.
1193b4be Poul Sander 2025-02-03 21:28 2035
    ImGuiTableColumnFlags_NoSortDescending      = 1 << 11,  // Disable ability to sort in the descending direction.
1193b4be Poul Sander 2025-02-03 21:28 2036
    ImGuiTableColumnFlags_NoHeaderLabel         = 1 << 12,  // TableHeadersRow() will submit an empty label for this column. Convenient for some small columns. Name will still appear in context menu or in angled headers. You may append into this cell by calling TableSetColumnIndex() right after the TableHeadersRow() call.
1193b4be Poul Sander 2025-02-03 21:28 2037
    ImGuiTableColumnFlags_NoHeaderWidth         = 1 << 13,  // Disable header text width contribution to automatic column width.
1193b4be Poul Sander 2025-02-03 21:28 2038
    ImGuiTableColumnFlags_PreferSortAscending   = 1 << 14,  // Make the initial sort direction Ascending when first sorting on this column (default).
1193b4be Poul Sander 2025-02-03 21:28 2039
    ImGuiTableColumnFlags_PreferSortDescending  = 1 << 15,  // Make the initial sort direction Descending when first sorting on this column.
1193b4be Poul Sander 2025-02-03 21:28 2040
    ImGuiTableColumnFlags_IndentEnable          = 1 << 16,  // Use current Indent value when entering cell (default for column 0).
1193b4be Poul Sander 2025-02-03 21:28 2041
    ImGuiTableColumnFlags_IndentDisable         = 1 << 17,  // Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored.
1193b4be Poul Sander 2025-02-03 21:28 2042
    ImGuiTableColumnFlags_AngledHeader          = 1 << 18,  // TableHeadersRow() will submit an angled header row for this column. Note this will add an extra row.
1193b4be Poul Sander 2025-02-03 21:28 2043
1193b4be Poul Sander 2025-02-03 21:28 2044
    // Output status flags, read-only via TableGetColumnFlags()
1193b4be Poul Sander 2025-02-03 21:28 2045
    ImGuiTableColumnFlags_IsEnabled             = 1 << 24,  // Status: is enabled == not hidden by user/api (referred to as "Hide" in _DefaultHide and _NoHide) flags.
1193b4be Poul Sander 2025-02-03 21:28 2046
    ImGuiTableColumnFlags_IsVisible             = 1 << 25,  // Status: is visible == is enabled AND not clipped by scrolling.
1193b4be Poul Sander 2025-02-03 21:28 2047
    ImGuiTableColumnFlags_IsSorted              = 1 << 26,  // Status: is currently part of the sort specs
1193b4be Poul Sander 2025-02-03 21:28 2048
    ImGuiTableColumnFlags_IsHovered             = 1 << 27,  // Status: is hovered by mouse
1193b4be Poul Sander 2025-02-03 21:28 2049
1193b4be Poul Sander 2025-02-03 21:28 2050
    // [Internal] Combinations and masks
1193b4be Poul Sander 2025-02-03 21:28 2051
    ImGuiTableColumnFlags_WidthMask_            = ImGuiTableColumnFlags_WidthStretch | ImGuiTableColumnFlags_WidthFixed,
1193b4be Poul Sander 2025-02-03 21:28 2052
    ImGuiTableColumnFlags_IndentMask_           = ImGuiTableColumnFlags_IndentEnable | ImGuiTableColumnFlags_IndentDisable,
1193b4be Poul Sander 2025-02-03 21:28 2053
    ImGuiTableColumnFlags_StatusMask_           = ImGuiTableColumnFlags_IsEnabled | ImGuiTableColumnFlags_IsVisible | ImGuiTableColumnFlags_IsSorted | ImGuiTableColumnFlags_IsHovered,
1193b4be Poul Sander 2025-02-03 21:28 2054
    ImGuiTableColumnFlags_NoDirectResize_       = 1 << 30,  // [Internal] Disable user resizing this column directly (it may however we resized indirectly from its left edge)
1193b4be Poul Sander 2025-02-03 21:28 2055
};
1193b4be Poul Sander 2025-02-03 21:28 2056
1193b4be Poul Sander 2025-02-03 21:28 2057
// Flags for ImGui::TableNextRow()
1193b4be Poul Sander 2025-02-03 21:28 2058
enum ImGuiTableRowFlags_
1193b4be Poul Sander 2025-02-03 21:28 2059
{
1193b4be Poul Sander 2025-02-03 21:28 2060
    ImGuiTableRowFlags_None                     = 0,
1193b4be Poul Sander 2025-02-03 21:28 2061
    ImGuiTableRowFlags_Headers                  = 1 << 0,   // Identify header row (set default background color + width of its contents accounted differently for auto column width)
1193b4be Poul Sander 2025-02-03 21:28 2062
};
1193b4be Poul Sander 2025-02-03 21:28 2063
1193b4be Poul Sander 2025-02-03 21:28 2064
// Enum for ImGui::TableSetBgColor()
1193b4be Poul Sander 2025-02-03 21:28 2065
// Background colors are rendering in 3 layers:
1193b4be Poul Sander 2025-02-03 21:28 2066
//  - Layer 0: draw with RowBg0 color if set, otherwise draw with ColumnBg0 if set.
1193b4be Poul Sander 2025-02-03 21:28 2067
//  - Layer 1: draw with RowBg1 color if set, otherwise draw with ColumnBg1 if set.
1193b4be Poul Sander 2025-02-03 21:28 2068
//  - Layer 2: draw with CellBg color if set.
1193b4be Poul Sander 2025-02-03 21:28 2069
// The purpose of the two row/columns layers is to let you decide if a background color change should override or blend with the existing color.
1193b4be Poul Sander 2025-02-03 21:28 2070
// When using ImGuiTableFlags_RowBg on the table, each row has the RowBg0 color automatically set for odd/even rows.
1193b4be Poul Sander 2025-02-03 21:28 2071
// If you set the color of RowBg0 target, your color will override the existing RowBg0 color.
1193b4be Poul Sander 2025-02-03 21:28 2072
// If you set the color of RowBg1 or ColumnBg1 target, your color will blend over the RowBg0 color.
1193b4be Poul Sander 2025-02-03 21:28 2073
enum ImGuiTableBgTarget_
1193b4be Poul Sander 2025-02-03 21:28 2074
{
1193b4be Poul Sander 2025-02-03 21:28 2075
    ImGuiTableBgTarget_None                     = 0,
1193b4be Poul Sander 2025-02-03 21:28 2076
    ImGuiTableBgTarget_RowBg0                   = 1,        // Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used)
1193b4be Poul Sander 2025-02-03 21:28 2077
    ImGuiTableBgTarget_RowBg1                   = 2,        // Set row background color 1 (generally used for selection marking)
1193b4be Poul Sander 2025-02-03 21:28 2078
    ImGuiTableBgTarget_CellBg                   = 3,        // Set cell background color (top-most color)
1193b4be Poul Sander 2025-02-03 21:28 2079
};
1193b4be Poul Sander 2025-02-03 21:28 2080
1193b4be Poul Sander 2025-02-03 21:28 2081
// Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
1193b4be Poul Sander 2025-02-03 21:28 2082
// Obtained by calling TableGetSortSpecs().
1193b4be Poul Sander 2025-02-03 21:28 2083
// When 'SpecsDirty == true' you can sort your data. It will be true with sorting specs have changed since last call, or the first time.
1193b4be Poul Sander 2025-02-03 21:28 2084
// Make sure to set 'SpecsDirty = false' after sorting, else you may wastefully sort your data every frame!
1193b4be Poul Sander 2025-02-03 21:28 2085
struct ImGuiTableSortSpecs
1193b4be Poul Sander 2025-02-03 21:28 2086
{
1193b4be Poul Sander 2025-02-03 21:28 2087
    const ImGuiTableColumnSortSpecs* Specs;     // Pointer to sort spec array.
1193b4be Poul Sander 2025-02-03 21:28 2088
    int                         SpecsCount;     // Sort spec count. Most often 1. May be > 1 when ImGuiTableFlags_SortMulti is enabled. May be == 0 when ImGuiTableFlags_SortTristate is enabled.
1193b4be Poul Sander 2025-02-03 21:28 2089
    bool                        SpecsDirty;     // Set to true when specs have changed since last time! Use this to sort again, then clear the flag.
1193b4be Poul Sander 2025-02-03 21:28 2090
1193b4be Poul Sander 2025-02-03 21:28 2091
    ImGuiTableSortSpecs()       { memset(this, 0, sizeof(*this)); }
1193b4be Poul Sander 2025-02-03 21:28 2092
};
1193b4be Poul Sander 2025-02-03 21:28 2093
1193b4be Poul Sander 2025-02-03 21:28 2094
// Sorting specification for one column of a table (sizeof == 12 bytes)
1193b4be Poul Sander 2025-02-03 21:28 2095
struct ImGuiTableColumnSortSpecs
1193b4be Poul Sander 2025-02-03 21:28 2096
{
1193b4be Poul Sander 2025-02-03 21:28 2097
    ImGuiID                     ColumnUserID;       // User id of the column (if specified by a TableSetupColumn() call)
1193b4be Poul Sander 2025-02-03 21:28 2098
    ImS16                       ColumnIndex;        // Index of the column
1193b4be Poul Sander 2025-02-03 21:28 2099
    ImS16                       SortOrder;          // Index within parent ImGuiTableSortSpecs (always stored in order starting from 0, tables sorted on a single criteria will always have a 0 here)
1193b4be Poul Sander 2025-02-03 21:28 2100
    ImGuiSortDirection          SortDirection;      // ImGuiSortDirection_Ascending or ImGuiSortDirection_Descending
1193b4be Poul Sander 2025-02-03 21:28 2101
1193b4be Poul Sander 2025-02-03 21:28 2102
    ImGuiTableColumnSortSpecs() { memset(this, 0, sizeof(*this)); }
1193b4be Poul Sander 2025-02-03 21:28 2103
};
1193b4be Poul Sander 2025-02-03 21:28 2104
1193b4be Poul Sander 2025-02-03 21:28 2105
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2106
// [SECTION] Helpers: Debug log, memory allocations macros, ImVector<>
1193b4be Poul Sander 2025-02-03 21:28 2107
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2108
1193b4be Poul Sander 2025-02-03 21:28 2109
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2110
// Debug Logging into ShowDebugLogWindow(), tty and more.
1193b4be Poul Sander 2025-02-03 21:28 2111
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2112
1193b4be Poul Sander 2025-02-03 21:28 2113
#ifndef IMGUI_DISABLE_DEBUG_TOOLS
1193b4be Poul Sander 2025-02-03 21:28 2114
#define IMGUI_DEBUG_LOG(...)        ImGui::DebugLog(__VA_ARGS__)
1193b4be Poul Sander 2025-02-03 21:28 2115
#else
1193b4be Poul Sander 2025-02-03 21:28 2116
#define IMGUI_DEBUG_LOG(...)        ((void)0)
1193b4be Poul Sander 2025-02-03 21:28 2117
#endif
1193b4be Poul Sander 2025-02-03 21:28 2118
1193b4be Poul Sander 2025-02-03 21:28 2119
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2120
// IM_MALLOC(), IM_FREE(), IM_NEW(), IM_PLACEMENT_NEW(), IM_DELETE()
1193b4be Poul Sander 2025-02-03 21:28 2121
// We call C++ constructor on own allocated memory via the placement "new(ptr) Type()" syntax.
1193b4be Poul Sander 2025-02-03 21:28 2122
// Defining a custom placement new() with a custom parameter allows us to bypass including <new> which on some platforms complains when user has disabled exceptions.
1193b4be Poul Sander 2025-02-03 21:28 2123
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2124
1193b4be Poul Sander 2025-02-03 21:28 2125
struct ImNewWrapper {};
1193b4be Poul Sander 2025-02-03 21:28 2126
inline void* operator new(size_t, ImNewWrapper, void* ptr) { return ptr; }
1193b4be Poul Sander 2025-02-03 21:28 2127
inline void  operator delete(void*, ImNewWrapper, void*)   {} // This is only required so we can use the symmetrical new()
1193b4be Poul Sander 2025-02-03 21:28 2128
#define IM_ALLOC(_SIZE)                     ImGui::MemAlloc(_SIZE)
1193b4be Poul Sander 2025-02-03 21:28 2129
#define IM_FREE(_PTR)                       ImGui::MemFree(_PTR)
1193b4be Poul Sander 2025-02-03 21:28 2130
#define IM_PLACEMENT_NEW(_PTR)              new(ImNewWrapper(), _PTR)
1193b4be Poul Sander 2025-02-03 21:28 2131
#define IM_NEW(_TYPE)                       new(ImNewWrapper(), ImGui::MemAlloc(sizeof(_TYPE))) _TYPE
1193b4be Poul Sander 2025-02-03 21:28 2132
template<typename T> void IM_DELETE(T* p)   { if (p) { p->~T(); ImGui::MemFree(p); } }
1193b4be Poul Sander 2025-02-03 21:28 2133
1193b4be Poul Sander 2025-02-03 21:28 2134
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2135
// ImVector<>
1193b4be Poul Sander 2025-02-03 21:28 2136
// Lightweight std::vector<>-like class to avoid dragging dependencies (also, some implementations of STL with debug enabled are absurdly slow, we bypass it so our code runs fast in debug).
1193b4be Poul Sander 2025-02-03 21:28 2137
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2138
// - You generally do NOT need to care or use this ever. But we need to make it available in imgui.h because some of our public structures are relying on it.
1193b4be Poul Sander 2025-02-03 21:28 2139
// - We use std-like naming convention here, which is a little unusual for this codebase.
1193b4be Poul Sander 2025-02-03 21:28 2140
// - Important: clear() frees memory, resize(0) keep the allocated buffer. We use resize(0) a lot to intentionally recycle allocated buffers across frames and amortize our costs.
1193b4be Poul Sander 2025-02-03 21:28 2141
// - Important: our implementation does NOT call C++ constructors/destructors, we treat everything as raw data! This is intentional but be extra mindful of that,
1193b4be Poul Sander 2025-02-03 21:28 2142
//   Do NOT use this class as a std::vector replacement in your own code! Many of the structures used by dear imgui can be safely initialized by a zero-memset.
1193b4be Poul Sander 2025-02-03 21:28 2143
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2144
1193b4be Poul Sander 2025-02-03 21:28 2145
IM_MSVC_RUNTIME_CHECKS_OFF
1193b4be Poul Sander 2025-02-03 21:28 2146
template<typename T>
1193b4be Poul Sander 2025-02-03 21:28 2147
struct ImVector
1193b4be Poul Sander 2025-02-03 21:28 2148
{
1193b4be Poul Sander 2025-02-03 21:28 2149
    int                 Size;
1193b4be Poul Sander 2025-02-03 21:28 2150
    int                 Capacity;
1193b4be Poul Sander 2025-02-03 21:28 2151
    T*                  Data;
1193b4be Poul Sander 2025-02-03 21:28 2152
1193b4be Poul Sander 2025-02-03 21:28 2153
    // Provide standard typedefs but we don't use them ourselves.
1193b4be Poul Sander 2025-02-03 21:28 2154
    typedef T                   value_type;
1193b4be Poul Sander 2025-02-03 21:28 2155
    typedef value_type*         iterator;
1193b4be Poul Sander 2025-02-03 21:28 2156
    typedef const value_type*   const_iterator;
1193b4be Poul Sander 2025-02-03 21:28 2157
1193b4be Poul Sander 2025-02-03 21:28 2158
    // Constructors, destructor
1193b4be Poul Sander 2025-02-03 21:28 2159
    inline ImVector()                                       { Size = Capacity = 0; Data = NULL; }
1193b4be Poul Sander 2025-02-03 21:28 2160
    inline ImVector(const ImVector<T>& src)                 { Size = Capacity = 0; Data = NULL; operator=(src); }
1193b4be Poul Sander 2025-02-03 21:28 2161
    inline ImVector<T>& operator=(const ImVector<T>& src)   { clear(); resize(src.Size); if (src.Data) memcpy(Data, src.Data, (size_t)Size * sizeof(T)); return *this; }
1193b4be Poul Sander 2025-02-03 21:28 2162
    inline ~ImVector()                                      { if (Data) IM_FREE(Data); } // Important: does not destruct anything
1193b4be Poul Sander 2025-02-03 21:28 2163
1193b4be Poul Sander 2025-02-03 21:28 2164
    inline void         clear()                             { if (Data) { Size = Capacity = 0; IM_FREE(Data); Data = NULL; } }  // Important: does not destruct anything
1193b4be Poul Sander 2025-02-03 21:28 2165
    inline void         clear_delete()                      { for (int n = 0; n < Size; n++) IM_DELETE(Data[n]); clear(); }     // Important: never called automatically! always explicit.
1193b4be Poul Sander 2025-02-03 21:28 2166
    inline void         clear_destruct()                    { for (int n = 0; n < Size; n++) Data[n].~T(); clear(); }           // Important: never called automatically! always explicit.
1193b4be Poul Sander 2025-02-03 21:28 2167
1193b4be Poul Sander 2025-02-03 21:28 2168
    inline bool         empty() const                       { return Size == 0; }
1193b4be Poul Sander 2025-02-03 21:28 2169
    inline int          size() const                        { return Size; }
1193b4be Poul Sander 2025-02-03 21:28 2170
    inline int          size_in_bytes() const               { return Size * (int)sizeof(T); }
1193b4be Poul Sander 2025-02-03 21:28 2171
    inline int          max_size() const                    { return 0x7FFFFFFF / (int)sizeof(T); }
1193b4be Poul Sander 2025-02-03 21:28 2172
    inline int          capacity() const                    { return Capacity; }
1193b4be Poul Sander 2025-02-03 21:28 2173
    inline T&           operator[](int i)                   { IM_ASSERT(i >= 0 && i < Size); return Data[i]; }
1193b4be Poul Sander 2025-02-03 21:28 2174
    inline const T&     operator[](int i) const             { IM_ASSERT(i >= 0 && i < Size); return Data[i]; }
1193b4be Poul Sander 2025-02-03 21:28 2175
1193b4be Poul Sander 2025-02-03 21:28 2176
    inline T*           begin()                             { return Data; }
1193b4be Poul Sander 2025-02-03 21:28 2177
    inline const T*     begin() const                       { return Data; }
1193b4be Poul Sander 2025-02-03 21:28 2178
    inline T*           end()                               { return Data + Size; }
1193b4be Poul Sander 2025-02-03 21:28 2179
    inline const T*     end() const                         { return Data + Size; }
1193b4be Poul Sander 2025-02-03 21:28 2180
    inline T&           front()                             { IM_ASSERT(Size > 0); return Data[0]; }
1193b4be Poul Sander 2025-02-03 21:28 2181
    inline const T&     front() const                       { IM_ASSERT(Size > 0); return Data[0]; }
1193b4be Poul Sander 2025-02-03 21:28 2182
    inline T&           back()                              { IM_ASSERT(Size > 0); return Data[Size - 1]; }
1193b4be Poul Sander 2025-02-03 21:28 2183
    inline const T&     back() const                        { IM_ASSERT(Size > 0); return Data[Size - 1]; }
1193b4be Poul Sander 2025-02-03 21:28 2184
    inline void         swap(ImVector<T>& rhs)              { int rhs_size = rhs.Size; rhs.Size = Size; Size = rhs_size; int rhs_cap = rhs.Capacity; rhs.Capacity = Capacity; Capacity = rhs_cap; T* rhs_data = rhs.Data; rhs.Data = Data; Data = rhs_data; }
1193b4be Poul Sander 2025-02-03 21:28 2185
1193b4be Poul Sander 2025-02-03 21:28 2186
    inline int          _grow_capacity(int sz) const        { int new_capacity = Capacity ? (Capacity + Capacity / 2) : 8; return new_capacity > sz ? new_capacity : sz; }
1193b4be Poul Sander 2025-02-03 21:28 2187
    inline void         resize(int new_size)                { if (new_size > Capacity) reserve(_grow_capacity(new_size)); Size = new_size; }
1193b4be Poul Sander 2025-02-03 21:28 2188
    inline void         resize(int new_size, const T& v)    { if (new_size > Capacity) reserve(_grow_capacity(new_size)); if (new_size > Size) for (int n = Size; n < new_size; n++) memcpy(&Data[n], &v, sizeof(v)); Size = new_size; }
1193b4be Poul Sander 2025-02-03 21:28 2189
    inline void         shrink(int new_size)                { IM_ASSERT(new_size <= Size); Size = new_size; } // Resize a vector to a smaller size, guaranteed not to cause a reallocation
1193b4be Poul Sander 2025-02-03 21:28 2190
    inline void         reserve(int new_capacity)           { if (new_capacity <= Capacity) return; T* new_data = (T*)IM_ALLOC((size_t)new_capacity * sizeof(T)); if (Data) { memcpy(new_data, Data, (size_t)Size * sizeof(T)); IM_FREE(Data); } Data = new_data; Capacity = new_capacity; }
1193b4be Poul Sander 2025-02-03 21:28 2191
    inline void         reserve_discard(int new_capacity)   { if (new_capacity <= Capacity) return; if (Data) IM_FREE(Data); Data = (T*)IM_ALLOC((size_t)new_capacity * sizeof(T)); Capacity = new_capacity; }
1193b4be Poul Sander 2025-02-03 21:28 2192
1193b4be Poul Sander 2025-02-03 21:28 2193
    // NB: It is illegal to call push_back/push_front/insert with a reference pointing inside the ImVector data itself! e.g. v.push_back(v[10]) is forbidden.
1193b4be Poul Sander 2025-02-03 21:28 2194
    inline void         push_back(const T& v)               { if (Size == Capacity) reserve(_grow_capacity(Size + 1)); memcpy(&Data[Size], &v, sizeof(v)); Size++; }
1193b4be Poul Sander 2025-02-03 21:28 2195
    inline void         pop_back()                          { IM_ASSERT(Size > 0); Size--; }
1193b4be Poul Sander 2025-02-03 21:28 2196
    inline void         push_front(const T& v)              { if (Size == 0) push_back(v); else insert(Data, v); }
1193b4be Poul Sander 2025-02-03 21:28 2197
    inline T*           erase(const T* it)                  { IM_ASSERT(it >= Data && it < Data + Size); const ptrdiff_t off = it - Data; memmove(Data + off, Data + off + 1, ((size_t)Size - (size_t)off - 1) * sizeof(T)); Size--; return Data + off; }
1193b4be Poul Sander 2025-02-03 21:28 2198
    inline T*           erase(const T* it, const T* it_last){ IM_ASSERT(it >= Data && it < Data + Size && it_last >= it && it_last <= Data + Size); const ptrdiff_t count = it_last - it; const ptrdiff_t off = it - Data; memmove(Data + off, Data + off + count, ((size_t)Size - (size_t)off - (size_t)count) * sizeof(T)); Size -= (int)count; return Data + off; }
1193b4be Poul Sander 2025-02-03 21:28 2199
    inline T*           erase_unsorted(const T* it)         { IM_ASSERT(it >= Data && it < Data + Size);  const ptrdiff_t off = it - Data; if (it < Data + Size - 1) memcpy(Data + off, Data + Size - 1, sizeof(T)); Size--; return Data + off; }
1193b4be Poul Sander 2025-02-03 21:28 2200
    inline T*           insert(const T* it, const T& v)     { IM_ASSERT(it >= Data && it <= Data + Size); const ptrdiff_t off = it - Data; if (Size == Capacity) reserve(_grow_capacity(Size + 1)); if (off < (int)Size) memmove(Data + off + 1, Data + off, ((size_t)Size - (size_t)off) * sizeof(T)); memcpy(&Data[off], &v, sizeof(v)); Size++; return Data + off; }
1193b4be Poul Sander 2025-02-03 21:28 2201
    inline bool         contains(const T& v) const          { const T* data = Data;  const T* data_end = Data + Size; while (data < data_end) if (*data++ == v) return true; return false; }
1193b4be Poul Sander 2025-02-03 21:28 2202
    inline T*           find(const T& v)                    { T* data = Data;  const T* data_end = Data + Size; while (data < data_end) if (*data == v) break; else ++data; return data; }
1193b4be Poul Sander 2025-02-03 21:28 2203
    inline const T*     find(const T& v) const              { const T* data = Data;  const T* data_end = Data + Size; while (data < data_end) if (*data == v) break; else ++data; return data; }
1193b4be Poul Sander 2025-02-03 21:28 2204
    inline int          find_index(const T& v) const        { const T* data_end = Data + Size; const T* it = find(v); if (it == data_end) return -1; const ptrdiff_t off = it - Data; return (int)off; }
1193b4be Poul Sander 2025-02-03 21:28 2205
    inline bool         find_erase(const T& v)              { const T* it = find(v); if (it < Data + Size) { erase(it); return true; } return false; }
1193b4be Poul Sander 2025-02-03 21:28 2206
    inline bool         find_erase_unsorted(const T& v)     { const T* it = find(v); if (it < Data + Size) { erase_unsorted(it); return true; } return false; }
1193b4be Poul Sander 2025-02-03 21:28 2207
    inline int          index_from_ptr(const T* it) const   { IM_ASSERT(it >= Data && it < Data + Size); const ptrdiff_t off = it - Data; return (int)off; }
1193b4be Poul Sander 2025-02-03 21:28 2208
};
1193b4be Poul Sander 2025-02-03 21:28 2209
IM_MSVC_RUNTIME_CHECKS_RESTORE
1193b4be Poul Sander 2025-02-03 21:28 2210
1193b4be Poul Sander 2025-02-03 21:28 2211
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2212
// [SECTION] ImGuiStyle
1193b4be Poul Sander 2025-02-03 21:28 2213
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2214
// You may modify the ImGui::GetStyle() main instance during initialization and before NewFrame().
1193b4be Poul Sander 2025-02-03 21:28 2215
// During the frame, use ImGui::PushStyleVar(ImGuiStyleVar_XXXX)/PopStyleVar() to alter the main style values,
1193b4be Poul Sander 2025-02-03 21:28 2216
// and ImGui::PushStyleColor(ImGuiCol_XXX)/PopStyleColor() for colors.
1193b4be Poul Sander 2025-02-03 21:28 2217
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2218
1193b4be Poul Sander 2025-02-03 21:28 2219
struct ImGuiStyle
1193b4be Poul Sander 2025-02-03 21:28 2220
{
1193b4be Poul Sander 2025-02-03 21:28 2221
    float       Alpha;                      // Global alpha applies to everything in Dear ImGui.
1193b4be Poul Sander 2025-02-03 21:28 2222
    float       DisabledAlpha;              // Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha.
1193b4be Poul Sander 2025-02-03 21:28 2223
    ImVec2      WindowPadding;              // Padding within a window.
1193b4be Poul Sander 2025-02-03 21:28 2224
    float       WindowRounding;             // Radius of window corners rounding. Set to 0.0f to have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended.
1193b4be Poul Sander 2025-02-03 21:28 2225
    float       WindowBorderSize;           // Thickness of border around windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
1193b4be Poul Sander 2025-02-03 21:28 2226
    ImVec2      WindowMinSize;              // Minimum window size. This is a global setting. If you want to constrain individual windows, use SetNextWindowSizeConstraints().
1193b4be Poul Sander 2025-02-03 21:28 2227
    ImVec2      WindowTitleAlign;           // Alignment for title bar text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.
1193b4be Poul Sander 2025-02-03 21:28 2228
    ImGuiDir    WindowMenuButtonPosition;   // Side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to ImGuiDir_Left.
1193b4be Poul Sander 2025-02-03 21:28 2229
    float       ChildRounding;              // Radius of child window corners rounding. Set to 0.0f to have rectangular windows.
1193b4be Poul Sander 2025-02-03 21:28 2230
    float       ChildBorderSize;            // Thickness of border around child windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
1193b4be Poul Sander 2025-02-03 21:28 2231
    float       PopupRounding;              // Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding)
1193b4be Poul Sander 2025-02-03 21:28 2232
    float       PopupBorderSize;            // Thickness of border around popup/tooltip windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
1193b4be Poul Sander 2025-02-03 21:28 2233
    ImVec2      FramePadding;               // Padding within a framed rectangle (used by most widgets).
1193b4be Poul Sander 2025-02-03 21:28 2234
    float       FrameRounding;              // Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets).
1193b4be Poul Sander 2025-02-03 21:28 2235
    float       FrameBorderSize;            // Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
1193b4be Poul Sander 2025-02-03 21:28 2236
    ImVec2      ItemSpacing;                // Horizontal and vertical spacing between widgets/lines.
1193b4be Poul Sander 2025-02-03 21:28 2237
    ImVec2      ItemInnerSpacing;           // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).
1193b4be Poul Sander 2025-02-03 21:28 2238
    ImVec2      CellPadding;                // Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows.
1193b4be Poul Sander 2025-02-03 21:28 2239
    ImVec2      TouchExtraPadding;          // Expand reactive bounding box for touch-based system where touch position is not accurate enough. Unfortunately we don't sort widgets so priority on overlap will always be given to the first widget. So don't grow this too much!
1193b4be Poul Sander 2025-02-03 21:28 2240
    float       IndentSpacing;              // Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).
1193b4be Poul Sander 2025-02-03 21:28 2241
    float       ColumnsMinSpacing;          // Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
1193b4be Poul Sander 2025-02-03 21:28 2242
    float       ScrollbarSize;              // Width of the vertical scrollbar, Height of the horizontal scrollbar.
1193b4be Poul Sander 2025-02-03 21:28 2243
    float       ScrollbarRounding;          // Radius of grab corners for scrollbar.
1193b4be Poul Sander 2025-02-03 21:28 2244
    float       GrabMinSize;                // Minimum width/height of a grab box for slider/scrollbar.
1193b4be Poul Sander 2025-02-03 21:28 2245
    float       GrabRounding;               // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
1193b4be Poul Sander 2025-02-03 21:28 2246
    float       LogSliderDeadzone;          // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
1193b4be Poul Sander 2025-02-03 21:28 2247
    float       TabRounding;                // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
1193b4be Poul Sander 2025-02-03 21:28 2248
    float       TabBorderSize;              // Thickness of border around tabs.
1193b4be Poul Sander 2025-02-03 21:28 2249
    float       TabMinWidthForCloseButton;  // Minimum width for close button to appear on an unselected tab when hovered. Set to 0.0f to always show when hovering, set to FLT_MAX to never show close button unless selected.
1193b4be Poul Sander 2025-02-03 21:28 2250
    float       TabBarBorderSize;           // Thickness of tab-bar separator, which takes on the tab active color to denote focus.
1193b4be Poul Sander 2025-02-03 21:28 2251
    float       TabBarOverlineSize;         // Thickness of tab-bar overline, which highlights the selected tab-bar.
1193b4be Poul Sander 2025-02-03 21:28 2252
    float       TableAngledHeadersAngle;    // Angle of angled headers (supported values range from -50.0f degrees to +50.0f degrees).
1193b4be Poul Sander 2025-02-03 21:28 2253
    ImVec2      TableAngledHeadersTextAlign;// Alignment of angled headers within the cell
1193b4be Poul Sander 2025-02-03 21:28 2254
    ImGuiDir    ColorButtonPosition;        // Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right.
1193b4be Poul Sander 2025-02-03 21:28 2255
    ImVec2      ButtonTextAlign;            // Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered).
1193b4be Poul Sander 2025-02-03 21:28 2256
    ImVec2      SelectableTextAlign;        // Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line.
1193b4be Poul Sander 2025-02-03 21:28 2257
    float       SeparatorTextBorderSize;    // Thickness of border in SeparatorText()
1193b4be Poul Sander 2025-02-03 21:28 2258
    ImVec2      SeparatorTextAlign;         // Alignment of text within the separator. Defaults to (0.0f, 0.5f) (left aligned, center).
1193b4be Poul Sander 2025-02-03 21:28 2259
    ImVec2      SeparatorTextPadding;       // Horizontal offset of text from each edge of the separator + spacing on other axis. Generally small values. .y is recommended to be == FramePadding.y.
1193b4be Poul Sander 2025-02-03 21:28 2260
    ImVec2      DisplayWindowPadding;       // Apply to regular windows: amount which we enforce to keep visible when moving near edges of your screen.
1193b4be Poul Sander 2025-02-03 21:28 2261
    ImVec2      DisplaySafeAreaPadding;     // Apply to every windows, menus, popups, tooltips: amount where we avoid displaying contents. Adjust if you cannot see the edges of your screen (e.g. on a TV where scaling has not been configured).
1193b4be Poul Sander 2025-02-03 21:28 2262
    float       DockingSeparatorSize;       // Thickness of resizing border between docked windows
1193b4be Poul Sander 2025-02-03 21:28 2263
    float       MouseCursorScale;           // Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). We apply per-monitor DPI scaling over this scale. May be removed later.
1193b4be Poul Sander 2025-02-03 21:28 2264
    bool        AntiAliasedLines;           // Enable anti-aliased lines/borders. Disable if you are really tight on CPU/GPU. Latched at the beginning of the frame (copied to ImDrawList).
1193b4be Poul Sander 2025-02-03 21:28 2265
    bool        AntiAliasedLinesUseTex;     // Enable anti-aliased lines/borders using textures where possible. Require backend to render with bilinear filtering (NOT point/nearest filtering). Latched at the beginning of the frame (copied to ImDrawList).
1193b4be Poul Sander 2025-02-03 21:28 2266
    bool        AntiAliasedFill;            // Enable anti-aliased edges around filled shapes (rounded rectangles, circles, etc.). Disable if you are really tight on CPU/GPU. Latched at the beginning of the frame (copied to ImDrawList).
1193b4be Poul Sander 2025-02-03 21:28 2267
    float       CurveTessellationTol;       // Tessellation tolerance when using PathBezierCurveTo() without a specific number of segments. Decrease for highly tessellated curves (higher quality, more polygons), increase to reduce quality.
1193b4be Poul Sander 2025-02-03 21:28 2268
    float       CircleTessellationMaxError; // Maximum error (in pixels) allowed when using AddCircle()/AddCircleFilled() or drawing rounded corner rectangles with no explicit segment count specified. Decrease for higher quality but more geometry.
1193b4be Poul Sander 2025-02-03 21:28 2269
    ImVec4      Colors[ImGuiCol_COUNT];
1193b4be Poul Sander 2025-02-03 21:28 2270
1193b4be Poul Sander 2025-02-03 21:28 2271
    // Behaviors
1193b4be Poul Sander 2025-02-03 21:28 2272
    // (It is possible to modify those fields mid-frame if specific behavior need it, unlike e.g. configuration fields in ImGuiIO)
1193b4be Poul Sander 2025-02-03 21:28 2273
    float             HoverStationaryDelay;     // Delay for IsItemHovered(ImGuiHoveredFlags_Stationary). Time required to consider mouse stationary.
1193b4be Poul Sander 2025-02-03 21:28 2274
    float             HoverDelayShort;          // Delay for IsItemHovered(ImGuiHoveredFlags_DelayShort). Usually used along with HoverStationaryDelay.
1193b4be Poul Sander 2025-02-03 21:28 2275
    float             HoverDelayNormal;         // Delay for IsItemHovered(ImGuiHoveredFlags_DelayNormal). "
1193b4be Poul Sander 2025-02-03 21:28 2276
    ImGuiHoveredFlags HoverFlagsForTooltipMouse;// Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using mouse.
1193b4be Poul Sander 2025-02-03 21:28 2277
    ImGuiHoveredFlags HoverFlagsForTooltipNav;  // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using keyboard/gamepad.
1193b4be Poul Sander 2025-02-03 21:28 2278
1193b4be Poul Sander 2025-02-03 21:28 2279
    IMGUI_API ImGuiStyle();
1193b4be Poul Sander 2025-02-03 21:28 2280
    IMGUI_API void ScaleAllSizes(float scale_factor);
1193b4be Poul Sander 2025-02-03 21:28 2281
};
1193b4be Poul Sander 2025-02-03 21:28 2282
1193b4be Poul Sander 2025-02-03 21:28 2283
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2284
// [SECTION] ImGuiIO
1193b4be Poul Sander 2025-02-03 21:28 2285
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2286
// Communicate most settings and inputs/outputs to Dear ImGui using this structure.
1193b4be Poul Sander 2025-02-03 21:28 2287
// Access via ImGui::GetIO(). Read 'Programmer guide' section in .cpp file for general usage.
1193b4be Poul Sander 2025-02-03 21:28 2288
// It is generally expected that:
1193b4be Poul Sander 2025-02-03 21:28 2289
// - initialization: backends and user code writes to ImGuiIO.
1193b4be Poul Sander 2025-02-03 21:28 2290
// - main loop: backends writes to ImGuiIO, user code and imgui code reads from ImGuiIO.
1193b4be Poul Sander 2025-02-03 21:28 2291
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2292
// Also see ImGui::GetPlatformIO() and ImGuiPlatformIO struct for OS/platform related functions: clipboard, IME etc.
1193b4be Poul Sander 2025-02-03 21:28 2293
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2294
1193b4be Poul Sander 2025-02-03 21:28 2295
// [Internal] Storage used by IsKeyDown(), IsKeyPressed() etc functions.
1193b4be Poul Sander 2025-02-03 21:28 2296
// If prior to 1.87 you used io.KeysDownDuration[] (which was marked as internal), you should use GetKeyData(key)->DownDuration and *NOT* io.KeysData[key]->DownDuration.
1193b4be Poul Sander 2025-02-03 21:28 2297
struct ImGuiKeyData
1193b4be Poul Sander 2025-02-03 21:28 2298
{
1193b4be Poul Sander 2025-02-03 21:28 2299
    bool        Down;               // True for if key is down
1193b4be Poul Sander 2025-02-03 21:28 2300
    float       DownDuration;       // Duration the key has been down (<0.0f: not pressed, 0.0f: just pressed, >0.0f: time held)
1193b4be Poul Sander 2025-02-03 21:28 2301
    float       DownDurationPrev;   // Last frame duration the key has been down
1193b4be Poul Sander 2025-02-03 21:28 2302
    float       AnalogValue;        // 0.0f..1.0f for gamepad values
1193b4be Poul Sander 2025-02-03 21:28 2303
};
1193b4be Poul Sander 2025-02-03 21:28 2304
1193b4be Poul Sander 2025-02-03 21:28 2305
struct ImGuiIO
1193b4be Poul Sander 2025-02-03 21:28 2306
{
1193b4be Poul Sander 2025-02-03 21:28 2307
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2308
    // Configuration                            // Default value
1193b4be Poul Sander 2025-02-03 21:28 2309
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2310
1193b4be Poul Sander 2025-02-03 21:28 2311
    ImGuiConfigFlags   ConfigFlags;             // = 0              // See ImGuiConfigFlags_ enum. Set by user/application. Keyboard/Gamepad navigation options, etc.
1193b4be Poul Sander 2025-02-03 21:28 2312
    ImGuiBackendFlags  BackendFlags;            // = 0              // See ImGuiBackendFlags_ enum. Set by backend (imgui_impl_xxx files or custom backend) to communicate features supported by the backend.
1193b4be Poul Sander 2025-02-03 21:28 2313
    ImVec2      DisplaySize;                    // <unset>          // Main display size, in pixels (generally == GetMainViewport()->Size). May change every frame.
1193b4be Poul Sander 2025-02-03 21:28 2314
    float       DeltaTime;                      // = 1.0f/60.0f     // Time elapsed since last frame, in seconds. May change every frame.
1193b4be Poul Sander 2025-02-03 21:28 2315
    float       IniSavingRate;                  // = 5.0f           // Minimum time between saving positions/sizes to .ini file, in seconds.
1193b4be Poul Sander 2025-02-03 21:28 2316
    const char* IniFilename;                    // = "imgui.ini"    // Path to .ini file (important: default "imgui.ini" is relative to current working dir!). Set NULL to disable automatic .ini loading/saving or if you want to manually call LoadIniSettingsXXX() / SaveIniSettingsXXX() functions.
1193b4be Poul Sander 2025-02-03 21:28 2317
    const char* LogFilename;                    // = "imgui_log.txt"// Path to .log file (default parameter to ImGui::LogToFile when no file is specified).
1193b4be Poul Sander 2025-02-03 21:28 2318
    void*       UserData;                       // = NULL           // Store your own data.
1193b4be Poul Sander 2025-02-03 21:28 2319
1193b4be Poul Sander 2025-02-03 21:28 2320
    // Font system
1193b4be Poul Sander 2025-02-03 21:28 2321
    ImFontAtlas*Fonts;                          // <auto>           // Font atlas: load, rasterize and pack one or more fonts into a single texture.
1193b4be Poul Sander 2025-02-03 21:28 2322
    float       FontGlobalScale;                // = 1.0f           // Global scale all fonts
1193b4be Poul Sander 2025-02-03 21:28 2323
    bool        FontAllowUserScaling;           // = false          // Allow user scaling text of individual window with CTRL+Wheel.
1193b4be Poul Sander 2025-02-03 21:28 2324
    ImFont*     FontDefault;                    // = NULL           // Font to use on NewFrame(). Use NULL to uses Fonts->Fonts[0].
1193b4be Poul Sander 2025-02-03 21:28 2325
    ImVec2      DisplayFramebufferScale;        // = (1, 1)         // For retina display or other situations where window coordinates are different from framebuffer coordinates. This generally ends up in ImDrawData::FramebufferScale.
1193b4be Poul Sander 2025-02-03 21:28 2326
1193b4be Poul Sander 2025-02-03 21:28 2327
    // Keyboard/Gamepad Navigation options
1193b4be Poul Sander 2025-02-03 21:28 2328
    bool        ConfigNavSwapGamepadButtons;    // = false          // Swap Activate<>Cancel (A<>B) buttons, matching typical "Nintendo/Japanese style" gamepad layout.
1193b4be Poul Sander 2025-02-03 21:28 2329
    bool        ConfigNavMoveSetMousePos;       // = false          // Directional/tabbing navigation teleports the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is difficult. Will update io.MousePos and set io.WantSetMousePos=true. 
1193b4be Poul Sander 2025-02-03 21:28 2330
    bool        ConfigNavCaptureKeyboard;       // = true           // Sets io.WantCaptureKeyboard when io.NavActive is set.
1193b4be Poul Sander 2025-02-03 21:28 2331
    bool        ConfigNavEscapeClearFocusItem;  // = true           // Pressing Escape can clear focused item + navigation id/highlight. Set to false if you want to always keep highlight on.
1193b4be Poul Sander 2025-02-03 21:28 2332
    bool        ConfigNavEscapeClearFocusWindow;// = false          // Pressing Escape can clear focused window as well (super set of io.ConfigNavEscapeClearFocusItem).
1193b4be Poul Sander 2025-02-03 21:28 2333
    bool        ConfigNavCursorVisibleAuto;     // = true           // Using directional navigation key makes the cursor visible. Mouse click hides the cursor.
1193b4be Poul Sander 2025-02-03 21:28 2334
    bool        ConfigNavCursorVisibleAlways;   // = false          // Navigation cursor is always visible.
1193b4be Poul Sander 2025-02-03 21:28 2335
1193b4be Poul Sander 2025-02-03 21:28 2336
    // Docking options (when ImGuiConfigFlags_DockingEnable is set)
1193b4be Poul Sander 2025-02-03 21:28 2337
    bool        ConfigDockingNoSplit;           // = false          // Simplified docking mode: disable window splitting, so docking is limited to merging multiple windows together into tab-bars.
1193b4be Poul Sander 2025-02-03 21:28 2338
    bool        ConfigDockingWithShift;         // = false          // Enable docking with holding Shift key (reduce visual noise, allows dropping in wider space)
1193b4be Poul Sander 2025-02-03 21:28 2339
    bool        ConfigDockingAlwaysTabBar;      // = false          // [BETA] [FIXME: This currently creates regression with auto-sizing and general overhead] Make every single floating window display within a docking node.
1193b4be Poul Sander 2025-02-03 21:28 2340
    bool        ConfigDockingTransparentPayload;// = false          // [BETA] Make window or viewport transparent when docking and only display docking boxes on the target viewport. Useful if rendering of multiple viewport cannot be synced. Best used with ConfigViewportsNoAutoMerge.
1193b4be Poul Sander 2025-02-03 21:28 2341
1193b4be Poul Sander 2025-02-03 21:28 2342
    // Viewport options (when ImGuiConfigFlags_ViewportsEnable is set)
1193b4be Poul Sander 2025-02-03 21:28 2343
    bool        ConfigViewportsNoAutoMerge;     // = false;         // Set to make all floating imgui windows always create their own viewport. Otherwise, they are merged into the main host viewports when overlapping it. May also set ImGuiViewportFlags_NoAutoMerge on individual viewport.
1193b4be Poul Sander 2025-02-03 21:28 2344
    bool        ConfigViewportsNoTaskBarIcon;   // = false          // Disable default OS task bar icon flag for secondary viewports. When a viewport doesn't want a task bar icon, ImGuiViewportFlags_NoTaskBarIcon will be set on it.
1193b4be Poul Sander 2025-02-03 21:28 2345
    bool        ConfigViewportsNoDecoration;    // = true           // Disable default OS window decoration flag for secondary viewports. When a viewport doesn't want window decorations, ImGuiViewportFlags_NoDecoration will be set on it. Enabling decoration can create subsequent issues at OS levels (e.g. minimum window size).
1193b4be Poul Sander 2025-02-03 21:28 2346
    bool        ConfigViewportsNoDefaultParent; // = false          // Disable default OS parenting to main viewport for secondary viewports. By default, viewports are marked with ParentViewportId = <main_viewport>, expecting the platform backend to setup a parent/child relationship between the OS windows (some backend may ignore this). Set to true if you want the default to be 0, then all viewports will be top-level OS windows.
1193b4be Poul Sander 2025-02-03 21:28 2347
1193b4be Poul Sander 2025-02-03 21:28 2348
    // Miscellaneous options
1193b4be Poul Sander 2025-02-03 21:28 2349
    // (you can visualize and interact with all options in 'Demo->Configuration')
1193b4be Poul Sander 2025-02-03 21:28 2350
    bool        MouseDrawCursor;                // = false          // Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor). Cannot be easily renamed to 'io.ConfigXXX' because this is frequently used by backend implementations.
1193b4be Poul Sander 2025-02-03 21:28 2351
    bool        ConfigMacOSXBehaviors;          // = defined(__APPLE__) // Swap Cmd<>Ctrl keys + OS X style text editing cursor movement using Alt instead of Ctrl, Shortcuts using Cmd/Super instead of Ctrl, Line/Text Start and End using Cmd+Arrows instead of Home/End, Double click selects by word instead of selecting whole text, Multi-selection in lists uses Cmd/Super instead of Ctrl.
1193b4be Poul Sander 2025-02-03 21:28 2352
    bool        ConfigInputTrickleEventQueue;   // = true           // Enable input queue trickling: some types of events submitted during the same frame (e.g. button down + up) will be spread over multiple frames, improving interactions with low framerates.
1193b4be Poul Sander 2025-02-03 21:28 2353
    bool        ConfigInputTextCursorBlink;     // = true           // Enable blinking cursor (optional as some users consider it to be distracting).
1193b4be Poul Sander 2025-02-03 21:28 2354
    bool        ConfigInputTextEnterKeepActive; // = false          // [BETA] Pressing Enter will keep item active and select contents (single-line only).
1193b4be Poul Sander 2025-02-03 21:28 2355
    bool        ConfigDragClickToInputText;     // = false          // [BETA] Enable turning DragXXX widgets into text input with a simple mouse click-release (without moving). Not desirable on devices without a keyboard.
1193b4be Poul Sander 2025-02-03 21:28 2356
    bool        ConfigWindowsResizeFromEdges;   // = true           // Enable resizing of windows from their edges and from the lower-left corner. This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback. (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
1193b4be Poul Sander 2025-02-03 21:28 2357
    bool        ConfigWindowsMoveFromTitleBarOnly;  // = false      // Enable allowing to move windows only when clicking on their title bar. Does not apply to windows without a title bar.
1193b4be Poul Sander 2025-02-03 21:28 2358
    bool        ConfigScrollbarScrollByPage;    // = true           // Enable scrolling page by page when clicking outside the scrollbar grab. When disabled, always scroll to clicked location. When enabled, Shift+Click scrolls to clicked location.
1193b4be Poul Sander 2025-02-03 21:28 2359
    float       ConfigMemoryCompactTimer;       // = 60.0f          // Timer (in seconds) to free transient windows/tables memory buffers when unused. Set to -1.0f to disable.
1193b4be Poul Sander 2025-02-03 21:28 2360
1193b4be Poul Sander 2025-02-03 21:28 2361
    // Inputs Behaviors
1193b4be Poul Sander 2025-02-03 21:28 2362
    // (other variables, ones which are expected to be tweaked within UI code, are exposed in ImGuiStyle)
1193b4be Poul Sander 2025-02-03 21:28 2363
    float       MouseDoubleClickTime;           // = 0.30f          // Time for a double-click, in seconds.
1193b4be Poul Sander 2025-02-03 21:28 2364
    float       MouseDoubleClickMaxDist;        // = 6.0f           // Distance threshold to stay in to validate a double-click, in pixels.
1193b4be Poul Sander 2025-02-03 21:28 2365
    float       MouseDragThreshold;             // = 6.0f           // Distance threshold before considering we are dragging.
1193b4be Poul Sander 2025-02-03 21:28 2366
    float       KeyRepeatDelay;                 // = 0.275f         // When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).
1193b4be Poul Sander 2025-02-03 21:28 2367
    float       KeyRepeatRate;                  // = 0.050f         // When holding a key/button, rate at which it repeats, in seconds.
1193b4be Poul Sander 2025-02-03 21:28 2368
1193b4be Poul Sander 2025-02-03 21:28 2369
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2370
    // Debug options
1193b4be Poul Sander 2025-02-03 21:28 2371
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2372
1193b4be Poul Sander 2025-02-03 21:28 2373
    // Options to configure Error Handling and how we handle recoverable errors [EXPERIMENTAL]
1193b4be Poul Sander 2025-02-03 21:28 2374
    // - Error recovery is provided as a way to facilitate:
1193b4be Poul Sander 2025-02-03 21:28 2375
    //    - Recovery after a programming error (native code or scripting language - the later tends to facilitate iterating on code while running).
1193b4be Poul Sander 2025-02-03 21:28 2376
    //    - Recovery after running an exception handler or any error processing which may skip code after an error has been detected.
1193b4be Poul Sander 2025-02-03 21:28 2377
    // - Error recovery is not perfect nor guaranteed! It is a feature to ease development.
1193b4be Poul Sander 2025-02-03 21:28 2378
    //   You not are not supposed to rely on it in the course of a normal application run.
1193b4be Poul Sander 2025-02-03 21:28 2379
    // - Functions that support error recovery are using IM_ASSERT_USER_ERROR() instead of IM_ASSERT().
1193b4be Poul Sander 2025-02-03 21:28 2380
    // - By design, we do NOT allow error recovery to be 100% silent. One of the three options needs to be checked!
1193b4be Poul Sander 2025-02-03 21:28 2381
    // - Always ensure that on programmers seats you have at minimum Asserts or Tooltips enabled when making direct imgui API calls!
1193b4be Poul Sander 2025-02-03 21:28 2382
    //   Otherwise it would severely hinder your ability to catch and correct mistakes!
1193b4be Poul Sander 2025-02-03 21:28 2383
    // Read https://github.com/ocornut/imgui/wiki/Error-Handling for details.
1193b4be Poul Sander 2025-02-03 21:28 2384
    // - Programmer seats: keep asserts (default), or disable asserts and keep error tooltips (new and nice!)
1193b4be Poul Sander 2025-02-03 21:28 2385
    // - Non-programmer seats: maybe disable asserts, but make sure errors are resurfaced (tooltips, visible log entries, use callback etc.)
1193b4be Poul Sander 2025-02-03 21:28 2386
    // - Recovery after error/exception: record stack sizes with ErrorRecoveryStoreState(), disable assert, set log callback (to e.g. trigger high-level breakpoint), recover with ErrorRecoveryTryToRecoverState(), restore settings.
1193b4be Poul Sander 2025-02-03 21:28 2387
    bool        ConfigErrorRecovery;                // = true       // Enable error recovery support. Some errors won't be detected and lead to direct crashes if recovery is disabled.
1193b4be Poul Sander 2025-02-03 21:28 2388
    bool        ConfigErrorRecoveryEnableAssert;    // = true       // Enable asserts on recoverable error. By default call IM_ASSERT() when returning from a failing IM_ASSERT_USER_ERROR()
1193b4be Poul Sander 2025-02-03 21:28 2389
    bool        ConfigErrorRecoveryEnableDebugLog;  // = true       // Enable debug log output on recoverable errors.
1193b4be Poul Sander 2025-02-03 21:28 2390
    bool        ConfigErrorRecoveryEnableTooltip;   // = true       // Enable tooltip on recoverable errors. The tooltip include a way to enable asserts if they were disabled.
1193b4be Poul Sander 2025-02-03 21:28 2391
1193b4be Poul Sander 2025-02-03 21:28 2392
    // Option to enable various debug tools showing buttons that will call the IM_DEBUG_BREAK() macro.
1193b4be Poul Sander 2025-02-03 21:28 2393
    // - The Item Picker tool will be available regardless of this being enabled, in order to maximize its discoverability.
1193b4be Poul Sander 2025-02-03 21:28 2394
    // - Requires a debugger being attached, otherwise IM_DEBUG_BREAK() options will appear to crash your application.
1193b4be Poul Sander 2025-02-03 21:28 2395
    //   e.g. io.ConfigDebugIsDebuggerPresent = ::IsDebuggerPresent() on Win32, or refer to ImOsIsDebuggerPresent() imgui_test_engine/imgui_te_utils.cpp for a Unix compatible version).
1193b4be Poul Sander 2025-02-03 21:28 2396
    bool        ConfigDebugIsDebuggerPresent;   // = false          // Enable various tools calling IM_DEBUG_BREAK().
1193b4be Poul Sander 2025-02-03 21:28 2397
1193b4be Poul Sander 2025-02-03 21:28 2398
    // Tools to detect code submitting items with conflicting/duplicate IDs
1193b4be Poul Sander 2025-02-03 21:28 2399
    // - Code should use PushID()/PopID() in loops, or append "##xx" to same-label identifiers.
1193b4be Poul Sander 2025-02-03 21:28 2400
    // - Empty label e.g. Button("") == same ID as parent widget/node. Use Button("##xx") instead!
1193b4be Poul Sander 2025-02-03 21:28 2401
    // - See FAQ https://github.com/ocornut/imgui/blob/master/docs/FAQ.md#q-about-the-id-stack-system
1193b4be Poul Sander 2025-02-03 21:28 2402
    bool        ConfigDebugHighlightIdConflicts;// = true           // Highlight and show an error message when multiple items have conflicting identifiers.
1193b4be Poul Sander 2025-02-03 21:28 2403
1193b4be Poul Sander 2025-02-03 21:28 2404
    // Tools to test correct Begin/End and BeginChild/EndChild behaviors.
1193b4be Poul Sander 2025-02-03 21:28 2405
    // - Presently Begin()/End() and BeginChild()/EndChild() needs to ALWAYS be called in tandem, regardless of return value of BeginXXX()
1193b4be Poul Sander 2025-02-03 21:28 2406
    // - This is inconsistent with other BeginXXX functions and create confusion for many users.
1193b4be Poul Sander 2025-02-03 21:28 2407
    // - We expect to update the API eventually. In the meanwhile we provide tools to facilitate checking user-code behavior.
1193b4be Poul Sander 2025-02-03 21:28 2408
    bool        ConfigDebugBeginReturnValueOnce;// = false          // First-time calls to Begin()/BeginChild() will return false. NEEDS TO BE SET AT APPLICATION BOOT TIME if you don't want to miss windows.
1193b4be Poul Sander 2025-02-03 21:28 2409
    bool        ConfigDebugBeginReturnValueLoop;// = false          // Some calls to Begin()/BeginChild() will return false. Will cycle through window depths then repeat. Suggested use: add "io.ConfigDebugBeginReturnValue = io.KeyShift" in your main loop then occasionally press SHIFT. Windows should be flickering while running.
1193b4be Poul Sander 2025-02-03 21:28 2410
1193b4be Poul Sander 2025-02-03 21:28 2411
    // Option to deactivate io.AddFocusEvent(false) handling.
1193b4be Poul Sander 2025-02-03 21:28 2412
    // - May facilitate interactions with a debugger when focus loss leads to clearing inputs data.
1193b4be Poul Sander 2025-02-03 21:28 2413
    // - Backends may have other side-effects on focus loss, so this will reduce side-effects but not necessary remove all of them.
1193b4be Poul Sander 2025-02-03 21:28 2414
    bool        ConfigDebugIgnoreFocusLoss;     // = false          // Ignore io.AddFocusEvent(false), consequently not calling io.ClearInputKeys()/io.ClearInputMouse() in input processing.
1193b4be Poul Sander 2025-02-03 21:28 2415
1193b4be Poul Sander 2025-02-03 21:28 2416
    // Option to audit .ini data
1193b4be Poul Sander 2025-02-03 21:28 2417
    bool        ConfigDebugIniSettings;         // = false          // Save .ini data with extra comments (particularly helpful for Docking, but makes saving slower)
1193b4be Poul Sander 2025-02-03 21:28 2418
1193b4be Poul Sander 2025-02-03 21:28 2419
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2420
    // Platform Identifiers
1193b4be Poul Sander 2025-02-03 21:28 2421
    // (the imgui_impl_xxxx backend files are setting those up for you)
1193b4be Poul Sander 2025-02-03 21:28 2422
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2423
1193b4be Poul Sander 2025-02-03 21:28 2424
    // Optional: Platform/Renderer backend name (informational only! will be displayed in About Window) + User data for backend/wrappers to store their own stuff.
1193b4be Poul Sander 2025-02-03 21:28 2425
    const char* BackendPlatformName;            // = NULL
1193b4be Poul Sander 2025-02-03 21:28 2426
    const char* BackendRendererName;            // = NULL
1193b4be Poul Sander 2025-02-03 21:28 2427
    void*       BackendPlatformUserData;        // = NULL           // User data for platform backend
1193b4be Poul Sander 2025-02-03 21:28 2428
    void*       BackendRendererUserData;        // = NULL           // User data for renderer backend
1193b4be Poul Sander 2025-02-03 21:28 2429
    void*       BackendLanguageUserData;        // = NULL           // User data for non C++ programming language backend
1193b4be Poul Sander 2025-02-03 21:28 2430
1193b4be Poul Sander 2025-02-03 21:28 2431
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2432
    // Input - Call before calling NewFrame()
1193b4be Poul Sander 2025-02-03 21:28 2433
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2434
1193b4be Poul Sander 2025-02-03 21:28 2435
    // Input Functions
1193b4be Poul Sander 2025-02-03 21:28 2436
    IMGUI_API void  AddKeyEvent(ImGuiKey key, bool down);                   // Queue a new key down/up event. Key should be "translated" (as in, generally ImGuiKey_A matches the key end-user would use to emit an 'A' character)
1193b4be Poul Sander 2025-02-03 21:28 2437
    IMGUI_API void  AddKeyAnalogEvent(ImGuiKey key, bool down, float v);    // Queue a new key down/up event for analog values (e.g. ImGuiKey_Gamepad_ values). Dead-zones should be handled by the backend.
1193b4be Poul Sander 2025-02-03 21:28 2438
    IMGUI_API void  AddMousePosEvent(float x, float y);                     // Queue a mouse position update. Use -FLT_MAX,-FLT_MAX to signify no mouse (e.g. app not focused and not hovered)
1193b4be Poul Sander 2025-02-03 21:28 2439
    IMGUI_API void  AddMouseButtonEvent(int button, bool down);             // Queue a mouse button change
1193b4be Poul Sander 2025-02-03 21:28 2440
    IMGUI_API void  AddMouseWheelEvent(float wheel_x, float wheel_y);       // Queue a mouse wheel update. wheel_y<0: scroll down, wheel_y>0: scroll up, wheel_x<0: scroll right, wheel_x>0: scroll left.
1193b4be Poul Sander 2025-02-03 21:28 2441
    IMGUI_API void  AddMouseSourceEvent(ImGuiMouseSource source);           // Queue a mouse source change (Mouse/TouchScreen/Pen)
1193b4be Poul Sander 2025-02-03 21:28 2442
    IMGUI_API void  AddMouseViewportEvent(ImGuiID id);                      // Queue a mouse hovered viewport. Requires backend to set ImGuiBackendFlags_HasMouseHoveredViewport to call this (for multi-viewport support).
1193b4be Poul Sander 2025-02-03 21:28 2443
    IMGUI_API void  AddFocusEvent(bool focused);                            // Queue a gain/loss of focus for the application (generally based on OS/platform focus of your window)
1193b4be Poul Sander 2025-02-03 21:28 2444
    IMGUI_API void  AddInputCharacter(unsigned int c);                      // Queue a new character input
1193b4be Poul Sander 2025-02-03 21:28 2445
    IMGUI_API void  AddInputCharacterUTF16(ImWchar16 c);                    // Queue a new character input from a UTF-16 character, it can be a surrogate
1193b4be Poul Sander 2025-02-03 21:28 2446
    IMGUI_API void  AddInputCharactersUTF8(const char* str);                // Queue a new characters input from a UTF-8 string
1193b4be Poul Sander 2025-02-03 21:28 2447
1193b4be Poul Sander 2025-02-03 21:28 2448
    IMGUI_API void  SetKeyEventNativeData(ImGuiKey key, int native_keycode, int native_scancode, int native_legacy_index = -1); // [Optional] Specify index for legacy <1.87 IsKeyXXX() functions with native indices + specify native keycode, scancode.
1193b4be Poul Sander 2025-02-03 21:28 2449
    IMGUI_API void  SetAppAcceptingEvents(bool accepting_events);           // Set master flag for accepting key/mouse/text events (default to true). Useful if you have native dialog boxes that are interrupting your application loop/refresh, and you want to disable events being queued while your app is frozen.
1193b4be Poul Sander 2025-02-03 21:28 2450
    IMGUI_API void  ClearEventsQueue();                                     // Clear all incoming events.
1193b4be Poul Sander 2025-02-03 21:28 2451
    IMGUI_API void  ClearInputKeys();                                       // Clear current keyboard/gamepad state + current frame text input buffer. Equivalent to releasing all keys/buttons.
1193b4be Poul Sander 2025-02-03 21:28 2452
    IMGUI_API void  ClearInputMouse();                                      // Clear current mouse state.
1193b4be Poul Sander 2025-02-03 21:28 2453
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 2454
    IMGUI_API void  ClearInputCharacters();                                 // [Obsoleted in 1.89.8] Clear the current frame text input buffer. Now included within ClearInputKeys().
1193b4be Poul Sander 2025-02-03 21:28 2455
#endif
1193b4be Poul Sander 2025-02-03 21:28 2456
1193b4be Poul Sander 2025-02-03 21:28 2457
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2458
    // Output - Updated by NewFrame() or EndFrame()/Render()
1193b4be Poul Sander 2025-02-03 21:28 2459
    // (when reading from the io.WantCaptureMouse, io.WantCaptureKeyboard flags to dispatch your inputs, it is
1193b4be Poul Sander 2025-02-03 21:28 2460
    //  generally easier and more correct to use their state BEFORE calling NewFrame(). See FAQ for details!)
1193b4be Poul Sander 2025-02-03 21:28 2461
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2462
1193b4be Poul Sander 2025-02-03 21:28 2463
    bool        WantCaptureMouse;                   // Set when Dear ImGui will use mouse inputs, in this case do not dispatch them to your main game/application (either way, always pass on mouse inputs to imgui). (e.g. unclicked mouse is hovering over an imgui window, widget is active, mouse was clicked over an imgui window, etc.).
1193b4be Poul Sander 2025-02-03 21:28 2464
    bool        WantCaptureKeyboard;                // Set when Dear ImGui will use keyboard inputs, in this case do not dispatch them to your main game/application (either way, always pass keyboard inputs to imgui). (e.g. InputText active, or an imgui window is focused and navigation is enabled, etc.).
1193b4be Poul Sander 2025-02-03 21:28 2465
    bool        WantTextInput;                      // Mobile/console: when set, you may display an on-screen keyboard. This is set by Dear ImGui when it wants textual keyboard input to happen (e.g. when a InputText widget is active).
1193b4be Poul Sander 2025-02-03 21:28 2466
    bool        WantSetMousePos;                    // MousePos has been altered, backend should reposition mouse on next frame. Rarely used! Set only when io.ConfigNavMoveSetMousePos is enabled.
1193b4be Poul Sander 2025-02-03 21:28 2467
    bool        WantSaveIniSettings;                // When manual .ini load/save is active (io.IniFilename == NULL), this will be set to notify your application that you can call SaveIniSettingsToMemory() and save yourself. Important: clear io.WantSaveIniSettings yourself after saving!
1193b4be Poul Sander 2025-02-03 21:28 2468
    bool        NavActive;                          // Keyboard/Gamepad navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused and it doesn't use the ImGuiWindowFlags_NoNavInputs flag.
1193b4be Poul Sander 2025-02-03 21:28 2469
    bool        NavVisible;                         // Keyboard/Gamepad navigation highlight is visible and allowed (will handle ImGuiKey_NavXXX events).
1193b4be Poul Sander 2025-02-03 21:28 2470
    float       Framerate;                          // Estimate of application framerate (rolling average over 60 frames, based on io.DeltaTime), in frame per second. Solely for convenience. Slow applications may not want to use a moving average or may want to reset underlying buffers occasionally.
1193b4be Poul Sander 2025-02-03 21:28 2471
    int         MetricsRenderVertices;              // Vertices output during last call to Render()
1193b4be Poul Sander 2025-02-03 21:28 2472
    int         MetricsRenderIndices;               // Indices output during last call to Render() = number of triangles * 3
1193b4be Poul Sander 2025-02-03 21:28 2473
    int         MetricsRenderWindows;               // Number of visible windows
1193b4be Poul Sander 2025-02-03 21:28 2474
    int         MetricsActiveWindows;               // Number of active windows
1193b4be Poul Sander 2025-02-03 21:28 2475
    ImVec2      MouseDelta;                         // Mouse delta. Note that this is zero if either current or previous position are invalid (-FLT_MAX,-FLT_MAX), so a disappearing/reappearing mouse won't have a huge delta.
1193b4be Poul Sander 2025-02-03 21:28 2476
1193b4be Poul Sander 2025-02-03 21:28 2477
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2478
    // [Internal] Dear ImGui will maintain those fields. Forward compatibility not guaranteed!
1193b4be Poul Sander 2025-02-03 21:28 2479
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2480
1193b4be Poul Sander 2025-02-03 21:28 2481
    ImGuiContext* Ctx;                              // Parent UI context (needs to be set explicitly by parent).
1193b4be Poul Sander 2025-02-03 21:28 2482
1193b4be Poul Sander 2025-02-03 21:28 2483
    // Main Input State
1193b4be Poul Sander 2025-02-03 21:28 2484
    // (this block used to be written by backend, since 1.87 it is best to NOT write to those directly, call the AddXXX functions above instead)
1193b4be Poul Sander 2025-02-03 21:28 2485
    // (reading from those variables is fair game, as they are extremely unlikely to be moving anywhere)
1193b4be Poul Sander 2025-02-03 21:28 2486
    ImVec2      MousePos;                           // Mouse position, in pixels. Set to ImVec2(-FLT_MAX, -FLT_MAX) if mouse is unavailable (on another screen, etc.)
1193b4be Poul Sander 2025-02-03 21:28 2487
    bool        MouseDown[5];                       // Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5). Dear ImGui mostly uses left and right buttons. Other buttons allow us to track if the mouse is being used by your application + available to user as a convenience via IsMouse** API.
1193b4be Poul Sander 2025-02-03 21:28 2488
    float       MouseWheel;                         // Mouse wheel Vertical: 1 unit scrolls about 5 lines text. >0 scrolls Up, <0 scrolls Down. Hold SHIFT to turn vertical scroll into horizontal scroll.
1193b4be Poul Sander 2025-02-03 21:28 2489
    float       MouseWheelH;                        // Mouse wheel Horizontal. >0 scrolls Left, <0 scrolls Right. Most users don't have a mouse with a horizontal wheel, may not be filled by all backends.
1193b4be Poul Sander 2025-02-03 21:28 2490
    ImGuiMouseSource MouseSource;                   // Mouse actual input peripheral (Mouse/TouchScreen/Pen).
1193b4be Poul Sander 2025-02-03 21:28 2491
    ImGuiID     MouseHoveredViewport;               // (Optional) Modify using io.AddMouseViewportEvent(). With multi-viewports: viewport the OS mouse is hovering. If possible _IGNORING_ viewports with the ImGuiViewportFlags_NoInputs flag is much better (few backends can handle that). Set io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport if you can provide this info. If you don't imgui will infer the value using the rectangles and last focused time of the viewports it knows about (ignoring other OS windows).
1193b4be Poul Sander 2025-02-03 21:28 2492
    bool        KeyCtrl;                            // Keyboard modifier down: Control
1193b4be Poul Sander 2025-02-03 21:28 2493
    bool        KeyShift;                           // Keyboard modifier down: Shift
1193b4be Poul Sander 2025-02-03 21:28 2494
    bool        KeyAlt;                             // Keyboard modifier down: Alt
1193b4be Poul Sander 2025-02-03 21:28 2495
    bool        KeySuper;                           // Keyboard modifier down: Cmd/Super/Windows
1193b4be Poul Sander 2025-02-03 21:28 2496
1193b4be Poul Sander 2025-02-03 21:28 2497
    // Other state maintained from data above + IO function calls
1193b4be Poul Sander 2025-02-03 21:28 2498
    ImGuiKeyChord KeyMods;                          // Key mods flags (any of ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Alt/ImGuiMod_Super flags, same as io.KeyCtrl/KeyShift/KeyAlt/KeySuper but merged into flags. Read-only, updated by NewFrame()
1193b4be Poul Sander 2025-02-03 21:28 2499
    ImGuiKeyData  KeysData[ImGuiKey_KeysData_SIZE]; // Key state for all known keys. Use IsKeyXXX() functions to access this.
1193b4be Poul Sander 2025-02-03 21:28 2500
    bool        WantCaptureMouseUnlessPopupClose;   // Alternative to WantCaptureMouse: (WantCaptureMouse == true && WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup.
1193b4be Poul Sander 2025-02-03 21:28 2501
    ImVec2      MousePosPrev;                       // Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
1193b4be Poul Sander 2025-02-03 21:28 2502
    ImVec2      MouseClickedPos[5];                 // Position at time of clicking
1193b4be Poul Sander 2025-02-03 21:28 2503
    double      MouseClickedTime[5];                // Time of last click (used to figure out double-click)
1193b4be Poul Sander 2025-02-03 21:28 2504
    bool        MouseClicked[5];                    // Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
1193b4be Poul Sander 2025-02-03 21:28 2505
    bool        MouseDoubleClicked[5];              // Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
1193b4be Poul Sander 2025-02-03 21:28 2506
    ImU16       MouseClickedCount[5];               // == 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc. when going from !Down to Down
1193b4be Poul Sander 2025-02-03 21:28 2507
    ImU16       MouseClickedLastCount[5];           // Count successive number of clicks. Stays valid after mouse release. Reset after another click is done.
1193b4be Poul Sander 2025-02-03 21:28 2508
    bool        MouseReleased[5];                   // Mouse button went from Down to !Down
1193b4be Poul Sander 2025-02-03 21:28 2509
    bool        MouseDownOwned[5];                  // Track if button was clicked inside a dear imgui window or over void blocked by a popup. We don't request mouse capture from the application if click started outside ImGui bounds.
1193b4be Poul Sander 2025-02-03 21:28 2510
    bool        MouseDownOwnedUnlessPopupClose[5];  // Track if button was clicked inside a dear imgui window.
1193b4be Poul Sander 2025-02-03 21:28 2511
    bool        MouseWheelRequestAxisSwap;          // On a non-Mac system, holding SHIFT requests WheelY to perform the equivalent of a WheelX event. On a Mac system this is already enforced by the system.
1193b4be Poul Sander 2025-02-03 21:28 2512
    bool        MouseCtrlLeftAsRightClick;          // (OSX) Set to true when the current click was a ctrl-click that spawned a simulated right click
1193b4be Poul Sander 2025-02-03 21:28 2513
    float       MouseDownDuration[5];               // Duration the mouse button has been down (0.0f == just clicked)
1193b4be Poul Sander 2025-02-03 21:28 2514
    float       MouseDownDurationPrev[5];           // Previous time the mouse button has been down
1193b4be Poul Sander 2025-02-03 21:28 2515
    ImVec2      MouseDragMaxDistanceAbs[5];         // Maximum distance, absolute, on each axis, of how much mouse has traveled from the clicking point
1193b4be Poul Sander 2025-02-03 21:28 2516
    float       MouseDragMaxDistanceSqr[5];         // Squared maximum distance of how much mouse has traveled from the clicking point (used for moving thresholds)
1193b4be Poul Sander 2025-02-03 21:28 2517
    float       PenPressure;                        // Touch/Pen pressure (0.0f to 1.0f, should be >0.0f only when MouseDown[0] == true). Helper storage currently unused by Dear ImGui.
1193b4be Poul Sander 2025-02-03 21:28 2518
    bool        AppFocusLost;                       // Only modify via AddFocusEvent()
1193b4be Poul Sander 2025-02-03 21:28 2519
    bool        AppAcceptingEvents;                 // Only modify via SetAppAcceptingEvents()
1193b4be Poul Sander 2025-02-03 21:28 2520
    ImS8        BackendUsingLegacyKeyArrays;        // -1: unknown, 0: using AddKeyEvent(), 1: using legacy io.KeysDown[]
1193b4be Poul Sander 2025-02-03 21:28 2521
    bool        BackendUsingLegacyNavInputArray;    // 0: using AddKeyAnalogEvent(), 1: writing to legacy io.NavInputs[] directly
1193b4be Poul Sander 2025-02-03 21:28 2522
    ImWchar16   InputQueueSurrogate;                // For AddInputCharacterUTF16()
1193b4be Poul Sander 2025-02-03 21:28 2523
    ImVector<ImWchar> InputQueueCharacters;         // Queue of _characters_ input (obtained by platform backend). Fill using AddInputCharacter() helper.
1193b4be Poul Sander 2025-02-03 21:28 2524
1193b4be Poul Sander 2025-02-03 21:28 2525
    // Legacy: before 1.87, we required backend to fill io.KeyMap[] (imgui->native map) during initialization and io.KeysDown[] (native indices) every frame.
1193b4be Poul Sander 2025-02-03 21:28 2526
    // This is still temporarily supported as a legacy feature. However the new preferred scheme is for backend to call io.AddKeyEvent().
1193b4be Poul Sander 2025-02-03 21:28 2527
    //   Old (<1.87):  ImGui::IsKeyPressed(ImGui::GetIO().KeyMap[ImGuiKey_Space]) --> New (1.87+) ImGui::IsKeyPressed(ImGuiKey_Space)
1193b4be Poul Sander 2025-02-03 21:28 2528
#ifndef IMGUI_DISABLE_OBSOLETE_KEYIO
1193b4be Poul Sander 2025-02-03 21:28 2529
    int         KeyMap[ImGuiKey_COUNT];             // [LEGACY] Input: map of indices into the KeysDown[512] entries array which represent your "native" keyboard state. The first 512 are now unused and should be kept zero. Legacy backend will write into KeyMap[] using ImGuiKey_ indices which are always >512.
1193b4be Poul Sander 2025-02-03 21:28 2530
    bool        KeysDown[ImGuiKey_COUNT];           // [LEGACY] Input: Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys). This used to be [512] sized. It is now ImGuiKey_COUNT to allow legacy io.KeysDown[GetKeyIndex(...)] to work without an overflow.
1193b4be Poul Sander 2025-02-03 21:28 2531
    float       NavInputs[ImGuiNavInput_COUNT];     // [LEGACY] Since 1.88, NavInputs[] was removed. Backends from 1.60 to 1.86 won't build. Feed gamepad inputs via io.AddKeyEvent() and ImGuiKey_GamepadXXX enums.
1193b4be Poul Sander 2025-02-03 21:28 2532
    //void*     ImeWindowHandle;                    // [Obsoleted in 1.87] Set ImGuiViewport::PlatformHandleRaw instead. Set this to your HWND to get automatic IME cursor positioning.
1193b4be Poul Sander 2025-02-03 21:28 2533
#endif
1193b4be Poul Sander 2025-02-03 21:28 2534
1193b4be Poul Sander 2025-02-03 21:28 2535
    // Legacy: before 1.91.1, clipboard functions were stored in ImGuiIO instead of ImGuiPlatformIO.
1193b4be Poul Sander 2025-02-03 21:28 2536
    // As this is will affect all users of custom engines/backends, we are providing proper legacy redirection (will obsolete).
1193b4be Poul Sander 2025-02-03 21:28 2537
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 2538
    const char* (*GetClipboardTextFn)(void* user_data);
1193b4be Poul Sander 2025-02-03 21:28 2539
    void        (*SetClipboardTextFn)(void* user_data, const char* text);
1193b4be Poul Sander 2025-02-03 21:28 2540
    void*       ClipboardUserData;
1193b4be Poul Sander 2025-02-03 21:28 2541
#endif
1193b4be Poul Sander 2025-02-03 21:28 2542
1193b4be Poul Sander 2025-02-03 21:28 2543
    IMGUI_API   ImGuiIO();
1193b4be Poul Sander 2025-02-03 21:28 2544
};
1193b4be Poul Sander 2025-02-03 21:28 2545
1193b4be Poul Sander 2025-02-03 21:28 2546
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2547
// [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiPayload)
1193b4be Poul Sander 2025-02-03 21:28 2548
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2549
1193b4be Poul Sander 2025-02-03 21:28 2550
// Shared state of InputText(), passed as an argument to your callback when a ImGuiInputTextFlags_Callback* flag is used.
1193b4be Poul Sander 2025-02-03 21:28 2551
// The callback function should return 0 by default.
1193b4be Poul Sander 2025-02-03 21:28 2552
// Callbacks (follow a flag name and see comments in ImGuiInputTextFlags_ declarations for more details)
1193b4be Poul Sander 2025-02-03 21:28 2553
// - ImGuiInputTextFlags_CallbackEdit:        Callback on buffer edit (note that InputText() already returns true on edit, the callback is useful mainly to manipulate the underlying buffer while focus is active)
1193b4be Poul Sander 2025-02-03 21:28 2554
// - ImGuiInputTextFlags_CallbackAlways:      Callback on each iteration
1193b4be Poul Sander 2025-02-03 21:28 2555
// - ImGuiInputTextFlags_CallbackCompletion:  Callback on pressing TAB
1193b4be Poul Sander 2025-02-03 21:28 2556
// - ImGuiInputTextFlags_CallbackHistory:     Callback on pressing Up/Down arrows
1193b4be Poul Sander 2025-02-03 21:28 2557
// - ImGuiInputTextFlags_CallbackCharFilter:  Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
1193b4be Poul Sander 2025-02-03 21:28 2558
// - ImGuiInputTextFlags_CallbackResize:      Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow.
1193b4be Poul Sander 2025-02-03 21:28 2559
struct ImGuiInputTextCallbackData
1193b4be Poul Sander 2025-02-03 21:28 2560
{
1193b4be Poul Sander 2025-02-03 21:28 2561
    ImGuiContext*       Ctx;            // Parent UI context
1193b4be Poul Sander 2025-02-03 21:28 2562
    ImGuiInputTextFlags EventFlag;      // One ImGuiInputTextFlags_Callback*    // Read-only
1193b4be Poul Sander 2025-02-03 21:28 2563
    ImGuiInputTextFlags Flags;          // What user passed to InputText()      // Read-only
1193b4be Poul Sander 2025-02-03 21:28 2564
    void*               UserData;       // What user passed to InputText()      // Read-only
1193b4be Poul Sander 2025-02-03 21:28 2565
1193b4be Poul Sander 2025-02-03 21:28 2566
    // Arguments for the different callback events
1193b4be Poul Sander 2025-02-03 21:28 2567
    // - During Resize callback, Buf will be same as your input buffer.
1193b4be Poul Sander 2025-02-03 21:28 2568
    // - However, during Completion/History/Always callback, Buf always points to our own internal data (it is not the same as your buffer)! Changes to it will be reflected into your own buffer shortly after the callback.
1193b4be Poul Sander 2025-02-03 21:28 2569
    // - To modify the text buffer in a callback, prefer using the InsertChars() / DeleteChars() function. InsertChars() will take care of calling the resize callback if necessary.
1193b4be Poul Sander 2025-02-03 21:28 2570
    // - If you know your edits are not going to resize the underlying buffer allocation, you may modify the contents of 'Buf[]' directly. You need to update 'BufTextLen' accordingly (0 <= BufTextLen < BufSize) and set 'BufDirty'' to true so InputText can update its internal state.
1193b4be Poul Sander 2025-02-03 21:28 2571
    ImWchar             EventChar;      // Character input                      // Read-write   // [CharFilter] Replace character with another one, or set to zero to drop. return 1 is equivalent to setting EventChar=0;
1193b4be Poul Sander 2025-02-03 21:28 2572
    ImGuiKey            EventKey;       // Key pressed (Up/Down/TAB)            // Read-only    // [Completion,History]
1193b4be Poul Sander 2025-02-03 21:28 2573
    char*               Buf;            // Text buffer                          // Read-write   // [Resize] Can replace pointer / [Completion,History,Always] Only write to pointed data, don't replace the actual pointer!
1193b4be Poul Sander 2025-02-03 21:28 2574
    int                 BufTextLen;     // Text length (in bytes)               // Read-write   // [Resize,Completion,History,Always] Exclude zero-terminator storage. In C land: == strlen(some_text), in C++ land: string.length()
1193b4be Poul Sander 2025-02-03 21:28 2575
    int                 BufSize;        // Buffer size (in bytes) = capacity+1  // Read-only    // [Resize,Completion,History,Always] Include zero-terminator storage. In C land == ARRAYSIZE(my_char_array), in C++ land: string.capacity()+1
1193b4be Poul Sander 2025-02-03 21:28 2576
    bool                BufDirty;       // Set if you modify Buf/BufTextLen!    // Write        // [Completion,History,Always]
1193b4be Poul Sander 2025-02-03 21:28 2577
    int                 CursorPos;      //                                      // Read-write   // [Completion,History,Always]
1193b4be Poul Sander 2025-02-03 21:28 2578
    int                 SelectionStart; //                                      // Read-write   // [Completion,History,Always] == to SelectionEnd when no selection)
1193b4be Poul Sander 2025-02-03 21:28 2579
    int                 SelectionEnd;   //                                      // Read-write   // [Completion,History,Always]
1193b4be Poul Sander 2025-02-03 21:28 2580
1193b4be Poul Sander 2025-02-03 21:28 2581
    // Helper functions for text manipulation.
1193b4be Poul Sander 2025-02-03 21:28 2582
    // Use those function to benefit from the CallbackResize behaviors. Calling those function reset the selection.
1193b4be Poul Sander 2025-02-03 21:28 2583
    IMGUI_API ImGuiInputTextCallbackData();
1193b4be Poul Sander 2025-02-03 21:28 2584
    IMGUI_API void      DeleteChars(int pos, int bytes_count);
1193b4be Poul Sander 2025-02-03 21:28 2585
    IMGUI_API void      InsertChars(int pos, const char* text, const char* text_end = NULL);
1193b4be Poul Sander 2025-02-03 21:28 2586
    void                SelectAll()             { SelectionStart = 0; SelectionEnd = BufTextLen; }
1193b4be Poul Sander 2025-02-03 21:28 2587
    void                ClearSelection()        { SelectionStart = SelectionEnd = BufTextLen; }
1193b4be Poul Sander 2025-02-03 21:28 2588
    bool                HasSelection() const    { return SelectionStart != SelectionEnd; }
1193b4be Poul Sander 2025-02-03 21:28 2589
};
1193b4be Poul Sander 2025-02-03 21:28 2590
1193b4be Poul Sander 2025-02-03 21:28 2591
// Resizing callback data to apply custom constraint. As enabled by SetNextWindowSizeConstraints(). Callback is called during the next Begin().
1193b4be Poul Sander 2025-02-03 21:28 2592
// NB: For basic min/max size constraint on each axis you don't need to use the callback! The SetNextWindowSizeConstraints() parameters are enough.
1193b4be Poul Sander 2025-02-03 21:28 2593
struct ImGuiSizeCallbackData
1193b4be Poul Sander 2025-02-03 21:28 2594
{
1193b4be Poul Sander 2025-02-03 21:28 2595
    void*   UserData;       // Read-only.   What user passed to SetNextWindowSizeConstraints(). Generally store an integer or float in here (need reinterpret_cast<>).
1193b4be Poul Sander 2025-02-03 21:28 2596
    ImVec2  Pos;            // Read-only.   Window position, for reference.
1193b4be Poul Sander 2025-02-03 21:28 2597
    ImVec2  CurrentSize;    // Read-only.   Current window size.
1193b4be Poul Sander 2025-02-03 21:28 2598
    ImVec2  DesiredSize;    // Read-write.  Desired size, based on user's mouse position. Write to this field to restrain resizing.
1193b4be Poul Sander 2025-02-03 21:28 2599
};
1193b4be Poul Sander 2025-02-03 21:28 2600
1193b4be Poul Sander 2025-02-03 21:28 2601
// [ALPHA] Rarely used / very advanced uses only. Use with SetNextWindowClass() and DockSpace() functions.
1193b4be Poul Sander 2025-02-03 21:28 2602
// Important: the content of this class is still highly WIP and likely to change and be refactored
1193b4be Poul Sander 2025-02-03 21:28 2603
// before we stabilize Docking features. Please be mindful if using this.
1193b4be Poul Sander 2025-02-03 21:28 2604
// Provide hints:
1193b4be Poul Sander 2025-02-03 21:28 2605
// - To the platform backend via altered viewport flags (enable/disable OS decoration, OS task bar icons, etc.)
1193b4be Poul Sander 2025-02-03 21:28 2606
// - To the platform backend for OS level parent/child relationships of viewport.
1193b4be Poul Sander 2025-02-03 21:28 2607
// - To the docking system for various options and filtering.
1193b4be Poul Sander 2025-02-03 21:28 2608
struct ImGuiWindowClass
1193b4be Poul Sander 2025-02-03 21:28 2609
{
1193b4be Poul Sander 2025-02-03 21:28 2610
    ImGuiID             ClassId;                    // User data. 0 = Default class (unclassed). Windows of different classes cannot be docked with each others.
1193b4be Poul Sander 2025-02-03 21:28 2611
    ImGuiID             ParentViewportId;           // Hint for the platform backend. -1: use default. 0: request platform backend to not parent the platform. != 0: request platform backend to create a parent<>child relationship between the platform windows. Not conforming backends are free to e.g. parent every viewport to the main viewport or not.
1193b4be Poul Sander 2025-02-03 21:28 2612
    ImGuiID             FocusRouteParentWindowId;   // ID of parent window for shortcut focus route evaluation, e.g. Shortcut() call from Parent Window will succeed when this window is focused.
1193b4be Poul Sander 2025-02-03 21:28 2613
    ImGuiViewportFlags  ViewportFlagsOverrideSet;   // Viewport flags to set when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.
1193b4be Poul Sander 2025-02-03 21:28 2614
    ImGuiViewportFlags  ViewportFlagsOverrideClear; // Viewport flags to clear when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.
1193b4be Poul Sander 2025-02-03 21:28 2615
    ImGuiTabItemFlags   TabItemFlagsOverrideSet;    // [EXPERIMENTAL] TabItem flags to set when a window of this class gets submitted into a dock node tab bar. May use with ImGuiTabItemFlags_Leading or ImGuiTabItemFlags_Trailing.
1193b4be Poul Sander 2025-02-03 21:28 2616
    ImGuiDockNodeFlags  DockNodeFlagsOverrideSet;   // [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)
1193b4be Poul Sander 2025-02-03 21:28 2617
    bool                DockingAlwaysTabBar;        // Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)
1193b4be Poul Sander 2025-02-03 21:28 2618
    bool                DockingAllowUnclassed;      // Set to true to allow windows of this class to be docked/merged with an unclassed window. // FIXME-DOCK: Move to DockNodeFlags override?
1193b4be Poul Sander 2025-02-03 21:28 2619
1193b4be Poul Sander 2025-02-03 21:28 2620
    ImGuiWindowClass() { memset(this, 0, sizeof(*this)); ParentViewportId = (ImGuiID)-1; DockingAllowUnclassed = true; }
1193b4be Poul Sander 2025-02-03 21:28 2621
};
1193b4be Poul Sander 2025-02-03 21:28 2622
1193b4be Poul Sander 2025-02-03 21:28 2623
// Data payload for Drag and Drop operations: AcceptDragDropPayload(), GetDragDropPayload()
1193b4be Poul Sander 2025-02-03 21:28 2624
struct ImGuiPayload
1193b4be Poul Sander 2025-02-03 21:28 2625
{
1193b4be Poul Sander 2025-02-03 21:28 2626
    // Members
1193b4be Poul Sander 2025-02-03 21:28 2627
    void*           Data;               // Data (copied and owned by dear imgui)
1193b4be Poul Sander 2025-02-03 21:28 2628
    int             DataSize;           // Data size
1193b4be Poul Sander 2025-02-03 21:28 2629
1193b4be Poul Sander 2025-02-03 21:28 2630
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 2631
    ImGuiID         SourceId;           // Source item id
1193b4be Poul Sander 2025-02-03 21:28 2632
    ImGuiID         SourceParentId;     // Source parent id (if available)
1193b4be Poul Sander 2025-02-03 21:28 2633
    int             DataFrameCount;     // Data timestamp
1193b4be Poul Sander 2025-02-03 21:28 2634
    char            DataType[32 + 1];   // Data type tag (short user-supplied string, 32 characters max)
1193b4be Poul Sander 2025-02-03 21:28 2635
    bool            Preview;            // Set when AcceptDragDropPayload() was called and mouse has been hovering the target item (nb: handle overlapping drag targets)
1193b4be Poul Sander 2025-02-03 21:28 2636
    bool            Delivery;           // Set when AcceptDragDropPayload() was called and mouse button is released over the target item.
1193b4be Poul Sander 2025-02-03 21:28 2637
1193b4be Poul Sander 2025-02-03 21:28 2638
    ImGuiPayload()  { Clear(); }
1193b4be Poul Sander 2025-02-03 21:28 2639
    void Clear()    { SourceId = SourceParentId = 0; Data = NULL; DataSize = 0; memset(DataType, 0, sizeof(DataType)); DataFrameCount = -1; Preview = Delivery = false; }
1193b4be Poul Sander 2025-02-03 21:28 2640
    bool IsDataType(const char* type) const { return DataFrameCount != -1 && strcmp(type, DataType) == 0; }
1193b4be Poul Sander 2025-02-03 21:28 2641
    bool IsPreview() const                  { return Preview; }
1193b4be Poul Sander 2025-02-03 21:28 2642
    bool IsDelivery() const                 { return Delivery; }
1193b4be Poul Sander 2025-02-03 21:28 2643
};
1193b4be Poul Sander 2025-02-03 21:28 2644
1193b4be Poul Sander 2025-02-03 21:28 2645
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2646
// [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, Math Operators, ImColor)
1193b4be Poul Sander 2025-02-03 21:28 2647
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2648
1193b4be Poul Sander 2025-02-03 21:28 2649
// Helper: Unicode defines
1193b4be Poul Sander 2025-02-03 21:28 2650
#define IM_UNICODE_CODEPOINT_INVALID 0xFFFD     // Invalid Unicode code point (standard value).
1193b4be Poul Sander 2025-02-03 21:28 2651
#ifdef IMGUI_USE_WCHAR32
1193b4be Poul Sander 2025-02-03 21:28 2652
#define IM_UNICODE_CODEPOINT_MAX     0x10FFFF   // Maximum Unicode code point supported by this build.
1193b4be Poul Sander 2025-02-03 21:28 2653
#else
1193b4be Poul Sander 2025-02-03 21:28 2654
#define IM_UNICODE_CODEPOINT_MAX     0xFFFF     // Maximum Unicode code point supported by this build.
1193b4be Poul Sander 2025-02-03 21:28 2655
#endif
1193b4be Poul Sander 2025-02-03 21:28 2656
1193b4be Poul Sander 2025-02-03 21:28 2657
// Helper: Execute a block of code at maximum once a frame. Convenient if you want to quickly create a UI within deep-nested code that runs multiple times every frame.
1193b4be Poul Sander 2025-02-03 21:28 2658
// Usage: static ImGuiOnceUponAFrame oaf; if (oaf) ImGui::Text("This will be called only once per frame");
1193b4be Poul Sander 2025-02-03 21:28 2659
struct ImGuiOnceUponAFrame
1193b4be Poul Sander 2025-02-03 21:28 2660
{
1193b4be Poul Sander 2025-02-03 21:28 2661
    ImGuiOnceUponAFrame() { RefFrame = -1; }
1193b4be Poul Sander 2025-02-03 21:28 2662
    mutable int RefFrame;
1193b4be Poul Sander 2025-02-03 21:28 2663
    operator bool() const { int current_frame = ImGui::GetFrameCount(); if (RefFrame == current_frame) return false; RefFrame = current_frame; return true; }
1193b4be Poul Sander 2025-02-03 21:28 2664
};
1193b4be Poul Sander 2025-02-03 21:28 2665
1193b4be Poul Sander 2025-02-03 21:28 2666
// Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]"
1193b4be Poul Sander 2025-02-03 21:28 2667
struct ImGuiTextFilter
1193b4be Poul Sander 2025-02-03 21:28 2668
{
1193b4be Poul Sander 2025-02-03 21:28 2669
    IMGUI_API           ImGuiTextFilter(const char* default_filter = "");
1193b4be Poul Sander 2025-02-03 21:28 2670
    IMGUI_API bool      Draw(const char* label = "Filter (inc,-exc)", float width = 0.0f);  // Helper calling InputText+Build
1193b4be Poul Sander 2025-02-03 21:28 2671
    IMGUI_API bool      PassFilter(const char* text, const char* text_end = NULL) const;
1193b4be Poul Sander 2025-02-03 21:28 2672
    IMGUI_API void      Build();
1193b4be Poul Sander 2025-02-03 21:28 2673
    void                Clear()          { InputBuf[0] = 0; Build(); }
1193b4be Poul Sander 2025-02-03 21:28 2674
    bool                IsActive() const { return !Filters.empty(); }
1193b4be Poul Sander 2025-02-03 21:28 2675
1193b4be Poul Sander 2025-02-03 21:28 2676
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 2677
    struct ImGuiTextRange
1193b4be Poul Sander 2025-02-03 21:28 2678
    {
1193b4be Poul Sander 2025-02-03 21:28 2679
        const char*     b;
1193b4be Poul Sander 2025-02-03 21:28 2680
        const char*     e;
1193b4be Poul Sander 2025-02-03 21:28 2681
1193b4be Poul Sander 2025-02-03 21:28 2682
        ImGuiTextRange()                                { b = e = NULL; }
1193b4be Poul Sander 2025-02-03 21:28 2683
        ImGuiTextRange(const char* _b, const char* _e)  { b = _b; e = _e; }
1193b4be Poul Sander 2025-02-03 21:28 2684
        bool            empty() const                   { return b == e; }
1193b4be Poul Sander 2025-02-03 21:28 2685
        IMGUI_API void  split(char separator, ImVector<ImGuiTextRange>* out) const;
1193b4be Poul Sander 2025-02-03 21:28 2686
    };
1193b4be Poul Sander 2025-02-03 21:28 2687
    char                    InputBuf[256];
1193b4be Poul Sander 2025-02-03 21:28 2688
    ImVector<ImGuiTextRange>Filters;
1193b4be Poul Sander 2025-02-03 21:28 2689
    int                     CountGrep;
1193b4be Poul Sander 2025-02-03 21:28 2690
};
1193b4be Poul Sander 2025-02-03 21:28 2691
1193b4be Poul Sander 2025-02-03 21:28 2692
// Helper: Growable text buffer for logging/accumulating text
1193b4be Poul Sander 2025-02-03 21:28 2693
// (this could be called 'ImGuiTextBuilder' / 'ImGuiStringBuilder')
1193b4be Poul Sander 2025-02-03 21:28 2694
struct ImGuiTextBuffer
1193b4be Poul Sander 2025-02-03 21:28 2695
{
1193b4be Poul Sander 2025-02-03 21:28 2696
    ImVector<char>      Buf;
1193b4be Poul Sander 2025-02-03 21:28 2697
    IMGUI_API static char EmptyString[1];
1193b4be Poul Sander 2025-02-03 21:28 2698
1193b4be Poul Sander 2025-02-03 21:28 2699
    ImGuiTextBuffer()   { }
1193b4be Poul Sander 2025-02-03 21:28 2700
    inline char         operator[](int i) const { IM_ASSERT(Buf.Data != NULL); return Buf.Data[i]; }
1193b4be Poul Sander 2025-02-03 21:28 2701
    const char*         begin() const           { return Buf.Data ? &Buf.front() : EmptyString; }
1193b4be Poul Sander 2025-02-03 21:28 2702
    const char*         end() const             { return Buf.Data ? &Buf.back() : EmptyString; }   // Buf is zero-terminated, so end() will point on the zero-terminator
1193b4be Poul Sander 2025-02-03 21:28 2703
    int                 size() const            { return Buf.Size ? Buf.Size - 1 : 0; }
1193b4be Poul Sander 2025-02-03 21:28 2704
    bool                empty() const           { return Buf.Size <= 1; }
1193b4be Poul Sander 2025-02-03 21:28 2705
    void                clear()                 { Buf.clear(); }
1193b4be Poul Sander 2025-02-03 21:28 2706
    void                reserve(int capacity)   { Buf.reserve(capacity); }
1193b4be Poul Sander 2025-02-03 21:28 2707
    const char*         c_str() const           { return Buf.Data ? Buf.Data : EmptyString; }
1193b4be Poul Sander 2025-02-03 21:28 2708
    IMGUI_API void      append(const char* str, const char* str_end = NULL);
1193b4be Poul Sander 2025-02-03 21:28 2709
    IMGUI_API void      appendf(const char* fmt, ...) IM_FMTARGS(2);
1193b4be Poul Sander 2025-02-03 21:28 2710
    IMGUI_API void      appendfv(const char* fmt, va_list args) IM_FMTLIST(2);
1193b4be Poul Sander 2025-02-03 21:28 2711
};
1193b4be Poul Sander 2025-02-03 21:28 2712
1193b4be Poul Sander 2025-02-03 21:28 2713
// [Internal] Key+Value for ImGuiStorage
1193b4be Poul Sander 2025-02-03 21:28 2714
struct ImGuiStoragePair
1193b4be Poul Sander 2025-02-03 21:28 2715
{
1193b4be Poul Sander 2025-02-03 21:28 2716
    ImGuiID     key;
1193b4be Poul Sander 2025-02-03 21:28 2717
    union       { int val_i; float val_f; void* val_p; };
1193b4be Poul Sander 2025-02-03 21:28 2718
    ImGuiStoragePair(ImGuiID _key, int _val)    { key = _key; val_i = _val; }
1193b4be Poul Sander 2025-02-03 21:28 2719
    ImGuiStoragePair(ImGuiID _key, float _val)  { key = _key; val_f = _val; }
1193b4be Poul Sander 2025-02-03 21:28 2720
    ImGuiStoragePair(ImGuiID _key, void* _val)  { key = _key; val_p = _val; }
1193b4be Poul Sander 2025-02-03 21:28 2721
};
1193b4be Poul Sander 2025-02-03 21:28 2722
1193b4be Poul Sander 2025-02-03 21:28 2723
// Helper: Key->Value storage
1193b4be Poul Sander 2025-02-03 21:28 2724
// Typically you don't have to worry about this since a storage is held within each Window.
1193b4be Poul Sander 2025-02-03 21:28 2725
// We use it to e.g. store collapse state for a tree (Int 0/1)
1193b4be Poul Sander 2025-02-03 21:28 2726
// This is optimized for efficient lookup (dichotomy into a contiguous buffer) and rare insertion (typically tied to user interactions aka max once a frame)
1193b4be Poul Sander 2025-02-03 21:28 2727
// You can use it as custom user storage for temporary values. Declare your own storage if, for example:
1193b4be Poul Sander 2025-02-03 21:28 2728
// - You want to manipulate the open/close state of a particular sub-tree in your interface (tree node uses Int 0/1 to store their state).
1193b4be Poul Sander 2025-02-03 21:28 2729
// - You want to store custom debug data easily without adding or editing structures in your code (probably not efficient, but convenient)
1193b4be Poul Sander 2025-02-03 21:28 2730
// Types are NOT stored, so it is up to you to make sure your Key don't collide with different types.
1193b4be Poul Sander 2025-02-03 21:28 2731
struct ImGuiStorage
1193b4be Poul Sander 2025-02-03 21:28 2732
{
1193b4be Poul Sander 2025-02-03 21:28 2733
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 2734
    ImVector<ImGuiStoragePair>      Data;
1193b4be Poul Sander 2025-02-03 21:28 2735
1193b4be Poul Sander 2025-02-03 21:28 2736
    // - Get***() functions find pair, never add/allocate. Pairs are sorted so a query is O(log N)
1193b4be Poul Sander 2025-02-03 21:28 2737
    // - Set***() functions find pair, insertion on demand if missing.
1193b4be Poul Sander 2025-02-03 21:28 2738
    // - Sorted insertion is costly, paid once. A typical frame shouldn't need to insert any new pair.
1193b4be Poul Sander 2025-02-03 21:28 2739
    void                Clear() { Data.clear(); }
1193b4be Poul Sander 2025-02-03 21:28 2740
    IMGUI_API int       GetInt(ImGuiID key, int default_val = 0) const;
1193b4be Poul Sander 2025-02-03 21:28 2741
    IMGUI_API void      SetInt(ImGuiID key, int val);
1193b4be Poul Sander 2025-02-03 21:28 2742
    IMGUI_API bool      GetBool(ImGuiID key, bool default_val = false) const;
1193b4be Poul Sander 2025-02-03 21:28 2743
    IMGUI_API void      SetBool(ImGuiID key, bool val);
1193b4be Poul Sander 2025-02-03 21:28 2744
    IMGUI_API float     GetFloat(ImGuiID key, float default_val = 0.0f) const;
1193b4be Poul Sander 2025-02-03 21:28 2745
    IMGUI_API void      SetFloat(ImGuiID key, float val);
1193b4be Poul Sander 2025-02-03 21:28 2746
    IMGUI_API void*     GetVoidPtr(ImGuiID key) const; // default_val is NULL
1193b4be Poul Sander 2025-02-03 21:28 2747
    IMGUI_API void      SetVoidPtr(ImGuiID key, void* val);
1193b4be Poul Sander 2025-02-03 21:28 2748
1193b4be Poul Sander 2025-02-03 21:28 2749
    // - Get***Ref() functions finds pair, insert on demand if missing, return pointer. Useful if you intend to do Get+Set.
1193b4be Poul Sander 2025-02-03 21:28 2750
    // - References are only valid until a new value is added to the storage. Calling a Set***() function or a Get***Ref() function invalidates the pointer.
1193b4be Poul Sander 2025-02-03 21:28 2751
    // - A typical use case where this is convenient for quick hacking (e.g. add storage during a live Edit&Continue session if you can't modify existing struct)
1193b4be Poul Sander 2025-02-03 21:28 2752
    //      float* pvar = ImGui::GetFloatRef(key); ImGui::SliderFloat("var", pvar, 0, 100.0f); some_var += *pvar;
1193b4be Poul Sander 2025-02-03 21:28 2753
    IMGUI_API int*      GetIntRef(ImGuiID key, int default_val = 0);
1193b4be Poul Sander 2025-02-03 21:28 2754
    IMGUI_API bool*     GetBoolRef(ImGuiID key, bool default_val = false);
1193b4be Poul Sander 2025-02-03 21:28 2755
    IMGUI_API float*    GetFloatRef(ImGuiID key, float default_val = 0.0f);
1193b4be Poul Sander 2025-02-03 21:28 2756
    IMGUI_API void**    GetVoidPtrRef(ImGuiID key, void* default_val = NULL);
1193b4be Poul Sander 2025-02-03 21:28 2757
1193b4be Poul Sander 2025-02-03 21:28 2758
    // Advanced: for quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once.
1193b4be Poul Sander 2025-02-03 21:28 2759
    IMGUI_API void      BuildSortByKey();
1193b4be Poul Sander 2025-02-03 21:28 2760
    // Obsolete: use on your own storage if you know only integer are being stored (open/close all tree nodes)
1193b4be Poul Sander 2025-02-03 21:28 2761
    IMGUI_API void      SetAllInt(int val);
1193b4be Poul Sander 2025-02-03 21:28 2762
1193b4be Poul Sander 2025-02-03 21:28 2763
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 2764
    //typedef ::ImGuiStoragePair ImGuiStoragePair;  // 1.90.8: moved type outside struct
1193b4be Poul Sander 2025-02-03 21:28 2765
#endif
1193b4be Poul Sander 2025-02-03 21:28 2766
};
1193b4be Poul Sander 2025-02-03 21:28 2767
1193b4be Poul Sander 2025-02-03 21:28 2768
// Helper: Manually clip large list of items.
1193b4be Poul Sander 2025-02-03 21:28 2769
// If you have lots evenly spaced items and you have random access to the list, you can perform coarse
1193b4be Poul Sander 2025-02-03 21:28 2770
// clipping based on visibility to only submit items that are in view.
1193b4be Poul Sander 2025-02-03 21:28 2771
// The clipper calculates the range of visible items and advance the cursor to compensate for the non-visible items we have skipped.
1193b4be Poul Sander 2025-02-03 21:28 2772
// (Dear ImGui already clip items based on their bounds but: it needs to first layout the item to do so, and generally
1193b4be Poul Sander 2025-02-03 21:28 2773
//  fetching/submitting your own data incurs additional cost. Coarse clipping using ImGuiListClipper allows you to easily
1193b4be Poul Sander 2025-02-03 21:28 2774
//  scale using lists with tens of thousands of items without a problem)
1193b4be Poul Sander 2025-02-03 21:28 2775
// Usage:
1193b4be Poul Sander 2025-02-03 21:28 2776
//   ImGuiListClipper clipper;
1193b4be Poul Sander 2025-02-03 21:28 2777
//   clipper.Begin(1000);         // We have 1000 elements, evenly spaced.
1193b4be Poul Sander 2025-02-03 21:28 2778
//   while (clipper.Step())
1193b4be Poul Sander 2025-02-03 21:28 2779
//       for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++)
1193b4be Poul Sander 2025-02-03 21:28 2780
//           ImGui::Text("line number %d", i);
1193b4be Poul Sander 2025-02-03 21:28 2781
// Generally what happens is:
1193b4be Poul Sander 2025-02-03 21:28 2782
// - Clipper lets you process the first element (DisplayStart = 0, DisplayEnd = 1) regardless of it being visible or not.
1193b4be Poul Sander 2025-02-03 21:28 2783
// - User code submit that one element.
1193b4be Poul Sander 2025-02-03 21:28 2784
// - Clipper can measure the height of the first element
1193b4be Poul Sander 2025-02-03 21:28 2785
// - Clipper calculate the actual range of elements to display based on the current clipping rectangle, position the cursor before the first visible element.
1193b4be Poul Sander 2025-02-03 21:28 2786
// - User code submit visible elements.
1193b4be Poul Sander 2025-02-03 21:28 2787
// - The clipper also handles various subtleties related to keyboard/gamepad navigation, wrapping etc.
1193b4be Poul Sander 2025-02-03 21:28 2788
struct ImGuiListClipper
1193b4be Poul Sander 2025-02-03 21:28 2789
{
1193b4be Poul Sander 2025-02-03 21:28 2790
    ImGuiContext*   Ctx;                // Parent UI context
1193b4be Poul Sander 2025-02-03 21:28 2791
    int             DisplayStart;       // First item to display, updated by each call to Step()
1193b4be Poul Sander 2025-02-03 21:28 2792
    int             DisplayEnd;         // End of items to display (exclusive)
1193b4be Poul Sander 2025-02-03 21:28 2793
    int             ItemsCount;         // [Internal] Number of items
1193b4be Poul Sander 2025-02-03 21:28 2794
    float           ItemsHeight;        // [Internal] Height of item after a first step and item submission can calculate it
1193b4be Poul Sander 2025-02-03 21:28 2795
    float           StartPosY;          // [Internal] Cursor position at the time of Begin() or after table frozen rows are all processed
1193b4be Poul Sander 2025-02-03 21:28 2796
    double          StartSeekOffsetY;   // [Internal] Account for frozen rows in a table and initial loss of precision in very large windows.
1193b4be Poul Sander 2025-02-03 21:28 2797
    void*           TempData;           // [Internal] Internal data
1193b4be Poul Sander 2025-02-03 21:28 2798
1193b4be Poul Sander 2025-02-03 21:28 2799
    // items_count: Use INT_MAX if you don't know how many items you have (in which case the cursor won't be advanced in the final step, and you can call SeekCursorForItem() manually if you need)
1193b4be Poul Sander 2025-02-03 21:28 2800
    // items_height: Use -1.0f to be calculated automatically on first step. Otherwise pass in the distance between your items, typically GetTextLineHeightWithSpacing() or GetFrameHeightWithSpacing().
1193b4be Poul Sander 2025-02-03 21:28 2801
    IMGUI_API ImGuiListClipper();
1193b4be Poul Sander 2025-02-03 21:28 2802
    IMGUI_API ~ImGuiListClipper();
1193b4be Poul Sander 2025-02-03 21:28 2803
    IMGUI_API void  Begin(int items_count, float items_height = -1.0f);
1193b4be Poul Sander 2025-02-03 21:28 2804
    IMGUI_API void  End();             // Automatically called on the last call of Step() that returns false.
1193b4be Poul Sander 2025-02-03 21:28 2805
    IMGUI_API bool  Step();            // Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items.
1193b4be Poul Sander 2025-02-03 21:28 2806
1193b4be Poul Sander 2025-02-03 21:28 2807
    // Call IncludeItemByIndex() or IncludeItemsByIndex() *BEFORE* first call to Step() if you need a range of items to not be clipped, regardless of their visibility.
1193b4be Poul Sander 2025-02-03 21:28 2808
    // (Due to alignment / padding of certain items it is possible that an extra item may be included on either end of the display range).
1193b4be Poul Sander 2025-02-03 21:28 2809
    inline void     IncludeItemByIndex(int item_index)                  { IncludeItemsByIndex(item_index, item_index + 1); }
1193b4be Poul Sander 2025-02-03 21:28 2810
    IMGUI_API void  IncludeItemsByIndex(int item_begin, int item_end);  // item_end is exclusive e.g. use (42, 42+1) to make item 42 never clipped.
1193b4be Poul Sander 2025-02-03 21:28 2811
1193b4be Poul Sander 2025-02-03 21:28 2812
    // Seek cursor toward given item. This is automatically called while stepping.
1193b4be Poul Sander 2025-02-03 21:28 2813
    // - The only reason to call this is: you can use ImGuiListClipper::Begin(INT_MAX) if you don't know item count ahead of time.
1193b4be Poul Sander 2025-02-03 21:28 2814
    // - In this case, after all steps are done, you'll want to call SeekCursorForItem(item_count).
1193b4be Poul Sander 2025-02-03 21:28 2815
    IMGUI_API void  SeekCursorForItem(int item_index);
1193b4be Poul Sander 2025-02-03 21:28 2816
1193b4be Poul Sander 2025-02-03 21:28 2817
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 2818
    inline void IncludeRangeByIndices(int item_begin, int item_end)      { IncludeItemsByIndex(item_begin, item_end); } // [renamed in 1.89.9]
1193b4be Poul Sander 2025-02-03 21:28 2819
    inline void ForceDisplayRangeByIndices(int item_begin, int item_end) { IncludeItemsByIndex(item_begin, item_end); } // [renamed in 1.89.6]
1193b4be Poul Sander 2025-02-03 21:28 2820
    //inline ImGuiListClipper(int items_count, float items_height = -1.0f) { memset(this, 0, sizeof(*this)); ItemsCount = -1; Begin(items_count, items_height); } // [removed in 1.79]
1193b4be Poul Sander 2025-02-03 21:28 2821
#endif
1193b4be Poul Sander 2025-02-03 21:28 2822
};
1193b4be Poul Sander 2025-02-03 21:28 2823
1193b4be Poul Sander 2025-02-03 21:28 2824
// Helpers: ImVec2/ImVec4 operators
1193b4be Poul Sander 2025-02-03 21:28 2825
// - It is important that we are keeping those disabled by default so they don't leak in user space.
1193b4be Poul Sander 2025-02-03 21:28 2826
// - This is in order to allow user enabling implicit cast operators between ImVec2/ImVec4 and their own types (using IM_VEC2_CLASS_EXTRA in imconfig.h)
1193b4be Poul Sander 2025-02-03 21:28 2827
// - Add '#define IMGUI_DEFINE_MATH_OPERATORS' before including this file (or in imconfig.h) to access courtesy maths operators for ImVec2 and ImVec4.
1193b4be Poul Sander 2025-02-03 21:28 2828
#ifdef IMGUI_DEFINE_MATH_OPERATORS
1193b4be Poul Sander 2025-02-03 21:28 2829
#define IMGUI_DEFINE_MATH_OPERATORS_IMPLEMENTED
1193b4be Poul Sander 2025-02-03 21:28 2830
IM_MSVC_RUNTIME_CHECKS_OFF
1193b4be Poul Sander 2025-02-03 21:28 2831
static inline ImVec2  operator*(const ImVec2& lhs, const float rhs)     { return ImVec2(lhs.x * rhs, lhs.y * rhs); }
1193b4be Poul Sander 2025-02-03 21:28 2832
static inline ImVec2  operator/(const ImVec2& lhs, const float rhs)     { return ImVec2(lhs.x / rhs, lhs.y / rhs); }
1193b4be Poul Sander 2025-02-03 21:28 2833
static inline ImVec2  operator+(const ImVec2& lhs, const ImVec2& rhs)   { return ImVec2(lhs.x + rhs.x, lhs.y + rhs.y); }
1193b4be Poul Sander 2025-02-03 21:28 2834
static inline ImVec2  operator-(const ImVec2& lhs, const ImVec2& rhs)   { return ImVec2(lhs.x - rhs.x, lhs.y - rhs.y); }
1193b4be Poul Sander 2025-02-03 21:28 2835
static inline ImVec2  operator*(const ImVec2& lhs, const ImVec2& rhs)   { return ImVec2(lhs.x * rhs.x, lhs.y * rhs.y); }
1193b4be Poul Sander 2025-02-03 21:28 2836
static inline ImVec2  operator/(const ImVec2& lhs, const ImVec2& rhs)   { return ImVec2(lhs.x / rhs.x, lhs.y / rhs.y); }
1193b4be Poul Sander 2025-02-03 21:28 2837
static inline ImVec2  operator-(const ImVec2& lhs)                      { return ImVec2(-lhs.x, -lhs.y); }
1193b4be Poul Sander 2025-02-03 21:28 2838
static inline ImVec2& operator*=(ImVec2& lhs, const float rhs)          { lhs.x *= rhs; lhs.y *= rhs; return lhs; }
1193b4be Poul Sander 2025-02-03 21:28 2839
static inline ImVec2& operator/=(ImVec2& lhs, const float rhs)          { lhs.x /= rhs; lhs.y /= rhs; return lhs; }
1193b4be Poul Sander 2025-02-03 21:28 2840
static inline ImVec2& operator+=(ImVec2& lhs, const ImVec2& rhs)        { lhs.x += rhs.x; lhs.y += rhs.y; return lhs; }
1193b4be Poul Sander 2025-02-03 21:28 2841
static inline ImVec2& operator-=(ImVec2& lhs, const ImVec2& rhs)        { lhs.x -= rhs.x; lhs.y -= rhs.y; return lhs; }
1193b4be Poul Sander 2025-02-03 21:28 2842
static inline ImVec2& operator*=(ImVec2& lhs, const ImVec2& rhs)        { lhs.x *= rhs.x; lhs.y *= rhs.y; return lhs; }
1193b4be Poul Sander 2025-02-03 21:28 2843
static inline ImVec2& operator/=(ImVec2& lhs, const ImVec2& rhs)        { lhs.x /= rhs.x; lhs.y /= rhs.y; return lhs; }
1193b4be Poul Sander 2025-02-03 21:28 2844
static inline bool    operator==(const ImVec2& lhs, const ImVec2& rhs)  { return lhs.x == rhs.x && lhs.y == rhs.y; }
1193b4be Poul Sander 2025-02-03 21:28 2845
static inline bool    operator!=(const ImVec2& lhs, const ImVec2& rhs)  { return lhs.x != rhs.x || lhs.y != rhs.y; }
1193b4be Poul Sander 2025-02-03 21:28 2846
static inline ImVec4  operator+(const ImVec4& lhs, const ImVec4& rhs)   { return ImVec4(lhs.x + rhs.x, lhs.y + rhs.y, lhs.z + rhs.z, lhs.w + rhs.w); }
1193b4be Poul Sander 2025-02-03 21:28 2847
static inline ImVec4  operator-(const ImVec4& lhs, const ImVec4& rhs)   { return ImVec4(lhs.x - rhs.x, lhs.y - rhs.y, lhs.z - rhs.z, lhs.w - rhs.w); }
1193b4be Poul Sander 2025-02-03 21:28 2848
static inline ImVec4  operator*(const ImVec4& lhs, const ImVec4& rhs)   { return ImVec4(lhs.x * rhs.x, lhs.y * rhs.y, lhs.z * rhs.z, lhs.w * rhs.w); }
1193b4be Poul Sander 2025-02-03 21:28 2849
static inline bool    operator==(const ImVec4& lhs, const ImVec4& rhs)  { return lhs.x == rhs.x && lhs.y == rhs.y && lhs.z == rhs.z && lhs.w == rhs.w; }
1193b4be Poul Sander 2025-02-03 21:28 2850
static inline bool    operator!=(const ImVec4& lhs, const ImVec4& rhs)  { return lhs.x != rhs.x || lhs.y != rhs.y || lhs.z != rhs.z || lhs.w != rhs.w; }
1193b4be Poul Sander 2025-02-03 21:28 2851
IM_MSVC_RUNTIME_CHECKS_RESTORE
1193b4be Poul Sander 2025-02-03 21:28 2852
#endif
1193b4be Poul Sander 2025-02-03 21:28 2853
1193b4be Poul Sander 2025-02-03 21:28 2854
// Helpers macros to generate 32-bit encoded colors
1193b4be Poul Sander 2025-02-03 21:28 2855
// User can declare their own format by #defining the 5 _SHIFT/_MASK macros in their imconfig file.
1193b4be Poul Sander 2025-02-03 21:28 2856
#ifndef IM_COL32_R_SHIFT
1193b4be Poul Sander 2025-02-03 21:28 2857
#ifdef IMGUI_USE_BGRA_PACKED_COLOR
1193b4be Poul Sander 2025-02-03 21:28 2858
#define IM_COL32_R_SHIFT    16
1193b4be Poul Sander 2025-02-03 21:28 2859
#define IM_COL32_G_SHIFT    8
1193b4be Poul Sander 2025-02-03 21:28 2860
#define IM_COL32_B_SHIFT    0
1193b4be Poul Sander 2025-02-03 21:28 2861
#define IM_COL32_A_SHIFT    24
1193b4be Poul Sander 2025-02-03 21:28 2862
#define IM_COL32_A_MASK     0xFF000000
1193b4be Poul Sander 2025-02-03 21:28 2863
#else
1193b4be Poul Sander 2025-02-03 21:28 2864
#define IM_COL32_R_SHIFT    0
1193b4be Poul Sander 2025-02-03 21:28 2865
#define IM_COL32_G_SHIFT    8
1193b4be Poul Sander 2025-02-03 21:28 2866
#define IM_COL32_B_SHIFT    16
1193b4be Poul Sander 2025-02-03 21:28 2867
#define IM_COL32_A_SHIFT    24
1193b4be Poul Sander 2025-02-03 21:28 2868
#define IM_COL32_A_MASK     0xFF000000
1193b4be Poul Sander 2025-02-03 21:28 2869
#endif
1193b4be Poul Sander 2025-02-03 21:28 2870
#endif
1193b4be Poul Sander 2025-02-03 21:28 2871
#define IM_COL32(R,G,B,A)    (((ImU32)(A)<<IM_COL32_A_SHIFT) | ((ImU32)(B)<<IM_COL32_B_SHIFT) | ((ImU32)(G)<<IM_COL32_G_SHIFT) | ((ImU32)(R)<<IM_COL32_R_SHIFT))
1193b4be Poul Sander 2025-02-03 21:28 2872
#define IM_COL32_WHITE       IM_COL32(255,255,255,255)  // Opaque white = 0xFFFFFFFF
1193b4be Poul Sander 2025-02-03 21:28 2873
#define IM_COL32_BLACK       IM_COL32(0,0,0,255)        // Opaque black
1193b4be Poul Sander 2025-02-03 21:28 2874
#define IM_COL32_BLACK_TRANS IM_COL32(0,0,0,0)          // Transparent black = 0x00000000
1193b4be Poul Sander 2025-02-03 21:28 2875
1193b4be Poul Sander 2025-02-03 21:28 2876
// Helper: ImColor() implicitly converts colors to either ImU32 (packed 4x1 byte) or ImVec4 (4x1 float)
1193b4be Poul Sander 2025-02-03 21:28 2877
// Prefer using IM_COL32() macros if you want a guaranteed compile-time ImU32 for usage with ImDrawList API.
1193b4be Poul Sander 2025-02-03 21:28 2878
// **Avoid storing ImColor! Store either u32 of ImVec4. This is not a full-featured color class. MAY OBSOLETE.
1193b4be Poul Sander 2025-02-03 21:28 2879
// **None of the ImGui API are using ImColor directly but you can use it as a convenience to pass colors in either ImU32 or ImVec4 formats. Explicitly cast to ImU32 or ImVec4 if needed.
1193b4be Poul Sander 2025-02-03 21:28 2880
struct ImColor
1193b4be Poul Sander 2025-02-03 21:28 2881
{
1193b4be Poul Sander 2025-02-03 21:28 2882
    ImVec4          Value;
1193b4be Poul Sander 2025-02-03 21:28 2883
1193b4be Poul Sander 2025-02-03 21:28 2884
    constexpr ImColor()                                             { }
1193b4be Poul Sander 2025-02-03 21:28 2885
    constexpr ImColor(float r, float g, float b, float a = 1.0f)    : Value(r, g, b, a) { }
1193b4be Poul Sander 2025-02-03 21:28 2886
    constexpr ImColor(const ImVec4& col)                            : Value(col) {}
1193b4be Poul Sander 2025-02-03 21:28 2887
    constexpr ImColor(int r, int g, int b, int a = 255)             : Value((float)r * (1.0f / 255.0f), (float)g * (1.0f / 255.0f), (float)b * (1.0f / 255.0f), (float)a* (1.0f / 255.0f)) {}
1193b4be Poul Sander 2025-02-03 21:28 2888
    constexpr ImColor(ImU32 rgba)                                   : Value((float)((rgba >> IM_COL32_R_SHIFT) & 0xFF) * (1.0f / 255.0f), (float)((rgba >> IM_COL32_G_SHIFT) & 0xFF) * (1.0f / 255.0f), (float)((rgba >> IM_COL32_B_SHIFT) & 0xFF) * (1.0f / 255.0f), (float)((rgba >> IM_COL32_A_SHIFT) & 0xFF) * (1.0f / 255.0f)) {}
1193b4be Poul Sander 2025-02-03 21:28 2889
    inline operator ImU32() const                                   { return ImGui::ColorConvertFloat4ToU32(Value); }
1193b4be Poul Sander 2025-02-03 21:28 2890
    inline operator ImVec4() const                                  { return Value; }
1193b4be Poul Sander 2025-02-03 21:28 2891
1193b4be Poul Sander 2025-02-03 21:28 2892
    // FIXME-OBSOLETE: May need to obsolete/cleanup those helpers.
1193b4be Poul Sander 2025-02-03 21:28 2893
    inline void    SetHSV(float h, float s, float v, float a = 1.0f){ ImGui::ColorConvertHSVtoRGB(h, s, v, Value.x, Value.y, Value.z); Value.w = a; }
1193b4be Poul Sander 2025-02-03 21:28 2894
    static ImColor HSV(float h, float s, float v, float a = 1.0f)   { float r, g, b; ImGui::ColorConvertHSVtoRGB(h, s, v, r, g, b); return ImColor(r, g, b, a); }
1193b4be Poul Sander 2025-02-03 21:28 2895
};
1193b4be Poul Sander 2025-02-03 21:28 2896
1193b4be Poul Sander 2025-02-03 21:28 2897
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2898
// [SECTION] Multi-Select API flags and structures (ImGuiMultiSelectFlags, ImGuiSelectionRequestType, ImGuiSelectionRequest, ImGuiMultiSelectIO, ImGuiSelectionBasicStorage)
1193b4be Poul Sander 2025-02-03 21:28 2899
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 2900
1193b4be Poul Sander 2025-02-03 21:28 2901
// Multi-selection system
1193b4be Poul Sander 2025-02-03 21:28 2902
// Documentation at: https://github.com/ocornut/imgui/wiki/Multi-Select
1193b4be Poul Sander 2025-02-03 21:28 2903
// - Refer to 'Demo->Widgets->Selection State & Multi-Select' for demos using this.
1193b4be Poul Sander 2025-02-03 21:28 2904
// - This system implements standard multi-selection idioms (CTRL+Mouse/Keyboard, SHIFT+Mouse/Keyboard, etc)
1193b4be Poul Sander 2025-02-03 21:28 2905
//   with support for clipper (skipping non-visible items), box-select and many other details.
1193b4be Poul Sander 2025-02-03 21:28 2906
// - Selectable(), Checkbox() are supported but custom widgets may use it as well.
1193b4be Poul Sander 2025-02-03 21:28 2907
// - TreeNode() is technically supported but... using this correctly is more complicated: you need some sort of linear/random access to your tree,
1193b4be Poul Sander 2025-02-03 21:28 2908
//   which is suited to advanced trees setups also implementing filters and clipper. We will work toward simplifying and demoing it.
1193b4be Poul Sander 2025-02-03 21:28 2909
// - In the spirit of Dear ImGui design, your code owns actual selection data.
1193b4be Poul Sander 2025-02-03 21:28 2910
//   This is designed to allow all kinds of selection storage you may use in your application e.g. set/map/hash.
1193b4be Poul Sander 2025-02-03 21:28 2911
// About ImGuiSelectionBasicStorage:
1193b4be Poul Sander 2025-02-03 21:28 2912
// - This is an optional helper to store a selection state and apply selection requests.
1193b4be Poul Sander 2025-02-03 21:28 2913
// - It is used by our demos and provided as a convenience to quickly implement multi-selection.
1193b4be Poul Sander 2025-02-03 21:28 2914
// Usage:
1193b4be Poul Sander 2025-02-03 21:28 2915
// - Identify submitted items with SetNextItemSelectionUserData(), most likely using an index into your current data-set.
1193b4be Poul Sander 2025-02-03 21:28 2916
// - Store and maintain actual selection data using persistent object identifiers.
1193b4be Poul Sander 2025-02-03 21:28 2917
// - Usage flow:
1193b4be Poul Sander 2025-02-03 21:28 2918
//     BEGIN - (1) Call BeginMultiSelect() and retrieve the ImGuiMultiSelectIO* result.
1193b4be Poul Sander 2025-02-03 21:28 2919
//           - (2) Honor request list (SetAll/SetRange requests) by updating your selection data. Same code as Step 6.
1193b4be Poul Sander 2025-02-03 21:28 2920
//           - (3) [If using clipper] You need to make sure RangeSrcItem is always submitted. Calculate its index and pass to clipper.IncludeItemByIndex(). If storing indices in ImGuiSelectionUserData, a simple clipper.IncludeItemByIndex(ms_io->RangeSrcItem) call will work.
1193b4be Poul Sander 2025-02-03 21:28 2921
//     LOOP  - (4) Submit your items with SetNextItemSelectionUserData() + Selectable()/TreeNode() calls.
1193b4be Poul Sander 2025-02-03 21:28 2922
//     END   - (5) Call EndMultiSelect() and retrieve the ImGuiMultiSelectIO* result.
1193b4be Poul Sander 2025-02-03 21:28 2923
//           - (6) Honor request list (SetAll/SetRange requests) by updating your selection data. Same code as Step 2.
1193b4be Poul Sander 2025-02-03 21:28 2924
//     If you submit all items (no clipper), Step 2 and 3 are optional and will be handled by each item themselves. It is fine to always honor those steps.
1193b4be Poul Sander 2025-02-03 21:28 2925
// About ImGuiSelectionUserData:
1193b4be Poul Sander 2025-02-03 21:28 2926
// - This can store an application-defined identifier (e.g. index or pointer) submitted via SetNextItemSelectionUserData().
1193b4be Poul Sander 2025-02-03 21:28 2927
// - In return we store them into RangeSrcItem/RangeFirstItem/RangeLastItem and other fields in ImGuiMultiSelectIO.
1193b4be Poul Sander 2025-02-03 21:28 2928
// - Most applications will store an object INDEX, hence the chosen name and type. Storing an index is natural, because
1193b4be Poul Sander 2025-02-03 21:28 2929
//   SetRange requests will give you two end-points and you will need to iterate/interpolate between them to update your selection.
1193b4be Poul Sander 2025-02-03 21:28 2930
// - However it is perfectly possible to store a POINTER or another IDENTIFIER inside ImGuiSelectionUserData.
1193b4be Poul Sander 2025-02-03 21:28 2931
//   Our system never assume that you identify items by indices, it never attempts to interpolate between two values.
1193b4be Poul Sander 2025-02-03 21:28 2932
// - If you enable ImGuiMultiSelectFlags_NoRangeSelect then it is guaranteed that you will never have to interpolate
1193b4be Poul Sander 2025-02-03 21:28 2933
//   between two ImGuiSelectionUserData, which may be a convenient way to use part of the feature with less code work.
1193b4be Poul Sander 2025-02-03 21:28 2934
// - As most users will want to store an index, for convenience and to reduce confusion we use ImS64 instead of void*,
1193b4be Poul Sander 2025-02-03 21:28 2935
//   being syntactically easier to downcast. Feel free to reinterpret_cast and store a pointer inside.
1193b4be Poul Sander 2025-02-03 21:28 2936
1193b4be Poul Sander 2025-02-03 21:28 2937
// Flags for BeginMultiSelect()
1193b4be Poul Sander 2025-02-03 21:28 2938
enum ImGuiMultiSelectFlags_
1193b4be Poul Sander 2025-02-03 21:28 2939
{
1193b4be Poul Sander 2025-02-03 21:28 2940
    ImGuiMultiSelectFlags_None                  = 0,
1193b4be Poul Sander 2025-02-03 21:28 2941
    ImGuiMultiSelectFlags_SingleSelect          = 1 << 0,   // Disable selecting more than one item. This is available to allow single-selection code to share same code/logic if desired. It essentially disables the main purpose of BeginMultiSelect() tho!
1193b4be Poul Sander 2025-02-03 21:28 2942
    ImGuiMultiSelectFlags_NoSelectAll           = 1 << 1,   // Disable CTRL+A shortcut to select all.
1193b4be Poul Sander 2025-02-03 21:28 2943
    ImGuiMultiSelectFlags_NoRangeSelect         = 1 << 2,   // Disable Shift+selection mouse/keyboard support (useful for unordered 2D selection). With BoxSelect is also ensure contiguous SetRange requests are not combined into one. This allows not handling interpolation in SetRange requests.
1193b4be Poul Sander 2025-02-03 21:28 2944
    ImGuiMultiSelectFlags_NoAutoSelect          = 1 << 3,   // Disable selecting items when navigating (useful for e.g. supporting range-select in a list of checkboxes).
1193b4be Poul Sander 2025-02-03 21:28 2945
    ImGuiMultiSelectFlags_NoAutoClear           = 1 << 4,   // Disable clearing selection when navigating or selecting another one (generally used with ImGuiMultiSelectFlags_NoAutoSelect. useful for e.g. supporting range-select in a list of checkboxes).
1193b4be Poul Sander 2025-02-03 21:28 2946
    ImGuiMultiSelectFlags_NoAutoClearOnReselect = 1 << 5,   // Disable clearing selection when clicking/selecting an already selected item.
1193b4be Poul Sander 2025-02-03 21:28 2947
    ImGuiMultiSelectFlags_BoxSelect1d           = 1 << 6,   // Enable box-selection with same width and same x pos items (e.g. full row Selectable()). Box-selection works better with little bit of spacing between items hit-box in order to be able to aim at empty space.
1193b4be Poul Sander 2025-02-03 21:28 2948
    ImGuiMultiSelectFlags_BoxSelect2d           = 1 << 7,   // Enable box-selection with varying width or varying x pos items support (e.g. different width labels, or 2D layout/grid). This is slower: alters clipping logic so that e.g. horizontal movements will update selection of normally clipped items.
1193b4be Poul Sander 2025-02-03 21:28 2949
    ImGuiMultiSelectFlags_BoxSelectNoScroll     = 1 << 8,   // Disable scrolling when box-selecting near edges of scope.
1193b4be Poul Sander 2025-02-03 21:28 2950
    ImGuiMultiSelectFlags_ClearOnEscape         = 1 << 9,   // Clear selection when pressing Escape while scope is focused.
1193b4be Poul Sander 2025-02-03 21:28 2951
    ImGuiMultiSelectFlags_ClearOnClickVoid      = 1 << 10,  // Clear selection when clicking on empty location within scope.
1193b4be Poul Sander 2025-02-03 21:28 2952
    ImGuiMultiSelectFlags_ScopeWindow           = 1 << 11,  // Scope for _BoxSelect and _ClearOnClickVoid is whole window (Default). Use if BeginMultiSelect() covers a whole window or used a single time in same window.
1193b4be Poul Sander 2025-02-03 21:28 2953
    ImGuiMultiSelectFlags_ScopeRect             = 1 << 12,  // Scope for _BoxSelect and _ClearOnClickVoid is rectangle encompassing BeginMultiSelect()/EndMultiSelect(). Use if BeginMultiSelect() is called multiple times in same window.
1193b4be Poul Sander 2025-02-03 21:28 2954
    ImGuiMultiSelectFlags_SelectOnClick         = 1 << 13,  // Apply selection on mouse down when clicking on unselected item. (Default)
1193b4be Poul Sander 2025-02-03 21:28 2955
    ImGuiMultiSelectFlags_SelectOnClickRelease  = 1 << 14,  // Apply selection on mouse release when clicking an unselected item. Allow dragging an unselected item without altering selection.
1193b4be Poul Sander 2025-02-03 21:28 2956
    //ImGuiMultiSelectFlags_RangeSelect2d       = 1 << 15,  // Shift+Selection uses 2d geometry instead of linear sequence, so possible to use Shift+up/down to select vertically in grid. Analogous to what BoxSelect does.
1193b4be Poul Sander 2025-02-03 21:28 2957
    ImGuiMultiSelectFlags_NavWrapX              = 1 << 16,  // [Temporary] Enable navigation wrapping on X axis. Provided as a convenience because we don't have a design for the general Nav API for this yet. When the more general feature be public we may obsolete this flag in favor of new one.
1193b4be Poul Sander 2025-02-03 21:28 2958
};
1193b4be Poul Sander 2025-02-03 21:28 2959
1193b4be Poul Sander 2025-02-03 21:28 2960
// Main IO structure returned by BeginMultiSelect()/EndMultiSelect().
1193b4be Poul Sander 2025-02-03 21:28 2961
// This mainly contains a list of selection requests.
1193b4be Poul Sander 2025-02-03 21:28 2962
// - Use 'Demo->Tools->Debug Log->Selection' to see requests as they happen.
1193b4be Poul Sander 2025-02-03 21:28 2963
// - Some fields are only useful if your list is dynamic and allows deletion (getting post-deletion focus/state right is shown in the demo)
1193b4be Poul Sander 2025-02-03 21:28 2964
// - Below: who reads/writes each fields? 'r'=read, 'w'=write, 'ms'=multi-select code, 'app'=application/user code.
1193b4be Poul Sander 2025-02-03 21:28 2965
struct ImGuiMultiSelectIO
1193b4be Poul Sander 2025-02-03 21:28 2966
{
1193b4be Poul Sander 2025-02-03 21:28 2967
    //------------------------------------------// BeginMultiSelect / EndMultiSelect
1193b4be Poul Sander 2025-02-03 21:28 2968
    ImVector<ImGuiSelectionRequest> Requests;   //  ms:w, app:r     /  ms:w  app:r   // Requests to apply to your selection data.
1193b4be Poul Sander 2025-02-03 21:28 2969
    ImGuiSelectionUserData      RangeSrcItem;   //  ms:w  app:r     /                // (If using clipper) Begin: Source item (often the first selected item) must never be clipped: use clipper.IncludeItemByIndex() to ensure it is submitted.
1193b4be Poul Sander 2025-02-03 21:28 2970
    ImGuiSelectionUserData      NavIdItem;      //  ms:w, app:r     /                // (If using deletion) Last known SetNextItemSelectionUserData() value for NavId (if part of submitted items).
1193b4be Poul Sander 2025-02-03 21:28 2971
    bool                        NavIdSelected;  //  ms:w, app:r     /        app:r   // (If using deletion) Last known selection state for NavId (if part of submitted items).
1193b4be Poul Sander 2025-02-03 21:28 2972
    bool                        RangeSrcReset;  //        app:w     /  ms:r          // (If using deletion) Set before EndMultiSelect() to reset ResetSrcItem (e.g. if deleted selection).
1193b4be Poul Sander 2025-02-03 21:28 2973
    int                         ItemsCount;     //  ms:w, app:r     /        app:r   // 'int items_count' parameter to BeginMultiSelect() is copied here for convenience, allowing simpler calls to your ApplyRequests handler. Not used internally.
1193b4be Poul Sander 2025-02-03 21:28 2974
};
1193b4be Poul Sander 2025-02-03 21:28 2975
1193b4be Poul Sander 2025-02-03 21:28 2976
// Selection request type
1193b4be Poul Sander 2025-02-03 21:28 2977
enum ImGuiSelectionRequestType
1193b4be Poul Sander 2025-02-03 21:28 2978
{
1193b4be Poul Sander 2025-02-03 21:28 2979
    ImGuiSelectionRequestType_None = 0,
1193b4be Poul Sander 2025-02-03 21:28 2980
    ImGuiSelectionRequestType_SetAll,           // Request app to clear selection (if Selected==false) or select all items (if Selected==true). We cannot set RangeFirstItem/RangeLastItem as its contents is entirely up to user (not necessarily an index)
1193b4be Poul Sander 2025-02-03 21:28 2981
    ImGuiSelectionRequestType_SetRange,         // Request app to select/unselect [RangeFirstItem..RangeLastItem] items (inclusive) based on value of Selected. Only EndMultiSelect() request this, app code can read after BeginMultiSelect() and it will always be false.
1193b4be Poul Sander 2025-02-03 21:28 2982
};
1193b4be Poul Sander 2025-02-03 21:28 2983
1193b4be Poul Sander 2025-02-03 21:28 2984
// Selection request item
1193b4be Poul Sander 2025-02-03 21:28 2985
struct ImGuiSelectionRequest
1193b4be Poul Sander 2025-02-03 21:28 2986
{
1193b4be Poul Sander 2025-02-03 21:28 2987
    //------------------------------------------// BeginMultiSelect / EndMultiSelect
1193b4be Poul Sander 2025-02-03 21:28 2988
    ImGuiSelectionRequestType   Type;           //  ms:w, app:r     /  ms:w, app:r   // Request type. You'll most often receive 1 Clear + 1 SetRange with a single-item range.
1193b4be Poul Sander 2025-02-03 21:28 2989
    bool                        Selected;       //  ms:w, app:r     /  ms:w, app:r   // Parameter for SetAll/SetRange requests (true = select, false = unselect)
1193b4be Poul Sander 2025-02-03 21:28 2990
    ImS8                        RangeDirection; //                  /  ms:w  app:r   // Parameter for SetRange request: +1 when RangeFirstItem comes before RangeLastItem, -1 otherwise. Useful if you want to preserve selection order on a backward Shift+Click.
1193b4be Poul Sander 2025-02-03 21:28 2991
    ImGuiSelectionUserData      RangeFirstItem; //                  /  ms:w, app:r   // Parameter for SetRange request (this is generally == RangeSrcItem when shift selecting from top to bottom).
1193b4be Poul Sander 2025-02-03 21:28 2992
    ImGuiSelectionUserData      RangeLastItem;  //                  /  ms:w, app:r   // Parameter for SetRange request (this is generally == RangeSrcItem when shift selecting from bottom to top). Inclusive!
1193b4be Poul Sander 2025-02-03 21:28 2993
};
1193b4be Poul Sander 2025-02-03 21:28 2994
1193b4be Poul Sander 2025-02-03 21:28 2995
// Optional helper to store multi-selection state + apply multi-selection requests.
1193b4be Poul Sander 2025-02-03 21:28 2996
// - Used by our demos and provided as a convenience to easily implement basic multi-selection.
1193b4be Poul Sander 2025-02-03 21:28 2997
// - Iterate selection with 'void* it = NULL; ImGuiID id; while (selection.GetNextSelectedItem(&it, &id)) { ... }'
1193b4be Poul Sander 2025-02-03 21:28 2998
//   Or you can check 'if (Contains(id)) { ... }' for each possible object if their number is not too high to iterate.
1193b4be Poul Sander 2025-02-03 21:28 2999
// - USING THIS IS NOT MANDATORY. This is only a helper and not a required API.
1193b4be Poul Sander 2025-02-03 21:28 3000
// To store a multi-selection, in your application you could:
1193b4be Poul Sander 2025-02-03 21:28 3001
// - Use this helper as a convenience. We use our simple key->value ImGuiStorage as a std::set<ImGuiID> replacement.
1193b4be Poul Sander 2025-02-03 21:28 3002
// - Use your own external storage: e.g. std::set<MyObjectId>, std::vector<MyObjectId>, interval trees, intrusively stored selection etc.
1193b4be Poul Sander 2025-02-03 21:28 3003
// In ImGuiSelectionBasicStorage we:
1193b4be Poul Sander 2025-02-03 21:28 3004
// - always use indices in the multi-selection API (passed to SetNextItemSelectionUserData(), retrieved in ImGuiMultiSelectIO)
1193b4be Poul Sander 2025-02-03 21:28 3005
// - use the AdapterIndexToStorageId() indirection layer to abstract how persistent selection data is derived from an index.
1193b4be Poul Sander 2025-02-03 21:28 3006
// - use decently optimized logic to allow queries and insertion of very large selection sets.
1193b4be Poul Sander 2025-02-03 21:28 3007
// - do not preserve selection order.
1193b4be Poul Sander 2025-02-03 21:28 3008
// Many combinations are possible depending on how you prefer to store your items and how you prefer to store your selection.
1193b4be Poul Sander 2025-02-03 21:28 3009
// Large applications are likely to eventually want to get rid of this indirection layer and do their own thing.
1193b4be Poul Sander 2025-02-03 21:28 3010
// See https://github.com/ocornut/imgui/wiki/Multi-Select for details and pseudo-code using this helper.
1193b4be Poul Sander 2025-02-03 21:28 3011
struct ImGuiSelectionBasicStorage
1193b4be Poul Sander 2025-02-03 21:28 3012
{
1193b4be Poul Sander 2025-02-03 21:28 3013
    // Members
1193b4be Poul Sander 2025-02-03 21:28 3014
    int             Size;           //          // Number of selected items, maintained by this helper.
1193b4be Poul Sander 2025-02-03 21:28 3015
    bool            PreserveOrder;  // = false  // GetNextSelectedItem() will return ordered selection (currently implemented by two additional sorts of selection. Could be improved)
1193b4be Poul Sander 2025-02-03 21:28 3016
    void*           UserData;       // = NULL   // User data for use by adapter function        // e.g. selection.UserData = (void*)my_items;
1193b4be Poul Sander 2025-02-03 21:28 3017
    ImGuiID         (*AdapterIndexToStorageId)(ImGuiSelectionBasicStorage* self, int idx);      // e.g. selection.AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage* self, int idx) { return ((MyItems**)self->UserData)[idx]->ID; };
1193b4be Poul Sander 2025-02-03 21:28 3018
    int             _SelectionOrder;// [Internal] Increasing counter to store selection order
1193b4be Poul Sander 2025-02-03 21:28 3019
    ImGuiStorage    _Storage;       // [Internal] Selection set. Think of this as similar to e.g. std::set<ImGuiID>. Prefer not accessing directly: iterate with GetNextSelectedItem().
1193b4be Poul Sander 2025-02-03 21:28 3020
1193b4be Poul Sander 2025-02-03 21:28 3021
    // Methods
1193b4be Poul Sander 2025-02-03 21:28 3022
    IMGUI_API ImGuiSelectionBasicStorage();
1193b4be Poul Sander 2025-02-03 21:28 3023
    IMGUI_API void  ApplyRequests(ImGuiMultiSelectIO* ms_io);   // Apply selection requests coming from BeginMultiSelect() and EndMultiSelect() functions. It uses 'items_count' passed to BeginMultiSelect()
1193b4be Poul Sander 2025-02-03 21:28 3024
    IMGUI_API bool  Contains(ImGuiID id) const;                 // Query if an item id is in selection.
1193b4be Poul Sander 2025-02-03 21:28 3025
    IMGUI_API void  Clear();                                    // Clear selection
1193b4be Poul Sander 2025-02-03 21:28 3026
    IMGUI_API void  Swap(ImGuiSelectionBasicStorage& r);        // Swap two selections
1193b4be Poul Sander 2025-02-03 21:28 3027
    IMGUI_API void  SetItemSelected(ImGuiID id, bool selected); // Add/remove an item from selection (generally done by ApplyRequests() function)
1193b4be Poul Sander 2025-02-03 21:28 3028
    IMGUI_API bool  GetNextSelectedItem(void** opaque_it, ImGuiID* out_id); // Iterate selection with 'void* it = NULL; ImGuiId id; while (selection.GetNextSelectedItem(&it, &id)) { ... }'
1193b4be Poul Sander 2025-02-03 21:28 3029
    inline ImGuiID  GetStorageIdFromIndex(int idx)              { return AdapterIndexToStorageId(this, idx); }  // Convert index to item id based on provided adapter.
1193b4be Poul Sander 2025-02-03 21:28 3030
};
1193b4be Poul Sander 2025-02-03 21:28 3031
1193b4be Poul Sander 2025-02-03 21:28 3032
// Optional helper to apply multi-selection requests to existing randomly accessible storage.
1193b4be Poul Sander 2025-02-03 21:28 3033
// Convenient if you want to quickly wire multi-select API on e.g. an array of bool or items storing their own selection state.
1193b4be Poul Sander 2025-02-03 21:28 3034
struct ImGuiSelectionExternalStorage
1193b4be Poul Sander 2025-02-03 21:28 3035
{
1193b4be Poul Sander 2025-02-03 21:28 3036
    // Members
1193b4be Poul Sander 2025-02-03 21:28 3037
    void*           UserData;       // User data for use by adapter function                                // e.g. selection.UserData = (void*)my_items;
1193b4be Poul Sander 2025-02-03 21:28 3038
    void            (*AdapterSetItemSelected)(ImGuiSelectionExternalStorage* self, int idx, bool selected); // e.g. AdapterSetItemSelected = [](ImGuiSelectionExternalStorage* self, int idx, bool selected) { ((MyItems**)self->UserData)[idx]->Selected = selected; }
1193b4be Poul Sander 2025-02-03 21:28 3039
1193b4be Poul Sander 2025-02-03 21:28 3040
    // Methods
1193b4be Poul Sander 2025-02-03 21:28 3041
    IMGUI_API ImGuiSelectionExternalStorage();
1193b4be Poul Sander 2025-02-03 21:28 3042
    IMGUI_API void  ApplyRequests(ImGuiMultiSelectIO* ms_io);   // Apply selection requests by using AdapterSetItemSelected() calls
1193b4be Poul Sander 2025-02-03 21:28 3043
};
1193b4be Poul Sander 2025-02-03 21:28 3044
1193b4be Poul Sander 2025-02-03 21:28 3045
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3046
// [SECTION] Drawing API (ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawListFlags, ImDrawList, ImDrawData)
1193b4be Poul Sander 2025-02-03 21:28 3047
// Hold a series of drawing commands. The user provides a renderer for ImDrawData which essentially contains an array of ImDrawList.
1193b4be Poul Sander 2025-02-03 21:28 3048
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3049
1193b4be Poul Sander 2025-02-03 21:28 3050
// The maximum line width to bake anti-aliased textures for. Build atlas with ImFontAtlasFlags_NoBakedLines to disable baking.
1193b4be Poul Sander 2025-02-03 21:28 3051
#ifndef IM_DRAWLIST_TEX_LINES_WIDTH_MAX
1193b4be Poul Sander 2025-02-03 21:28 3052
#define IM_DRAWLIST_TEX_LINES_WIDTH_MAX     (63)
1193b4be Poul Sander 2025-02-03 21:28 3053
#endif
1193b4be Poul Sander 2025-02-03 21:28 3054
1193b4be Poul Sander 2025-02-03 21:28 3055
// ImDrawCallback: Draw callbacks for advanced uses [configurable type: override in imconfig.h]
1193b4be Poul Sander 2025-02-03 21:28 3056
// NB: You most likely do NOT need to use draw callbacks just to create your own widget or customized UI rendering,
1193b4be Poul Sander 2025-02-03 21:28 3057
// you can poke into the draw list for that! Draw callback may be useful for example to:
1193b4be Poul Sander 2025-02-03 21:28 3058
//  A) Change your GPU render state,
1193b4be Poul Sander 2025-02-03 21:28 3059
//  B) render a complex 3D scene inside a UI element without an intermediate texture/render target, etc.
1193b4be Poul Sander 2025-02-03 21:28 3060
// The expected behavior from your rendering function is 'if (cmd.UserCallback != NULL) { cmd.UserCallback(parent_list, cmd); } else { RenderTriangles() }'
1193b4be Poul Sander 2025-02-03 21:28 3061
// If you want to override the signature of ImDrawCallback, you can simply use e.g. '#define ImDrawCallback MyDrawCallback' (in imconfig.h) + update rendering backend accordingly.
1193b4be Poul Sander 2025-02-03 21:28 3062
#ifndef ImDrawCallback
1193b4be Poul Sander 2025-02-03 21:28 3063
typedef void (*ImDrawCallback)(const ImDrawList* parent_list, const ImDrawCmd* cmd);
1193b4be Poul Sander 2025-02-03 21:28 3064
#endif
1193b4be Poul Sander 2025-02-03 21:28 3065
1193b4be Poul Sander 2025-02-03 21:28 3066
// Special Draw callback value to request renderer backend to reset the graphics/render state.
1193b4be Poul Sander 2025-02-03 21:28 3067
// The renderer backend needs to handle this special value, otherwise it will crash trying to call a function at this address.
1193b4be Poul Sander 2025-02-03 21:28 3068
// This is useful, for example, if you submitted callbacks which you know have altered the render state and you want it to be restored.
1193b4be Poul Sander 2025-02-03 21:28 3069
// Render state is not reset by default because they are many perfectly useful way of altering render state (e.g. changing shader/blending settings before an Image call).
1193b4be Poul Sander 2025-02-03 21:28 3070
#define ImDrawCallback_ResetRenderState     (ImDrawCallback)(-8)
1193b4be Poul Sander 2025-02-03 21:28 3071
1193b4be Poul Sander 2025-02-03 21:28 3072
// Typically, 1 command = 1 GPU draw call (unless command is a callback)
1193b4be Poul Sander 2025-02-03 21:28 3073
// - VtxOffset: When 'io.BackendFlags & ImGuiBackendFlags_RendererHasVtxOffset' is enabled,
1193b4be Poul Sander 2025-02-03 21:28 3074
//   this fields allow us to render meshes larger than 64K vertices while keeping 16-bit indices.
1193b4be Poul Sander 2025-02-03 21:28 3075
//   Backends made for <1.71. will typically ignore the VtxOffset fields.
1193b4be Poul Sander 2025-02-03 21:28 3076
// - The ClipRect/TextureId/VtxOffset fields must be contiguous as we memcmp() them together (this is asserted for).
1193b4be Poul Sander 2025-02-03 21:28 3077
struct ImDrawCmd
1193b4be Poul Sander 2025-02-03 21:28 3078
{
1193b4be Poul Sander 2025-02-03 21:28 3079
    ImVec4          ClipRect;           // 4*4  // Clipping rectangle (x1, y1, x2, y2). Subtract ImDrawData->DisplayPos to get clipping rectangle in "viewport" coordinates
1193b4be Poul Sander 2025-02-03 21:28 3080
    ImTextureID     TextureId;          // 4-8  // User-provided texture ID. Set by user in ImfontAtlas::SetTexID() for fonts or passed to Image*() functions. Ignore if never using images or multiple fonts atlas.
1193b4be Poul Sander 2025-02-03 21:28 3081
    unsigned int    VtxOffset;          // 4    // Start offset in vertex buffer. ImGuiBackendFlags_RendererHasVtxOffset: always 0, otherwise may be >0 to support meshes larger than 64K vertices with 16-bit indices.
1193b4be Poul Sander 2025-02-03 21:28 3082
    unsigned int    IdxOffset;          // 4    // Start offset in index buffer.
1193b4be Poul Sander 2025-02-03 21:28 3083
    unsigned int    ElemCount;          // 4    // Number of indices (multiple of 3) to be rendered as triangles. Vertices are stored in the callee ImDrawList's vtx_buffer[] array, indices in idx_buffer[].
1193b4be Poul Sander 2025-02-03 21:28 3084
    ImDrawCallback  UserCallback;       // 4-8  // If != NULL, call the function instead of rendering the vertices. clip_rect and texture_id will be set normally.
1193b4be Poul Sander 2025-02-03 21:28 3085
    void*           UserCallbackData;   // 4-8  // Callback user data (when UserCallback != NULL). If called AddCallback() with size == 0, this is a copy of the AddCallback() argument. If called AddCallback() with size > 0, this is pointing to a buffer where data is stored.
1193b4be Poul Sander 2025-02-03 21:28 3086
    int             UserCallbackDataSize;  // 4 // Size of callback user data when using storage, otherwise 0.
1193b4be Poul Sander 2025-02-03 21:28 3087
    int             UserCallbackDataOffset;// 4 // [Internal] Offset of callback user data when using storage, otherwise -1.
1193b4be Poul Sander 2025-02-03 21:28 3088
1193b4be Poul Sander 2025-02-03 21:28 3089
    ImDrawCmd()     { memset(this, 0, sizeof(*this)); } // Also ensure our padding fields are zeroed
1193b4be Poul Sander 2025-02-03 21:28 3090
1193b4be Poul Sander 2025-02-03 21:28 3091
    // Since 1.83: returns ImTextureID associated with this draw call. Warning: DO NOT assume this is always same as 'TextureId' (we will change this function for an upcoming feature)
1193b4be Poul Sander 2025-02-03 21:28 3092
    inline ImTextureID GetTexID() const { return TextureId; }
1193b4be Poul Sander 2025-02-03 21:28 3093
};
1193b4be Poul Sander 2025-02-03 21:28 3094
1193b4be Poul Sander 2025-02-03 21:28 3095
// Vertex layout
1193b4be Poul Sander 2025-02-03 21:28 3096
#ifndef IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT
1193b4be Poul Sander 2025-02-03 21:28 3097
struct ImDrawVert
1193b4be Poul Sander 2025-02-03 21:28 3098
{
1193b4be Poul Sander 2025-02-03 21:28 3099
    ImVec2  pos;
1193b4be Poul Sander 2025-02-03 21:28 3100
    ImVec2  uv;
1193b4be Poul Sander 2025-02-03 21:28 3101
    ImU32   col;
1193b4be Poul Sander 2025-02-03 21:28 3102
};
1193b4be Poul Sander 2025-02-03 21:28 3103
#else
1193b4be Poul Sander 2025-02-03 21:28 3104
// You can override the vertex format layout by defining IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT in imconfig.h
1193b4be Poul Sander 2025-02-03 21:28 3105
// The code expect ImVec2 pos (8 bytes), ImVec2 uv (8 bytes), ImU32 col (4 bytes), but you can re-order them or add other fields as needed to simplify integration in your engine.
1193b4be Poul Sander 2025-02-03 21:28 3106
// The type has to be described within the macro (you can either declare the struct or use a typedef). This is because ImVec2/ImU32 are likely not declared at the time you'd want to set your type up.
1193b4be Poul Sander 2025-02-03 21:28 3107
// NOTE: IMGUI DOESN'T CLEAR THE STRUCTURE AND DOESN'T CALL A CONSTRUCTOR SO ANY CUSTOM FIELD WILL BE UNINITIALIZED. IF YOU ADD EXTRA FIELDS (SUCH AS A 'Z' COORDINATES) YOU WILL NEED TO CLEAR THEM DURING RENDER OR TO IGNORE THEM.
1193b4be Poul Sander 2025-02-03 21:28 3108
IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT;
1193b4be Poul Sander 2025-02-03 21:28 3109
#endif
1193b4be Poul Sander 2025-02-03 21:28 3110
1193b4be Poul Sander 2025-02-03 21:28 3111
// [Internal] For use by ImDrawList
1193b4be Poul Sander 2025-02-03 21:28 3112
struct ImDrawCmdHeader
1193b4be Poul Sander 2025-02-03 21:28 3113
{
1193b4be Poul Sander 2025-02-03 21:28 3114
    ImVec4          ClipRect;
1193b4be Poul Sander 2025-02-03 21:28 3115
    ImTextureID     TextureId;
1193b4be Poul Sander 2025-02-03 21:28 3116
    unsigned int    VtxOffset;
1193b4be Poul Sander 2025-02-03 21:28 3117
};
1193b4be Poul Sander 2025-02-03 21:28 3118
1193b4be Poul Sander 2025-02-03 21:28 3119
// [Internal] For use by ImDrawListSplitter
1193b4be Poul Sander 2025-02-03 21:28 3120
struct ImDrawChannel
1193b4be Poul Sander 2025-02-03 21:28 3121
{
1193b4be Poul Sander 2025-02-03 21:28 3122
    ImVector<ImDrawCmd>         _CmdBuffer;
1193b4be Poul Sander 2025-02-03 21:28 3123
    ImVector<ImDrawIdx>         _IdxBuffer;
1193b4be Poul Sander 2025-02-03 21:28 3124
};
1193b4be Poul Sander 2025-02-03 21:28 3125
1193b4be Poul Sander 2025-02-03 21:28 3126
1193b4be Poul Sander 2025-02-03 21:28 3127
// Split/Merge functions are used to split the draw list into different layers which can be drawn into out of order.
1193b4be Poul Sander 2025-02-03 21:28 3128
// This is used by the Columns/Tables API, so items of each column can be batched together in a same draw call.
1193b4be Poul Sander 2025-02-03 21:28 3129
struct ImDrawListSplitter
1193b4be Poul Sander 2025-02-03 21:28 3130
{
1193b4be Poul Sander 2025-02-03 21:28 3131
    int                         _Current;    // Current channel number (0)
1193b4be Poul Sander 2025-02-03 21:28 3132
    int                         _Count;      // Number of active channels (1+)
1193b4be Poul Sander 2025-02-03 21:28 3133
    ImVector<ImDrawChannel>     _Channels;   // Draw channels (not resized down so _Count might be < Channels.Size)
1193b4be Poul Sander 2025-02-03 21:28 3134
1193b4be Poul Sander 2025-02-03 21:28 3135
    inline ImDrawListSplitter()  { memset(this, 0, sizeof(*this)); }
1193b4be Poul Sander 2025-02-03 21:28 3136
    inline ~ImDrawListSplitter() { ClearFreeMemory(); }
1193b4be Poul Sander 2025-02-03 21:28 3137
    inline void                 Clear() { _Current = 0; _Count = 1; } // Do not clear Channels[] so our allocations are reused next frame
1193b4be Poul Sander 2025-02-03 21:28 3138
    IMGUI_API void              ClearFreeMemory();
1193b4be Poul Sander 2025-02-03 21:28 3139
    IMGUI_API void              Split(ImDrawList* draw_list, int count);
1193b4be Poul Sander 2025-02-03 21:28 3140
    IMGUI_API void              Merge(ImDrawList* draw_list);
1193b4be Poul Sander 2025-02-03 21:28 3141
    IMGUI_API void              SetCurrentChannel(ImDrawList* draw_list, int channel_idx);
1193b4be Poul Sander 2025-02-03 21:28 3142
};
1193b4be Poul Sander 2025-02-03 21:28 3143
1193b4be Poul Sander 2025-02-03 21:28 3144
// Flags for ImDrawList functions
1193b4be Poul Sander 2025-02-03 21:28 3145
// (Legacy: bit 0 must always correspond to ImDrawFlags_Closed to be backward compatible with old API using a bool. Bits 1..3 must be unused)
1193b4be Poul Sander 2025-02-03 21:28 3146
enum ImDrawFlags_
1193b4be Poul Sander 2025-02-03 21:28 3147
{
1193b4be Poul Sander 2025-02-03 21:28 3148
    ImDrawFlags_None                        = 0,
1193b4be Poul Sander 2025-02-03 21:28 3149
    ImDrawFlags_Closed                      = 1 << 0, // PathStroke(), AddPolyline(): specify that shape should be closed (Important: this is always == 1 for legacy reason)
1193b4be Poul Sander 2025-02-03 21:28 3150
    ImDrawFlags_RoundCornersTopLeft         = 1 << 4, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-left corner only (when rounding > 0.0f, we default to all corners). Was 0x01.
1193b4be Poul Sander 2025-02-03 21:28 3151
    ImDrawFlags_RoundCornersTopRight        = 1 << 5, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-right corner only (when rounding > 0.0f, we default to all corners). Was 0x02.
1193b4be Poul Sander 2025-02-03 21:28 3152
    ImDrawFlags_RoundCornersBottomLeft      = 1 << 6, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners). Was 0x04.
1193b4be Poul Sander 2025-02-03 21:28 3153
    ImDrawFlags_RoundCornersBottomRight     = 1 << 7, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners). Wax 0x08.
1193b4be Poul Sander 2025-02-03 21:28 3154
    ImDrawFlags_RoundCornersNone            = 1 << 8, // AddRect(), AddRectFilled(), PathRect(): disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag!
1193b4be Poul Sander 2025-02-03 21:28 3155
    ImDrawFlags_RoundCornersTop             = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersTopRight,
1193b4be Poul Sander 2025-02-03 21:28 3156
    ImDrawFlags_RoundCornersBottom          = ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersBottomRight,
1193b4be Poul Sander 2025-02-03 21:28 3157
    ImDrawFlags_RoundCornersLeft            = ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersTopLeft,
1193b4be Poul Sander 2025-02-03 21:28 3158
    ImDrawFlags_RoundCornersRight           = ImDrawFlags_RoundCornersBottomRight | ImDrawFlags_RoundCornersTopRight,
1193b4be Poul Sander 2025-02-03 21:28 3159
    ImDrawFlags_RoundCornersAll             = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersTopRight | ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersBottomRight,
1193b4be Poul Sander 2025-02-03 21:28 3160
    ImDrawFlags_RoundCornersDefault_        = ImDrawFlags_RoundCornersAll, // Default to ALL corners if none of the _RoundCornersXX flags are specified.
1193b4be Poul Sander 2025-02-03 21:28 3161
    ImDrawFlags_RoundCornersMask_           = ImDrawFlags_RoundCornersAll | ImDrawFlags_RoundCornersNone,
1193b4be Poul Sander 2025-02-03 21:28 3162
};
1193b4be Poul Sander 2025-02-03 21:28 3163
1193b4be Poul Sander 2025-02-03 21:28 3164
// Flags for ImDrawList instance. Those are set automatically by ImGui:: functions from ImGuiIO settings, and generally not manipulated directly.
1193b4be Poul Sander 2025-02-03 21:28 3165
// It is however possible to temporarily alter flags between calls to ImDrawList:: functions.
1193b4be Poul Sander 2025-02-03 21:28 3166
enum ImDrawListFlags_
1193b4be Poul Sander 2025-02-03 21:28 3167
{
1193b4be Poul Sander 2025-02-03 21:28 3168
    ImDrawListFlags_None                    = 0,
1193b4be Poul Sander 2025-02-03 21:28 3169
    ImDrawListFlags_AntiAliasedLines        = 1 << 0,  // Enable anti-aliased lines/borders (*2 the number of triangles for 1.0f wide line or lines thin enough to be drawn using textures, otherwise *3 the number of triangles)
1193b4be Poul Sander 2025-02-03 21:28 3170
    ImDrawListFlags_AntiAliasedLinesUseTex  = 1 << 1,  // Enable anti-aliased lines/borders using textures when possible. Require backend to render with bilinear filtering (NOT point/nearest filtering).
1193b4be Poul Sander 2025-02-03 21:28 3171
    ImDrawListFlags_AntiAliasedFill         = 1 << 2,  // Enable anti-aliased edge around filled shapes (rounded rectangles, circles).
1193b4be Poul Sander 2025-02-03 21:28 3172
    ImDrawListFlags_AllowVtxOffset          = 1 << 3,  // Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
1193b4be Poul Sander 2025-02-03 21:28 3173
};
1193b4be Poul Sander 2025-02-03 21:28 3174
1193b4be Poul Sander 2025-02-03 21:28 3175
// Draw command list
1193b4be Poul Sander 2025-02-03 21:28 3176
// This is the low-level list of polygons that ImGui:: functions are filling. At the end of the frame,
1193b4be Poul Sander 2025-02-03 21:28 3177
// all command lists are passed to your ImGuiIO::RenderDrawListFn function for rendering.
1193b4be Poul Sander 2025-02-03 21:28 3178
// Each dear imgui window contains its own ImDrawList. You can use ImGui::GetWindowDrawList() to
1193b4be Poul Sander 2025-02-03 21:28 3179
// access the current window draw list and draw custom primitives.
1193b4be Poul Sander 2025-02-03 21:28 3180
// You can interleave normal ImGui:: calls and adding primitives to the current draw list.
1193b4be Poul Sander 2025-02-03 21:28 3181
// In single viewport mode, top-left is == GetMainViewport()->Pos (generally 0,0), bottom-right is == GetMainViewport()->Pos+Size (generally io.DisplaySize).
1193b4be Poul Sander 2025-02-03 21:28 3182
// You are totally free to apply whatever transformation matrix to want to the data (depending on the use of the transformation you may want to apply it to ClipRect as well!)
1193b4be Poul Sander 2025-02-03 21:28 3183
// Important: Primitives are always added to the list and not culled (culling is done at higher-level by ImGui:: functions), if you use this API a lot consider coarse culling your drawn objects.
1193b4be Poul Sander 2025-02-03 21:28 3184
struct ImDrawList
1193b4be Poul Sander 2025-02-03 21:28 3185
{
1193b4be Poul Sander 2025-02-03 21:28 3186
    // This is what you have to render
1193b4be Poul Sander 2025-02-03 21:28 3187
    ImVector<ImDrawCmd>     CmdBuffer;          // Draw commands. Typically 1 command = 1 GPU draw call, unless the command is a callback.
1193b4be Poul Sander 2025-02-03 21:28 3188
    ImVector<ImDrawIdx>     IdxBuffer;          // Index buffer. Each command consume ImDrawCmd::ElemCount of those
1193b4be Poul Sander 2025-02-03 21:28 3189
    ImVector<ImDrawVert>    VtxBuffer;          // Vertex buffer.
1193b4be Poul Sander 2025-02-03 21:28 3190
    ImDrawListFlags         Flags;              // Flags, you may poke into these to adjust anti-aliasing settings per-primitive.
1193b4be Poul Sander 2025-02-03 21:28 3191
1193b4be Poul Sander 2025-02-03 21:28 3192
    // [Internal, used while building lists]
1193b4be Poul Sander 2025-02-03 21:28 3193
    unsigned int            _VtxCurrentIdx;     // [Internal] generally == VtxBuffer.Size unless we are past 64K vertices, in which case this gets reset to 0.
1193b4be Poul Sander 2025-02-03 21:28 3194
    ImDrawListSharedData*   _Data;              // Pointer to shared draw data (you can use ImGui::GetDrawListSharedData() to get the one from current ImGui context)
1193b4be Poul Sander 2025-02-03 21:28 3195
    ImDrawVert*             _VtxWritePtr;       // [Internal] point within VtxBuffer.Data after each add command (to avoid using the ImVector<> operators too much)
1193b4be Poul Sander 2025-02-03 21:28 3196
    ImDrawIdx*              _IdxWritePtr;       // [Internal] point within IdxBuffer.Data after each add command (to avoid using the ImVector<> operators too much)
1193b4be Poul Sander 2025-02-03 21:28 3197
    ImVector<ImVec2>        _Path;              // [Internal] current path building
1193b4be Poul Sander 2025-02-03 21:28 3198
    ImDrawCmdHeader         _CmdHeader;         // [Internal] template of active commands. Fields should match those of CmdBuffer.back().
1193b4be Poul Sander 2025-02-03 21:28 3199
    ImDrawListSplitter      _Splitter;          // [Internal] for channels api (note: prefer using your own persistent instance of ImDrawListSplitter!)
1193b4be Poul Sander 2025-02-03 21:28 3200
    ImVector<ImVec4>        _ClipRectStack;     // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 3201
    ImVector<ImTextureID>   _TextureIdStack;    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 3202
    ImVector<ImU8>          _CallbacksDataBuf;  // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 3203
    float                   _FringeScale;       // [Internal] anti-alias fringe is scaled by this value, this helps to keep things sharp while zooming at vertex buffer content
1193b4be Poul Sander 2025-02-03 21:28 3204
    const char*             _OwnerName;         // Pointer to owner window's name for debugging
1193b4be Poul Sander 2025-02-03 21:28 3205
1193b4be Poul Sander 2025-02-03 21:28 3206
    // If you want to create ImDrawList instances, pass them ImGui::GetDrawListSharedData() or create and use your own ImDrawListSharedData (so you can use ImDrawList without ImGui)
1193b4be Poul Sander 2025-02-03 21:28 3207
    ImDrawList(ImDrawListSharedData* shared_data) { memset(this, 0, sizeof(*this)); _Data = shared_data; }
1193b4be Poul Sander 2025-02-03 21:28 3208
1193b4be Poul Sander 2025-02-03 21:28 3209
    ~ImDrawList() { _ClearFreeMemory(); }
1193b4be Poul Sander 2025-02-03 21:28 3210
    IMGUI_API void  PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect = false);  // Render-level scissoring. This is passed down to your render function but not used for CPU-side coarse clipping. Prefer using higher-level ImGui::PushClipRect() to affect logic (hit-testing and widget culling)
1193b4be Poul Sander 2025-02-03 21:28 3211
    IMGUI_API void  PushClipRectFullScreen();
1193b4be Poul Sander 2025-02-03 21:28 3212
    IMGUI_API void  PopClipRect();
1193b4be Poul Sander 2025-02-03 21:28 3213
    IMGUI_API void  PushTextureID(ImTextureID texture_id);
1193b4be Poul Sander 2025-02-03 21:28 3214
    IMGUI_API void  PopTextureID();
1193b4be Poul Sander 2025-02-03 21:28 3215
    inline ImVec2   GetClipRectMin() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.x, cr.y); }
1193b4be Poul Sander 2025-02-03 21:28 3216
    inline ImVec2   GetClipRectMax() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.z, cr.w); }
1193b4be Poul Sander 2025-02-03 21:28 3217
1193b4be Poul Sander 2025-02-03 21:28 3218
    // Primitives
1193b4be Poul Sander 2025-02-03 21:28 3219
    // - Filled shapes must always use clockwise winding order. The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
1193b4be Poul Sander 2025-02-03 21:28 3220
    // - For rectangular primitives, "p_min" and "p_max" represent the upper-left and lower-right corners.
1193b4be Poul Sander 2025-02-03 21:28 3221
    // - For circle primitives, use "num_segments == 0" to automatically calculate tessellation (preferred).
1193b4be Poul Sander 2025-02-03 21:28 3222
    //   In older versions (until Dear ImGui 1.77) the AddCircle functions defaulted to num_segments == 12.
1193b4be Poul Sander 2025-02-03 21:28 3223
    //   In future versions we will use textures to provide cheaper and higher-quality circles.
1193b4be Poul Sander 2025-02-03 21:28 3224
    //   Use AddNgon() and AddNgonFilled() functions if you need to guarantee a specific number of sides.
1193b4be Poul Sander 2025-02-03 21:28 3225
    IMGUI_API void  AddLine(const ImVec2& p1, const ImVec2& p2, ImU32 col, float thickness = 1.0f);
1193b4be Poul Sander 2025-02-03 21:28 3226
    IMGUI_API void  AddRect(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding = 0.0f, ImDrawFlags flags = 0, float thickness = 1.0f);   // a: upper-left, b: lower-right (== upper-left + size)
1193b4be Poul Sander 2025-02-03 21:28 3227
    IMGUI_API void  AddRectFilled(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding = 0.0f, ImDrawFlags flags = 0);                     // a: upper-left, b: lower-right (== upper-left + size)
1193b4be Poul Sander 2025-02-03 21:28 3228
    IMGUI_API void  AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left);
1193b4be Poul Sander 2025-02-03 21:28 3229
    IMGUI_API void  AddQuad(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness = 1.0f);
1193b4be Poul Sander 2025-02-03 21:28 3230
    IMGUI_API void  AddQuadFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col);
1193b4be Poul Sander 2025-02-03 21:28 3231
    IMGUI_API void  AddTriangle(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness = 1.0f);
1193b4be Poul Sander 2025-02-03 21:28 3232
    IMGUI_API void  AddTriangleFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col);
1193b4be Poul Sander 2025-02-03 21:28 3233
    IMGUI_API void  AddCircle(const ImVec2& center, float radius, ImU32 col, int num_segments = 0, float thickness = 1.0f);
1193b4be Poul Sander 2025-02-03 21:28 3234
    IMGUI_API void  AddCircleFilled(const ImVec2& center, float radius, ImU32 col, int num_segments = 0);
1193b4be Poul Sander 2025-02-03 21:28 3235
    IMGUI_API void  AddNgon(const ImVec2& center, float radius, ImU32 col, int num_segments, float thickness = 1.0f);
1193b4be Poul Sander 2025-02-03 21:28 3236
    IMGUI_API void  AddNgonFilled(const ImVec2& center, float radius, ImU32 col, int num_segments);
1193b4be Poul Sander 2025-02-03 21:28 3237
    IMGUI_API void  AddEllipse(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot = 0.0f, int num_segments = 0, float thickness = 1.0f);
1193b4be Poul Sander 2025-02-03 21:28 3238
    IMGUI_API void  AddEllipseFilled(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot = 0.0f, int num_segments = 0);
1193b4be Poul Sander 2025-02-03 21:28 3239
    IMGUI_API void  AddText(const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end = NULL);
1193b4be Poul Sander 2025-02-03 21:28 3240
    IMGUI_API void  AddText(const ImFont* font, float font_size, const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end = NULL, float wrap_width = 0.0f, const ImVec4* cpu_fine_clip_rect = NULL);
1193b4be Poul Sander 2025-02-03 21:28 3241
    IMGUI_API void  AddBezierCubic(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness, int num_segments = 0); // Cubic Bezier (4 control points)
1193b4be Poul Sander 2025-02-03 21:28 3242
    IMGUI_API void  AddBezierQuadratic(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness, int num_segments = 0);               // Quadratic Bezier (3 control points)
1193b4be Poul Sander 2025-02-03 21:28 3243
1193b4be Poul Sander 2025-02-03 21:28 3244
    // General polygon
1193b4be Poul Sander 2025-02-03 21:28 3245
    // - Only simple polygons are supported by filling functions (no self-intersections, no holes).
1193b4be Poul Sander 2025-02-03 21:28 3246
    // - Concave polygon fill is more expensive than convex one: it has O(N^2) complexity. Provided as a convenience fo user but not used by main library.
1193b4be Poul Sander 2025-02-03 21:28 3247
    IMGUI_API void  AddPolyline(const ImVec2* points, int num_points, ImU32 col, ImDrawFlags flags, float thickness);
1193b4be Poul Sander 2025-02-03 21:28 3248
    IMGUI_API void  AddConvexPolyFilled(const ImVec2* points, int num_points, ImU32 col);
1193b4be Poul Sander 2025-02-03 21:28 3249
    IMGUI_API void  AddConcavePolyFilled(const ImVec2* points, int num_points, ImU32 col);
1193b4be Poul Sander 2025-02-03 21:28 3250
1193b4be Poul Sander 2025-02-03 21:28 3251
    // Image primitives
1193b4be Poul Sander 2025-02-03 21:28 3252
    // - Read FAQ to understand what ImTextureID is.
1193b4be Poul Sander 2025-02-03 21:28 3253
    // - "p_min" and "p_max" represent the upper-left and lower-right corners of the rectangle.
1193b4be Poul Sander 2025-02-03 21:28 3254
    // - "uv_min" and "uv_max" represent the normalized texture coordinates to use for those corners. Using (0,0)->(1,1) texture coordinates will generally display the entire texture.
1193b4be Poul Sander 2025-02-03 21:28 3255
    IMGUI_API void  AddImage(ImTextureID user_texture_id, const ImVec2& p_min, const ImVec2& p_max, const ImVec2& uv_min = ImVec2(0, 0), const ImVec2& uv_max = ImVec2(1, 1), ImU32 col = IM_COL32_WHITE);
1193b4be Poul Sander 2025-02-03 21:28 3256
    IMGUI_API void  AddImageQuad(ImTextureID user_texture_id, const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& uv1 = ImVec2(0, 0), const ImVec2& uv2 = ImVec2(1, 0), const ImVec2& uv3 = ImVec2(1, 1), const ImVec2& uv4 = ImVec2(0, 1), ImU32 col = IM_COL32_WHITE);
1193b4be Poul Sander 2025-02-03 21:28 3257
    IMGUI_API void  AddImageRounded(ImTextureID user_texture_id, const ImVec2& p_min, const ImVec2& p_max, const ImVec2& uv_min, const ImVec2& uv_max, ImU32 col, float rounding, ImDrawFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 3258
1193b4be Poul Sander 2025-02-03 21:28 3259
    // Stateful path API, add points then finish with PathFillConvex() or PathStroke()
1193b4be Poul Sander 2025-02-03 21:28 3260
    // - Important: filled shapes must always use clockwise winding order! The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
1193b4be Poul Sander 2025-02-03 21:28 3261
    //   so e.g. 'PathArcTo(center, radius, PI * -0.5f, PI)' is ok, whereas 'PathArcTo(center, radius, PI, PI * -0.5f)' won't have correct anti-aliasing when followed by PathFillConvex().
1193b4be Poul Sander 2025-02-03 21:28 3262
    inline    void  PathClear()                                                 { _Path.Size = 0; }
1193b4be Poul Sander 2025-02-03 21:28 3263
    inline    void  PathLineTo(const ImVec2& pos)                               { _Path.push_back(pos); }
1193b4be Poul Sander 2025-02-03 21:28 3264
    inline    void  PathLineToMergeDuplicate(const ImVec2& pos)                 { if (_Path.Size == 0 || memcmp(&_Path.Data[_Path.Size - 1], &pos, 8) != 0) _Path.push_back(pos); }
1193b4be Poul Sander 2025-02-03 21:28 3265
    inline    void  PathFillConvex(ImU32 col)                                   { AddConvexPolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; }
1193b4be Poul Sander 2025-02-03 21:28 3266
    inline    void  PathFillConcave(ImU32 col)                                  { AddConcavePolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; }
1193b4be Poul Sander 2025-02-03 21:28 3267
    inline    void  PathStroke(ImU32 col, ImDrawFlags flags = 0, float thickness = 1.0f) { AddPolyline(_Path.Data, _Path.Size, col, flags, thickness); _Path.Size = 0; }
1193b4be Poul Sander 2025-02-03 21:28 3268
    IMGUI_API void  PathArcTo(const ImVec2& center, float radius, float a_min, float a_max, int num_segments = 0);
1193b4be Poul Sander 2025-02-03 21:28 3269
    IMGUI_API void  PathArcToFast(const ImVec2& center, float radius, int a_min_of_12, int a_max_of_12);                // Use precomputed angles for a 12 steps circle
1193b4be Poul Sander 2025-02-03 21:28 3270
    IMGUI_API void  PathEllipticalArcTo(const ImVec2& center, const ImVec2& radius, float rot, float a_min, float a_max, int num_segments = 0); // Ellipse
1193b4be Poul Sander 2025-02-03 21:28 3271
    IMGUI_API void  PathBezierCubicCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments = 0); // Cubic Bezier (4 control points)
1193b4be Poul Sander 2025-02-03 21:28 3272
    IMGUI_API void  PathBezierQuadraticCurveTo(const ImVec2& p2, const ImVec2& p3, int num_segments = 0);               // Quadratic Bezier (3 control points)
1193b4be Poul Sander 2025-02-03 21:28 3273
    IMGUI_API void  PathRect(const ImVec2& rect_min, const ImVec2& rect_max, float rounding = 0.0f, ImDrawFlags flags = 0);
1193b4be Poul Sander 2025-02-03 21:28 3274
1193b4be Poul Sander 2025-02-03 21:28 3275
    // Advanced: Draw Callbacks
1193b4be Poul Sander 2025-02-03 21:28 3276
    // - May be used to alter render state (change sampler, blending, current shader). May be used to emit custom rendering commands (difficult to do correctly, but possible).
1193b4be Poul Sander 2025-02-03 21:28 3277
    // - Use special ImDrawCallback_ResetRenderState callback to instruct backend to reset its render state to the default.
1193b4be Poul Sander 2025-02-03 21:28 3278
    // - Your rendering loop must check for 'UserCallback' in ImDrawCmd and call the function instead of rendering triangles. All standard backends are honoring this.
1193b4be Poul Sander 2025-02-03 21:28 3279
    // - For some backends, the callback may access selected render-states exposed by the backend in a ImGui_ImplXXXX_RenderState structure pointed to by platform_io.Renderer_RenderState.
1193b4be Poul Sander 2025-02-03 21:28 3280
    // - IMPORTANT: please be mindful of the different level of indirection between using size==0 (copying argument) and using size>0 (copying pointed data into a buffer).
1193b4be Poul Sander 2025-02-03 21:28 3281
    //   - If userdata_size == 0: we copy/store the 'userdata' argument as-is. It will be available unmodified in ImDrawCmd::UserCallbackData during render.
1193b4be Poul Sander 2025-02-03 21:28 3282
    //   - If userdata_size > 0,  we copy/store 'userdata_size' bytes pointed to by 'userdata'. We store them in a buffer stored inside the drawlist. ImDrawCmd::UserCallbackData will point inside that buffer so you have to retrieve data from there. Your callback may need to use ImDrawCmd::UserCallbackDataSize if you expect dynamically-sized data.
1193b4be Poul Sander 2025-02-03 21:28 3283
    //   - Support for userdata_size > 0 was added in v1.91.4, October 2024. So earlier code always only allowed to copy/store a simple void*.
1193b4be Poul Sander 2025-02-03 21:28 3284
    IMGUI_API void  AddCallback(ImDrawCallback callback, void* userdata, size_t userdata_size = 0);
1193b4be Poul Sander 2025-02-03 21:28 3285
1193b4be Poul Sander 2025-02-03 21:28 3286
    // Advanced: Miscellaneous
1193b4be Poul Sander 2025-02-03 21:28 3287
    IMGUI_API void  AddDrawCmd();                                               // This is useful if you need to forcefully create a new draw call (to allow for dependent rendering / blending). Otherwise primitives are merged into the same draw-call as much as possible
1193b4be Poul Sander 2025-02-03 21:28 3288
    IMGUI_API ImDrawList* CloneOutput() const;                                  // Create a clone of the CmdBuffer/IdxBuffer/VtxBuffer.
1193b4be Poul Sander 2025-02-03 21:28 3289
1193b4be Poul Sander 2025-02-03 21:28 3290
    // Advanced: Channels
1193b4be Poul Sander 2025-02-03 21:28 3291
    // - Use to split render into layers. By switching channels to can render out-of-order (e.g. submit FG primitives before BG primitives)
1193b4be Poul Sander 2025-02-03 21:28 3292
    // - Use to minimize draw calls (e.g. if going back-and-forth between multiple clipping rectangles, prefer to append into separate channels then merge at the end)
1193b4be Poul Sander 2025-02-03 21:28 3293
    // - This API shouldn't have been in ImDrawList in the first place!
1193b4be Poul Sander 2025-02-03 21:28 3294
    //   Prefer using your own persistent instance of ImDrawListSplitter as you can stack them.
1193b4be Poul Sander 2025-02-03 21:28 3295
    //   Using the ImDrawList::ChannelsXXXX you cannot stack a split over another.
1193b4be Poul Sander 2025-02-03 21:28 3296
    inline void     ChannelsSplit(int count)    { _Splitter.Split(this, count); }
1193b4be Poul Sander 2025-02-03 21:28 3297
    inline void     ChannelsMerge()             { _Splitter.Merge(this); }
1193b4be Poul Sander 2025-02-03 21:28 3298
    inline void     ChannelsSetCurrent(int n)   { _Splitter.SetCurrentChannel(this, n); }
1193b4be Poul Sander 2025-02-03 21:28 3299
1193b4be Poul Sander 2025-02-03 21:28 3300
    // Advanced: Primitives allocations
1193b4be Poul Sander 2025-02-03 21:28 3301
    // - We render triangles (three vertices)
1193b4be Poul Sander 2025-02-03 21:28 3302
    // - All primitives needs to be reserved via PrimReserve() beforehand.
1193b4be Poul Sander 2025-02-03 21:28 3303
    IMGUI_API void  PrimReserve(int idx_count, int vtx_count);
1193b4be Poul Sander 2025-02-03 21:28 3304
    IMGUI_API void  PrimUnreserve(int idx_count, int vtx_count);
1193b4be Poul Sander 2025-02-03 21:28 3305
    IMGUI_API void  PrimRect(const ImVec2& a, const ImVec2& b, ImU32 col);      // Axis aligned rectangle (composed of two triangles)
1193b4be Poul Sander 2025-02-03 21:28 3306
    IMGUI_API void  PrimRectUV(const ImVec2& a, const ImVec2& b, const ImVec2& uv_a, const ImVec2& uv_b, ImU32 col);
1193b4be Poul Sander 2025-02-03 21:28 3307
    IMGUI_API void  PrimQuadUV(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& d, const ImVec2& uv_a, const ImVec2& uv_b, const ImVec2& uv_c, const ImVec2& uv_d, ImU32 col);
1193b4be Poul Sander 2025-02-03 21:28 3308
    inline    void  PrimWriteVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col)    { _VtxWritePtr->pos = pos; _VtxWritePtr->uv = uv; _VtxWritePtr->col = col; _VtxWritePtr++; _VtxCurrentIdx++; }
1193b4be Poul Sander 2025-02-03 21:28 3309
    inline    void  PrimWriteIdx(ImDrawIdx idx)                                     { *_IdxWritePtr = idx; _IdxWritePtr++; }
1193b4be Poul Sander 2025-02-03 21:28 3310
    inline    void  PrimVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col)         { PrimWriteIdx((ImDrawIdx)_VtxCurrentIdx); PrimWriteVtx(pos, uv, col); } // Write vertex with unique index
1193b4be Poul Sander 2025-02-03 21:28 3311
1193b4be Poul Sander 2025-02-03 21:28 3312
    // Obsolete names
1193b4be Poul Sander 2025-02-03 21:28 3313
    //inline  void  AddEllipse(const ImVec2& center, float radius_x, float radius_y, ImU32 col, float rot = 0.0f, int num_segments = 0, float thickness = 1.0f) { AddEllipse(center, ImVec2(radius_x, radius_y), col, rot, num_segments, thickness); } // OBSOLETED in 1.90.5 (Mar 2024)
1193b4be Poul Sander 2025-02-03 21:28 3314
    //inline  void  AddEllipseFilled(const ImVec2& center, float radius_x, float radius_y, ImU32 col, float rot = 0.0f, int num_segments = 0) { AddEllipseFilled(center, ImVec2(radius_x, radius_y), col, rot, num_segments); }                        // OBSOLETED in 1.90.5 (Mar 2024)
1193b4be Poul Sander 2025-02-03 21:28 3315
    //inline  void  PathEllipticalArcTo(const ImVec2& center, float radius_x, float radius_y, float rot, float a_min, float a_max, int num_segments = 0) { PathEllipticalArcTo(center, ImVec2(radius_x, radius_y), rot, a_min, a_max, num_segments); } // OBSOLETED in 1.90.5 (Mar 2024)
1193b4be Poul Sander 2025-02-03 21:28 3316
    //inline  void  AddBezierCurve(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness, int num_segments = 0) { AddBezierCubic(p1, p2, p3, p4, col, thickness, num_segments); }                         // OBSOLETED in 1.80 (Jan 2021)
1193b4be Poul Sander 2025-02-03 21:28 3317
    //inline  void  PathBezierCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments = 0) { PathBezierCubicCurveTo(p2, p3, p4, num_segments); }                                                                                // OBSOLETED in 1.80 (Jan 2021)
1193b4be Poul Sander 2025-02-03 21:28 3318
1193b4be Poul Sander 2025-02-03 21:28 3319
    // [Internal helpers]
1193b4be Poul Sander 2025-02-03 21:28 3320
    IMGUI_API void  _ResetForNewFrame();
1193b4be Poul Sander 2025-02-03 21:28 3321
    IMGUI_API void  _ClearFreeMemory();
1193b4be Poul Sander 2025-02-03 21:28 3322
    IMGUI_API void  _PopUnusedDrawCmd();
1193b4be Poul Sander 2025-02-03 21:28 3323
    IMGUI_API void  _TryMergeDrawCmds();
1193b4be Poul Sander 2025-02-03 21:28 3324
    IMGUI_API void  _OnChangedClipRect();
1193b4be Poul Sander 2025-02-03 21:28 3325
    IMGUI_API void  _OnChangedTextureID();
1193b4be Poul Sander 2025-02-03 21:28 3326
    IMGUI_API void  _OnChangedVtxOffset();
1193b4be Poul Sander 2025-02-03 21:28 3327
    IMGUI_API void  _SetTextureID(ImTextureID texture_id);
1193b4be Poul Sander 2025-02-03 21:28 3328
    IMGUI_API int   _CalcCircleAutoSegmentCount(float radius) const;
1193b4be Poul Sander 2025-02-03 21:28 3329
    IMGUI_API void  _PathArcToFastEx(const ImVec2& center, float radius, int a_min_sample, int a_max_sample, int a_step);
1193b4be Poul Sander 2025-02-03 21:28 3330
    IMGUI_API void  _PathArcToN(const ImVec2& center, float radius, float a_min, float a_max, int num_segments);
1193b4be Poul Sander 2025-02-03 21:28 3331
};
1193b4be Poul Sander 2025-02-03 21:28 3332
1193b4be Poul Sander 2025-02-03 21:28 3333
// All draw data to render a Dear ImGui frame
1193b4be Poul Sander 2025-02-03 21:28 3334
// (NB: the style and the naming convention here is a little inconsistent, we currently preserve them for backward compatibility purpose,
1193b4be Poul Sander 2025-02-03 21:28 3335
// as this is one of the oldest structure exposed by the library! Basically, ImDrawList == CmdList)
1193b4be Poul Sander 2025-02-03 21:28 3336
struct ImDrawData
1193b4be Poul Sander 2025-02-03 21:28 3337
{
1193b4be Poul Sander 2025-02-03 21:28 3338
    bool                Valid;              // Only valid after Render() is called and before the next NewFrame() is called.
1193b4be Poul Sander 2025-02-03 21:28 3339
    int                 CmdListsCount;      // Number of ImDrawList* to render
1193b4be Poul Sander 2025-02-03 21:28 3340
    int                 TotalIdxCount;      // For convenience, sum of all ImDrawList's IdxBuffer.Size
1193b4be Poul Sander 2025-02-03 21:28 3341
    int                 TotalVtxCount;      // For convenience, sum of all ImDrawList's VtxBuffer.Size
1193b4be Poul Sander 2025-02-03 21:28 3342
    ImVector<ImDrawList*> CmdLists;         // Array of ImDrawList* to render. The ImDrawLists are owned by ImGuiContext and only pointed to from here.
1193b4be Poul Sander 2025-02-03 21:28 3343
    ImVec2              DisplayPos;         // Top-left position of the viewport to render (== top-left of the orthogonal projection matrix to use) (== GetMainViewport()->Pos for the main viewport, == (0.0) in most single-viewport applications)
1193b4be Poul Sander 2025-02-03 21:28 3344
    ImVec2              DisplaySize;        // Size of the viewport to render (== GetMainViewport()->Size for the main viewport, == io.DisplaySize in most single-viewport applications)
1193b4be Poul Sander 2025-02-03 21:28 3345
    ImVec2              FramebufferScale;   // Amount of pixels for each unit of DisplaySize. Based on io.DisplayFramebufferScale. Generally (1,1) on normal display, (2,2) on OSX with Retina display.
1193b4be Poul Sander 2025-02-03 21:28 3346
    ImGuiViewport*      OwnerViewport;      // Viewport carrying the ImDrawData instance, might be of use to the renderer (generally not).
1193b4be Poul Sander 2025-02-03 21:28 3347
1193b4be Poul Sander 2025-02-03 21:28 3348
    // Functions
1193b4be Poul Sander 2025-02-03 21:28 3349
    ImDrawData()    { Clear(); }
1193b4be Poul Sander 2025-02-03 21:28 3350
    IMGUI_API void  Clear();
1193b4be Poul Sander 2025-02-03 21:28 3351
    IMGUI_API void  AddDrawList(ImDrawList* draw_list);     // Helper to add an external draw list into an existing ImDrawData.
1193b4be Poul Sander 2025-02-03 21:28 3352
    IMGUI_API void  DeIndexAllBuffers();                    // Helper to convert all buffers from indexed to non-indexed, in case you cannot render indexed. Note: this is slow and most likely a waste of resources. Always prefer indexed rendering!
1193b4be Poul Sander 2025-02-03 21:28 3353
    IMGUI_API void  ScaleClipRects(const ImVec2& fb_scale); // Helper to scale the ClipRect field of each ImDrawCmd. Use if your final output buffer is at a different scale than Dear ImGui expects, or if there is a difference between your window resolution and framebuffer resolution.
1193b4be Poul Sander 2025-02-03 21:28 3354
};
1193b4be Poul Sander 2025-02-03 21:28 3355
1193b4be Poul Sander 2025-02-03 21:28 3356
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3357
// [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontAtlasFlags, ImFontAtlas, ImFontGlyphRangesBuilder, ImFont)
1193b4be Poul Sander 2025-02-03 21:28 3358
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3359
1193b4be Poul Sander 2025-02-03 21:28 3360
struct ImFontConfig
1193b4be Poul Sander 2025-02-03 21:28 3361
{
1193b4be Poul Sander 2025-02-03 21:28 3362
    void*           FontData;               //          // TTF/OTF data
1193b4be Poul Sander 2025-02-03 21:28 3363
    int             FontDataSize;           //          // TTF/OTF data size
1193b4be Poul Sander 2025-02-03 21:28 3364
    bool            FontDataOwnedByAtlas;   // true     // TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
1193b4be Poul Sander 2025-02-03 21:28 3365
    int             FontNo;                 // 0        // Index of font within TTF/OTF file
1193b4be Poul Sander 2025-02-03 21:28 3366
    float           SizePixels;             //          // Size in pixels for rasterizer (more or less maps to the resulting font height).
1193b4be Poul Sander 2025-02-03 21:28 3367
    int             OversampleH;            // 2        // Rasterize at higher quality for sub-pixel positioning. Note the difference between 2 and 3 is minimal. You can reduce this to 1 for large glyphs save memory. Read https://github.com/nothings/stb/blob/master/tests/oversample/README.md for details.
1193b4be Poul Sander 2025-02-03 21:28 3368
    int             OversampleV;            // 1        // Rasterize at higher quality for sub-pixel positioning. This is not really useful as we don't use sub-pixel positions on the Y axis.
1193b4be Poul Sander 2025-02-03 21:28 3369
    bool            PixelSnapH;             // false    // Align every glyph to pixel boundary. Useful e.g. if you are merging a non-pixel aligned font with the default font. If enabled, you can set OversampleH/V to 1.
1193b4be Poul Sander 2025-02-03 21:28 3370
    ImVec2          GlyphExtraSpacing;      // 0, 0     // Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
1193b4be Poul Sander 2025-02-03 21:28 3371
    ImVec2          GlyphOffset;            // 0, 0     // Offset all glyphs from this font input.
1193b4be Poul Sander 2025-02-03 21:28 3372
    const ImWchar*  GlyphRanges;            // NULL     // THE ARRAY DATA NEEDS TO PERSIST AS LONG AS THE FONT IS ALIVE. Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list).
1193b4be Poul Sander 2025-02-03 21:28 3373
    float           GlyphMinAdvanceX;       // 0        // Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
1193b4be Poul Sander 2025-02-03 21:28 3374
    float           GlyphMaxAdvanceX;       // FLT_MAX  // Maximum AdvanceX for glyphs
1193b4be Poul Sander 2025-02-03 21:28 3375
    bool            MergeMode;              // false    // Merge into previous ImFont, so you can combine multiple inputs font into one ImFont (e.g. ASCII font + icons + Japanese glyphs). You may want to use GlyphOffset.y when merge font of different heights.
1193b4be Poul Sander 2025-02-03 21:28 3376
    unsigned int    FontBuilderFlags;       // 0        // Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure.
1193b4be Poul Sander 2025-02-03 21:28 3377
    float           RasterizerMultiply;     // 1.0f     // Linearly brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. This is a silly thing we may remove in the future.
1193b4be Poul Sander 2025-02-03 21:28 3378
    float           RasterizerDensity;      // 1.0f     // DPI scale for rasterization, not altering other font metrics: make it easy to swap between e.g. a 100% and a 400% fonts for a zooming display. IMPORTANT: If you increase this it is expected that you increase font scale accordingly, otherwise quality may look lowered.
1193b4be Poul Sander 2025-02-03 21:28 3379
    ImWchar         EllipsisChar;           // -1       // Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.
1193b4be Poul Sander 2025-02-03 21:28 3380
1193b4be Poul Sander 2025-02-03 21:28 3381
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 3382
    char            Name[40];               // Name (strictly to ease debugging)
1193b4be Poul Sander 2025-02-03 21:28 3383
    ImFont*         DstFont;
1193b4be Poul Sander 2025-02-03 21:28 3384
1193b4be Poul Sander 2025-02-03 21:28 3385
    IMGUI_API ImFontConfig();
1193b4be Poul Sander 2025-02-03 21:28 3386
};
1193b4be Poul Sander 2025-02-03 21:28 3387
1193b4be Poul Sander 2025-02-03 21:28 3388
// Hold rendering data for one glyph.
1193b4be Poul Sander 2025-02-03 21:28 3389
// (Note: some language parsers may fail to convert the 31+1 bitfield members, in this case maybe drop store a single u32 or we can rework this)
1193b4be Poul Sander 2025-02-03 21:28 3390
struct ImFontGlyph
1193b4be Poul Sander 2025-02-03 21:28 3391
{
1193b4be Poul Sander 2025-02-03 21:28 3392
    unsigned int    Colored : 1;        // Flag to indicate glyph is colored and should generally ignore tinting (make it usable with no shift on little-endian as this is used in loops)
1193b4be Poul Sander 2025-02-03 21:28 3393
    unsigned int    Visible : 1;        // Flag to indicate glyph has no visible pixels (e.g. space). Allow early out when rendering.
1193b4be Poul Sander 2025-02-03 21:28 3394
    unsigned int    Codepoint : 30;     // 0x0000..0x10FFFF
1193b4be Poul Sander 2025-02-03 21:28 3395
    float           AdvanceX;           // Distance to next character (= data from font + ImFontConfig::GlyphExtraSpacing.x baked in)
1193b4be Poul Sander 2025-02-03 21:28 3396
    float           X0, Y0, X1, Y1;     // Glyph corners
1193b4be Poul Sander 2025-02-03 21:28 3397
    float           U0, V0, U1, V1;     // Texture coordinates
1193b4be Poul Sander 2025-02-03 21:28 3398
};
1193b4be Poul Sander 2025-02-03 21:28 3399
1193b4be Poul Sander 2025-02-03 21:28 3400
// Helper to build glyph ranges from text/string data. Feed your application strings/characters to it then call BuildRanges().
1193b4be Poul Sander 2025-02-03 21:28 3401
// This is essentially a tightly packed of vector of 64k booleans = 8KB storage.
1193b4be Poul Sander 2025-02-03 21:28 3402
struct ImFontGlyphRangesBuilder
1193b4be Poul Sander 2025-02-03 21:28 3403
{
1193b4be Poul Sander 2025-02-03 21:28 3404
    ImVector<ImU32> UsedChars;            // Store 1-bit per Unicode code point (0=unused, 1=used)
1193b4be Poul Sander 2025-02-03 21:28 3405
1193b4be Poul Sander 2025-02-03 21:28 3406
    ImFontGlyphRangesBuilder()              { Clear(); }
1193b4be Poul Sander 2025-02-03 21:28 3407
    inline void     Clear()                 { int size_in_bytes = (IM_UNICODE_CODEPOINT_MAX + 1) / 8; UsedChars.resize(size_in_bytes / (int)sizeof(ImU32)); memset(UsedChars.Data, 0, (size_t)size_in_bytes); }
1193b4be Poul Sander 2025-02-03 21:28 3408
    inline bool     GetBit(size_t n) const  { int off = (int)(n >> 5); ImU32 mask = 1u << (n & 31); return (UsedChars[off] & mask) != 0; }  // Get bit n in the array
1193b4be Poul Sander 2025-02-03 21:28 3409
    inline void     SetBit(size_t n)        { int off = (int)(n >> 5); ImU32 mask = 1u << (n & 31); UsedChars[off] |= mask; }               // Set bit n in the array
1193b4be Poul Sander 2025-02-03 21:28 3410
    inline void     AddChar(ImWchar c)      { SetBit(c); }                      // Add character
1193b4be Poul Sander 2025-02-03 21:28 3411
    IMGUI_API void  AddText(const char* text, const char* text_end = NULL);     // Add string (each character of the UTF-8 string are added)
1193b4be Poul Sander 2025-02-03 21:28 3412
    IMGUI_API void  AddRanges(const ImWchar* ranges);                           // Add ranges, e.g. builder.AddRanges(ImFontAtlas::GetGlyphRangesDefault()) to force add all of ASCII/Latin+Ext
1193b4be Poul Sander 2025-02-03 21:28 3413
    IMGUI_API void  BuildRanges(ImVector<ImWchar>* out_ranges);                 // Output new ranges
1193b4be Poul Sander 2025-02-03 21:28 3414
};
1193b4be Poul Sander 2025-02-03 21:28 3415
1193b4be Poul Sander 2025-02-03 21:28 3416
// See ImFontAtlas::AddCustomRectXXX functions.
1193b4be Poul Sander 2025-02-03 21:28 3417
struct ImFontAtlasCustomRect
1193b4be Poul Sander 2025-02-03 21:28 3418
{
1193b4be Poul Sander 2025-02-03 21:28 3419
    unsigned short  Width, Height;  // Input    // Desired rectangle dimension
1193b4be Poul Sander 2025-02-03 21:28 3420
    unsigned short  X, Y;           // Output   // Packed position in Atlas
1193b4be Poul Sander 2025-02-03 21:28 3421
    unsigned int    GlyphID;        // Input    // For custom font glyphs only (ID < 0x110000)
1193b4be Poul Sander 2025-02-03 21:28 3422
    float           GlyphAdvanceX;  // Input    // For custom font glyphs only: glyph xadvance
1193b4be Poul Sander 2025-02-03 21:28 3423
    ImVec2          GlyphOffset;    // Input    // For custom font glyphs only: glyph display offset
1193b4be Poul Sander 2025-02-03 21:28 3424
    ImFont*         Font;           // Input    // For custom font glyphs only: target font
1193b4be Poul Sander 2025-02-03 21:28 3425
    ImFontAtlasCustomRect()         { Width = Height = 0; X = Y = 0xFFFF; GlyphID = 0; GlyphAdvanceX = 0.0f; GlyphOffset = ImVec2(0, 0); Font = NULL; }
1193b4be Poul Sander 2025-02-03 21:28 3426
    bool IsPacked() const           { return X != 0xFFFF; }
1193b4be Poul Sander 2025-02-03 21:28 3427
};
1193b4be Poul Sander 2025-02-03 21:28 3428
1193b4be Poul Sander 2025-02-03 21:28 3429
// Flags for ImFontAtlas build
1193b4be Poul Sander 2025-02-03 21:28 3430
enum ImFontAtlasFlags_
1193b4be Poul Sander 2025-02-03 21:28 3431
{
1193b4be Poul Sander 2025-02-03 21:28 3432
    ImFontAtlasFlags_None               = 0,
1193b4be Poul Sander 2025-02-03 21:28 3433
    ImFontAtlasFlags_NoPowerOfTwoHeight = 1 << 0,   // Don't round the height to next power of two
1193b4be Poul Sander 2025-02-03 21:28 3434
    ImFontAtlasFlags_NoMouseCursors     = 1 << 1,   // Don't build software mouse cursors into the atlas (save a little texture memory)
1193b4be Poul Sander 2025-02-03 21:28 3435
    ImFontAtlasFlags_NoBakedLines       = 1 << 2,   // Don't build thick line textures into the atlas (save a little texture memory, allow support for point/nearest filtering). The AntiAliasedLinesUseTex features uses them, otherwise they will be rendered using polygons (more expensive for CPU/GPU).
1193b4be Poul Sander 2025-02-03 21:28 3436
};
1193b4be Poul Sander 2025-02-03 21:28 3437
1193b4be Poul Sander 2025-02-03 21:28 3438
// Load and rasterize multiple TTF/OTF fonts into a same texture. The font atlas will build a single texture holding:
1193b4be Poul Sander 2025-02-03 21:28 3439
//  - One or more fonts.
1193b4be Poul Sander 2025-02-03 21:28 3440
//  - Custom graphics data needed to render the shapes needed by Dear ImGui.
1193b4be Poul Sander 2025-02-03 21:28 3441
//  - Mouse cursor shapes for software cursor rendering (unless setting 'Flags |= ImFontAtlasFlags_NoMouseCursors' in the font atlas).
1193b4be Poul Sander 2025-02-03 21:28 3442
// It is the user-code responsibility to setup/build the atlas, then upload the pixel data into a texture accessible by your graphics api.
1193b4be Poul Sander 2025-02-03 21:28 3443
//  - Optionally, call any of the AddFont*** functions. If you don't call any, the default font embedded in the code will be loaded for you.
1193b4be Poul Sander 2025-02-03 21:28 3444
//  - Call GetTexDataAsAlpha8() or GetTexDataAsRGBA32() to build and retrieve pixels data.
1193b4be Poul Sander 2025-02-03 21:28 3445
//  - Upload the pixels data into a texture within your graphics system (see imgui_impl_xxxx.cpp examples)
1193b4be Poul Sander 2025-02-03 21:28 3446
//  - Call SetTexID(my_tex_id); and pass the pointer/identifier to your texture in a format natural to your graphics API.
1193b4be Poul Sander 2025-02-03 21:28 3447
//    This value will be passed back to you during rendering to identify the texture. Read FAQ entry about ImTextureID for more details.
1193b4be Poul Sander 2025-02-03 21:28 3448
// Common pitfalls:
1193b4be Poul Sander 2025-02-03 21:28 3449
// - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the
1193b4be Poul Sander 2025-02-03 21:28 3450
//   atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data.
1193b4be Poul Sander 2025-02-03 21:28 3451
// - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction.
1193b4be Poul Sander 2025-02-03 21:28 3452
//   You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
1193b4be Poul Sander 2025-02-03 21:28 3453
// - Even though many functions are suffixed with "TTF", OTF data is supported just as well.
1193b4be Poul Sander 2025-02-03 21:28 3454
// - This is an old API and it is currently awkward for those and various other reasons! We will address them in the future!
1193b4be Poul Sander 2025-02-03 21:28 3455
struct ImFontAtlas
1193b4be Poul Sander 2025-02-03 21:28 3456
{
1193b4be Poul Sander 2025-02-03 21:28 3457
    IMGUI_API ImFontAtlas();
1193b4be Poul Sander 2025-02-03 21:28 3458
    IMGUI_API ~ImFontAtlas();
1193b4be Poul Sander 2025-02-03 21:28 3459
    IMGUI_API ImFont*           AddFont(const ImFontConfig* font_cfg);
1193b4be Poul Sander 2025-02-03 21:28 3460
    IMGUI_API ImFont*           AddFontDefault(const ImFontConfig* font_cfg = NULL);
1193b4be Poul Sander 2025-02-03 21:28 3461
    IMGUI_API ImFont*           AddFontFromFileTTF(const char* filename, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL);
1193b4be Poul Sander 2025-02-03 21:28 3462
    IMGUI_API ImFont*           AddFontFromMemoryTTF(void* font_data, int font_data_size, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL); // Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
1193b4be Poul Sander 2025-02-03 21:28 3463
    IMGUI_API ImFont*           AddFontFromMemoryCompressedTTF(const void* compressed_font_data, int compressed_font_data_size, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL); // 'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp.
1193b4be Poul Sander 2025-02-03 21:28 3464
    IMGUI_API ImFont*           AddFontFromMemoryCompressedBase85TTF(const char* compressed_font_data_base85, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL);              // 'compressed_font_data_base85' still owned by caller. Compress with binary_to_compressed_c.cpp with -base85 parameter.
1193b4be Poul Sander 2025-02-03 21:28 3465
    IMGUI_API void              ClearInputData();           // Clear input data (all ImFontConfig structures including sizes, TTF data, glyph ranges, etc.) = all the data used to build the texture and fonts.
1193b4be Poul Sander 2025-02-03 21:28 3466
    IMGUI_API void              ClearTexData();             // Clear output texture data (CPU side). Saves RAM once the texture has been copied to graphics memory.
1193b4be Poul Sander 2025-02-03 21:28 3467
    IMGUI_API void              ClearFonts();               // Clear output font data (glyphs storage, UV coordinates).
1193b4be Poul Sander 2025-02-03 21:28 3468
    IMGUI_API void              Clear();                    // Clear all input and output.
1193b4be Poul Sander 2025-02-03 21:28 3469
1193b4be Poul Sander 2025-02-03 21:28 3470
    // Build atlas, retrieve pixel data.
1193b4be Poul Sander 2025-02-03 21:28 3471
    // User is in charge of copying the pixels into graphics memory (e.g. create a texture with your engine). Then store your texture handle with SetTexID().
1193b4be Poul Sander 2025-02-03 21:28 3472
    // The pitch is always = Width * BytesPerPixels (1 or 4)
1193b4be Poul Sander 2025-02-03 21:28 3473
    // Building in RGBA32 format is provided for convenience and compatibility, but note that unless you manually manipulate or copy color data into
1193b4be Poul Sander 2025-02-03 21:28 3474
    // the texture (e.g. when using the AddCustomRect*** api), then the RGB pixels emitted will always be white (~75% of memory/bandwidth waste.
1193b4be Poul Sander 2025-02-03 21:28 3475
    IMGUI_API bool              Build();                    // Build pixels data. This is called automatically for you by the GetTexData*** functions.
1193b4be Poul Sander 2025-02-03 21:28 3476
    IMGUI_API void              GetTexDataAsAlpha8(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL);  // 1 byte per-pixel
1193b4be Poul Sander 2025-02-03 21:28 3477
    IMGUI_API void              GetTexDataAsRGBA32(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL);  // 4 bytes-per-pixel
1193b4be Poul Sander 2025-02-03 21:28 3478
    bool                        IsBuilt() const             { return Fonts.Size > 0 && TexReady; } // Bit ambiguous: used to detect when user didn't build texture but effectively we should check TexID != 0 except that would be backend dependent...
1193b4be Poul Sander 2025-02-03 21:28 3479
    void                        SetTexID(ImTextureID id)    { TexID = id; }
1193b4be Poul Sander 2025-02-03 21:28 3480
1193b4be Poul Sander 2025-02-03 21:28 3481
    //-------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3482
    // Glyph Ranges
1193b4be Poul Sander 2025-02-03 21:28 3483
    //-------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3484
1193b4be Poul Sander 2025-02-03 21:28 3485
    // Helpers to retrieve list of common Unicode ranges (2 value per range, values are inclusive, zero-terminated list)
1193b4be Poul Sander 2025-02-03 21:28 3486
    // NB: Make sure that your string are UTF-8 and NOT in your local code page.
1193b4be Poul Sander 2025-02-03 21:28 3487
    // Read https://github.com/ocornut/imgui/blob/master/docs/FONTS.md/#about-utf-8-encoding for details.
1193b4be Poul Sander 2025-02-03 21:28 3488
    // NB: Consider using ImFontGlyphRangesBuilder to build glyph ranges from textual data.
1193b4be Poul Sander 2025-02-03 21:28 3489
    IMGUI_API const ImWchar*    GetGlyphRangesDefault();                // Basic Latin, Extended Latin
1193b4be Poul Sander 2025-02-03 21:28 3490
    IMGUI_API const ImWchar*    GetGlyphRangesGreek();                  // Default + Greek and Coptic
1193b4be Poul Sander 2025-02-03 21:28 3491
    IMGUI_API const ImWchar*    GetGlyphRangesKorean();                 // Default + Korean characters
1193b4be Poul Sander 2025-02-03 21:28 3492
    IMGUI_API const ImWchar*    GetGlyphRangesJapanese();               // Default + Hiragana, Katakana, Half-Width, Selection of 2999 Ideographs
1193b4be Poul Sander 2025-02-03 21:28 3493
    IMGUI_API const ImWchar*    GetGlyphRangesChineseFull();            // Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs
1193b4be Poul Sander 2025-02-03 21:28 3494
    IMGUI_API const ImWchar*    GetGlyphRangesChineseSimplifiedCommon();// Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese
1193b4be Poul Sander 2025-02-03 21:28 3495
    IMGUI_API const ImWchar*    GetGlyphRangesCyrillic();               // Default + about 400 Cyrillic characters
1193b4be Poul Sander 2025-02-03 21:28 3496
    IMGUI_API const ImWchar*    GetGlyphRangesThai();                   // Default + Thai characters
1193b4be Poul Sander 2025-02-03 21:28 3497
    IMGUI_API const ImWchar*    GetGlyphRangesVietnamese();             // Default + Vietnamese characters
1193b4be Poul Sander 2025-02-03 21:28 3498
1193b4be Poul Sander 2025-02-03 21:28 3499
    //-------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3500
    // [BETA] Custom Rectangles/Glyphs API
1193b4be Poul Sander 2025-02-03 21:28 3501
    //-------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3502
1193b4be Poul Sander 2025-02-03 21:28 3503
    // You can request arbitrary rectangles to be packed into the atlas, for your own purposes.
1193b4be Poul Sander 2025-02-03 21:28 3504
    // - After calling Build(), you can query the rectangle position and render your pixels.
1193b4be Poul Sander 2025-02-03 21:28 3505
    // - If you render colored output, set 'atlas->TexPixelsUseColors = true' as this may help some backends decide of preferred texture format.
1193b4be Poul Sander 2025-02-03 21:28 3506
    // - You can also request your rectangles to be mapped as font glyph (given a font + Unicode point),
1193b4be Poul Sander 2025-02-03 21:28 3507
    //   so you can render e.g. custom colorful icons and use them as regular glyphs.
1193b4be Poul Sander 2025-02-03 21:28 3508
    // - Read docs/FONTS.md for more details about using colorful icons.
1193b4be Poul Sander 2025-02-03 21:28 3509
    // - Note: this API may be redesigned later in order to support multi-monitor varying DPI settings.
1193b4be Poul Sander 2025-02-03 21:28 3510
    IMGUI_API int               AddCustomRectRegular(int width, int height);
1193b4be Poul Sander 2025-02-03 21:28 3511
    IMGUI_API int               AddCustomRectFontGlyph(ImFont* font, ImWchar id, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
1193b4be Poul Sander 2025-02-03 21:28 3512
    ImFontAtlasCustomRect*      GetCustomRectByIndex(int index) { IM_ASSERT(index >= 0); return &CustomRects[index]; }
1193b4be Poul Sander 2025-02-03 21:28 3513
1193b4be Poul Sander 2025-02-03 21:28 3514
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 3515
    IMGUI_API void              CalcCustomRectUV(const ImFontAtlasCustomRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const;
1193b4be Poul Sander 2025-02-03 21:28 3516
    IMGUI_API bool              GetMouseCursorTexData(ImGuiMouseCursor cursor, ImVec2* out_offset, ImVec2* out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2]);
1193b4be Poul Sander 2025-02-03 21:28 3517
1193b4be Poul Sander 2025-02-03 21:28 3518
    //-------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3519
    // Members
1193b4be Poul Sander 2025-02-03 21:28 3520
    //-------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3521
1193b4be Poul Sander 2025-02-03 21:28 3522
    ImFontAtlasFlags            Flags;              // Build flags (see ImFontAtlasFlags_)
1193b4be Poul Sander 2025-02-03 21:28 3523
    ImTextureID                 TexID;              // User data to refer to the texture once it has been uploaded to user's graphic systems. It is passed back to you during rendering via the ImDrawCmd structure.
1193b4be Poul Sander 2025-02-03 21:28 3524
    int                         TexDesiredWidth;    // Texture width desired by user before Build(). Must be a power-of-two. If have many glyphs your graphics API have texture size restrictions you may want to increase texture width to decrease height.
1193b4be Poul Sander 2025-02-03 21:28 3525
    int                         TexGlyphPadding;    // Padding between glyphs within texture in pixels. Defaults to 1. If your rendering method doesn't rely on bilinear filtering you may set this to 0 (will also need to set AntiAliasedLinesUseTex = false).
1193b4be Poul Sander 2025-02-03 21:28 3526
    bool                        Locked;             // Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.
1193b4be Poul Sander 2025-02-03 21:28 3527
    void*                       UserData;           // Store your own atlas related user-data (if e.g. you have multiple font atlas).
1193b4be Poul Sander 2025-02-03 21:28 3528
1193b4be Poul Sander 2025-02-03 21:28 3529
    // [Internal]
1193b4be Poul Sander 2025-02-03 21:28 3530
    // NB: Access texture data via GetTexData*() calls! Which will setup a default font for you.
1193b4be Poul Sander 2025-02-03 21:28 3531
    bool                        TexReady;           // Set when texture was built matching current font input
1193b4be Poul Sander 2025-02-03 21:28 3532
    bool                        TexPixelsUseColors; // Tell whether our texture data is known to use colors (rather than just alpha channel), in order to help backend select a format.
1193b4be Poul Sander 2025-02-03 21:28 3533
    unsigned char*              TexPixelsAlpha8;    // 1 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight
1193b4be Poul Sander 2025-02-03 21:28 3534
    unsigned int*               TexPixelsRGBA32;    // 4 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight * 4
1193b4be Poul Sander 2025-02-03 21:28 3535
    int                         TexWidth;           // Texture width calculated during Build().
1193b4be Poul Sander 2025-02-03 21:28 3536
    int                         TexHeight;          // Texture height calculated during Build().
1193b4be Poul Sander 2025-02-03 21:28 3537
    ImVec2                      TexUvScale;         // = (1.0f/TexWidth, 1.0f/TexHeight)
1193b4be Poul Sander 2025-02-03 21:28 3538
    ImVec2                      TexUvWhitePixel;    // Texture coordinates to a white pixel
1193b4be Poul Sander 2025-02-03 21:28 3539
    ImVector<ImFont*>           Fonts;              // Hold all the fonts returned by AddFont*. Fonts[0] is the default font upon calling ImGui::NewFrame(), use ImGui::PushFont()/PopFont() to change the current font.
1193b4be Poul Sander 2025-02-03 21:28 3540
    ImVector<ImFontAtlasCustomRect> CustomRects;    // Rectangles for packing custom texture data into the atlas.
1193b4be Poul Sander 2025-02-03 21:28 3541
    ImVector<ImFontConfig>      ConfigData;         // Configuration data
1193b4be Poul Sander 2025-02-03 21:28 3542
    ImVec4                      TexUvLines[IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 1];  // UVs for baked anti-aliased lines
1193b4be Poul Sander 2025-02-03 21:28 3543
1193b4be Poul Sander 2025-02-03 21:28 3544
    // [Internal] Font builder
1193b4be Poul Sander 2025-02-03 21:28 3545
    const ImFontBuilderIO*      FontBuilderIO;      // Opaque interface to a font builder (default to stb_truetype, can be changed to use FreeType by defining IMGUI_ENABLE_FREETYPE).
1193b4be Poul Sander 2025-02-03 21:28 3546
    unsigned int                FontBuilderFlags;   // Shared flags (for all fonts) for custom font builder. THIS IS BUILD IMPLEMENTATION DEPENDENT. Per-font override is also available in ImFontConfig.
1193b4be Poul Sander 2025-02-03 21:28 3547
1193b4be Poul Sander 2025-02-03 21:28 3548
    // [Internal] Packing data
1193b4be Poul Sander 2025-02-03 21:28 3549
    int                         PackIdMouseCursors; // Custom texture rectangle ID for white pixel and mouse cursors
1193b4be Poul Sander 2025-02-03 21:28 3550
    int                         PackIdLines;        // Custom texture rectangle ID for baked anti-aliased lines
1193b4be Poul Sander 2025-02-03 21:28 3551
1193b4be Poul Sander 2025-02-03 21:28 3552
    // [Obsolete]
1193b4be Poul Sander 2025-02-03 21:28 3553
    //typedef ImFontAtlasCustomRect    CustomRect;         // OBSOLETED in 1.72+
1193b4be Poul Sander 2025-02-03 21:28 3554
    //typedef ImFontGlyphRangesBuilder GlyphRangesBuilder; // OBSOLETED in 1.67+
1193b4be Poul Sander 2025-02-03 21:28 3555
};
1193b4be Poul Sander 2025-02-03 21:28 3556
1193b4be Poul Sander 2025-02-03 21:28 3557
// Font runtime data and rendering
1193b4be Poul Sander 2025-02-03 21:28 3558
// ImFontAtlas automatically loads a default embedded font for you when you call GetTexDataAsAlpha8() or GetTexDataAsRGBA32().
1193b4be Poul Sander 2025-02-03 21:28 3559
struct ImFont
1193b4be Poul Sander 2025-02-03 21:28 3560
{
1193b4be Poul Sander 2025-02-03 21:28 3561
    // Members: Hot ~20/24 bytes (for CalcTextSize)
1193b4be Poul Sander 2025-02-03 21:28 3562
    ImVector<float>             IndexAdvanceX;      // 12-16 // out //            // Sparse. Glyphs->AdvanceX in a directly indexable way (cache-friendly for CalcTextSize functions which only this info, and are often bottleneck in large UI).
1193b4be Poul Sander 2025-02-03 21:28 3563
    float                       FallbackAdvanceX;   // 4     // out // = FallbackGlyph->AdvanceX
1193b4be Poul Sander 2025-02-03 21:28 3564
    float                       FontSize;           // 4     // in  //            // Height of characters/line, set during loading (don't change after loading)
1193b4be Poul Sander 2025-02-03 21:28 3565
1193b4be Poul Sander 2025-02-03 21:28 3566
    // Members: Hot ~28/40 bytes (for CalcTextSize + render loop)
1193b4be Poul Sander 2025-02-03 21:28 3567
    ImVector<ImWchar>           IndexLookup;        // 12-16 // out //            // Sparse. Index glyphs by Unicode code-point.
1193b4be Poul Sander 2025-02-03 21:28 3568
    ImVector<ImFontGlyph>       Glyphs;             // 12-16 // out //            // All glyphs.
1193b4be Poul Sander 2025-02-03 21:28 3569
    const ImFontGlyph*          FallbackGlyph;      // 4-8   // out // = FindGlyph(FontFallbackChar)
1193b4be Poul Sander 2025-02-03 21:28 3570
1193b4be Poul Sander 2025-02-03 21:28 3571
    // Members: Cold ~32/40 bytes
1193b4be Poul Sander 2025-02-03 21:28 3572
    ImFontAtlas*                ContainerAtlas;     // 4-8   // out //            // What we has been loaded into
1193b4be Poul Sander 2025-02-03 21:28 3573
    const ImFontConfig*         ConfigData;         // 4-8   // in  //            // Pointer within ContainerAtlas->ConfigData
1193b4be Poul Sander 2025-02-03 21:28 3574
    short                       ConfigDataCount;    // 2     // in  // ~ 1        // Number of ImFontConfig involved in creating this font. Bigger than 1 when merging multiple font sources into one ImFont.
1193b4be Poul Sander 2025-02-03 21:28 3575
    ImWchar                     FallbackChar;       // 2     // out // = FFFD/'?' // Character used if a glyph isn't found.
1193b4be Poul Sander 2025-02-03 21:28 3576
    ImWchar                     EllipsisChar;       // 2     // out // = '...'/'.'// Character used for ellipsis rendering.
1193b4be Poul Sander 2025-02-03 21:28 3577
    short                       EllipsisCharCount;  // 1     // out // 1 or 3
1193b4be Poul Sander 2025-02-03 21:28 3578
    float                       EllipsisWidth;      // 4     // out               // Width
1193b4be Poul Sander 2025-02-03 21:28 3579
    float                       EllipsisCharStep;   // 4     // out               // Step between characters when EllipsisCount > 0
1193b4be Poul Sander 2025-02-03 21:28 3580
    bool                        DirtyLookupTables;  // 1     // out //
1193b4be Poul Sander 2025-02-03 21:28 3581
    float                       Scale;              // 4     // in  // = 1.f      // Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()
1193b4be Poul Sander 2025-02-03 21:28 3582
    float                       Ascent, Descent;    // 4+4   // out //            // Ascent: distance from top to bottom of e.g. 'A' [0..FontSize] (unscaled)
1193b4be Poul Sander 2025-02-03 21:28 3583
    int                         MetricsTotalSurface;// 4     // out //            // Total surface in pixels to get an idea of the font rasterization/texture cost (not exact, we approximate the cost of padding between glyphs)
1193b4be Poul Sander 2025-02-03 21:28 3584
    ImU8                        Used4kPagesMap[(IM_UNICODE_CODEPOINT_MAX+1)/4096/8]; // 2 bytes if ImWchar=ImWchar16, 34 bytes if ImWchar==ImWchar32. Store 1-bit for each block of 4K codepoints that has one active glyph. This is mainly used to facilitate iterations across all used codepoints.
1193b4be Poul Sander 2025-02-03 21:28 3585
1193b4be Poul Sander 2025-02-03 21:28 3586
    // Methods
1193b4be Poul Sander 2025-02-03 21:28 3587
    IMGUI_API ImFont();
1193b4be Poul Sander 2025-02-03 21:28 3588
    IMGUI_API ~ImFont();
1193b4be Poul Sander 2025-02-03 21:28 3589
    IMGUI_API const ImFontGlyph*FindGlyph(ImWchar c) const;
1193b4be Poul Sander 2025-02-03 21:28 3590
    IMGUI_API const ImFontGlyph*FindGlyphNoFallback(ImWchar c) const;
1193b4be Poul Sander 2025-02-03 21:28 3591
    float                       GetCharAdvance(ImWchar c) const     { return ((int)c < IndexAdvanceX.Size) ? IndexAdvanceX[(int)c] : FallbackAdvanceX; }
1193b4be Poul Sander 2025-02-03 21:28 3592
    bool                        IsLoaded() const                    { return ContainerAtlas != NULL; }
1193b4be Poul Sander 2025-02-03 21:28 3593
    const char*                 GetDebugName() const                { return ConfigData ? ConfigData->Name : "<unknown>"; }
1193b4be Poul Sander 2025-02-03 21:28 3594
1193b4be Poul Sander 2025-02-03 21:28 3595
    // 'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable.
1193b4be Poul Sander 2025-02-03 21:28 3596
    // 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable.
1193b4be Poul Sander 2025-02-03 21:28 3597
    IMGUI_API ImVec2            CalcTextSizeA(float size, float max_width, float wrap_width, const char* text_begin, const char* text_end = NULL, const char** remaining = NULL) const; // utf8
1193b4be Poul Sander 2025-02-03 21:28 3598
    IMGUI_API const char*       CalcWordWrapPositionA(float scale, const char* text, const char* text_end, float wrap_width) const;
1193b4be Poul Sander 2025-02-03 21:28 3599
    IMGUI_API void              RenderChar(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, ImWchar c) const;
1193b4be Poul Sander 2025-02-03 21:28 3600
    IMGUI_API void              RenderText(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, const ImVec4& clip_rect, const char* text_begin, const char* text_end, float wrap_width = 0.0f, bool cpu_fine_clip = false) const;
1193b4be Poul Sander 2025-02-03 21:28 3601
1193b4be Poul Sander 2025-02-03 21:28 3602
    // [Internal] Don't use!
1193b4be Poul Sander 2025-02-03 21:28 3603
    IMGUI_API void              BuildLookupTable();
1193b4be Poul Sander 2025-02-03 21:28 3604
    IMGUI_API void              ClearOutputData();
1193b4be Poul Sander 2025-02-03 21:28 3605
    IMGUI_API void              GrowIndex(int new_size);
1193b4be Poul Sander 2025-02-03 21:28 3606
    IMGUI_API void              AddGlyph(const ImFontConfig* src_cfg, ImWchar c, float x0, float y0, float x1, float y1, float u0, float v0, float u1, float v1, float advance_x);
1193b4be Poul Sander 2025-02-03 21:28 3607
    IMGUI_API void              AddRemapChar(ImWchar dst, ImWchar src, bool overwrite_dst = true); // Makes 'dst' character/glyph points to 'src' character/glyph. Currently needs to be called AFTER fonts have been built.
1193b4be Poul Sander 2025-02-03 21:28 3608
    IMGUI_API void              SetGlyphVisible(ImWchar c, bool visible);
1193b4be Poul Sander 2025-02-03 21:28 3609
    IMGUI_API bool              IsGlyphRangeUnused(unsigned int c_begin, unsigned int c_last);
1193b4be Poul Sander 2025-02-03 21:28 3610
};
1193b4be Poul Sander 2025-02-03 21:28 3611
1193b4be Poul Sander 2025-02-03 21:28 3612
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3613
// [SECTION] Viewports
1193b4be Poul Sander 2025-02-03 21:28 3614
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3615
1193b4be Poul Sander 2025-02-03 21:28 3616
// Flags stored in ImGuiViewport::Flags, giving indications to the platform backends.
1193b4be Poul Sander 2025-02-03 21:28 3617
enum ImGuiViewportFlags_
1193b4be Poul Sander 2025-02-03 21:28 3618
{
1193b4be Poul Sander 2025-02-03 21:28 3619
    ImGuiViewportFlags_None                     = 0,
1193b4be Poul Sander 2025-02-03 21:28 3620
    ImGuiViewportFlags_IsPlatformWindow         = 1 << 0,   // Represent a Platform Window
1193b4be Poul Sander 2025-02-03 21:28 3621
    ImGuiViewportFlags_IsPlatformMonitor        = 1 << 1,   // Represent a Platform Monitor (unused yet)
1193b4be Poul Sander 2025-02-03 21:28 3622
    ImGuiViewportFlags_OwnedByApp               = 1 << 2,   // Platform Window: Is created/managed by the user application? (rather than our backend)
1193b4be Poul Sander 2025-02-03 21:28 3623
    ImGuiViewportFlags_NoDecoration             = 1 << 3,   // Platform Window: Disable platform decorations: title bar, borders, etc. (generally set all windows, but if ImGuiConfigFlags_ViewportsDecoration is set we only set this on popups/tooltips)
1193b4be Poul Sander 2025-02-03 21:28 3624
    ImGuiViewportFlags_NoTaskBarIcon            = 1 << 4,   // Platform Window: Disable platform task bar icon (generally set on popups/tooltips, or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcon is set)
1193b4be Poul Sander 2025-02-03 21:28 3625
    ImGuiViewportFlags_NoFocusOnAppearing       = 1 << 5,   // Platform Window: Don't take focus when created.
1193b4be Poul Sander 2025-02-03 21:28 3626
    ImGuiViewportFlags_NoFocusOnClick           = 1 << 6,   // Platform Window: Don't take focus when clicked on.
1193b4be Poul Sander 2025-02-03 21:28 3627
    ImGuiViewportFlags_NoInputs                 = 1 << 7,   // Platform Window: Make mouse pass through so we can drag this window while peaking behind it.
1193b4be Poul Sander 2025-02-03 21:28 3628
    ImGuiViewportFlags_NoRendererClear          = 1 << 8,   // Platform Window: Renderer doesn't need to clear the framebuffer ahead (because we will fill it entirely).
1193b4be Poul Sander 2025-02-03 21:28 3629
    ImGuiViewportFlags_NoAutoMerge              = 1 << 9,   // Platform Window: Avoid merging this window into another host window. This can only be set via ImGuiWindowClass viewport flags override (because we need to now ahead if we are going to create a viewport in the first place!).
1193b4be Poul Sander 2025-02-03 21:28 3630
    ImGuiViewportFlags_TopMost                  = 1 << 10,  // Platform Window: Display on top (for tooltips only).
1193b4be Poul Sander 2025-02-03 21:28 3631
    ImGuiViewportFlags_CanHostOtherWindows      = 1 << 11,  // Viewport can host multiple imgui windows (secondary viewports are associated to a single window). // FIXME: In practice there's still probably code making the assumption that this is always and only on the MainViewport. Will fix once we add support for "no main viewport".
1193b4be Poul Sander 2025-02-03 21:28 3632
1193b4be Poul Sander 2025-02-03 21:28 3633
    // Output status flags (from Platform)
1193b4be Poul Sander 2025-02-03 21:28 3634
    ImGuiViewportFlags_IsMinimized              = 1 << 12,  // Platform Window: Window is minimized, can skip render. When minimized we tend to avoid using the viewport pos/size for clipping window or testing if they are contained in the viewport.
1193b4be Poul Sander 2025-02-03 21:28 3635
    ImGuiViewportFlags_IsFocused                = 1 << 13,  // Platform Window: Window is focused (last call to Platform_GetWindowFocus() returned true)
1193b4be Poul Sander 2025-02-03 21:28 3636
};
1193b4be Poul Sander 2025-02-03 21:28 3637
1193b4be Poul Sander 2025-02-03 21:28 3638
// - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.
1193b4be Poul Sander 2025-02-03 21:28 3639
// - With multi-viewport enabled, we extend this concept to have multiple active viewports.
1193b4be Poul Sander 2025-02-03 21:28 3640
// - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode.
1193b4be Poul Sander 2025-02-03 21:28 3641
// - About Main Area vs Work Area:
1193b4be Poul Sander 2025-02-03 21:28 3642
//   - Main Area = entire viewport.
1193b4be Poul Sander 2025-02-03 21:28 3643
//   - Work Area = entire viewport minus sections used by main menu bars (for platform windows), or by task bar (for platform monitor).
1193b4be Poul Sander 2025-02-03 21:28 3644
//   - Windows are generally trying to stay within the Work Area of their host viewport.
1193b4be Poul Sander 2025-02-03 21:28 3645
struct ImGuiViewport
1193b4be Poul Sander 2025-02-03 21:28 3646
{
1193b4be Poul Sander 2025-02-03 21:28 3647
    ImGuiID             ID;                     // Unique identifier for the viewport
1193b4be Poul Sander 2025-02-03 21:28 3648
    ImGuiViewportFlags  Flags;                  // See ImGuiViewportFlags_
1193b4be Poul Sander 2025-02-03 21:28 3649
    ImVec2              Pos;                    // Main Area: Position of the viewport (Dear ImGui coordinates are the same as OS desktop/native coordinates)
1193b4be Poul Sander 2025-02-03 21:28 3650
    ImVec2              Size;                   // Main Area: Size of the viewport.
1193b4be Poul Sander 2025-02-03 21:28 3651
    ImVec2              WorkPos;                // Work Area: Position of the viewport minus task bars, menus bars, status bars (>= Pos)
1193b4be Poul Sander 2025-02-03 21:28 3652
    ImVec2              WorkSize;               // Work Area: Size of the viewport minus task bars, menu bars, status bars (<= Size)
1193b4be Poul Sander 2025-02-03 21:28 3653
    float               DpiScale;               // 1.0f = 96 DPI = No extra scale.
1193b4be Poul Sander 2025-02-03 21:28 3654
    ImGuiID             ParentViewportId;       // (Advanced) 0: no parent. Instruct the platform backend to setup a parent/child relationship between platform windows.
1193b4be Poul Sander 2025-02-03 21:28 3655
    ImDrawData*         DrawData;               // The ImDrawData corresponding to this viewport. Valid after Render() and until the next call to NewFrame().
1193b4be Poul Sander 2025-02-03 21:28 3656
1193b4be Poul Sander 2025-02-03 21:28 3657
    // Platform/Backend Dependent Data
1193b4be Poul Sander 2025-02-03 21:28 3658
    // Our design separate the Renderer and Platform backends to facilitate combining default backends with each others.
1193b4be Poul Sander 2025-02-03 21:28 3659
    // When our create your own backend for a custom engine, it is possible that both Renderer and Platform will be handled
1193b4be Poul Sander 2025-02-03 21:28 3660
    // by the same system and you may not need to use all the UserData/Handle fields.
1193b4be Poul Sander 2025-02-03 21:28 3661
    // The library never uses those fields, they are merely storage to facilitate backend implementation.
1193b4be Poul Sander 2025-02-03 21:28 3662
    void*               RendererUserData;       // void* to hold custom data structure for the renderer (e.g. swap chain, framebuffers etc.). generally set by your Renderer_CreateWindow function.
1193b4be Poul Sander 2025-02-03 21:28 3663
    void*               PlatformUserData;       // void* to hold custom data structure for the OS / platform (e.g. windowing info, render context). generally set by your Platform_CreateWindow function.
1193b4be Poul Sander 2025-02-03 21:28 3664
    void*               PlatformHandle;         // void* to hold higher-level, platform window handle (e.g. HWND, GLFWWindow*, SDL_Window*), for FindViewportByPlatformHandle().
1193b4be Poul Sander 2025-02-03 21:28 3665
    void*               PlatformHandleRaw;      // void* to hold lower-level, platform-native window handle (under Win32 this is expected to be a HWND, unused for other platforms), when using an abstraction layer like GLFW or SDL (where PlatformHandle would be a SDL_Window*)
1193b4be Poul Sander 2025-02-03 21:28 3666
    bool                PlatformWindowCreated;  // Platform window has been created (Platform_CreateWindow() has been called). This is false during the first frame where a viewport is being created.
1193b4be Poul Sander 2025-02-03 21:28 3667
    bool                PlatformRequestMove;    // Platform window requested move (e.g. window was moved by the OS / host window manager, authoritative position will be OS window position)
1193b4be Poul Sander 2025-02-03 21:28 3668
    bool                PlatformRequestResize;  // Platform window requested resize (e.g. window was resized by the OS / host window manager, authoritative size will be OS window size)
1193b4be Poul Sander 2025-02-03 21:28 3669
    bool                PlatformRequestClose;   // Platform window requested closure (e.g. window was moved by the OS / host window manager, e.g. pressing ALT-F4)
1193b4be Poul Sander 2025-02-03 21:28 3670
1193b4be Poul Sander 2025-02-03 21:28 3671
    ImGuiViewport()     { memset(this, 0, sizeof(*this)); }
1193b4be Poul Sander 2025-02-03 21:28 3672
    ~ImGuiViewport()    { IM_ASSERT(PlatformUserData == NULL && RendererUserData == NULL); }
1193b4be Poul Sander 2025-02-03 21:28 3673
1193b4be Poul Sander 2025-02-03 21:28 3674
    // Helpers
1193b4be Poul Sander 2025-02-03 21:28 3675
    ImVec2              GetCenter() const       { return ImVec2(Pos.x + Size.x * 0.5f, Pos.y + Size.y * 0.5f); }
1193b4be Poul Sander 2025-02-03 21:28 3676
    ImVec2              GetWorkCenter() const   { return ImVec2(WorkPos.x + WorkSize.x * 0.5f, WorkPos.y + WorkSize.y * 0.5f); }
1193b4be Poul Sander 2025-02-03 21:28 3677
};
1193b4be Poul Sander 2025-02-03 21:28 3678
1193b4be Poul Sander 2025-02-03 21:28 3679
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3680
// [SECTION] ImGuiPlatformIO + other Platform Dependent Interfaces (ImGuiPlatformMonitor, ImGuiPlatformImeData)
1193b4be Poul Sander 2025-02-03 21:28 3681
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3682
1193b4be Poul Sander 2025-02-03 21:28 3683
// [BETA] (Optional) Multi-Viewport Support!
1193b4be Poul Sander 2025-02-03 21:28 3684
// If you are new to Dear ImGui and trying to integrate it into your engine, you can probably ignore this for now.
1193b4be Poul Sander 2025-02-03 21:28 3685
//
1193b4be Poul Sander 2025-02-03 21:28 3686
// This feature allows you to seamlessly drag Dear ImGui windows outside of your application viewport.
1193b4be Poul Sander 2025-02-03 21:28 3687
// This is achieved by creating new Platform/OS windows on the fly, and rendering into them.
1193b4be Poul Sander 2025-02-03 21:28 3688
// Dear ImGui manages the viewport structures, and the backend create and maintain one Platform/OS window for each of those viewports.
1193b4be Poul Sander 2025-02-03 21:28 3689
//
1193b4be Poul Sander 2025-02-03 21:28 3690
// See Recap:   https://github.com/ocornut/imgui/wiki/Multi-Viewports
1193b4be Poul Sander 2025-02-03 21:28 3691
// See Glossary https://github.com/ocornut/imgui/wiki/Glossary for details about some of the terminology.
1193b4be Poul Sander 2025-02-03 21:28 3692
//
1193b4be Poul Sander 2025-02-03 21:28 3693
// About the coordinates system:
1193b4be Poul Sander 2025-02-03 21:28 3694
// - When multi-viewports are enabled, all Dear ImGui coordinates become absolute coordinates (same as OS coordinates!)
1193b4be Poul Sander 2025-02-03 21:28 3695
// - So e.g. ImGui::SetNextWindowPos(ImVec2(0,0)) will position a window relative to your primary monitor!
1193b4be Poul Sander 2025-02-03 21:28 3696
// - If you want to position windows relative to your main application viewport, use ImGui::GetMainViewport()->Pos as a base position.
1193b4be Poul Sander 2025-02-03 21:28 3697
//
1193b4be Poul Sander 2025-02-03 21:28 3698
// Steps to use multi-viewports in your application, when using a default backend from the examples/ folder:
1193b4be Poul Sander 2025-02-03 21:28 3699
// - Application:  Enable feature with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
1193b4be Poul Sander 2025-02-03 21:28 3700
// - Backend:      The backend initialization will setup all necessary ImGuiPlatformIO's functions and update monitors info every frame.
1193b4be Poul Sander 2025-02-03 21:28 3701
// - Application:  In your main loop, call ImGui::UpdatePlatformWindows(), ImGui::RenderPlatformWindowsDefault() after EndFrame() or Render().
1193b4be Poul Sander 2025-02-03 21:28 3702
// - Application:  Fix absolute coordinates used in ImGui::SetWindowPos() or ImGui::SetNextWindowPos() calls.
1193b4be Poul Sander 2025-02-03 21:28 3703
//
1193b4be Poul Sander 2025-02-03 21:28 3704
// Steps to use multi-viewports in your application, when using a custom backend:
1193b4be Poul Sander 2025-02-03 21:28 3705
// - Important:    THIS IS NOT EASY TO DO and comes with many subtleties not described here!
1193b4be Poul Sander 2025-02-03 21:28 3706
//                 It's also an experimental feature, so some of the requirements may evolve.
1193b4be Poul Sander 2025-02-03 21:28 3707
//                 Consider using default backends if you can. Either way, carefully follow and refer to examples/ backends for details.
1193b4be Poul Sander 2025-02-03 21:28 3708
// - Application:  Enable feature with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
1193b4be Poul Sander 2025-02-03 21:28 3709
// - Backend:      Hook ImGuiPlatformIO's Platform_* and Renderer_* callbacks (see below).
1193b4be Poul Sander 2025-02-03 21:28 3710
//                 Set 'io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports' and 'io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports'.
1193b4be Poul Sander 2025-02-03 21:28 3711
//                 Update ImGuiPlatformIO's Monitors list every frame.
1193b4be Poul Sander 2025-02-03 21:28 3712
//                 Update MousePos every frame, in absolute coordinates.
1193b4be Poul Sander 2025-02-03 21:28 3713
// - Application:  In your main loop, call ImGui::UpdatePlatformWindows(), ImGui::RenderPlatformWindowsDefault() after EndFrame() or Render().
1193b4be Poul Sander 2025-02-03 21:28 3714
//                 You may skip calling RenderPlatformWindowsDefault() if its API is not convenient for your needs. Read comments below.
1193b4be Poul Sander 2025-02-03 21:28 3715
// - Application:  Fix absolute coordinates used in ImGui::SetWindowPos() or ImGui::SetNextWindowPos() calls.
1193b4be Poul Sander 2025-02-03 21:28 3716
//
1193b4be Poul Sander 2025-02-03 21:28 3717
// About ImGui::RenderPlatformWindowsDefault():
1193b4be Poul Sander 2025-02-03 21:28 3718
// - This function is a mostly a _helper_ for the common-most cases, and to facilitate using default backends.
1193b4be Poul Sander 2025-02-03 21:28 3719
// - You can check its simple source code to understand what it does.
1193b4be Poul Sander 2025-02-03 21:28 3720
//   It basically iterates secondary viewports and call 4 functions that are setup in ImGuiPlatformIO, if available:
1193b4be Poul Sander 2025-02-03 21:28 3721
//     Platform_RenderWindow(), Renderer_RenderWindow(), Platform_SwapBuffers(), Renderer_SwapBuffers()
1193b4be Poul Sander 2025-02-03 21:28 3722
//   Those functions pointers exists only for the benefit of RenderPlatformWindowsDefault().
1193b4be Poul Sander 2025-02-03 21:28 3723
// - If you have very specific rendering needs (e.g. flipping multiple swap-chain simultaneously, unusual sync/threading issues, etc.),
1193b4be Poul Sander 2025-02-03 21:28 3724
//   you may be tempted to ignore RenderPlatformWindowsDefault() and write customized code to perform your renderingg.
1193b4be Poul Sander 2025-02-03 21:28 3725
//   You may decide to setup the platform_io's *RenderWindow and *SwapBuffers pointers and call your functions through those pointers,
1193b4be Poul Sander 2025-02-03 21:28 3726
//   or you may decide to never setup those pointers and call your code directly. They are a convenience, not an obligatory interface.
1193b4be Poul Sander 2025-02-03 21:28 3727
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3728
1193b4be Poul Sander 2025-02-03 21:28 3729
// Access via ImGui::GetPlatformIO()
1193b4be Poul Sander 2025-02-03 21:28 3730
struct ImGuiPlatformIO
1193b4be Poul Sander 2025-02-03 21:28 3731
{
1193b4be Poul Sander 2025-02-03 21:28 3732
    IMGUI_API ImGuiPlatformIO();
1193b4be Poul Sander 2025-02-03 21:28 3733
1193b4be Poul Sander 2025-02-03 21:28 3734
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3735
    // Interface with OS and Platform backend (basic)
1193b4be Poul Sander 2025-02-03 21:28 3736
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3737
1193b4be Poul Sander 2025-02-03 21:28 3738
    // Optional: Access OS clipboard
1193b4be Poul Sander 2025-02-03 21:28 3739
    // (default to use native Win32 clipboard on Windows, otherwise uses a private clipboard. Override to access OS clipboard on other architectures)
1193b4be Poul Sander 2025-02-03 21:28 3740
    const char* (*Platform_GetClipboardTextFn)(ImGuiContext* ctx);
1193b4be Poul Sander 2025-02-03 21:28 3741
    void        (*Platform_SetClipboardTextFn)(ImGuiContext* ctx, const char* text);
1193b4be Poul Sander 2025-02-03 21:28 3742
    void*       Platform_ClipboardUserData;
1193b4be Poul Sander 2025-02-03 21:28 3743
1193b4be Poul Sander 2025-02-03 21:28 3744
    // Optional: Open link/folder/file in OS Shell
1193b4be Poul Sander 2025-02-03 21:28 3745
    // (default to use ShellExecuteA() on Windows, system() on Linux/Mac)
1193b4be Poul Sander 2025-02-03 21:28 3746
    bool        (*Platform_OpenInShellFn)(ImGuiContext* ctx, const char* path);
1193b4be Poul Sander 2025-02-03 21:28 3747
    void*       Platform_OpenInShellUserData;
1193b4be Poul Sander 2025-02-03 21:28 3748
1193b4be Poul Sander 2025-02-03 21:28 3749
    // Optional: Notify OS Input Method Editor of the screen position of your cursor for text input position (e.g. when using Japanese/Chinese IME on Windows)
1193b4be Poul Sander 2025-02-03 21:28 3750
    // (default to use native imm32 api on Windows)
1193b4be Poul Sander 2025-02-03 21:28 3751
    void        (*Platform_SetImeDataFn)(ImGuiContext* ctx, ImGuiViewport* viewport, ImGuiPlatformImeData* data);
1193b4be Poul Sander 2025-02-03 21:28 3752
    void*       Platform_ImeUserData;
1193b4be Poul Sander 2025-02-03 21:28 3753
    //void      (*SetPlatformImeDataFn)(ImGuiViewport* viewport, ImGuiPlatformImeData* data); // [Renamed to platform_io.PlatformSetImeDataFn in 1.91.1]
1193b4be Poul Sander 2025-02-03 21:28 3754
1193b4be Poul Sander 2025-02-03 21:28 3755
    // Optional: Platform locale
1193b4be Poul Sander 2025-02-03 21:28 3756
    // [Experimental] Configure decimal point e.g. '.' or ',' useful for some languages (e.g. German), generally pulled from *localeconv()->decimal_point
1193b4be Poul Sander 2025-02-03 21:28 3757
    ImWchar     Platform_LocaleDecimalPoint;     // '.'
1193b4be Poul Sander 2025-02-03 21:28 3758
1193b4be Poul Sander 2025-02-03 21:28 3759
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3760
    // Interface with Renderer Backend
1193b4be Poul Sander 2025-02-03 21:28 3761
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3762
1193b4be Poul Sander 2025-02-03 21:28 3763
    // Written by some backends during ImGui_ImplXXXX_RenderDrawData() call to point backend_specific ImGui_ImplXXXX_RenderState* structure.
1193b4be Poul Sander 2025-02-03 21:28 3764
    void*       Renderer_RenderState;
1193b4be Poul Sander 2025-02-03 21:28 3765
1193b4be Poul Sander 2025-02-03 21:28 3766
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3767
    // Input - Interface with OS/backends (Multi-Viewport support!)
1193b4be Poul Sander 2025-02-03 21:28 3768
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3769
1193b4be Poul Sander 2025-02-03 21:28 3770
    // For reference, the second column shows which function are generally calling the Platform Functions:
1193b4be Poul Sander 2025-02-03 21:28 3771
    //   N = ImGui::NewFrame()                        ~ beginning of the dear imgui frame: read info from platform/OS windows (latest size/position)
1193b4be Poul Sander 2025-02-03 21:28 3772
    //   F = ImGui::Begin(), ImGui::EndFrame()        ~ during the dear imgui frame
1193b4be Poul Sander 2025-02-03 21:28 3773
    //   U = ImGui::UpdatePlatformWindows()           ~ after the dear imgui frame: create and update all platform/OS windows
1193b4be Poul Sander 2025-02-03 21:28 3774
    //   R = ImGui::RenderPlatformWindowsDefault()    ~ render
1193b4be Poul Sander 2025-02-03 21:28 3775
    //   D = ImGui::DestroyPlatformWindows()          ~ shutdown
1193b4be Poul Sander 2025-02-03 21:28 3776
    // The general idea is that NewFrame() we will read the current Platform/OS state, and UpdatePlatformWindows() will write to it.
1193b4be Poul Sander 2025-02-03 21:28 3777
1193b4be Poul Sander 2025-02-03 21:28 3778
    // The handlers are designed so we can mix and match two imgui_impl_xxxx files, one Platform backend and one Renderer backend.
1193b4be Poul Sander 2025-02-03 21:28 3779
    // Custom engine backends will often provide both Platform and Renderer interfaces together and so may not need to use all functions.
1193b4be Poul Sander 2025-02-03 21:28 3780
    // Platform functions are typically called _before_ their Renderer counterpart, apart from Destroy which are called the other way.
1193b4be Poul Sander 2025-02-03 21:28 3781
1193b4be Poul Sander 2025-02-03 21:28 3782
    // Platform Backend functions (e.g. Win32, GLFW, SDL) ------------------- Called by -----
1193b4be Poul Sander 2025-02-03 21:28 3783
    void    (*Platform_CreateWindow)(ImGuiViewport* vp);                    // . . U . .  // Create a new platform window for the given viewport
1193b4be Poul Sander 2025-02-03 21:28 3784
    void    (*Platform_DestroyWindow)(ImGuiViewport* vp);                   // N . U . D  //
1193b4be Poul Sander 2025-02-03 21:28 3785
    void    (*Platform_ShowWindow)(ImGuiViewport* vp);                      // . . U . .  // Newly created windows are initially hidden so SetWindowPos/Size/Title can be called on them before showing the window
1193b4be Poul Sander 2025-02-03 21:28 3786
    void    (*Platform_SetWindowPos)(ImGuiViewport* vp, ImVec2 pos);        // . . U . .  // Set platform window position (given the upper-left corner of client area)
1193b4be Poul Sander 2025-02-03 21:28 3787
    ImVec2  (*Platform_GetWindowPos)(ImGuiViewport* vp);                    // N . . . .  //
1193b4be Poul Sander 2025-02-03 21:28 3788
    void    (*Platform_SetWindowSize)(ImGuiViewport* vp, ImVec2 size);      // . . U . .  // Set platform window client area size (ignoring OS decorations such as OS title bar etc.)
1193b4be Poul Sander 2025-02-03 21:28 3789
    ImVec2  (*Platform_GetWindowSize)(ImGuiViewport* vp);                   // N . . . .  // Get platform window client area size
1193b4be Poul Sander 2025-02-03 21:28 3790
    void    (*Platform_SetWindowFocus)(ImGuiViewport* vp);                  // N . . . .  // Move window to front and set input focus
1193b4be Poul Sander 2025-02-03 21:28 3791
    bool    (*Platform_GetWindowFocus)(ImGuiViewport* vp);                  // . . U . .  //
1193b4be Poul Sander 2025-02-03 21:28 3792
    bool    (*Platform_GetWindowMinimized)(ImGuiViewport* vp);              // N . . . .  // Get platform window minimized state. When minimized, we generally won't attempt to get/set size and contents will be culled more easily
1193b4be Poul Sander 2025-02-03 21:28 3793
    void    (*Platform_SetWindowTitle)(ImGuiViewport* vp, const char* str); // . . U . .  // Set platform window title (given an UTF-8 string)
1193b4be Poul Sander 2025-02-03 21:28 3794
    void    (*Platform_SetWindowAlpha)(ImGuiViewport* vp, float alpha);     // . . U . .  // (Optional) Setup global transparency (not per-pixel transparency)
1193b4be Poul Sander 2025-02-03 21:28 3795
    void    (*Platform_UpdateWindow)(ImGuiViewport* vp);                    // . . U . .  // (Optional) Called by UpdatePlatformWindows(). Optional hook to allow the platform backend from doing general book-keeping every frame.
1193b4be Poul Sander 2025-02-03 21:28 3796
    void    (*Platform_RenderWindow)(ImGuiViewport* vp, void* render_arg);  // . . . R .  // (Optional) Main rendering (platform side! This is often unused, or just setting a "current" context for OpenGL bindings). 'render_arg' is the value passed to RenderPlatformWindowsDefault().
1193b4be Poul Sander 2025-02-03 21:28 3797
    void    (*Platform_SwapBuffers)(ImGuiViewport* vp, void* render_arg);   // . . . R .  // (Optional) Call Present/SwapBuffers (platform side! This is often unused!). 'render_arg' is the value passed to RenderPlatformWindowsDefault().
1193b4be Poul Sander 2025-02-03 21:28 3798
    float   (*Platform_GetWindowDpiScale)(ImGuiViewport* vp);               // N . . . .  // (Optional) [BETA] FIXME-DPI: DPI handling: Return DPI scale for this viewport. 1.0f = 96 DPI.
1193b4be Poul Sander 2025-02-03 21:28 3799
    void    (*Platform_OnChangedViewport)(ImGuiViewport* vp);               // . F . . .  // (Optional) [BETA] FIXME-DPI: DPI handling: Called during Begin() every time the viewport we are outputting into changes, so backend has a chance to swap fonts to adjust style.
1193b4be Poul Sander 2025-02-03 21:28 3800
    ImVec4  (*Platform_GetWindowWorkAreaInsets)(ImGuiViewport* vp);         // N . . . .  // (Optional) [BETA] Get initial work area inset for the viewport (won't be covered by main menu bar, dockspace over viewport etc.). Default to (0,0),(0,0). 'safeAreaInsets' in iOS land, 'DisplayCutout' in Android land.
1193b4be Poul Sander 2025-02-03 21:28 3801
    int     (*Platform_CreateVkSurface)(ImGuiViewport* vp, ImU64 vk_inst, const void* vk_allocators, ImU64* out_vk_surface); // (Optional) For a Vulkan Renderer to call into Platform code (since the surface creation needs to tie them both).
1193b4be Poul Sander 2025-02-03 21:28 3802
1193b4be Poul Sander 2025-02-03 21:28 3803
    // Renderer Backend functions (e.g. DirectX, OpenGL, Vulkan) ------------ Called by -----
1193b4be Poul Sander 2025-02-03 21:28 3804
    void    (*Renderer_CreateWindow)(ImGuiViewport* vp);                    // . . U . .  // Create swap chain, frame buffers etc. (called after Platform_CreateWindow)
1193b4be Poul Sander 2025-02-03 21:28 3805
    void    (*Renderer_DestroyWindow)(ImGuiViewport* vp);                   // N . U . D  // Destroy swap chain, frame buffers etc. (called before Platform_DestroyWindow)
1193b4be Poul Sander 2025-02-03 21:28 3806
    void    (*Renderer_SetWindowSize)(ImGuiViewport* vp, ImVec2 size);      // . . U . .  // Resize swap chain, frame buffers etc. (called after Platform_SetWindowSize)
1193b4be Poul Sander 2025-02-03 21:28 3807
    void    (*Renderer_RenderWindow)(ImGuiViewport* vp, void* render_arg);  // . . . R .  // (Optional) Clear framebuffer, setup render target, then render the viewport->DrawData. 'render_arg' is the value passed to RenderPlatformWindowsDefault().
1193b4be Poul Sander 2025-02-03 21:28 3808
    void    (*Renderer_SwapBuffers)(ImGuiViewport* vp, void* render_arg);   // . . . R .  // (Optional) Call Present/SwapBuffers. 'render_arg' is the value passed to RenderPlatformWindowsDefault().
1193b4be Poul Sander 2025-02-03 21:28 3809
1193b4be Poul Sander 2025-02-03 21:28 3810
    // (Optional) Monitor list
1193b4be Poul Sander 2025-02-03 21:28 3811
    // - Updated by: app/backend. Update every frame to dynamically support changing monitor or DPI configuration.
1193b4be Poul Sander 2025-02-03 21:28 3812
    // - Used by: dear imgui to query DPI info, clamp popups/tooltips within same monitor and not have them straddle monitors.
1193b4be Poul Sander 2025-02-03 21:28 3813
    ImVector<ImGuiPlatformMonitor>  Monitors;
1193b4be Poul Sander 2025-02-03 21:28 3814
1193b4be Poul Sander 2025-02-03 21:28 3815
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3816
    // Output - List of viewports to render into platform windows
1193b4be Poul Sander 2025-02-03 21:28 3817
    //------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3818
1193b4be Poul Sander 2025-02-03 21:28 3819
    // Viewports list (the list is updated by calling ImGui::EndFrame or ImGui::Render)
1193b4be Poul Sander 2025-02-03 21:28 3820
    // (in the future we will attempt to organize this feature to remove the need for a "main viewport")
1193b4be Poul Sander 2025-02-03 21:28 3821
    ImVector<ImGuiViewport*>        Viewports;                              // Main viewports, followed by all secondary viewports.
1193b4be Poul Sander 2025-02-03 21:28 3822
};
1193b4be Poul Sander 2025-02-03 21:28 3823
1193b4be Poul Sander 2025-02-03 21:28 3824
// (Optional) This is required when enabling multi-viewport. Represent the bounds of each connected monitor/display and their DPI.
1193b4be Poul Sander 2025-02-03 21:28 3825
// We use this information for multiple DPI support + clamping the position of popups and tooltips so they don't straddle multiple monitors.
1193b4be Poul Sander 2025-02-03 21:28 3826
struct ImGuiPlatformMonitor
1193b4be Poul Sander 2025-02-03 21:28 3827
{
1193b4be Poul Sander 2025-02-03 21:28 3828
    ImVec2  MainPos, MainSize;      // Coordinates of the area displayed on this monitor (Min = upper left, Max = bottom right)
1193b4be Poul Sander 2025-02-03 21:28 3829
    ImVec2  WorkPos, WorkSize;      // Coordinates without task bars / side bars / menu bars. Used to avoid positioning popups/tooltips inside this region. If you don't have this info, please copy the value for MainPos/MainSize.
1193b4be Poul Sander 2025-02-03 21:28 3830
    float   DpiScale;               // 1.0f = 96 DPI
1193b4be Poul Sander 2025-02-03 21:28 3831
    void*   PlatformHandle;         // Backend dependant data (e.g. HMONITOR, GLFWmonitor*, SDL Display Index, NSScreen*)
1193b4be Poul Sander 2025-02-03 21:28 3832
    ImGuiPlatformMonitor()          { MainPos = MainSize = WorkPos = WorkSize = ImVec2(0, 0); DpiScale = 1.0f; PlatformHandle = NULL; }
1193b4be Poul Sander 2025-02-03 21:28 3833
};
1193b4be Poul Sander 2025-02-03 21:28 3834
1193b4be Poul Sander 2025-02-03 21:28 3835
// (Optional) Support for IME (Input Method Editor) via the platform_io.Platform_SetImeDataFn() function.
1193b4be Poul Sander 2025-02-03 21:28 3836
struct ImGuiPlatformImeData
1193b4be Poul Sander 2025-02-03 21:28 3837
{
1193b4be Poul Sander 2025-02-03 21:28 3838
    bool    WantVisible;        // A widget wants the IME to be visible
1193b4be Poul Sander 2025-02-03 21:28 3839
    ImVec2  InputPos;           // Position of the input cursor
1193b4be Poul Sander 2025-02-03 21:28 3840
    float   InputLineHeight;    // Line height
1193b4be Poul Sander 2025-02-03 21:28 3841
1193b4be Poul Sander 2025-02-03 21:28 3842
    ImGuiPlatformImeData() { memset(this, 0, sizeof(*this)); }
1193b4be Poul Sander 2025-02-03 21:28 3843
};
1193b4be Poul Sander 2025-02-03 21:28 3844
1193b4be Poul Sander 2025-02-03 21:28 3845
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3846
// [SECTION] Obsolete functions and types
1193b4be Poul Sander 2025-02-03 21:28 3847
// (Will be removed! Read 'API BREAKING CHANGES' section in imgui.cpp for details)
1193b4be Poul Sander 2025-02-03 21:28 3848
// Please keep your copy of dear imgui up to date! Occasionally set '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in imconfig.h to stay ahead.
1193b4be Poul Sander 2025-02-03 21:28 3849
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3850
1193b4be Poul Sander 2025-02-03 21:28 3851
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 3852
namespace ImGui
1193b4be Poul Sander 2025-02-03 21:28 3853
{
1193b4be Poul Sander 2025-02-03 21:28 3854
    // OBSOLETED in 1.91.0 (from July 2024)
1193b4be Poul Sander 2025-02-03 21:28 3855
    static inline void  PushButtonRepeat(bool repeat)                           { PushItemFlag(ImGuiItemFlags_ButtonRepeat, repeat); }
1193b4be Poul Sander 2025-02-03 21:28 3856
    static inline void  PopButtonRepeat()                                       { PopItemFlag(); }
1193b4be Poul Sander 2025-02-03 21:28 3857
    static inline void  PushTabStop(bool tab_stop)                              { PushItemFlag(ImGuiItemFlags_NoTabStop, !tab_stop); }
1193b4be Poul Sander 2025-02-03 21:28 3858
    static inline void  PopTabStop()                                            { PopItemFlag(); }
1193b4be Poul Sander 2025-02-03 21:28 3859
    IMGUI_API ImVec2    GetContentRegionMax();                                  // Content boundaries max (e.g. window boundaries including scrolling, or current column boundaries). You should never need this. Always use GetCursorScreenPos() and GetContentRegionAvail()!
1193b4be Poul Sander 2025-02-03 21:28 3860
    IMGUI_API ImVec2    GetWindowContentRegionMin();                            // Content boundaries min for the window (roughly (0,0)-Scroll), in window-local coordinates. You should never need this. Always use GetCursorScreenPos() and GetContentRegionAvail()!
1193b4be Poul Sander 2025-02-03 21:28 3861
    IMGUI_API ImVec2    GetWindowContentRegionMax();                            // Content boundaries max for the window (roughly (0,0)+Size-Scroll), in window-local coordinates. You should never need this. Always use GetCursorScreenPos() and GetContentRegionAvail()!
1193b4be Poul Sander 2025-02-03 21:28 3862
    // OBSOLETED in 1.90.0 (from September 2023)
1193b4be Poul Sander 2025-02-03 21:28 3863
    static inline bool  BeginChildFrame(ImGuiID id, const ImVec2& size, ImGuiWindowFlags window_flags = 0)  { return BeginChild(id, size, ImGuiChildFlags_FrameStyle, window_flags); }
1193b4be Poul Sander 2025-02-03 21:28 3864
    static inline void  EndChildFrame()                                                                     { EndChild(); }
1193b4be Poul Sander 2025-02-03 21:28 3865
    //static inline bool BeginChild(const char* str_id, const ImVec2& size_arg, bool borders, ImGuiWindowFlags window_flags){ return BeginChild(str_id, size_arg, borders ? ImGuiChildFlags_Borders : ImGuiChildFlags_None, window_flags); } // Unnecessary as true == ImGuiChildFlags_Borders
1193b4be Poul Sander 2025-02-03 21:28 3866
    //static inline bool BeginChild(ImGuiID id, const ImVec2& size_arg, bool borders, ImGuiWindowFlags window_flags)        { return BeginChild(id, size_arg, borders ? ImGuiChildFlags_Borders : ImGuiChildFlags_None, window_flags);     } // Unnecessary as true == ImGuiChildFlags_Borders
1193b4be Poul Sander 2025-02-03 21:28 3867
    static inline void  ShowStackToolWindow(bool* p_open = NULL)                { ShowIDStackToolWindow(p_open); }
1193b4be Poul Sander 2025-02-03 21:28 3868
    IMGUI_API bool      Combo(const char* label, int* current_item, bool (*old_callback)(void* user_data, int idx, const char** out_text), void* user_data, int items_count, int popup_max_height_in_items = -1);
1193b4be Poul Sander 2025-02-03 21:28 3869
    IMGUI_API bool      ListBox(const char* label, int* current_item, bool (*old_callback)(void* user_data, int idx, const char** out_text), void* user_data, int items_count, int height_in_items = -1);
1193b4be Poul Sander 2025-02-03 21:28 3870
    // OBSOLETED in 1.89.7 (from June 2023)
1193b4be Poul Sander 2025-02-03 21:28 3871
    IMGUI_API void      SetItemAllowOverlap();                                  // Use SetNextItemAllowOverlap() before item.
1193b4be Poul Sander 2025-02-03 21:28 3872
    // OBSOLETED in 1.89.4 (from March 2023)
1193b4be Poul Sander 2025-02-03 21:28 3873
    static inline void  PushAllowKeyboardFocus(bool tab_stop)                   { PushItemFlag(ImGuiItemFlags_NoTabStop, !tab_stop); }
1193b4be Poul Sander 2025-02-03 21:28 3874
    static inline void  PopAllowKeyboardFocus()                                 { PopItemFlag(); }
1193b4be Poul Sander 2025-02-03 21:28 3875
    // OBSOLETED in 1.87 (from February 2022 but more formally obsoleted April 2024)
1193b4be Poul Sander 2025-02-03 21:28 3876
    IMGUI_API ImGuiKey  GetKeyIndex(ImGuiKey key);                              // Map ImGuiKey_* values into legacy native key index. == io.KeyMap[key]. When using a 1.87+ backend using io.AddKeyEvent(), calling GetKeyIndex() with ANY ImGuiKey_XXXX values will return the same value!
1193b4be Poul Sander 2025-02-03 21:28 3877
    //static inline ImGuiKey GetKeyIndex(ImGuiKey key)                          { IM_ASSERT(key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END); return key; }
1193b4be Poul Sander 2025-02-03 21:28 3878
1193b4be Poul Sander 2025-02-03 21:28 3879
    // Some of the older obsolete names along with their replacement (commented out so they are not reported in IDE)
1193b4be Poul Sander 2025-02-03 21:28 3880
    //-- OBSOLETED in 1.89 (from August 2022)
1193b4be Poul Sander 2025-02-03 21:28 3881
    //IMGUI_API bool      ImageButton(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), int frame_padding = -1, const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1)); // --> Use new ImageButton() signature (explicit item id, regular FramePadding). Refer to code in 1.91 if you want to grab a copy of this version.
1193b4be Poul Sander 2025-02-03 21:28 3882
    //-- OBSOLETED in 1.88 (from May 2022)
1193b4be Poul Sander 2025-02-03 21:28 3883
    //static inline void  CaptureKeyboardFromApp(bool want_capture_keyboard = true)                   { SetNextFrameWantCaptureKeyboard(want_capture_keyboard); } // Renamed as name was misleading + removed default value.
1193b4be Poul Sander 2025-02-03 21:28 3884
    //static inline void  CaptureMouseFromApp(bool want_capture_mouse = true)                         { SetNextFrameWantCaptureMouse(want_capture_mouse); }       // Renamed as name was misleading + removed default value.
1193b4be Poul Sander 2025-02-03 21:28 3885
    //-- OBSOLETED in 1.86 (from November 2021)
1193b4be Poul Sander 2025-02-03 21:28 3886
    //IMGUI_API void      CalcListClipping(int items_count, float items_height, int* out_items_display_start, int* out_items_display_end); // Code removed, see 1.90 for last version of the code. Calculate range of visible items for large list of evenly sized items. Prefer using ImGuiListClipper.
1193b4be Poul Sander 2025-02-03 21:28 3887
    //-- OBSOLETED in 1.85 (from August 2021)
1193b4be Poul Sander 2025-02-03 21:28 3888
    //static inline float GetWindowContentRegionWidth()                                               { return GetWindowContentRegionMax().x - GetWindowContentRegionMin().x; }
1193b4be Poul Sander 2025-02-03 21:28 3889
    //-- OBSOLETED in 1.81 (from February 2021)
1193b4be Poul Sander 2025-02-03 21:28 3890
    //static inline bool  ListBoxHeader(const char* label, const ImVec2& size = ImVec2(0, 0))         { return BeginListBox(label, size); }
1193b4be Poul Sander 2025-02-03 21:28 3891
    //static inline bool  ListBoxHeader(const char* label, int items_count, int height_in_items = -1) { float height = GetTextLineHeightWithSpacing() * ((height_in_items < 0 ? ImMin(items_count, 7) : height_in_items) + 0.25f) + GetStyle().FramePadding.y * 2.0f; return BeginListBox(label, ImVec2(0.0f, height)); } // Helper to calculate size from items_count and height_in_items
1193b4be Poul Sander 2025-02-03 21:28 3892
    //static inline void  ListBoxFooter()                                                             { EndListBox(); }
1193b4be Poul Sander 2025-02-03 21:28 3893
    //-- OBSOLETED in 1.79 (from August 2020)
1193b4be Poul Sander 2025-02-03 21:28 3894
    //static inline void  OpenPopupContextItem(const char* str_id = NULL, ImGuiMouseButton mb = 1)    { OpenPopupOnItemClick(str_id, mb); } // Bool return value removed. Use IsWindowAppearing() in BeginPopup() instead. Renamed in 1.77, renamed back in 1.79. Sorry!
1193b4be Poul Sander 2025-02-03 21:28 3895
    //-- OBSOLETED in 1.78 (from June 2020): Old drag/sliders functions that took a 'float power > 1.0f' argument instead of ImGuiSliderFlags_Logarithmic. See github.com/ocornut/imgui/issues/3361 for details.
1193b4be Poul Sander 2025-02-03 21:28 3896
    //IMGUI_API bool      DragScalar(const char* label, ImGuiDataType data_type, void* p_data, float v_speed, const void* p_min, const void* p_max, const char* format, float power = 1.0f)                                                            // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3897
    //IMGUI_API bool      DragScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, float v_speed, const void* p_min, const void* p_max, const char* format, float power = 1.0f);                                          // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3898
    //IMGUI_API bool      SliderScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format, float power = 1.0f);                                                                        // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3899
    //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, float power = 1.0f);                                                       // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3900
    //static inline bool  DragFloat(const char* label, float* v, float v_speed, float v_min, float v_max, const char* format, float power = 1.0f)    { return DragScalar(label, ImGuiDataType_Float, v, v_speed, &v_min, &v_max, format, power); }     // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3901
    //static inline bool  DragFloat2(const char* label, float v[2], float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalarN(label, ImGuiDataType_Float, v, 2, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3902
    //static inline bool  DragFloat3(const char* label, float v[3], float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalarN(label, ImGuiDataType_Float, v, 3, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3903
    //static inline bool  DragFloat4(const char* label, float v[4], float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalarN(label, ImGuiDataType_Float, v, 4, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3904
    //static inline bool  SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format, float power = 1.0f)                 { return SliderScalar(label, ImGuiDataType_Float, v, &v_min, &v_max, format, power); }            // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3905
    //static inline bool  SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format, float power = 1.0f)              { return SliderScalarN(label, ImGuiDataType_Float, v, 2, &v_min, &v_max, format, power); }        // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3906
    //static inline bool  SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format, float power = 1.0f)              { return SliderScalarN(label, ImGuiDataType_Float, v, 3, &v_min, &v_max, format, power); }        // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3907
    //static inline bool  SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format, float power = 1.0f)              { return SliderScalarN(label, ImGuiDataType_Float, v, 4, &v_min, &v_max, format, power); }        // OBSOLETED in 1.78 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3908
    //-- OBSOLETED in 1.77 and before
1193b4be Poul Sander 2025-02-03 21:28 3909
    //static inline bool  BeginPopupContextWindow(const char* str_id, ImGuiMouseButton mb, bool over_items) { return BeginPopupContextWindow(str_id, mb | (over_items ? 0 : ImGuiPopupFlags_NoOpenOverItems)); } // OBSOLETED in 1.77 (from June 2020)
1193b4be Poul Sander 2025-02-03 21:28 3910
    //static inline void  TreeAdvanceToLabelPos()               { SetCursorPosX(GetCursorPosX() + GetTreeNodeToLabelSpacing()); }   // OBSOLETED in 1.72 (from July 2019)
1193b4be Poul Sander 2025-02-03 21:28 3911
    //static inline void  SetNextTreeNodeOpen(bool open, ImGuiCond cond = 0) { SetNextItemOpen(open, cond); }                       // OBSOLETED in 1.71 (from June 2019)
1193b4be Poul Sander 2025-02-03 21:28 3912
    //static inline float GetContentRegionAvailWidth()          { return GetContentRegionAvail().x; }                               // OBSOLETED in 1.70 (from May 2019)
1193b4be Poul Sander 2025-02-03 21:28 3913
    //static inline ImDrawList* GetOverlayDrawList()            { return GetForegroundDrawList(); }                                 // OBSOLETED in 1.69 (from Mar 2019)
1193b4be Poul Sander 2025-02-03 21:28 3914
    //static inline void  SetScrollHere(float ratio = 0.5f)     { SetScrollHereY(ratio); }                                          // OBSOLETED in 1.66 (from Nov 2018)
1193b4be Poul Sander 2025-02-03 21:28 3915
    //static inline bool  IsItemDeactivatedAfterChange()        { return IsItemDeactivatedAfterEdit(); }                            // OBSOLETED in 1.63 (from Aug 2018)
1193b4be Poul Sander 2025-02-03 21:28 3916
    //-- OBSOLETED in 1.60 and before
1193b4be Poul Sander 2025-02-03 21:28 3917
    //static inline bool  IsAnyWindowFocused()                  { return IsWindowFocused(ImGuiFocusedFlags_AnyWindow); }            // OBSOLETED in 1.60 (from Apr 2018)
1193b4be Poul Sander 2025-02-03 21:28 3918
    //static inline bool  IsAnyWindowHovered()                  { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); }            // OBSOLETED in 1.60 (between Dec 2017 and Apr 2018)
1193b4be Poul Sander 2025-02-03 21:28 3919
    //static inline void  ShowTestWindow()                      { return ShowDemoWindow(); }                                        // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
1193b4be Poul Sander 2025-02-03 21:28 3920
    //static inline bool  IsRootWindowFocused()                 { return IsWindowFocused(ImGuiFocusedFlags_RootWindow); }           // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
1193b4be Poul Sander 2025-02-03 21:28 3921
    //static inline bool  IsRootWindowOrAnyChildFocused()       { return IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows); }  // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
1193b4be Poul Sander 2025-02-03 21:28 3922
    //static inline void  SetNextWindowContentWidth(float w)    { SetNextWindowContentSize(ImVec2(w, 0.0f)); }                      // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
1193b4be Poul Sander 2025-02-03 21:28 3923
    //static inline float GetItemsLineHeightWithSpacing()       { return GetFrameHeightWithSpacing(); }                             // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
1193b4be Poul Sander 2025-02-03 21:28 3924
    //IMGUI_API bool      Begin(char* name, bool* p_open, ImVec2 size_first_use, float bg_alpha = -1.0f, ImGuiWindowFlags flags=0); // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017): Equivalent of using SetNextWindowSize(size, ImGuiCond_FirstUseEver) and SetNextWindowBgAlpha().
1193b4be Poul Sander 2025-02-03 21:28 3925
    //static inline bool  IsRootWindowOrAnyChildHovered()       { return IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows); }  // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017)
1193b4be Poul Sander 2025-02-03 21:28 3926
    //static inline void  AlignFirstTextHeightToWidgets()       { AlignTextToFramePadding(); }                                      // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017)
1193b4be Poul Sander 2025-02-03 21:28 3927
    //static inline void  SetNextWindowPosCenter(ImGuiCond c=0) { SetNextWindowPos(GetMainViewport()->GetCenter(), c, ImVec2(0.5f,0.5f)); } // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017)
1193b4be Poul Sander 2025-02-03 21:28 3928
    //static inline bool  IsItemHoveredRect()                   { return IsItemHovered(ImGuiHoveredFlags_RectOnly); }               // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017)
1193b4be Poul Sander 2025-02-03 21:28 3929
    //static inline bool  IsPosHoveringAnyWindow(const ImVec2&) { IM_ASSERT(0); return false; }                                     // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017): This was misleading and partly broken. You probably want to use the io.WantCaptureMouse flag instead.
1193b4be Poul Sander 2025-02-03 21:28 3930
    //static inline bool  IsMouseHoveringAnyWindow()            { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); }            // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017)
1193b4be Poul Sander 2025-02-03 21:28 3931
    //static inline bool  IsMouseHoveringWindow()               { return IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem); }       // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017)
1193b4be Poul Sander 2025-02-03 21:28 3932
    //-- OBSOLETED in 1.50 and before
1193b4be Poul Sander 2025-02-03 21:28 3933
    //static inline bool  CollapsingHeader(char* label, const char* str_id, bool framed = true, bool default_open = false) { return CollapsingHeader(label, (default_open ? (1 << 5) : 0)); } // OBSOLETED in 1.49
1193b4be Poul Sander 2025-02-03 21:28 3934
    //static inline ImFont*GetWindowFont()                      { return GetFont(); }                                               // OBSOLETED in 1.48
1193b4be Poul Sander 2025-02-03 21:28 3935
    //static inline float GetWindowFontSize()                   { return GetFontSize(); }                                           // OBSOLETED in 1.48
1193b4be Poul Sander 2025-02-03 21:28 3936
    //static inline void  SetScrollPosHere()                    { SetScrollHere(); }                                                // OBSOLETED in 1.42
1193b4be Poul Sander 2025-02-03 21:28 3937
}
1193b4be Poul Sander 2025-02-03 21:28 3938
1193b4be Poul Sander 2025-02-03 21:28 3939
//-- OBSOLETED in 1.82 (from Mars 2021): flags for AddRect(), AddRectFilled(), AddImageRounded(), PathRect()
1193b4be Poul Sander 2025-02-03 21:28 3940
//typedef ImDrawFlags ImDrawCornerFlags;
1193b4be Poul Sander 2025-02-03 21:28 3941
//enum ImDrawCornerFlags_
1193b4be Poul Sander 2025-02-03 21:28 3942
//{
1193b4be Poul Sander 2025-02-03 21:28 3943
//    ImDrawCornerFlags_None      = ImDrawFlags_RoundCornersNone,         // Was == 0 prior to 1.82, this is now == ImDrawFlags_RoundCornersNone which is != 0 and not implicit
1193b4be Poul Sander 2025-02-03 21:28 3944
//    ImDrawCornerFlags_TopLeft   = ImDrawFlags_RoundCornersTopLeft,      // Was == 0x01 (1 << 0) prior to 1.82. Order matches ImDrawFlags_NoRoundCorner* flag (we exploit this internally).
1193b4be Poul Sander 2025-02-03 21:28 3945
//    ImDrawCornerFlags_TopRight  = ImDrawFlags_RoundCornersTopRight,     // Was == 0x02 (1 << 1) prior to 1.82.
1193b4be Poul Sander 2025-02-03 21:28 3946
//    ImDrawCornerFlags_BotLeft   = ImDrawFlags_RoundCornersBottomLeft,   // Was == 0x04 (1 << 2) prior to 1.82.
1193b4be Poul Sander 2025-02-03 21:28 3947
//    ImDrawCornerFlags_BotRight  = ImDrawFlags_RoundCornersBottomRight,  // Was == 0x08 (1 << 3) prior to 1.82.
1193b4be Poul Sander 2025-02-03 21:28 3948
//    ImDrawCornerFlags_All       = ImDrawFlags_RoundCornersAll,          // Was == 0x0F prior to 1.82
1193b4be Poul Sander 2025-02-03 21:28 3949
//    ImDrawCornerFlags_Top       = ImDrawCornerFlags_TopLeft | ImDrawCornerFlags_TopRight,
1193b4be Poul Sander 2025-02-03 21:28 3950
//    ImDrawCornerFlags_Bot       = ImDrawCornerFlags_BotLeft | ImDrawCornerFlags_BotRight,
1193b4be Poul Sander 2025-02-03 21:28 3951
//    ImDrawCornerFlags_Left      = ImDrawCornerFlags_TopLeft | ImDrawCornerFlags_BotLeft,
1193b4be Poul Sander 2025-02-03 21:28 3952
//    ImDrawCornerFlags_Right     = ImDrawCornerFlags_TopRight | ImDrawCornerFlags_BotRight,
1193b4be Poul Sander 2025-02-03 21:28 3953
//};
1193b4be Poul Sander 2025-02-03 21:28 3954
1193b4be Poul Sander 2025-02-03 21:28 3955
// RENAMED and MERGED both ImGuiKey_ModXXX and ImGuiModFlags_XXX into ImGuiMod_XXX (from September 2022)
1193b4be Poul Sander 2025-02-03 21:28 3956
// RENAMED ImGuiKeyModFlags -> ImGuiModFlags in 1.88 (from April 2022). Exceptionally commented out ahead of obscolescence schedule to reduce confusion and because they were not meant to be used in the first place.
1193b4be Poul Sander 2025-02-03 21:28 3957
//typedef ImGuiKeyChord ImGuiModFlags;      // == int. We generally use ImGuiKeyChord to mean "a ImGuiKey or-ed with any number of ImGuiMod_XXX value", so you may store mods in there.
1193b4be Poul Sander 2025-02-03 21:28 3958
//enum ImGuiModFlags_ { ImGuiModFlags_None = 0, ImGuiModFlags_Ctrl = ImGuiMod_Ctrl, ImGuiModFlags_Shift = ImGuiMod_Shift, ImGuiModFlags_Alt = ImGuiMod_Alt, ImGuiModFlags_Super = ImGuiMod_Super };
1193b4be Poul Sander 2025-02-03 21:28 3959
//typedef ImGuiKeyChord ImGuiKeyModFlags; // == int
1193b4be Poul Sander 2025-02-03 21:28 3960
//enum ImGuiKeyModFlags_ { ImGuiKeyModFlags_None = 0, ImGuiKeyModFlags_Ctrl = ImGuiMod_Ctrl, ImGuiKeyModFlags_Shift = ImGuiMod_Shift, ImGuiKeyModFlags_Alt = ImGuiMod_Alt, ImGuiKeyModFlags_Super = ImGuiMod_Super };
1193b4be Poul Sander 2025-02-03 21:28 3961
1193b4be Poul Sander 2025-02-03 21:28 3962
#define IM_OFFSETOF(_TYPE,_MEMBER)  offsetof(_TYPE, _MEMBER)    // OBSOLETED IN 1.90 (now using C++11 standard version)
1193b4be Poul Sander 2025-02-03 21:28 3963
1193b4be Poul Sander 2025-02-03 21:28 3964
#endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1193b4be Poul Sander 2025-02-03 21:28 3965
1193b4be Poul Sander 2025-02-03 21:28 3966
// RENAMED IMGUI_DISABLE_METRICS_WINDOW > IMGUI_DISABLE_DEBUG_TOOLS in 1.88 (from June 2022)
1193b4be Poul Sander 2025-02-03 21:28 3967
#ifdef IMGUI_DISABLE_METRICS_WINDOW
1193b4be Poul Sander 2025-02-03 21:28 3968
#error IMGUI_DISABLE_METRICS_WINDOW was renamed to IMGUI_DISABLE_DEBUG_TOOLS, please use new name.
1193b4be Poul Sander 2025-02-03 21:28 3969
#endif
1193b4be Poul Sander 2025-02-03 21:28 3970
1193b4be Poul Sander 2025-02-03 21:28 3971
//-----------------------------------------------------------------------------
1193b4be Poul Sander 2025-02-03 21:28 3972
1193b4be Poul Sander 2025-02-03 21:28 3973
#if defined(__clang__)
1193b4be Poul Sander 2025-02-03 21:28 3974
#pragma clang diagnostic pop
1193b4be Poul Sander 2025-02-03 21:28 3975
#elif defined(__GNUC__)
1193b4be Poul Sander 2025-02-03 21:28 3976
#pragma GCC diagnostic pop
1193b4be Poul Sander 2025-02-03 21:28 3977
#endif
1193b4be Poul Sander 2025-02-03 21:28 3978
1193b4be Poul Sander 2025-02-03 21:28 3979
#ifdef _MSC_VER
1193b4be Poul Sander 2025-02-03 21:28 3980
#pragma warning (pop)
1193b4be Poul Sander 2025-02-03 21:28 3981
#endif
1193b4be Poul Sander 2025-02-03 21:28 3982
1193b4be Poul Sander 2025-02-03 21:28 3983
// Include imgui_user.h at the end of imgui.h
1193b4be Poul Sander 2025-02-03 21:28 3984
// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
1193b4be Poul Sander 2025-02-03 21:28 3985
#ifdef IMGUI_INCLUDE_IMGUI_USER_H
1193b4be Poul Sander 2025-02-03 21:28 3986
#ifdef IMGUI_USER_H_FILENAME
1193b4be Poul Sander 2025-02-03 21:28 3987
#include IMGUI_USER_H_FILENAME
1193b4be Poul Sander 2025-02-03 21:28 3988
#else
1193b4be Poul Sander 2025-02-03 21:28 3989
#include "imgui_user.h"
1193b4be Poul Sander 2025-02-03 21:28 3990
#endif
1193b4be Poul Sander 2025-02-03 21:28 3991
#endif
1193b4be Poul Sander 2025-02-03 21:28 3992
1193b4be Poul Sander 2025-02-03 21:28 3993
#endif // #ifndef IMGUI_DISABLE
1970-01-01 00:00 3994