Steppable 0.0.1
A CAS project written from scratch in C++
Loading...
Searching...
No Matches
imgui.h
1// dear imgui, v1.91.0 WIP
2// (headers)
3
4// Help:
5// - See links below.
6// - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that.
7// - Read top of imgui.cpp for more details, links and comments.
8
9// Resources:
10// - FAQ ........................ https://dearimgui.com/faq (in repository as docs/FAQ.md)
11// - Homepage ................... https://github.com/ocornut/imgui
12// - Releases & changelog ....... https://github.com/ocornut/imgui/releases
13// - Gallery .................... https://github.com/ocornut/imgui/issues/7503 (please post your screenshots/video there!)
14// - Wiki ....................... https://github.com/ocornut/imgui/wiki (lots of good stuff there)
15// - Getting Started https://github.com/ocornut/imgui/wiki/Getting-Started (how to integrate in an existing app by adding ~25 lines of code)
16// - Third-party Extensions https://github.com/ocornut/imgui/wiki/Useful-Extensions (ImPlot & many more)
17// - Bindings/Backends https://github.com/ocornut/imgui/wiki/Bindings (language bindings, backends for various tech/engines)
18// - Glossary https://github.com/ocornut/imgui/wiki/Glossary
19// - Debug Tools https://github.com/ocornut/imgui/wiki/Debug-Tools
20// - Software using Dear ImGui https://github.com/ocornut/imgui/wiki/Software-using-dear-imgui
21// - Issues & support ........... https://github.com/ocornut/imgui/issues
22// - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps)
23
24// For first-time users having issues compiling/linking/running/loading fonts:
25// please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above.
26// Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there.
27
28// Library Version
29// (Integer encoded as XYYZZ for use in #if preprocessor conditionals, e.g. '#if IMGUI_VERSION_NUM >= 12345')
30#define IMGUI_VERSION "1.91.0 WIP"
31#define IMGUI_VERSION_NUM 19096
32#define IMGUI_HAS_TABLE
33#define IMGUI_HAS_VIEWPORT // Viewport WIP branch
34#define IMGUI_HAS_DOCK // Docking WIP branch
35
36/*
37
38Index of this file:
39// [SECTION] Header mess
40// [SECTION] Forward declarations and basic types
41// [SECTION] Dear ImGui end-user API functions
42// [SECTION] Flags & Enumerations
43// [SECTION] Tables API flags and structures (ImGuiTableFlags, ImGuiTableColumnFlags, ImGuiTableRowFlags, ImGuiTableBgTarget, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs)
44// [SECTION] Helpers: Debug log, Memory allocations macros, ImVector<>
45// [SECTION] ImGuiStyle
46// [SECTION] ImGuiIO
47// [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiWindowClass, ImGuiPayload)
48// [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, Math Operators, ImColor)
49// [SECTION] Multi-Select API flags and structures (ImGuiMultiSelectFlags, ImGuiMultiSelectIO, ImGuiSelectionRequest, ImGuiSelectionBasicStorage, ImGuiSelectionExternalStorage)
50// [SECTION] Drawing API (ImDrawCallback, ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawFlags, ImDrawListFlags, ImDrawList, ImDrawData)
51// [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontGlyphRangesBuilder, ImFontAtlasFlags, ImFontAtlas, ImFont)
52// [SECTION] Viewports (ImGuiViewportFlags, ImGuiViewport)
53// [SECTION] Platform Dependent Interfaces (ImGuiPlatformIO, ImGuiPlatformMonitor, ImGuiPlatformImeData)
54// [SECTION] Obsolete functions and types
55
56*/
57
58#pragma once
59
60// Configuration file with compile-time options
61// (edit imconfig.h or '#define IMGUI_USER_CONFIG "myfilename.h" from your build system)
62#ifdef IMGUI_USER_CONFIG
63#include IMGUI_USER_CONFIG
64#endif
65#include "imconfig.h"
66
67#ifndef IMGUI_DISABLE
68
69//-----------------------------------------------------------------------------
70// [SECTION] Header mess
71//-----------------------------------------------------------------------------
72
73// Includes
74#include <float.h> // FLT_MIN, FLT_MAX
75#include <stdarg.h> // va_list, va_start, va_end
76#include <stddef.h> // ptrdiff_t, NULL
77#include <string.h> // memset, memmove, memcpy, strlen, strchr, strcpy, strcmp
78
79// Define attributes of all API symbols declarations (e.g. for DLL under Windows)
80// IMGUI_API is used for core imgui functions, IMGUI_IMPL_API is used for the default backends files (imgui_impl_xxx.h)
81// 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.
82#ifndef IMGUI_API
83#define IMGUI_API
84#endif
85#ifndef IMGUI_IMPL_API
86#define IMGUI_IMPL_API IMGUI_API
87#endif
88
89// Helper Macros
90#ifndef IM_ASSERT
91#include <assert.h>
92#define IM_ASSERT(_EXPR) assert(_EXPR) // You can override the default assert handler by editing imconfig.h
93#endif
94#define IM_ARRAYSIZE(_ARR) ((int)(sizeof(_ARR) / sizeof(*(_ARR)))) // Size of a static C-style array. Don't use on pointers!
95#define IM_UNUSED(_VAR) ((void)(_VAR)) // Used to silence "unused variable warnings". Often useful as asserts may be stripped out from final builds.
96
97// Check that version and structures layouts are matching between compiled imgui code and caller. Read comments above DebugCheckVersionAndDataLayout() for details.
98#define IMGUI_CHECKVERSION() ImGui::DebugCheckVersionAndDataLayout(IMGUI_VERSION, sizeof(ImGuiIO), sizeof(ImGuiStyle), sizeof(ImVec2), sizeof(ImVec4), sizeof(ImDrawVert), sizeof(ImDrawIdx))
99
100// Helper Macros - IM_FMTARGS, IM_FMTLIST: Apply printf-style warnings to our formatting functions.
101// (MSVC provides an equivalent mechanism via SAL Annotations but it would require the macros in a different
102// location. e.g. #include <sal.h> + void myprintf(_Printf_format_string_ const char* format, ...))
103#if !defined(IMGUI_USE_STB_SPRINTF) && defined(__MINGW32__) && !defined(__clang__)
104#define IM_FMTARGS(FMT) __attribute__((format(gnu_printf, FMT, FMT+1)))
105#define IM_FMTLIST(FMT) __attribute__((format(gnu_printf, FMT, 0)))
106#elif !defined(IMGUI_USE_STB_SPRINTF) && (defined(__clang__) || defined(__GNUC__))
107#define IM_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1)))
108#define IM_FMTLIST(FMT) __attribute__((format(printf, FMT, 0)))
109#else
110#define IM_FMTARGS(FMT)
111#define IM_FMTLIST(FMT)
112#endif
113
114// Disable some of MSVC most aggressive Debug runtime checks in function header/footer (used in some simple/low-level functions)
115#if defined(_MSC_VER) && !defined(__clang__) && !defined(__INTEL_COMPILER) && !defined(IMGUI_DEBUG_PARANOID)
116#define IM_MSVC_RUNTIME_CHECKS_OFF __pragma(runtime_checks("",off)) __pragma(check_stack(off)) __pragma(strict_gs_check(push,off))
117#define IM_MSVC_RUNTIME_CHECKS_RESTORE __pragma(runtime_checks("",restore)) __pragma(check_stack()) __pragma(strict_gs_check(pop))
118#else
119#define IM_MSVC_RUNTIME_CHECKS_OFF
120#define IM_MSVC_RUNTIME_CHECKS_RESTORE
121#endif
122
123// Warnings
124#ifdef _MSC_VER
125#pragma warning (push)
126#pragma warning (disable: 26495) // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6).
127#endif
128#if defined(__clang__)
129#pragma clang diagnostic push
130#if __has_warning("-Wunknown-warning-option")
131#pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx'
132#endif
133#pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx'
134#pragma clang diagnostic ignored "-Wold-style-cast"
135#pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe
136#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant"
137#pragma clang diagnostic ignored "-Wreserved-identifier" // warning: identifier '_Xxx' is reserved because it starts with '_' followed by a capital letter
138#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access
139#elif defined(__GNUC__)
140#pragma GCC diagnostic push
141#pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind
142#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
143#endif
144
145//-----------------------------------------------------------------------------
146// [SECTION] Forward declarations and basic types
147//-----------------------------------------------------------------------------
148
149// Scalar data types
150typedef unsigned int ImGuiID;// A unique ID used by widgets (typically the result of hashing a stack of string)
151typedef signed char ImS8; // 8-bit signed integer
152typedef unsigned char ImU8; // 8-bit unsigned integer
153typedef signed short ImS16; // 16-bit signed integer
154typedef unsigned short ImU16; // 16-bit unsigned integer
155typedef signed int ImS32; // 32-bit signed integer == int
156typedef unsigned int ImU32; // 32-bit unsigned integer (often used to store packed colors)
157typedef signed long long ImS64; // 64-bit signed integer
158typedef unsigned long long ImU64; // 64-bit unsigned integer
159
160// Forward declarations
161struct ImDrawChannel; // Temporary storage to output draw commands out of order, used by ImDrawListSplitter and ImDrawList::ChannelsSplit()
162struct ImDrawCmd; // A single draw command within a parent ImDrawList (generally maps to 1 GPU draw call, unless it is a callback)
163struct ImDrawData; // All draw command lists required to render the frame + pos/size coordinates to use for the projection matrix.
164struct ImDrawList; // A single draw command list (generally one per window, conceptually you may see this as a dynamic "mesh" builder)
165struct ImDrawListSharedData; // Data shared among multiple draw lists (typically owned by parent ImGui context, but you may create one yourself)
166struct ImDrawListSplitter; // Helper to split a draw list into different layers which can be drawn into out of order, then flattened back.
167struct ImDrawVert; // A single vertex (pos + uv + col = 20 bytes by default. Override layout with IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT)
168struct ImFont; // Runtime data for a single font within a parent ImFontAtlas
169struct ImFontAtlas; // Runtime data for multiple fonts, bake multiple fonts into a single texture, TTF/OTF font loader
170struct ImFontBuilderIO; // Opaque interface to a font builder (stb_truetype or FreeType).
171struct ImFontConfig; // Configuration data when adding a font or merging fonts
172struct ImFontGlyph; // A single font glyph (code point + coordinates within in ImFontAtlas + offset)
173struct ImFontGlyphRangesBuilder; // Helper to build glyph ranges from text/string data
174struct ImColor; // Helper functions to create a color that can be converted to either u32 or float4 (*OBSOLETE* please avoid using)
175struct ImGuiContext; // Dear ImGui context (opaque structure, unless including imgui_internal.h)
176struct ImGuiIO; // Main configuration and I/O between your application and ImGui
177struct ImGuiInputTextCallbackData; // Shared state of InputText() when using custom ImGuiInputTextCallback (rare/advanced use)
178struct ImGuiKeyData; // Storage for ImGuiIO and IsKeyDown(), IsKeyPressed() etc functions.
179struct ImGuiListClipper; // Helper to manually clip large list of items
180struct ImGuiMultiSelectIO; // Structure to interact with a BeginMultiSelect()/EndMultiSelect() block
181struct ImGuiOnceUponAFrame; // Helper for running a block of code not more than once a frame
182struct ImGuiPayload; // User data payload for drag and drop operations
183struct ImGuiPlatformIO; // Multi-viewport support: interface for Platform/Renderer backends + viewports to render
184struct ImGuiPlatformMonitor; // Multi-viewport support: user-provided bounds for each connected monitor/display. Used when positioning popups and tooltips to avoid them straddling monitors
185struct ImGuiPlatformImeData; // Platform IME data for io.PlatformSetImeDataFn() function.
186struct ImGuiSelectionBasicStorage; // Optional helper to store multi-selection state + apply multi-selection requests.
187struct ImGuiSelectionExternalStorage;//Optional helper to apply multi-selection requests to existing randomly accessible storage.
188struct ImGuiSelectionRequest; // A selection request (stored in ImGuiMultiSelectIO)
189struct ImGuiSizeCallbackData; // Callback data when using SetNextWindowSizeConstraints() (rare/advanced use)
190struct ImGuiStorage; // Helper for key->value storage (container sorted by key)
191struct ImGuiStoragePair; // Helper for key->value storage (pair)
192struct ImGuiStyle; // Runtime data for styling/colors
193struct ImGuiTableSortSpecs; // Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
194struct ImGuiTableColumnSortSpecs; // Sorting specification for one column of a table
195struct ImGuiTextBuffer; // Helper to hold and append into a text buffer (~string builder)
196struct ImGuiTextFilter; // Helper to parse and apply text filters (e.g. "aaaaa[,bbbbb][,ccccc]")
197struct 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
198struct ImGuiWindowClass; // Window class (rare/advanced uses: provide hints to the platform backend via altered viewport flags and parent/child info)
199
200// Enumerations
201// - 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)
202// - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists!
203// - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
204// - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
205// - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
206enum ImGuiDir : int; // -> enum ImGuiDir // Enum: A cardinal direction (Left, Right, Up, Down)
207enum ImGuiKey : int; // -> enum ImGuiKey // Enum: A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value)
208enum ImGuiMouseSource : int; // -> enum ImGuiMouseSource // Enum; A mouse input source identifier (Mouse, TouchScreen, Pen)
209enum ImGuiSortDirection : ImU8; // -> enum ImGuiSortDirection // Enum: A sorting direction (ascending or descending)
210typedef int ImGuiCol; // -> enum ImGuiCol_ // Enum: A color identifier for styling
211typedef int ImGuiCond; // -> enum ImGuiCond_ // Enum: A condition for many Set*() functions
212typedef int ImGuiDataType; // -> enum ImGuiDataType_ // Enum: A primary data type
213typedef int ImGuiMouseButton; // -> enum ImGuiMouseButton_ // Enum: A mouse button identifier (0=left, 1=right, 2=middle)
214typedef int ImGuiMouseCursor; // -> enum ImGuiMouseCursor_ // Enum: A mouse cursor shape
215typedef int ImGuiStyleVar; // -> enum ImGuiStyleVar_ // Enum: A variable identifier for styling
216typedef int ImGuiTableBgTarget; // -> enum ImGuiTableBgTarget_ // Enum: A color target for TableSetBgColor()
217
218// Flags (declared as int to allow using as flags without overhead, and to not pollute the top of this file)
219// - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists!
220// - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
221// - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
222// - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
223typedef int ImDrawFlags; // -> enum ImDrawFlags_ // Flags: for ImDrawList functions
224typedef int ImDrawListFlags; // -> enum ImDrawListFlags_ // Flags: for ImDrawList instance
225typedef int ImFontAtlasFlags; // -> enum ImFontAtlasFlags_ // Flags: for ImFontAtlas build
226typedef int ImGuiBackendFlags; // -> enum ImGuiBackendFlags_ // Flags: for io.BackendFlags
227typedef int ImGuiButtonFlags; // -> enum ImGuiButtonFlags_ // Flags: for InvisibleButton()
228typedef int ImGuiChildFlags; // -> enum ImGuiChildFlags_ // Flags: for BeginChild()
229typedef int ImGuiColorEditFlags; // -> enum ImGuiColorEditFlags_ // Flags: for ColorEdit4(), ColorPicker4() etc.
230typedef int ImGuiConfigFlags; // -> enum ImGuiConfigFlags_ // Flags: for io.ConfigFlags
231typedef int ImGuiComboFlags; // -> enum ImGuiComboFlags_ // Flags: for BeginCombo()
232typedef int ImGuiDockNodeFlags; // -> enum ImGuiDockNodeFlags_ // Flags: for DockSpace()
233typedef int ImGuiDragDropFlags; // -> enum ImGuiDragDropFlags_ // Flags: for BeginDragDropSource(), AcceptDragDropPayload()
234typedef int ImGuiFocusedFlags; // -> enum ImGuiFocusedFlags_ // Flags: for IsWindowFocused()
235typedef int ImGuiHoveredFlags; // -> enum ImGuiHoveredFlags_ // Flags: for IsItemHovered(), IsWindowHovered() etc.
236typedef int ImGuiInputFlags; // -> enum ImGuiInputFlags_ // Flags: for Shortcut(), SetNextItemShortcut()
237typedef int ImGuiInputTextFlags; // -> enum ImGuiInputTextFlags_ // Flags: for InputText(), InputTextMultiline()
238typedef int ImGuiItemFlags; // -> enum ImGuiItemFlags_ // Flags: for PushItemFlag(), shared by all items
239typedef int ImGuiKeyChord; // -> ImGuiKey | ImGuiMod_XXX // Flags: for IsKeyChordPressed(), Shortcut() etc. an ImGuiKey optionally OR-ed with one or more ImGuiMod_XXX values.
240typedef int ImGuiPopupFlags; // -> enum ImGuiPopupFlags_ // Flags: for OpenPopup*(), BeginPopupContext*(), IsPopupOpen()
241typedef int ImGuiMultiSelectFlags; // -> enum ImGuiMultiSelectFlags_// Flags: for BeginMultiSelect()
242typedef int ImGuiSelectableFlags; // -> enum ImGuiSelectableFlags_ // Flags: for Selectable()
243typedef int ImGuiSliderFlags; // -> enum ImGuiSliderFlags_ // Flags: for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
244typedef int ImGuiTabBarFlags; // -> enum ImGuiTabBarFlags_ // Flags: for BeginTabBar()
245typedef int ImGuiTabItemFlags; // -> enum ImGuiTabItemFlags_ // Flags: for BeginTabItem()
246typedef int ImGuiTableFlags; // -> enum ImGuiTableFlags_ // Flags: For BeginTable()
247typedef int ImGuiTableColumnFlags; // -> enum ImGuiTableColumnFlags_// Flags: For TableSetupColumn()
248typedef int ImGuiTableRowFlags; // -> enum ImGuiTableRowFlags_ // Flags: For TableNextRow()
249typedef int ImGuiTreeNodeFlags; // -> enum ImGuiTreeNodeFlags_ // Flags: for TreeNode(), TreeNodeEx(), CollapsingHeader()
250typedef int ImGuiViewportFlags; // -> enum ImGuiViewportFlags_ // Flags: for ImGuiViewport
251typedef int ImGuiWindowFlags; // -> enum ImGuiWindowFlags_ // Flags: for Begin(), BeginChild()
252
253// ImTexture: user data for renderer backend to identify a texture [Compile-time configurable type]
254// - To use something else than an opaque void* pointer: override with e.g. '#define ImTextureID MyTextureType*' in your imconfig.h file.
255// - This can be whatever to you want it to be! read the FAQ about ImTextureID for details.
256#ifndef ImTextureID
257typedef void* ImTextureID; // Default: store a pointer or an integer fitting in a pointer (most renderer backends are ok with that)
258#endif
259
260// ImDrawIdx: vertex index. [Compile-time configurable type]
261// - To use 16-bit indices + allow large meshes: backend need to set 'io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset' and handle ImDrawCmd::VtxOffset (recommended).
262// - To use 32-bit indices: override with '#define ImDrawIdx unsigned int' in your imconfig.h file.
263#ifndef ImDrawIdx
264typedef unsigned short ImDrawIdx; // Default: 16-bit (for maximum compatibility with renderer backends)
265#endif
266
267// Character types
268// (we generally use UTF-8 encoded string in the API. This is storage specifically for a decoded character used for keyboard input and display)
269typedef unsigned int ImWchar32; // A single decoded U32 character/code point. We encode them as multi bytes UTF-8 when used in strings.
270typedef unsigned short ImWchar16; // A single decoded U16 character/code point. We encode them as multi bytes UTF-8 when used in strings.
271#ifdef IMGUI_USE_WCHAR32 // ImWchar [configurable type: override in imconfig.h with '#define IMGUI_USE_WCHAR32' to support Unicode planes 1-16]
272typedef ImWchar32 ImWchar;
273#else
274typedef ImWchar16 ImWchar;
275#endif
276
277// Multi-Selection item index or identifier when using BeginMultiSelect()
278// - Used by SetNextItemSelectionUserData() + and inside ImGuiMultiSelectIO structure.
279// - 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.
280typedef ImS64 ImGuiSelectionUserData;
281
282// Callback and functions types
283typedef int (*ImGuiInputTextCallback)(ImGuiInputTextCallbackData* data); // Callback function for ImGui::InputText()
284typedef void (*ImGuiSizeCallback)(ImGuiSizeCallbackData* data); // Callback function for ImGui::SetNextWindowSizeConstraints()
285typedef void* (*ImGuiMemAllocFunc)(size_t sz, void* user_data); // Function signature for ImGui::SetAllocatorFunctions()
286typedef void (*ImGuiMemFreeFunc)(void* ptr, void* user_data); // Function signature for ImGui::SetAllocatorFunctions()
287
288// ImVec2: 2D vector used to store positions, sizes etc. [Compile-time configurable type]
289// This is a frequently used type in the API. Consider using IM_VEC2_CLASS_EXTRA to create implicit cast from/to our preferred type.
290// Add '#define IMGUI_DEFINE_MATH_OPERATORS' in your imconfig.h file to benefit from courtesy maths operators for those types.
291IM_MSVC_RUNTIME_CHECKS_OFF
292struct ImVec2
293{
294 float x, y;
295 constexpr ImVec2() : x(0.0f), y(0.0f) { }
296 constexpr ImVec2(float _x, float _y) : x(_x), y(_y) { }
297 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.
298 float operator[] (size_t idx) const { IM_ASSERT(idx == 0 || idx == 1); return ((const float*)(const void*)(const char*)this)[idx]; }
299#ifdef IM_VEC2_CLASS_EXTRA
300 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.
301#endif
302};
303
304// ImVec4: 4D vector used to store clipping rectangles, colors etc. [Compile-time configurable type]
305struct ImVec4
306{
307 float x, y, z, w;
308 constexpr ImVec4() : x(0.0f), y(0.0f), z(0.0f), w(0.0f) { }
309 constexpr ImVec4(float _x, float _y, float _z, float _w) : x(_x), y(_y), z(_z), w(_w) { }
310#ifdef IM_VEC4_CLASS_EXTRA
311 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.
312#endif
313};
314IM_MSVC_RUNTIME_CHECKS_RESTORE
315
316//-----------------------------------------------------------------------------
317// [SECTION] Dear ImGui end-user API functions
318// (Note that ImGui:: being a namespace, you can add extra ImGui:: functions in your own separate file. Please don't modify imgui source files!)
319//-----------------------------------------------------------------------------
320
321namespace ImGui
322{
323 // Context creation and access
324 // - 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.
325 // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
326 // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for details.
327 IMGUI_API ImGuiContext* CreateContext(ImFontAtlas* shared_font_atlas = NULL);
328 IMGUI_API void DestroyContext(ImGuiContext* ctx = NULL); // NULL = destroy current context
329 IMGUI_API ImGuiContext* GetCurrentContext();
330 IMGUI_API void SetCurrentContext(ImGuiContext* ctx);
331
332 // Main
333 IMGUI_API ImGuiIO& GetIO(); // access the IO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)
334 IMGUI_API ImGuiStyle& GetStyle(); // access the Style structure (colors, sizes). Always use PushStyleColor(), PushStyleVar() to modify style mid-frame!
335 IMGUI_API void NewFrame(); // start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().
336 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!
337 IMGUI_API void Render(); // ends the Dear ImGui frame, finalize the draw data. You can then get call GetDrawData().
338 IMGUI_API ImDrawData* GetDrawData(); // valid after Render() and until the next call to NewFrame(). this is what you have to render.
339
340 // Demo, Debug, Information
341 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!
342 IMGUI_API void ShowMetricsWindow(bool* p_open = NULL); // create Metrics/Debugger window. display Dear ImGui internals: windows, draw commands, various internal state, etc.
343 IMGUI_API void ShowDebugLogWindow(bool* p_open = NULL); // create Debug Log window. display a simplified log of important dear imgui events.
344 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.
345 IMGUI_API void ShowAboutWindow(bool* p_open = NULL); // create About window. display Dear ImGui version, credits and build/system information.
346 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)
347 IMGUI_API bool ShowStyleSelector(const char* label); // add style selector block (not a window), essentially a combo listing the default styles.
348 IMGUI_API void ShowFontSelector(const char* label); // add font selector block (not a window), essentially a combo listing the loaded fonts.
349 IMGUI_API void ShowUserGuide(); // add basic help/info block (not a window): how to manipulate ImGui as an end-user (mouse/keyboard controls).
350 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)
351
352 // Styles
353 IMGUI_API void StyleColorsDark(ImGuiStyle* dst = NULL); // new, recommended style (default)
354 IMGUI_API void StyleColorsLight(ImGuiStyle* dst = NULL); // best used with borders and a custom, thicker font
355 IMGUI_API void StyleColorsClassic(ImGuiStyle* dst = NULL); // classic imgui style
356
357 // Windows
358 // - Begin() = push window to the stack and start appending to it. End() = pop window from the stack.
359 // - Passing 'bool* p_open != NULL' shows a window-closing widget in the upper-right corner of the window,
360 // which clicking will set the boolean to false when clicked.
361 // - You may append multiple times to the same window during the same frame by calling Begin()/End() pairs multiple times.
362 // Some information such as 'flags' or 'p_open' will only be considered by the first call to Begin().
363 // - Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting
364 // anything to the window. Always call a matching End() for each Begin() call, regardless of its return value!
365 // [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions
366 // such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding
367 // BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
368 // - Note that the bottom of window stack always contains a window called "Debug".
369 IMGUI_API bool Begin(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0);
370 IMGUI_API void End();
371
372 // Child Windows
373 // - Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child.
374 // - Before 1.90 (November 2023), the "ImGuiChildFlags child_flags = 0" parameter was "bool border = false".
375 // This API is backward compatible with old code, as we guarantee that ImGuiChildFlags_Border == true.
376 // Consider updating your old code:
377 // BeginChild("Name", size, false) -> Begin("Name", size, 0); or Begin("Name", size, ImGuiChildFlags_None);
378 // BeginChild("Name", size, true) -> Begin("Name", size, ImGuiChildFlags_Border);
379 // - Manual sizing (each axis can use a different setting e.g. ImVec2(0.0f, 400.0f)):
380 // == 0.0f: use remaining parent window size for this axis.
381 // > 0.0f: use specified size for this axis.
382 // < 0.0f: right/bottom-align to specified distance from available content boundaries.
383 // - Specifying ImGuiChildFlags_AutoResizeX or ImGuiChildFlags_AutoResizeY makes the sizing automatic based on child contents.
384 // Combining both ImGuiChildFlags_AutoResizeX _and_ ImGuiChildFlags_AutoResizeY defeats purpose of a scrolling region and is NOT recommended.
385 // - BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting
386 // anything to the window. Always call a matching EndChild() for each BeginChild() call, regardless of its return value.
387 // [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions
388 // such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding
389 // BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
390 IMGUI_API bool BeginChild(const char* str_id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0);
391 IMGUI_API bool BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0);
392 IMGUI_API void EndChild();
393
394 // Windows Utilities
395 // - 'current window' = the window we are appending into while inside a Begin()/End() block. 'next window' = next window we will Begin() into.
396 IMGUI_API bool IsWindowAppearing();
397 IMGUI_API bool IsWindowCollapsed();
398 IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0); // is current window focused? or its root/child, depending on flags. see flags for options.
399 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.
400 IMGUI_API ImDrawList* GetWindowDrawList(); // get draw list associated to the current window, to append your own drawing primitives
401 IMGUI_API float GetWindowDpiScale(); // get DPI scale currently associated to the current window's viewport.
402 IMGUI_API ImVec2 GetWindowPos(); // get current window position in screen space (note: it is unlikely you need to use this. Consider using current layout pos instead, GetCursorScreenPos())
403 IMGUI_API ImVec2 GetWindowSize(); // get current window size (note: it is unlikely you need to use this. Consider using GetCursorScreenPos() and e.g. GetContentRegionAvail() instead)
404 IMGUI_API float GetWindowWidth(); // get current window width (shortcut for GetWindowSize().x)
405 IMGUI_API float GetWindowHeight(); // get current window height (shortcut for GetWindowSize().y)
406 IMGUI_API ImGuiViewport*GetWindowViewport(); // get viewport currently associated to the current window.
407
408 // Window manipulation
409 // - Prefer using SetNextXXX functions (before Begin) rather that SetXXX functions (after Begin).
410 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.
411 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()
412 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.
413 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()
414 IMGUI_API void SetNextWindowCollapsed(bool collapsed, ImGuiCond cond = 0); // set next window collapsed state. call before Begin()
415 IMGUI_API void SetNextWindowFocus(); // set next window to be focused / top-most. call before Begin()
416 IMGUI_API void SetNextWindowScroll(const ImVec2& scroll); // set next window scrolling value (use < 0.0f to not affect a given axis).
417 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.
418 IMGUI_API void SetNextWindowViewport(ImGuiID viewport_id); // set next window viewport
419 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.
420 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.
421 IMGUI_API void SetWindowCollapsed(bool collapsed, ImGuiCond cond = 0); // (not recommended) set current window collapsed state. prefer using SetNextWindowCollapsed().
422 IMGUI_API void SetWindowFocus(); // (not recommended) set current window to be focused / top-most. prefer using SetNextWindowFocus().
423 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().
424 IMGUI_API void SetWindowPos(const char* name, const ImVec2& pos, ImGuiCond cond = 0); // set named window position.
425 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.
426 IMGUI_API void SetWindowCollapsed(const char* name, bool collapsed, ImGuiCond cond = 0); // set named window collapsed state
427 IMGUI_API void SetWindowFocus(const char* name); // set named window to be focused / top-most. use NULL to remove focus.
428
429 // Content region
430 // - Retrieve available space from a given point. GetContentRegionAvail() is frequently useful.
431 // - Those functions are bound to be redesigned (they are confusing, incomplete and the Min/Max return values are in local window coordinates which increases confusion)
432 IMGUI_API ImVec2 GetContentRegionAvail(); // == GetContentRegionMax() - GetCursorPos()
433 IMGUI_API ImVec2 GetContentRegionMax(); // current content boundaries (typically window boundaries including scrolling, or current column boundaries), in windows coordinates
434 IMGUI_API ImVec2 GetWindowContentRegionMin(); // content boundaries min for the full window (roughly (0,0)-Scroll), in window coordinates
435 IMGUI_API ImVec2 GetWindowContentRegionMax(); // content boundaries max for the full window (roughly (0,0)+Size-Scroll) where Size can be overridden with SetNextWindowContentSize(), in window coordinates
436
437 // Windows Scrolling
438 // - Any change of Scroll will be applied at the beginning of next frame in the first call to Begin().
439 // - You may instead use SetNextWindowScroll() prior to calling Begin() to avoid this delay, as an alternative to using SetScrollX()/SetScrollY().
440 IMGUI_API float GetScrollX(); // get scrolling amount [0 .. GetScrollMaxX()]
441 IMGUI_API float GetScrollY(); // get scrolling amount [0 .. GetScrollMaxY()]
442 IMGUI_API void SetScrollX(float scroll_x); // set scrolling amount [0 .. GetScrollMaxX()]
443 IMGUI_API void SetScrollY(float scroll_y); // set scrolling amount [0 .. GetScrollMaxY()]
444 IMGUI_API float GetScrollMaxX(); // get maximum scrolling amount ~~ ContentSize.x - WindowSize.x - DecorationsSize.x
445 IMGUI_API float GetScrollMaxY(); // get maximum scrolling amount ~~ ContentSize.y - WindowSize.y - DecorationsSize.y
446 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.
447 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.
448 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.
449 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.
450
451 // Parameters stacks (shared)
452 IMGUI_API void PushFont(ImFont* font); // use NULL as a shortcut to push default font
453 IMGUI_API void PopFont();
454 IMGUI_API void PushStyleColor(ImGuiCol idx, ImU32 col); // modify a style color. always use this if you modify the style after NewFrame().
455 IMGUI_API void PushStyleColor(ImGuiCol idx, const ImVec4& col);
456 IMGUI_API void PopStyleColor(int count = 1);
457 IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val); // modify a style float variable. always use this if you modify the style after NewFrame().
458 IMGUI_API void PushStyleVar(ImGuiStyleVar idx, const ImVec2& val); // modify a style ImVec2 variable. always use this if you modify the style after NewFrame().
459 IMGUI_API void PopStyleVar(int count = 1);
460 IMGUI_API void PushItemFlag(ImGuiItemFlags option, bool enabled); // modify specified shared item flag, e.g. PushItemFlag(ImGuiItemFlags_NoTabStop, true)
461 IMGUI_API void PopItemFlag();
462
463 // Parameters stacks (current window)
464 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).
465 IMGUI_API void PopItemWidth();
466 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)
467 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.
468 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
469 IMGUI_API void PopTextWrapPos();
470
471 // Style read access
472 // - Use the ShowStyleEditor() function to interactively see/edit the colors.
473 IMGUI_API ImFont* GetFont(); // get current font
474 IMGUI_API float GetFontSize(); // get current font size (= height in pixels) of current font with current scale applied
475 IMGUI_API ImVec2 GetFontTexUvWhitePixel(); // get UV coordinate for a while pixel, useful to draw custom shapes via the ImDrawList API
476 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
477 IMGUI_API ImU32 GetColorU32(const ImVec4& col); // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList
478 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
479 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.
480
481 // Layout cursor positioning
482 // - By "cursor" we mean the current output position.
483 // - The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
484 // - You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceding widget.
485 // - Attention! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:
486 // - Absolute coordinate: GetCursorScreenPos(), SetCursorScreenPos(), all ImDrawList:: functions. -> this is the preferred way forward.
487 // - Window-local coordinates: SameLine(), GetCursorPos(), SetCursorPos(), GetCursorStartPos(), GetContentRegionMax(), GetWindowContentRegion*(), PushTextWrapPos()
488 // - GetCursorScreenPos() = GetCursorPos() + GetWindowPos(). GetWindowPos() is almost only ever useful to convert from window-local to absolute coordinates.
489 IMGUI_API ImVec2 GetCursorScreenPos(); // cursor position in absolute coordinates (prefer using this, also more useful to work with ImDrawList API).
490 IMGUI_API void SetCursorScreenPos(const ImVec2& pos); // cursor position in absolute coordinates
491 IMGUI_API ImVec2 GetCursorPos(); // [window-local] cursor position in window coordinates (relative to window position)
492 IMGUI_API float GetCursorPosX(); // [window-local] "
493 IMGUI_API float GetCursorPosY(); // [window-local] "
494 IMGUI_API void SetCursorPos(const ImVec2& local_pos); // [window-local] "
495 IMGUI_API void SetCursorPosX(float local_x); // [window-local] "
496 IMGUI_API void SetCursorPosY(float local_y); // [window-local] "
497 IMGUI_API ImVec2 GetCursorStartPos(); // [window-local] initial cursor position, in window coordinates
498
499 // Other layout functions
500 IMGUI_API void Separator(); // separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.
501 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.
502 IMGUI_API void NewLine(); // undo a SameLine() or force a new line when in a horizontal-layout context.
503 IMGUI_API void Spacing(); // add vertical spacing.
504 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.
505 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
506 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
507 IMGUI_API void BeginGroup(); // lock horizontal starting position
508 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.)
509 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)
510 IMGUI_API float GetTextLineHeight(); // ~ FontSize
511 IMGUI_API float GetTextLineHeightWithSpacing(); // ~ FontSize + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of text)
512 IMGUI_API float GetFrameHeight(); // ~ FontSize + style.FramePadding.y * 2
513 IMGUI_API float GetFrameHeightWithSpacing(); // ~ FontSize + style.FramePadding.y * 2 + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets)
514
515 // ID stack/scopes
516 // Read the FAQ (docs/FAQ.md or http://dearimgui.com/faq) for more details about how ID are handled in dear imgui.
517 // - Those questions are answered and impacted by understanding of the ID stack system:
518 // - "Q: Why is my widget not reacting when I click on it?"
519 // - "Q: How can I have widgets with an empty label?"
520 // - "Q: How can I have multiple widgets with the same label?"
521 // - Short version: ID are hashes of the entire ID stack. If you are creating widgets in a loop you most likely
522 // want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them.
523 // - You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
524 // - In this header file we use the "label"/"name" terminology to denote a string that will be displayed + used as an ID,
525 // whereas "str_id" denote a string that is only used as an ID and not normally displayed.
526 IMGUI_API void PushID(const char* str_id); // push string into the ID stack (will hash string).
527 IMGUI_API void PushID(const char* str_id_begin, const char* str_id_end); // push string into the ID stack (will hash string).
528 IMGUI_API void PushID(const void* ptr_id); // push pointer into the ID stack (will hash pointer).
529 IMGUI_API void PushID(int int_id); // push integer into the ID stack (will hash integer).
530 IMGUI_API void PopID(); // pop from the ID stack.
531 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
532 IMGUI_API ImGuiID GetID(const char* str_id_begin, const char* str_id_end);
533 IMGUI_API ImGuiID GetID(const void* ptr_id);
534
535 // Widgets: Text
536 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.
537 IMGUI_API void Text(const char* fmt, ...) IM_FMTARGS(1); // formatted text
538 IMGUI_API void TextV(const char* fmt, va_list args) IM_FMTLIST(1);
539 IMGUI_API void TextColored(const ImVec4& col, const char* fmt, ...) IM_FMTARGS(2); // shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor();
540 IMGUI_API void TextColoredV(const ImVec4& col, const char* fmt, va_list args) IM_FMTLIST(2);
541 IMGUI_API void TextDisabled(const char* fmt, ...) IM_FMTARGS(1); // shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(fmt, ...); PopStyleColor();
542 IMGUI_API void TextDisabledV(const char* fmt, va_list args) IM_FMTLIST(1);
543 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().
544 IMGUI_API void TextWrappedV(const char* fmt, va_list args) IM_FMTLIST(1);
545 IMGUI_API void LabelText(const char* label, const char* fmt, ...) IM_FMTARGS(2); // display text+label aligned the same way as value+label widgets
546 IMGUI_API void LabelTextV(const char* label, const char* fmt, va_list args) IM_FMTLIST(2);
547 IMGUI_API void BulletText(const char* fmt, ...) IM_FMTARGS(1); // shortcut for Bullet()+Text()
548 IMGUI_API void BulletTextV(const char* fmt, va_list args) IM_FMTLIST(1);
549 IMGUI_API void SeparatorText(const char* label); // currently: formatted text with an horizontal line
550
551 // Widgets: Main
552 // - Most widgets return true when the value has been changed or when pressed/selected
553 // - You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state.
554 IMGUI_API bool Button(const char* label, const ImVec2& size = ImVec2(0, 0)); // button
555 IMGUI_API bool SmallButton(const char* label); // button with (FramePadding.y == 0) to easily embed within text
556 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.)
557 IMGUI_API bool ArrowButton(const char* str_id, ImGuiDir dir); // square button with an arrow shape
558 IMGUI_API bool Checkbox(const char* label, bool* v);
559 IMGUI_API bool CheckboxFlags(const char* label, int* flags, int flags_value);
560 IMGUI_API bool CheckboxFlags(const char* label, unsigned int* flags, unsigned int flags_value);
561 IMGUI_API bool RadioButton(const char* label, bool active); // use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; }
562 IMGUI_API bool RadioButton(const char* label, int* v, int v_button); // shortcut to handle the above pattern when value is an integer
563 IMGUI_API void ProgressBar(float fraction, const ImVec2& size_arg = ImVec2(-FLT_MIN, 0), const char* overlay = NULL);
564 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
565 IMGUI_API bool TextLink(const char* label); // hyperlink text button, return true when clicked
566 IMGUI_API void TextLinkOpenURL(const char* label, const char* url = NULL); // hyperlink text button, automatically open file/url when clicked
567
568 // Widgets: Images
569 // - Read about ImTextureID here: https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples
570 // - 'uv0' and 'uv1' are texture coordinates. Read about them from the same link above.
571 // - Note that Image() may add +2.0f to provided size if a border is visible, ImageButton() adds style.FramePadding*2.0f to provided size.
572 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));
573 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));
574
575 // Widgets: Combo Box (Dropdown)
576 // - The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.
577 // - The old Combo() api are helpers over BeginCombo()/EndCombo() which are kept available for convenience purpose. This is analogous to how ListBox are created.
578 IMGUI_API bool BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags = 0);
579 IMGUI_API void EndCombo(); // only call EndCombo() if BeginCombo() returns true!
580 IMGUI_API bool Combo(const char* label, int* current_item, const char* const items[], int items_count, int popup_max_height_in_items = -1);
581 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"
582 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);
583
584 // Widgets: Drag Sliders
585 // - 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.
586 // - 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',
587 // 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
588 // - 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.
589 // - Format string may also be set to NULL or use the default format ("%f" or "%d").
590 // - Speed are per-pixel of mouse movement (v_speed=0.2f: mouse needs to move by 5 pixels to increase value by 1). For gamepad/keyboard navigation, minimum speed is Max(v_speed, minimum_step_at_given_precision).
591 // - 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.
592 // - 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.
593 // - 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.
594 // - 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.
595 // If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
596 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
597 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);
598 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);
599 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);
600 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);
601 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
602 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);
603 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);
604 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);
605 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);
606 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);
607 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);
608
609 // Widgets: Regular Sliders
610 // - 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.
611 // - 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.
612 // - Format string may also be set to NULL or use the default format ("%f" or "%d").
613 // - 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.
614 // If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
615 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.
616 IMGUI_API bool SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
617 IMGUI_API bool SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
618 IMGUI_API bool SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
619 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);
620 IMGUI_API bool SliderInt(const char* label, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
621 IMGUI_API bool SliderInt2(const char* label, int v[2], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
622 IMGUI_API bool SliderInt3(const char* label, int v[3], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
623 IMGUI_API bool SliderInt4(const char* label, int v[4], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
624 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);
625 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);
626 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);
627 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);
628 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);
629
630 // Widgets: Input with Keyboard
631 // - 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.
632 // - Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc.
633 IMGUI_API bool InputText(const char* label, char* buf, size_t buf_size, ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL);
634 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);
635 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);
636 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);
637 IMGUI_API bool InputFloat2(const char* label, float v[2], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
638 IMGUI_API bool InputFloat3(const char* label, float v[3], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
639 IMGUI_API bool InputFloat4(const char* label, float v[4], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
640 IMGUI_API bool InputInt(const char* label, int* v, int step = 1, int step_fast = 100, ImGuiInputTextFlags flags = 0);
641 IMGUI_API bool InputInt2(const char* label, int v[2], ImGuiInputTextFlags flags = 0);
642 IMGUI_API bool InputInt3(const char* label, int v[3], ImGuiInputTextFlags flags = 0);
643 IMGUI_API bool InputInt4(const char* label, int v[4], ImGuiInputTextFlags flags = 0);
644 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);
645 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);
646 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);
647
648 // 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.)
649 // - 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.
650 // - You can pass the address of a first float element out of a contiguous structure, e.g. &myvector.x
651 IMGUI_API bool ColorEdit3(const char* label, float col[3], ImGuiColorEditFlags flags = 0);
652 IMGUI_API bool ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags = 0);
653 IMGUI_API bool ColorPicker3(const char* label, float col[3], ImGuiColorEditFlags flags = 0);
654 IMGUI_API bool ColorPicker4(const char* label, float col[4], ImGuiColorEditFlags flags = 0, const float* ref_col = NULL);
655 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.
656 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.
657
658 // Widgets: Trees
659 // - 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.
660 IMGUI_API bool TreeNode(const char* label);
661 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().
662 IMGUI_API bool TreeNode(const void* ptr_id, const char* fmt, ...) IM_FMTARGS(2); // "
663 IMGUI_API bool TreeNodeV(const char* str_id, const char* fmt, va_list args) IM_FMTLIST(2);
664 IMGUI_API bool TreeNodeV(const void* ptr_id, const char* fmt, va_list args) IM_FMTLIST(2);
665 IMGUI_API bool TreeNodeEx(const char* label, ImGuiTreeNodeFlags flags = 0);
666 IMGUI_API bool TreeNodeEx(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3);
667 IMGUI_API bool TreeNodeEx(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3);
668 IMGUI_API bool TreeNodeExV(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3);
669 IMGUI_API bool TreeNodeExV(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3);
670 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.
671 IMGUI_API void TreePush(const void* ptr_id); // "
672 IMGUI_API void TreePop(); // ~ Unindent()+PopID()
673 IMGUI_API float GetTreeNodeToLabelSpacing(); // horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode
674 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().
675 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.
676 IMGUI_API void SetNextItemOpen(bool is_open, ImGuiCond cond = 0); // set next TreeNode/CollapsingHeader open state.
677
678 // Widgets: Selectables
679 // - A selectable highlights when hovered, and can display another color when selected.
680 // - Neighbors selectable extend their highlight bounds in order to leave no gap between them. This is so a series of selected Selectable appear contiguous.
681 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
682 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.
683
684 // Multi-selection system for Selectable(), Checkbox() functions*
685 // - 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.
686 // - ImGuiSelectionUserData is often used to store your item index within the current view (but may store something else).
687 // - Read comments near ImGuiMultiSelectIO for instructions/details and see 'Demo->Widgets->Selection State & Multi-Select' for demo.
688 // - (*) TreeNode() is technically supported but... using this correctly is more complicate: you need some sort of linear/random access to your tree,
689 // which is suited to advanced trees setups already implementing filters and clipper. We will work toward simplifying and demoing this.
690 // - '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.
691 IMGUI_API ImGuiMultiSelectIO* BeginMultiSelect(ImGuiMultiSelectFlags flags, int selection_size = -1, int items_count = -1);
692 IMGUI_API ImGuiMultiSelectIO* EndMultiSelect();
693 IMGUI_API void SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data);
694 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.
695
696 // Widgets: List Boxes
697 // - This is essentially a thin wrapper to using BeginChild/EndChild with the ImGuiChildFlags_FrameStyle flag for stylistic changes + displaying a label.
698 // - You can submit contents and manage your selection state however you want it, by creating e.g. Selectable() or any other items.
699 // - 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.
700 // - 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
701 // - 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
702 IMGUI_API bool BeginListBox(const char* label, const ImVec2& size = ImVec2(0, 0)); // open a framed scrolling region
703 IMGUI_API void EndListBox(); // only call EndListBox() if BeginListBox() returned true!
704 IMGUI_API bool ListBox(const char* label, int* current_item, const char* const items[], int items_count, int height_in_items = -1);
705 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);
706
707 // Widgets: Data Plotting
708 // - Consider using ImPlot (https://github.com/epezent/implot) which is much better!
709 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));
710 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));
711 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));
712 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));
713
714 // Widgets: Value() Helpers.
715 // - 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)
716 IMGUI_API void Value(const char* prefix, bool b);
717 IMGUI_API void Value(const char* prefix, int v);
718 IMGUI_API void Value(const char* prefix, unsigned int v);
719 IMGUI_API void Value(const char* prefix, float v, const char* float_format = NULL);
720
721 // Widgets: Menus
722 // - Use BeginMenuBar() on a window ImGuiWindowFlags_MenuBar to append to its menu bar.
723 // - Use BeginMainMenuBar() to create a menu bar at the top of the screen and append to it.
724 // - Use BeginMenu() to create a menu. You can call BeginMenu() multiple time with the same identifier to append more items to it.
725 // - Not that MenuItem() keyboardshortcuts are displayed as a convenience but _not processed_ by Dear ImGui at the moment.
726 IMGUI_API bool BeginMenuBar(); // append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).
727 IMGUI_API void EndMenuBar(); // only call EndMenuBar() if BeginMenuBar() returns true!
728 IMGUI_API bool BeginMainMenuBar(); // create and append to a full screen menu-bar.
729 IMGUI_API void EndMainMenuBar(); // only call EndMainMenuBar() if BeginMainMenuBar() returns true!
730 IMGUI_API bool BeginMenu(const char* label, bool enabled = true); // create a sub-menu entry. only call EndMenu() if this returns true!
731 IMGUI_API void EndMenu(); // only call EndMenu() if BeginMenu() returns true!
732 IMGUI_API bool MenuItem(const char* label, const char* shortcut = NULL, bool selected = false, bool enabled = true); // return true when activated.
733 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
734
735 // Tooltips
736 // - Tooltips are windows following the mouse. They do not take focus away.
737 // - A tooltip window can contain items of any types.
738 // - SetTooltip() is more or less a shortcut for the 'if (BeginTooltip()) { Text(...); EndTooltip(); }' idiom (with a subtlety that it discard any previously submitted tooltip)
739 IMGUI_API bool BeginTooltip(); // begin/append a tooltip window.
740 IMGUI_API void EndTooltip(); // only call EndTooltip() if BeginTooltip()/BeginItemTooltip() returns true!
741 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().
742 IMGUI_API void SetTooltipV(const char* fmt, va_list args) IM_FMTLIST(1);
743
744 // Tooltips: helpers for showing a tooltip when hovering an item
745 // - BeginItemTooltip() is a shortcut for the 'if (IsItemHovered(ImGuiHoveredFlags_ForTooltip) && BeginTooltip())' idiom.
746 // - SetItemTooltip() is a shortcut for the 'if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) { SetTooltip(...); }' idiom.
747 // - 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'.
748 IMGUI_API bool BeginItemTooltip(); // begin/append a tooltip window if preceding item was hovered.
749 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().
750 IMGUI_API void SetItemTooltipV(const char* fmt, va_list args) IM_FMTLIST(1);
751
752 // Popups, Modals
753 // - They block normal mouse hovering detection (and therefore most mouse interactions) behind them.
754 // - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
755 // - Their visibility state (~bool) is held internally instead of being held by the programmer as we are used to with regular Begin*() calls.
756 // - The 3 properties above are related: we need to retain popup visibility state in the library because popups may be closed as any time.
757 // - You can bypass the hovering restriction by using ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered().
758 // - 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.
759 // This is sometimes leading to confusing mistakes. May rework this in the future.
760 // - BeginPopup(): query popup state, if open start appending into the window. Call EndPopup() afterwards if returned true. ImGuiWindowFlags are forwarded to the window.
761 // - BeginPopupModal(): block every interaction behind the window, cannot be closed by user, add a dimming background, has a title bar.
762 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.
763 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.
764 IMGUI_API void EndPopup(); // only call EndPopup() if BeginPopupXXX() returns true!
765
766 // Popups: open/close functions
767 // - OpenPopup(): set popup state to open. ImGuiPopupFlags are available for opening options.
768 // - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
769 // - CloseCurrentPopup(): use inside the BeginPopup()/EndPopup() scope to close manually.
770 // - CloseCurrentPopup() is called by default by Selectable()/MenuItem() when activated (FIXME: need some options).
771 // - 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().
772 // - Use IsWindowAppearing() after BeginPopup() to tell if a window just opened.
773 // - 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
774 IMGUI_API void OpenPopup(const char* str_id, ImGuiPopupFlags popup_flags = 0); // call to mark popup as open (don't call every frame!).
775 IMGUI_API void OpenPopup(ImGuiID id, ImGuiPopupFlags popup_flags = 0); // id overload to facilitate calling from nested stacks
776 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)
777 IMGUI_API void CloseCurrentPopup(); // manually close the popup we have begin-ed into.
778
779 // Popups: open+begin combined functions helpers
780 // - Helpers to do OpenPopup+BeginPopup where the Open action is triggered by e.g. hovering an item and right-clicking.
781 // - They are convenient to easily create context menus, hence the name.
782 // - 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.
783 // - 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.
784 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!
785 IMGUI_API bool BeginPopupContextWindow(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);// open+begin popup when clicked on current window.
786 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).
787
788 // Popups: query functions
789 // - IsPopupOpen(): return true if the popup is open at the current BeginPopup() level of the popup stack.
790 // - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId: return true if any popup is open at the current BeginPopup() level of the popup stack.
791 // - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId + ImGuiPopupFlags_AnyPopupLevel: return true if any popup is open.
792 IMGUI_API bool IsPopupOpen(const char* str_id, ImGuiPopupFlags flags = 0); // return true if the popup is open.
793
794 // Tables
795 // - Full-featured replacement for old Columns API.
796 // - See Demo->Tables for demo code. See top of imgui_tables.cpp for general commentary.
797 // - See ImGuiTableFlags_ and ImGuiTableColumnFlags_ enums for a description of available flags.
798 // The typical call flow is:
799 // - 1. Call BeginTable(), early out if returning false.
800 // - 2. Optionally call TableSetupColumn() to submit column name/flags/defaults.
801 // - 3. Optionally call TableSetupScrollFreeze() to request scroll freezing of columns/rows.
802 // - 4. Optionally call TableHeadersRow() to submit a header row. Names are pulled from TableSetupColumn() data.
803 // - 5. Populate contents:
804 // - In most situations you can use TableNextRow() + TableSetColumnIndex(N) to start appending into a column.
805 // - If you are using tables as a sort of grid, where every column is holding the same type of contents,
806 // you may prefer using TableNextColumn() instead of TableNextRow() + TableSetColumnIndex().
807 // TableNextColumn() will automatically wrap-around into the next row if needed.
808 // - IMPORTANT: Comparatively to the old Columns() API, we need to call TableNextColumn() for the first column!
809 // - Summary of possible call flow:
810 // - TableNextRow() -> TableSetColumnIndex(0) -> Text("Hello 0") -> TableSetColumnIndex(1) -> Text("Hello 1") // OK
811 // - TableNextRow() -> TableNextColumn() -> Text("Hello 0") -> TableNextColumn() -> Text("Hello 1") // OK
812 // - TableNextColumn() -> Text("Hello 0") -> TableNextColumn() -> Text("Hello 1") // OK: TableNextColumn() automatically gets to next row!
813 // - TableNextRow() -> Text("Hello 0") // Not OK! Missing TableSetColumnIndex() or TableNextColumn()! Text will not appear!
814 // - 5. Call EndTable()
815 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);
816 IMGUI_API void EndTable(); // only call EndTable() if BeginTable() returns true!
817 IMGUI_API void TableNextRow(ImGuiTableRowFlags row_flags = 0, float min_row_height = 0.0f); // append into the first cell of a new row.
818 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.
819 IMGUI_API bool TableSetColumnIndex(int column_n); // append into the specified column. Return true when column is visible.
820
821 // Tables: Headers & Columns declaration
822 // - Use TableSetupColumn() to specify label, resizing policy, default width/weight, id, various other flags etc.
823 // - Use TableHeadersRow() to create a header row and automatically submit a TableHeader() for each column.
824 // Headers are required to perform: reordering, sorting, and opening the context menu.
825 // The context menu can also be made available in columns body using ImGuiTableFlags_ContextMenuInBody.
826 // - You may manually submit headers using TableNextRow() + TableHeader() calls, but this is only useful in
827 // some advanced use cases (e.g. adding custom widgets in header row).
828 // - Use TableSetupScrollFreeze() to lock columns/rows so they stay visible when scrolled.
829 IMGUI_API void TableSetupColumn(const char* label, ImGuiTableColumnFlags flags = 0, float init_width_or_weight = 0.0f, ImGuiID user_id = 0);
830 IMGUI_API void TableSetupScrollFreeze(int cols, int rows); // lock columns/rows so they stay visible when scrolled.
831 IMGUI_API void TableHeader(const char* label); // submit one header cell manually (rarely used)
832 IMGUI_API void TableHeadersRow(); // submit a row with headers cells based on data provided to TableSetupColumn() + submit context menu
833 IMGUI_API void TableAngledHeadersRow(); // submit a row with angled headers for every column with the ImGuiTableColumnFlags_AngledHeader flag. MUST BE FIRST ROW.
834
835 // Tables: Sorting & Miscellaneous functions
836 // - Sorting: call TableGetSortSpecs() to retrieve latest sort specs for the table. NULL when not sorting.
837 // When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have
838 // changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting,
839 // else you may wastefully sort your data every frame!
840 // - Functions args 'int column_n' treat the default value of -1 as the same as passing the current column index.
841 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().
842 IMGUI_API int TableGetColumnCount(); // return number of columns (value passed to BeginTable)
843 IMGUI_API int TableGetColumnIndex(); // return current column index.
844 IMGUI_API int TableGetRowIndex(); // return current row index.
845 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.
846 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.
847 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)
848 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.
849 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.
850
851 // Legacy Columns API (prefer using Tables!)
852 // - You can also use SameLine(pos_x) to mimic simplified columns.
853 IMGUI_API void Columns(int count = 1, const char* id = NULL, bool border = true);
854 IMGUI_API void NextColumn(); // next column, defaults to current row or next row if the current row is finished
855 IMGUI_API int GetColumnIndex(); // get current column index
856 IMGUI_API float GetColumnWidth(int column_index = -1); // get column width (in pixels). pass -1 to use current column
857 IMGUI_API void SetColumnWidth(int column_index, float width); // set column width (in pixels). pass -1 to use current column
858 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
859 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
860 IMGUI_API int GetColumnsCount();
861
862 // Tab Bars, Tabs
863 // - Note: Tabs are automatically created by the docking system (when in 'docking' branch). Use this to create tab bars/tabs yourself.
864 IMGUI_API bool BeginTabBar(const char* str_id, ImGuiTabBarFlags flags = 0); // create and append into a TabBar
865 IMGUI_API void EndTabBar(); // only call EndTabBar() if BeginTabBar() returns true!
866 IMGUI_API bool BeginTabItem(const char* label, bool* p_open = NULL, ImGuiTabItemFlags flags = 0); // create a Tab. Returns true if the Tab is selected.
867 IMGUI_API void EndTabItem(); // only call EndTabItem() if BeginTabItem() returns true!
868 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.
869 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.
870
871 // Docking
872 // [BETA API] Enable with io.ConfigFlags |= ImGuiConfigFlags_DockingEnable.
873 // Note: You can use most Docking facilities without calling any API. You DO NOT need to call DockSpace() to use Docking!
874 // - Drag from window title bar or their tab to dock/undock. Hold SHIFT to disable docking.
875 // - Drag from window menu button (upper-left button) to undock an entire node (all windows).
876 // - When io.ConfigDockingWithShift == true, you instead need to hold SHIFT to enable docking.
877 // About dockspaces:
878 // - Use DockSpaceOverViewport() to create a window covering the screen or a specific viewport + a dockspace inside it.
879 // This is often used with ImGuiDockNodeFlags_PassthruCentralNode to make it transparent.
880 // - Use DockSpace() to create an explicit dock node _within_ an existing window. See Docking demo for details.
881 // - Important: Dockspaces need to be submitted _before_ any window they can host. Submit it early in your frame!
882 // - Important: Dockspaces need to be kept alive if hidden, otherwise windows docked into it will be undocked.
883 // e.g. if you have multiple tabs with a dockspace inside each tab: submit the non-visible dockspaces with ImGuiDockNodeFlags_KeepAliveOnly.
884 IMGUI_API ImGuiID DockSpace(ImGuiID dockspace_id, const ImVec2& size = ImVec2(0, 0), ImGuiDockNodeFlags flags = 0, const ImGuiWindowClass* window_class = NULL);
885 IMGUI_API ImGuiID DockSpaceOverViewport(ImGuiID dockspace_id = 0, const ImGuiViewport* viewport = NULL, ImGuiDockNodeFlags flags = 0, const ImGuiWindowClass* window_class = NULL);
886 IMGUI_API void SetNextWindowDockID(ImGuiID dock_id, ImGuiCond cond = 0); // set next window dock id
887 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)
888 IMGUI_API ImGuiID GetWindowDockID();
889 IMGUI_API bool IsWindowDocked(); // is current window docked into another window?
890
891 // Logging/Capture
892 // - All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.
893 IMGUI_API void LogToTTY(int auto_open_depth = -1); // start logging to tty (stdout)
894 IMGUI_API void LogToFile(int auto_open_depth = -1, const char* filename = NULL); // start logging to file
895 IMGUI_API void LogToClipboard(int auto_open_depth = -1); // start logging to OS clipboard
896 IMGUI_API void LogFinish(); // stop logging (close file, etc.)
897 IMGUI_API void LogButtons(); // helper to display buttons for logging to tty/file/clipboard
898 IMGUI_API void LogText(const char* fmt, ...) IM_FMTARGS(1); // pass text data straight to log (without being displayed)
899 IMGUI_API void LogTextV(const char* fmt, va_list args) IM_FMTLIST(1);
900
901 // Drag and Drop
902 // - On source items, call BeginDragDropSource(), if it returns true also call SetDragDropPayload() + EndDragDropSource().
903 // - On target candidates, call BeginDragDropTarget(), if it returns true also call AcceptDragDropPayload() + EndDragDropTarget().
904 // - 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)
905 // - An item can be both drag source and drop target.
906 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()
907 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.
908 IMGUI_API void EndDragDropSource(); // only call EndDragDropSource() if BeginDragDropSource() returns true!
909 IMGUI_API bool BeginDragDropTarget(); // call after submitting an item that may receive a payload. If this returns true, you can call AcceptDragDropPayload() + EndDragDropTarget()
910 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.
911 IMGUI_API void EndDragDropTarget(); // only call EndDragDropTarget() if BeginDragDropTarget() returns true!
912 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.
913
914 // Disabling [BETA API]
915 // - Disable all user interactions and dim items visuals (applying style.DisabledAlpha over current colors)
916 // - 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)
917 // - Tooltips windows by exception are opted out of disabling.
918 // - BeginDisabled(false) essentially does nothing useful but is provided to facilitate use of boolean expressions. If you can avoid calling BeginDisabled(False)/EndDisabled() best to avoid it.
919 IMGUI_API void BeginDisabled(bool disabled = true);
920 IMGUI_API void EndDisabled();
921
922 // Clipping
923 // - Mouse hovering is affected by ImGui::PushClipRect() calls, unlike direct calls to ImDrawList::PushClipRect() which are render only.
924 IMGUI_API void PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect);
925 IMGUI_API void PopClipRect();
926
927 // Focus, Activation
928 // - Prefer using "SetItemDefaultFocus()" over "if (IsWindowAppearing()) SetScrollHereY()" when applicable to signify "this is the default item"
929 IMGUI_API void SetItemDefaultFocus(); // make last item the default focused item of a window.
930 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.
931
932 // Overlapping mode
933 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.
934
935 // Item/Widgets Utilities and Query Functions
936 // - Most of the functions are referring to the previous Item that has been submitted.
937 // - See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions.
938 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.
939 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)
940 IMGUI_API bool IsItemFocused(); // is the last item focused for keyboard/gamepad navigation?
941 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.
942 IMGUI_API bool IsItemVisible(); // is the last item visible? (items may be out of sight because of clipping/scrolling)
943 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.
944 IMGUI_API bool IsItemActivated(); // was the last item just made active (item was previously inactive).
945 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.
946 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).
947 IMGUI_API bool IsItemToggledOpen(); // was the last item open state toggled? set by TreeNode().
948 IMGUI_API bool IsAnyItemHovered(); // is any item hovered?
949 IMGUI_API bool IsAnyItemActive(); // is any item active?
950 IMGUI_API bool IsAnyItemFocused(); // is any item focused?
951 IMGUI_API ImGuiID GetItemID(); // get ID of last item (~~ often same ImGui::GetID(label) beforehand)
952 IMGUI_API ImVec2 GetItemRectMin(); // get upper-left bounding rectangle of the last item (screen space)
953 IMGUI_API ImVec2 GetItemRectMax(); // get lower-right bounding rectangle of the last item (screen space)
954 IMGUI_API ImVec2 GetItemRectSize(); // get size of last item
955
956 // Viewports
957 // - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.
958 // - In 'docking' branch with multi-viewport enabled, we extend this concept to have multiple active viewports.
959 // - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode.
960 IMGUI_API ImGuiViewport* GetMainViewport(); // return primary/default viewport. This can never be NULL.
961
962 // Background/Foreground Draw Lists
963 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.
964 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.
965
966 // Miscellaneous Utilities
967 IMGUI_API bool IsRectVisible(const ImVec2& size); // test if rectangle (of given size, starting from cursor position) is visible / not clipped.
968 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.
969 IMGUI_API double GetTime(); // get global imgui time. incremented by io.DeltaTime every frame.
970 IMGUI_API int GetFrameCount(); // get global imgui frame count. incremented by 1 every frame.
971 IMGUI_API ImDrawListSharedData* GetDrawListSharedData(); // you may use this when creating your own ImDrawList instances.
972 IMGUI_API const char* GetStyleColorName(ImGuiCol idx); // get a string corresponding to the enum value (for display, saving, etc.).
973 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)
974 IMGUI_API ImGuiStorage* GetStateStorage();
975
976 // Text Utilities
977 IMGUI_API ImVec2 CalcTextSize(const char* text, const char* text_end = NULL, bool hide_text_after_double_hash = false, float wrap_width = -1.0f);
978
979 // Color Utilities
980 IMGUI_API ImVec4 ColorConvertU32ToFloat4(ImU32 in);
981 IMGUI_API ImU32 ColorConvertFloat4ToU32(const ImVec4& in);
982 IMGUI_API void ColorConvertRGBtoHSV(float r, float g, float b, float& out_h, float& out_s, float& out_v);
983 IMGUI_API void ColorConvertHSVtoRGB(float h, float s, float v, float& out_r, float& out_g, float& out_b);
984
985 // Inputs Utilities: Keyboard/Mouse/Gamepad
986 // - the ImGuiKey enum contains all possible keyboard, mouse and gamepad inputs (e.g. ImGuiKey_A, ImGuiKey_MouseLeft, ImGuiKey_GamepadDpadUp...).
987 // - before v1.87, we used ImGuiKey to carry native/user indices as defined by each backends. About use of those legacy ImGuiKey values:
988 // - 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.
989 // - 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).
990 IMGUI_API bool IsKeyDown(ImGuiKey key); // is key being held.
991 IMGUI_API bool IsKeyPressed(ImGuiKey key, bool repeat = true); // was key pressed (went from !Down to Down)? if repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate
992 IMGUI_API bool IsKeyReleased(ImGuiKey key); // was key released (went from Down to !Down)?
993 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.
994 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
995 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.
996 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.
997
998 // Inputs Utilities: Shortcut Testing & Routing [BETA]
999 // - ImGuiKeyChord = a ImGuiKey + optional ImGuiMod_Alt/ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Super.
1000 // ImGuiKey_C // Accepted by functions taking ImGuiKey or ImGuiKeyChord arguments)
1001 // ImGuiMod_Ctrl | ImGuiKey_C // Accepted by functions taking ImGuiKeyChord arguments)
1002 // only ImGuiMod_XXX values are legal to combine with an ImGuiKey. You CANNOT combine two ImGuiKey values.
1003 // - The general idea is that several callers may register interest in a shortcut, and only one owner gets it.
1004 // Parent -> call Shortcut(Ctrl+S) // When Parent is focused, Parent gets the shortcut.
1005 // Child1 -> call Shortcut(Ctrl+S) // When Child1 is focused, Child1 gets the shortcut (Child1 overrides Parent shortcuts)
1006 // Child2 -> no call // When Child2 is focused, Parent gets the shortcut.
1007 // The whole system is order independent, so if Child1 makes its calls before Parent, results will be identical.
1008 // This is an important property as it facilitate working with foreign code or larger codebase.
1009 // - To understand the difference:
1010 // - IsKeyChordPressed() compares mods and call IsKeyPressed() -> function has no side-effect.
1011 // - 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.
1012 // - Visualize registered routes in 'Metrics/Debugger->Inputs'.
1013 IMGUI_API bool Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);
1014 IMGUI_API void SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);
1015
1016 // Inputs Utilities: Mouse specific
1017 // - To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.
1018 // - You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.
1019 // - Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see 'lock_threshold' and 'io.MouseDraggingThreshold')
1020 IMGUI_API bool IsMouseDown(ImGuiMouseButton button); // is mouse button held?
1021 IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, bool repeat = false); // did mouse button clicked? (went from !Down to Down). Same as GetMouseClickedCount() == 1.
1022 IMGUI_API bool IsMouseReleased(ImGuiMouseButton button); // did mouse button released? (went from Down to !Down)
1023 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)
1024 IMGUI_API int GetMouseClickedCount(ImGuiMouseButton button); // return the number of successive mouse-clicks at the time where a click happen (otherwise 0).
1025 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.
1026 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
1027 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.
1028 IMGUI_API ImVec2 GetMousePos(); // shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls
1029 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)
1030 IMGUI_API bool IsMouseDragging(ImGuiMouseButton button, float lock_threshold = -1.0f); // is mouse dragging? (uses io.MouseDraggingThreshold if lock_threshold < 0.0f)
1031 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)
1032 IMGUI_API void ResetMouseDragDelta(ImGuiMouseButton button = 0); //
1033 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
1034 IMGUI_API void SetMouseCursor(ImGuiMouseCursor cursor_type); // set desired mouse cursor shape
1035 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.
1036
1037 // Clipboard Utilities
1038 // - Also see the LogToClipboard() function to capture GUI into clipboard, or easily output text data to the clipboard.
1039 IMGUI_API const char* GetClipboardText();
1040 IMGUI_API void SetClipboardText(const char* text);
1041
1042 // Settings/.Ini Utilities
1043 // - The disk functions are automatically called if io.IniFilename != NULL (default is "imgui.ini").
1044 // - Set io.IniFilename to NULL to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually.
1045 // - 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).
1046 IMGUI_API void LoadIniSettingsFromDisk(const char* ini_filename); // call after CreateContext() and before the first call to NewFrame(). NewFrame() automatically calls LoadIniSettingsFromDisk(io.IniFilename).
1047 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.
1048 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).
1049 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.
1050
1051 // Debug Utilities
1052 // - Your main debugging friend is the ShowMetricsWindow() function, which is also accessible from Demo->Tools->Metrics Debugger
1053 IMGUI_API void DebugTextEncoding(const char* text);
1054 IMGUI_API void DebugFlashStyleColor(ImGuiCol idx);
1055 IMGUI_API void DebugStartItemPicker();
1056 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.
1057#ifndef IMGUI_DISABLE_DEBUG_TOOLS
1058 IMGUI_API void DebugLog(const char* fmt, ...) IM_FMTARGS(1); // Call via IMGUI_DEBUG_LOG() for maximum stripping in caller code!
1059 IMGUI_API void DebugLogV(const char* fmt, va_list args) IM_FMTLIST(1);
1060#endif
1061
1062 // Memory Allocators
1063 // - Those functions are not reliant on the current context.
1064 // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
1065 // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details.
1066 IMGUI_API void SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void* user_data = NULL);
1067 IMGUI_API void GetAllocatorFunctions(ImGuiMemAllocFunc* p_alloc_func, ImGuiMemFreeFunc* p_free_func, void** p_user_data);
1068 IMGUI_API void* MemAlloc(size_t size);
1069 IMGUI_API void MemFree(void* ptr);
1070
1071 // (Optional) Platform/OS interface for multi-viewport support
1072 // Read comments around the ImGuiPlatformIO structure for more details.
1073 // Note: You may use GetWindowViewport() to get the current viewport of the current window.
1074 IMGUI_API ImGuiPlatformIO& GetPlatformIO(); // platform/renderer functions, for backend to setup + viewports list.
1075 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.
1076 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.
1077 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().
1078 IMGUI_API ImGuiViewport* FindViewportByID(ImGuiID id); // this is a helper for backends.
1079 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.)
1080
1081} // namespace ImGui
1082
1083//-----------------------------------------------------------------------------
1084// [SECTION] Flags & Enumerations
1085//-----------------------------------------------------------------------------
1086
1087// Flags for ImGui::Begin()
1088// (Those are per-window flags. There are shared flags in ImGuiIO: io.ConfigWindowsResizeFromEdges and io.ConfigWindowsMoveFromTitleBarOnly)
1089enum ImGuiWindowFlags_
1090{
1091 ImGuiWindowFlags_None = 0,
1092 ImGuiWindowFlags_NoTitleBar = 1 << 0, // Disable title-bar
1093 ImGuiWindowFlags_NoResize = 1 << 1, // Disable user resizing with the lower-right grip
1094 ImGuiWindowFlags_NoMove = 1 << 2, // Disable user moving the window
1095 ImGuiWindowFlags_NoScrollbar = 1 << 3, // Disable scrollbars (window can still scroll with mouse or programmatically)
1096 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.
1097 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).
1098 ImGuiWindowFlags_AlwaysAutoResize = 1 << 6, // Resize every window to its content every frame
1099 ImGuiWindowFlags_NoBackground = 1 << 7, // Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
1100 ImGuiWindowFlags_NoSavedSettings = 1 << 8, // Never load/save settings in .ini file
1101 ImGuiWindowFlags_NoMouseInputs = 1 << 9, // Disable catching mouse, hovering test with pass through.
1102 ImGuiWindowFlags_MenuBar = 1 << 10, // Has a menu-bar
1103 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.
1104 ImGuiWindowFlags_NoFocusOnAppearing = 1 << 12, // Disable taking focus when transitioning from hidden to visible state
1105 ImGuiWindowFlags_NoBringToFrontOnFocus = 1 << 13, // Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)
1106 ImGuiWindowFlags_AlwaysVerticalScrollbar= 1 << 14, // Always show vertical scrollbar (even if ContentSize.y < Size.y)
1107 ImGuiWindowFlags_AlwaysHorizontalScrollbar=1<< 15, // Always show horizontal scrollbar (even if ContentSize.x < Size.x)
1108 ImGuiWindowFlags_NoNavInputs = 1 << 16, // No gamepad/keyboard navigation within the window
1109 ImGuiWindowFlags_NoNavFocus = 1 << 17, // No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)
1110 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.
1111 ImGuiWindowFlags_NoDocking = 1 << 19, // Disable docking of this window
1112 ImGuiWindowFlags_NoNav = ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,
1113 ImGuiWindowFlags_NoDecoration = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoCollapse,
1114 ImGuiWindowFlags_NoInputs = ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,
1115
1116 // [Internal]
1117 ImGuiWindowFlags_ChildWindow = 1 << 24, // Don't use! For internal use by BeginChild()
1118 ImGuiWindowFlags_Tooltip = 1 << 25, // Don't use! For internal use by BeginTooltip()
1119 ImGuiWindowFlags_Popup = 1 << 26, // Don't use! For internal use by BeginPopup()
1120 ImGuiWindowFlags_Modal = 1 << 27, // Don't use! For internal use by BeginPopupModal()
1121 ImGuiWindowFlags_ChildMenu = 1 << 28, // Don't use! For internal use by BeginMenu()
1122 ImGuiWindowFlags_DockNodeHost = 1 << 29, // Don't use! For internal use by Begin()/NewFrame()
1123
1124 // Obsolete names
1125#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1126 ImGuiWindowFlags_AlwaysUseWindowPadding = 1 << 30, // Obsoleted in 1.90: Use ImGuiChildFlags_AlwaysUseWindowPadding in BeginChild() call.
1127 ImGuiWindowFlags_NavFlattened = 1 << 31, // Obsoleted in 1.90.9: Use ImGuiChildFlags_NavFlattened in BeginChild() call.
1128#endif
1129};
1130
1131// Flags for ImGui::BeginChild()
1132// (Legacy: bit 0 must always correspond to ImGuiChildFlags_Border to be backward compatible with old API using 'bool border = false'.
1133// About using AutoResizeX/AutoResizeY flags:
1134// - May be combined with SetNextWindowSizeConstraints() to set a min/max size for each axis (see "Demo->Child->Auto-resize with Constraints").
1135// - Size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing.
1136// - 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.
1137// 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.
1138// - You may also use ImGuiChildFlags_AlwaysAutoResize to force an update even when child window is not in view.
1139// HOWEVER PLEASE UNDERSTAND THAT DOING SO WILL PREVENT BeginChild() FROM EVER RETURNING FALSE, disabling benefits of coarse clipping.
1140enum ImGuiChildFlags_
1141{
1142 ImGuiChildFlags_None = 0,
1143 ImGuiChildFlags_Border = 1 << 0, // Show an outer border and enable WindowPadding. (IMPORTANT: this is always == 1 == true for legacy reason)
1144 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)
1145 ImGuiChildFlags_ResizeX = 1 << 2, // Allow resize from right border (layout direction). Enable .ini saving (unless ImGuiWindowFlags_NoSavedSettings passed to window flags)
1146 ImGuiChildFlags_ResizeY = 1 << 3, // Allow resize from bottom border (layout direction). "
1147 ImGuiChildFlags_AutoResizeX = 1 << 4, // Enable auto-resizing width. Read "IMPORTANT: Size measurement" details above.
1148 ImGuiChildFlags_AutoResizeY = 1 << 5, // Enable auto-resizing height. Read "IMPORTANT: Size measurement" details above.
1149 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.
1150 ImGuiChildFlags_FrameStyle = 1 << 7, // Style the child window like a framed item: use FrameBg, FrameRounding, FrameBorderSize, FramePadding instead of ChildBg, ChildRounding, ChildBorderSize, WindowPadding.
1151 ImGuiChildFlags_NavFlattened = 1 << 8, // Share focus scope, allow gamepad/keyboard navigation to cross over parent border to this child or between sibling child windows.
1152};
1153
1154// Flags for ImGui::PushItemFlag()
1155// (Those are shared by all items)
1156enum ImGuiItemFlags_
1157{
1158 ImGuiItemFlags_None = 0, // (Default)
1159 ImGuiItemFlags_NoTabStop = 1 << 0, // false // Disable keyboard tabbing. This is a "lighter" version of ImGuiItemFlags_NoNav.
1160 ImGuiItemFlags_NoNav = 1 << 1, // false // Disable any form of focusing (keyboard/gamepad directional navigation and SetKeyboardFocusHere() calls).
1161 ImGuiItemFlags_NoNavDefaultFocus = 1 << 2, // false // Disable item being a candidate for default focus (e.g. used by title bar items).
1162 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.
1163 ImGuiItemFlags_AutoClosePopups = 1 << 4, // true // MenuItem()/Selectable() automatically close their parent popup window.
1164};
1165
1166// Flags for ImGui::InputText()
1167// (Those are per-item flags. There are shared flags in ImGuiIO: io.ConfigInputTextCursorBlink and io.ConfigInputTextEnterKeepActive)
1168enum ImGuiInputTextFlags_
1169{
1170 // Basic filters (also see ImGuiInputTextFlags_CallbackCharFilter)
1171 ImGuiInputTextFlags_None = 0,
1172 ImGuiInputTextFlags_CharsDecimal = 1 << 0, // Allow 0123456789.+-*/
1173 ImGuiInputTextFlags_CharsHexadecimal = 1 << 1, // Allow 0123456789ABCDEFabcdef
1174 ImGuiInputTextFlags_CharsScientific = 1 << 2, // Allow 0123456789.+-*/eE (Scientific notation input)
1175 ImGuiInputTextFlags_CharsUppercase = 1 << 3, // Turn a..z into A..Z
1176 ImGuiInputTextFlags_CharsNoBlank = 1 << 4, // Filter out spaces, tabs
1177
1178 // Inputs
1179 ImGuiInputTextFlags_AllowTabInput = 1 << 5, // Pressing TAB input a '\t' character into the text field
1180 ImGuiInputTextFlags_EnterReturnsTrue = 1 << 6, // Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider looking at the IsItemDeactivatedAfterEdit() function.
1181 ImGuiInputTextFlags_EscapeClearsAll = 1 << 7, // Escape key clears content if not empty, and deactivate otherwise (contrast to default behavior of Escape to revert)
1182 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).
1183
1184 // Other options
1185 ImGuiInputTextFlags_ReadOnly = 1 << 9, // Read-only mode
1186 ImGuiInputTextFlags_Password = 1 << 10, // Password mode, display all characters as '*', disable copy
1187 ImGuiInputTextFlags_AlwaysOverwrite = 1 << 11, // Overwrite mode
1188 ImGuiInputTextFlags_AutoSelectAll = 1 << 12, // Select entire text when first taking mouse focus
1189 ImGuiInputTextFlags_ParseEmptyRefVal = 1 << 13, // InputFloat(), InputInt(), InputScalar() etc. only: parse empty string as zero value.
1190 ImGuiInputTextFlags_DisplayEmptyRefVal = 1 << 14, // InputFloat(), InputInt(), InputScalar() etc. only: when value is zero, do not display it. Generally used with ImGuiInputTextFlags_ParseEmptyRefVal.
1191 ImGuiInputTextFlags_NoHorizontalScroll = 1 << 15, // Disable following the cursor horizontally
1192 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().
1193
1194 // Callback features
1195 ImGuiInputTextFlags_CallbackCompletion = 1 << 17, // Callback on pressing TAB (for completion handling)
1196 ImGuiInputTextFlags_CallbackHistory = 1 << 18, // Callback on pressing Up/Down arrows (for history handling)
1197 ImGuiInputTextFlags_CallbackAlways = 1 << 19, // Callback on each iteration. User code may query cursor position, modify text buffer.
1198 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.
1199 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)
1200 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)
1201
1202 // Obsolete names
1203 //ImGuiInputTextFlags_AlwaysInsertMode = ImGuiInputTextFlags_AlwaysOverwrite // [renamed in 1.82] name was not matching behavior
1204};
1205
1206// Flags for ImGui::TreeNodeEx(), ImGui::CollapsingHeader*()
1207enum ImGuiTreeNodeFlags_
1208{
1209 ImGuiTreeNodeFlags_None = 0,
1210 ImGuiTreeNodeFlags_Selected = 1 << 0, // Draw as selected
1211 ImGuiTreeNodeFlags_Framed = 1 << 1, // Draw frame with background (e.g. for CollapsingHeader)
1212 ImGuiTreeNodeFlags_AllowOverlap = 1 << 2, // Hit testing to allow subsequent widgets to overlap this one
1213 ImGuiTreeNodeFlags_NoTreePushOnOpen = 1 << 3, // Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack
1214 ImGuiTreeNodeFlags_NoAutoOpenOnLog = 1 << 4, // Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)
1215 ImGuiTreeNodeFlags_DefaultOpen = 1 << 5, // Default node to be open
1216 ImGuiTreeNodeFlags_OpenOnDoubleClick = 1 << 6, // Need double-click to open node
1217 ImGuiTreeNodeFlags_OpenOnArrow = 1 << 7, // Only open when clicking on the arrow part. If ImGuiTreeNodeFlags_OpenOnDoubleClick is also set, single-click arrow or double-click all box to open.
1218 ImGuiTreeNodeFlags_Leaf = 1 << 8, // No collapsing, no arrow (use as a convenience for leaf nodes).
1219 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!
1220 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.
1221 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.
1222 ImGuiTreeNodeFlags_SpanFullWidth = 1 << 12, // Extend hit box to the left-most and right-most edges (cover the indent area).
1223 ImGuiTreeNodeFlags_SpanTextWidth = 1 << 13, // Narrow hit box + narrow hovering highlight, will only cover the label text.
1224 ImGuiTreeNodeFlags_SpanAllColumns = 1 << 14, // Frame will span all columns of its container table (text will still fit in current column)
1225 ImGuiTreeNodeFlags_NavLeftJumpsBackHere = 1 << 15, // (WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)
1226 //ImGuiTreeNodeFlags_NoScrollOnOpen = 1 << 16, // FIXME: TODO: Disable automatic scroll on TreePop() if node got just open and contents is not visible
1227 ImGuiTreeNodeFlags_CollapsingHeader = ImGuiTreeNodeFlags_Framed | ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_NoAutoOpenOnLog,
1228
1229#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1230 ImGuiTreeNodeFlags_AllowItemOverlap = ImGuiTreeNodeFlags_AllowOverlap, // Renamed in 1.89.7
1231#endif
1232};
1233
1234// Flags for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() functions.
1235// - To be backward compatible with older API which took an 'int mouse_button = 1' argument instead of 'ImGuiPopupFlags flags',
1236// 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.
1237// It is therefore guaranteed to be legal to pass a mouse button index in ImGuiPopupFlags.
1238// - For the same reason, we exceptionally default the ImGuiPopupFlags argument of BeginPopupContextXXX functions to 1 instead of 0.
1239// IMPORTANT: because the default parameter is 1 (==ImGuiPopupFlags_MouseButtonRight), if you rely on the default parameter
1240// and want to use another flag, you need to pass in the ImGuiPopupFlags_MouseButtonRight flag explicitly.
1241// - Multiple buttons currently cannot be combined/or-ed in those functions (we could allow it later).
1242enum ImGuiPopupFlags_
1243{
1244 ImGuiPopupFlags_None = 0,
1245 ImGuiPopupFlags_MouseButtonLeft = 0, // For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left)
1246 ImGuiPopupFlags_MouseButtonRight = 1, // For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right)
1247 ImGuiPopupFlags_MouseButtonMiddle = 2, // For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle)
1248 ImGuiPopupFlags_MouseButtonMask_ = 0x1F,
1249 ImGuiPopupFlags_MouseButtonDefault_ = 1,
1250 ImGuiPopupFlags_NoReopen = 1 << 5, // For OpenPopup*(), BeginPopupContext*(): don't reopen same popup if already open (won't reposition, won't reinitialize navigation)
1251 //ImGuiPopupFlags_NoReopenAlwaysNavInit = 1 << 6, // For OpenPopup*(), BeginPopupContext*(): focus and initialize navigation even when not reopening.
1252 ImGuiPopupFlags_NoOpenOverExistingPopup = 1 << 7, // For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack
1253 ImGuiPopupFlags_NoOpenOverItems = 1 << 8, // For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space
1254 ImGuiPopupFlags_AnyPopupId = 1 << 10, // For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.
1255 ImGuiPopupFlags_AnyPopupLevel = 1 << 11, // For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)
1256 ImGuiPopupFlags_AnyPopup = ImGuiPopupFlags_AnyPopupId | ImGuiPopupFlags_AnyPopupLevel,
1257};
1258
1259// Flags for ImGui::Selectable()
1260enum ImGuiSelectableFlags_
1261{
1262 ImGuiSelectableFlags_None = 0,
1263 ImGuiSelectableFlags_NoAutoClosePopups = 1 << 0, // Clicking this doesn't close parent popup window (overrides ImGuiItemFlags_AutoClosePopups)
1264 ImGuiSelectableFlags_SpanAllColumns = 1 << 1, // Frame will span all columns of its container table (text will still fit in current column)
1265 ImGuiSelectableFlags_AllowDoubleClick = 1 << 2, // Generate press events on double clicks too
1266 ImGuiSelectableFlags_Disabled = 1 << 3, // Cannot be selected, display grayed out text
1267 ImGuiSelectableFlags_AllowOverlap = 1 << 4, // (WIP) Hit testing to allow subsequent widgets to overlap this one
1268
1269#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1270 ImGuiSelectableFlags_DontClosePopups = ImGuiSelectableFlags_NoAutoClosePopups, // Renamed in 1.91.0
1271 ImGuiSelectableFlags_AllowItemOverlap = ImGuiSelectableFlags_AllowOverlap, // Renamed in 1.89.7
1272#endif
1273};
1274
1275// Flags for ImGui::BeginCombo()
1276enum ImGuiComboFlags_
1277{
1278 ImGuiComboFlags_None = 0,
1279 ImGuiComboFlags_PopupAlignLeft = 1 << 0, // Align the popup toward the left by default
1280 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()
1281 ImGuiComboFlags_HeightRegular = 1 << 2, // Max ~8 items visible (default)
1282 ImGuiComboFlags_HeightLarge = 1 << 3, // Max ~20 items visible
1283 ImGuiComboFlags_HeightLargest = 1 << 4, // As many fitting items as possible
1284 ImGuiComboFlags_NoArrowButton = 1 << 5, // Display on the preview box without the square arrow button
1285 ImGuiComboFlags_NoPreview = 1 << 6, // Display only a square arrow button
1286 ImGuiComboFlags_WidthFitPreview = 1 << 7, // Width dynamically calculated from preview contents
1287 ImGuiComboFlags_HeightMask_ = ImGuiComboFlags_HeightSmall | ImGuiComboFlags_HeightRegular | ImGuiComboFlags_HeightLarge | ImGuiComboFlags_HeightLargest,
1288};
1289
1290// Flags for ImGui::BeginTabBar()
1291enum ImGuiTabBarFlags_
1292{
1293 ImGuiTabBarFlags_None = 0,
1294 ImGuiTabBarFlags_Reorderable = 1 << 0, // Allow manually dragging tabs to re-order them + New tabs are appended at the end of list
1295 ImGuiTabBarFlags_AutoSelectNewTabs = 1 << 1, // Automatically select new tabs when they appear
1296 ImGuiTabBarFlags_TabListPopupButton = 1 << 2, // Disable buttons to open the tab list popup
1297 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.
1298 ImGuiTabBarFlags_NoTabListScrollingButtons = 1 << 4, // Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)
1299 ImGuiTabBarFlags_NoTooltip = 1 << 5, // Disable tooltips when hovering a tab
1300 ImGuiTabBarFlags_DrawSelectedOverline = 1 << 6, // Draw selected overline markers over selected tab
1301 ImGuiTabBarFlags_FittingPolicyResizeDown = 1 << 7, // Resize tabs when they don't fit
1302 ImGuiTabBarFlags_FittingPolicyScroll = 1 << 8, // Add scroll buttons when tabs don't fit
1303 ImGuiTabBarFlags_FittingPolicyMask_ = ImGuiTabBarFlags_FittingPolicyResizeDown | ImGuiTabBarFlags_FittingPolicyScroll,
1304 ImGuiTabBarFlags_FittingPolicyDefault_ = ImGuiTabBarFlags_FittingPolicyResizeDown,
1305};
1306
1307// Flags for ImGui::BeginTabItem()
1308enum ImGuiTabItemFlags_
1309{
1310 ImGuiTabItemFlags_None = 0,
1311 ImGuiTabItemFlags_UnsavedDocument = 1 << 0, // Display a dot next to the title + set ImGuiTabItemFlags_NoAssumedClosure.
1312 ImGuiTabItemFlags_SetSelected = 1 << 1, // Trigger flag to programmatically make the tab selected when calling BeginTabItem()
1313 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.
1314 ImGuiTabItemFlags_NoPushId = 1 << 3, // Don't call PushID()/PopID() on BeginTabItem()/EndTabItem()
1315 ImGuiTabItemFlags_NoTooltip = 1 << 4, // Disable tooltip for the given tab
1316 ImGuiTabItemFlags_NoReorder = 1 << 5, // Disable reordering this tab or having another tab cross over this tab
1317 ImGuiTabItemFlags_Leading = 1 << 6, // Enforce the tab position to the left of the tab bar (after the tab list popup button)
1318 ImGuiTabItemFlags_Trailing = 1 << 7, // Enforce the tab position to the right of the tab bar (before the scrolling buttons)
1319 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.
1320};
1321
1322// Flags for ImGui::IsWindowFocused()
1323enum ImGuiFocusedFlags_
1324{
1325 ImGuiFocusedFlags_None = 0,
1326 ImGuiFocusedFlags_ChildWindows = 1 << 0, // Return true if any children of the window is focused
1327 ImGuiFocusedFlags_RootWindow = 1 << 1, // Test from root window (top most parent of the current hierarchy)
1328 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!
1329 ImGuiFocusedFlags_NoPopupHierarchy = 1 << 3, // Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow)
1330 ImGuiFocusedFlags_DockHierarchy = 1 << 4, // Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow)
1331 ImGuiFocusedFlags_RootAndChildWindows = ImGuiFocusedFlags_RootWindow | ImGuiFocusedFlags_ChildWindows,
1332};
1333
1334// Flags for ImGui::IsItemHovered(), ImGui::IsWindowHovered()
1335// 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!
1336// Note: windows with the ImGuiWindowFlags_NoInputs flag are ignored by IsWindowHovered() calls.
1337enum ImGuiHoveredFlags_
1338{
1339 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.
1340 ImGuiHoveredFlags_ChildWindows = 1 << 0, // IsWindowHovered() only: Return true if any children of the window is hovered
1341 ImGuiHoveredFlags_RootWindow = 1 << 1, // IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)
1342 ImGuiHoveredFlags_AnyWindow = 1 << 2, // IsWindowHovered() only: Return true if any window is hovered
1343 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)
1344 ImGuiHoveredFlags_DockHierarchy = 1 << 4, // IsWindowHovered() only: Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow)
1345 ImGuiHoveredFlags_AllowWhenBlockedByPopup = 1 << 5, // Return true even if a popup window is normally blocking access to this item/window
1346 //ImGuiHoveredFlags_AllowWhenBlockedByModal = 1 << 6, // Return true even if a modal popup window is normally blocking access to this item/window. FIXME-TODO: Unavailable yet.
1347 ImGuiHoveredFlags_AllowWhenBlockedByActiveItem = 1 << 7, // Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
1348 ImGuiHoveredFlags_AllowWhenOverlappedByItem = 1 << 8, // IsItemHovered() only: Return true even if the item uses AllowOverlap mode and is overlapped by another hoverable item.
1349 ImGuiHoveredFlags_AllowWhenOverlappedByWindow = 1 << 9, // IsItemHovered() only: Return true even if the position is obstructed or overlapped by another window.
1350 ImGuiHoveredFlags_AllowWhenDisabled = 1 << 10, // IsItemHovered() only: Return true even if the item is disabled
1351 ImGuiHoveredFlags_NoNavOverride = 1 << 11, // IsItemHovered() only: Disable using gamepad/keyboard navigation state when active, always query mouse
1352 ImGuiHoveredFlags_AllowWhenOverlapped = ImGuiHoveredFlags_AllowWhenOverlappedByItem | ImGuiHoveredFlags_AllowWhenOverlappedByWindow,
1353 ImGuiHoveredFlags_RectOnly = ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenOverlapped,
1354 ImGuiHoveredFlags_RootAndChildWindows = ImGuiHoveredFlags_RootWindow | ImGuiHoveredFlags_ChildWindows,
1355
1356 // Tooltips mode
1357 // - typically used in IsItemHovered() + SetTooltip() sequence.
1358 // - this is a shortcut to pull flags from 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav' where you can reconfigure desired behavior.
1359 // e.g. 'TooltipHoveredFlagsForMouse' defaults to 'ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort'.
1360 // - 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.
1361 // - 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.
1362 ImGuiHoveredFlags_ForTooltip = 1 << 12, // Shortcut for standard flags when using IsItemHovered() + SetTooltip() sequence.
1363
1364 // (Advanced) Mouse Hovering delays.
1365 // - generally you can use ImGuiHoveredFlags_ForTooltip to use application-standardized flags.
1366 // - use those if you need specific overrides.
1367 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.
1368 ImGuiHoveredFlags_DelayNone = 1 << 14, // IsItemHovered() only: Return true immediately (default). As this is the default you generally ignore this.
1369 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).
1370 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).
1371 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)
1372};
1373
1374// Flags for ImGui::DockSpace(), shared/inherited by child nodes.
1375// (Some flags can be applied to individual nodes directly)
1376// FIXME-DOCK: Also see ImGuiDockNodeFlagsPrivate_ which may involve using the WIP and internal DockBuilder api.
1377enum ImGuiDockNodeFlags_
1378{
1379 ImGuiDockNodeFlags_None = 0,
1380 ImGuiDockNodeFlags_KeepAliveOnly = 1 << 0, // // Don't display the dockspace node but keep it alive. Windows docked into this dockspace node won't be undocked.
1381 //ImGuiDockNodeFlags_NoCentralNode = 1 << 1, // // Disable Central Node (the node which can stay empty)
1382 ImGuiDockNodeFlags_NoDockingOverCentralNode = 1 << 2, // // Disable docking over the Central Node, which will be always kept empty.
1383 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.
1384 ImGuiDockNodeFlags_NoDockingSplit = 1 << 4, // // Disable other windows/nodes from splitting this node.
1385 ImGuiDockNodeFlags_NoResize = 1 << 5, // Saved // Disable resizing node using the splitter/separators. Useful with programmatically setup dockspaces.
1386 ImGuiDockNodeFlags_AutoHideTabBar = 1 << 6, // // Tab bar will automatically hide when there is a single window in the dock node.
1387 ImGuiDockNodeFlags_NoUndocking = 1 << 7, // // Disable undocking this node.
1388
1389#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1390 ImGuiDockNodeFlags_NoSplit = ImGuiDockNodeFlags_NoDockingSplit, // Renamed in 1.90
1391 ImGuiDockNodeFlags_NoDockingInCentralNode = ImGuiDockNodeFlags_NoDockingOverCentralNode, // Renamed in 1.90
1392#endif
1393};
1394
1395// Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload()
1396enum ImGuiDragDropFlags_
1397{
1398 ImGuiDragDropFlags_None = 0,
1399 // BeginDragDropSource() flags
1400 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.
1401 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.
1402 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.
1403 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.
1404 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.
1405 ImGuiDragDropFlags_PayloadAutoExpire = 1 << 5, // Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
1406 ImGuiDragDropFlags_PayloadNoCrossContext = 1 << 6, // Hint to specify that the payload may not be copied outside current dear imgui context.
1407 ImGuiDragDropFlags_PayloadNoCrossProcess = 1 << 7, // Hint to specify that the payload may not be copied outside current process.
1408 // AcceptDragDropPayload() flags
1409 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.
1410 ImGuiDragDropFlags_AcceptNoDrawDefaultRect = 1 << 11, // Do not draw the default highlight rectangle when hovering over target.
1411 ImGuiDragDropFlags_AcceptNoPreviewTooltip = 1 << 12, // Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
1412 ImGuiDragDropFlags_AcceptPeekOnly = ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoDrawDefaultRect, // For peeking ahead and inspecting the payload before delivery.
1413
1414#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1415 ImGuiDragDropFlags_SourceAutoExpirePayload = ImGuiDragDropFlags_PayloadAutoExpire, // Renamed in 1.90.9
1416#endif
1417};
1418
1419// Standard Drag and Drop payload types. You can define you own payload types using short strings. Types starting with '_' are defined by Dear ImGui.
1420#define IMGUI_PAYLOAD_TYPE_COLOR_3F "_COL3F" // float[3]: Standard type for colors, without alpha. User code may use this type.
1421#define IMGUI_PAYLOAD_TYPE_COLOR_4F "_COL4F" // float[4]: Standard type for colors. User code may use this type.
1422
1423// A primary data type
1424enum ImGuiDataType_
1425{
1426 ImGuiDataType_S8, // signed char / char (with sensible compilers)
1427 ImGuiDataType_U8, // unsigned char
1428 ImGuiDataType_S16, // short
1429 ImGuiDataType_U16, // unsigned short
1430 ImGuiDataType_S32, // int
1431 ImGuiDataType_U32, // unsigned int
1432 ImGuiDataType_S64, // long long / __int64
1433 ImGuiDataType_U64, // unsigned long long / unsigned __int64
1434 ImGuiDataType_Float, // float
1435 ImGuiDataType_Double, // double
1436 ImGuiDataType_Bool, // bool (provided for user convenience, not supported by scalar widgets)
1437 ImGuiDataType_COUNT
1438};
1439
1440// A cardinal direction
1441enum ImGuiDir : int
1442{
1443 ImGuiDir_None = -1,
1444 ImGuiDir_Left = 0,
1445 ImGuiDir_Right = 1,
1446 ImGuiDir_Up = 2,
1447 ImGuiDir_Down = 3,
1448 ImGuiDir_COUNT
1449};
1450
1451// A sorting direction
1452enum ImGuiSortDirection : ImU8
1453{
1454 ImGuiSortDirection_None = 0,
1455 ImGuiSortDirection_Ascending = 1, // Ascending = 0->9, A->Z etc.
1456 ImGuiSortDirection_Descending = 2 // Descending = 9->0, Z->A etc.
1457};
1458
1459// Since 1.90, defining IMGUI_DISABLE_OBSOLETE_FUNCTIONS automatically defines IMGUI_DISABLE_OBSOLETE_KEYIO as well.
1460#if defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS) && !defined(IMGUI_DISABLE_OBSOLETE_KEYIO)
1461#define IMGUI_DISABLE_OBSOLETE_KEYIO
1462#endif
1463
1464// A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value): can represent Keyboard, Mouse and Gamepad values.
1465// All our named keys are >= 512. Keys value 0 to 511 are left unused as legacy native/opaque key values (< 1.87).
1466// Since >= 1.89 we increased typing (went from int to enum), some legacy code may need a cast to ImGuiKey.
1467// Read details about the 1.87 and 1.89 transition : https://github.com/ocornut/imgui/issues/4921
1468// Note that "Keys" related to physical keys and are not the same concept as input "Characters", the later are submitted via io.AddInputCharacter().
1469// 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.
1470enum ImGuiKey : int
1471{
1472 // Keyboard
1473 ImGuiKey_None = 0,
1474 ImGuiKey_Tab = 512, // == ImGuiKey_NamedKey_BEGIN
1475 ImGuiKey_LeftArrow,
1476 ImGuiKey_RightArrow,
1477 ImGuiKey_UpArrow,
1478 ImGuiKey_DownArrow,
1479 ImGuiKey_PageUp,
1480 ImGuiKey_PageDown,
1481 ImGuiKey_Home,
1482 ImGuiKey_End,
1483 ImGuiKey_Insert,
1484 ImGuiKey_Delete,
1485 ImGuiKey_Backspace,
1486 ImGuiKey_Space,
1487 ImGuiKey_Enter,
1488 ImGuiKey_Escape,
1489 ImGuiKey_LeftCtrl, ImGuiKey_LeftShift, ImGuiKey_LeftAlt, ImGuiKey_LeftSuper,
1490 ImGuiKey_RightCtrl, ImGuiKey_RightShift, ImGuiKey_RightAlt, ImGuiKey_RightSuper,
1491 ImGuiKey_Menu,
1492 ImGuiKey_0, ImGuiKey_1, ImGuiKey_2, ImGuiKey_3, ImGuiKey_4, ImGuiKey_5, ImGuiKey_6, ImGuiKey_7, ImGuiKey_8, ImGuiKey_9,
1493 ImGuiKey_A, ImGuiKey_B, ImGuiKey_C, ImGuiKey_D, ImGuiKey_E, ImGuiKey_F, ImGuiKey_G, ImGuiKey_H, ImGuiKey_I, ImGuiKey_J,
1494 ImGuiKey_K, ImGuiKey_L, ImGuiKey_M, ImGuiKey_N, ImGuiKey_O, ImGuiKey_P, ImGuiKey_Q, ImGuiKey_R, ImGuiKey_S, ImGuiKey_T,
1495 ImGuiKey_U, ImGuiKey_V, ImGuiKey_W, ImGuiKey_X, ImGuiKey_Y, ImGuiKey_Z,
1496 ImGuiKey_F1, ImGuiKey_F2, ImGuiKey_F3, ImGuiKey_F4, ImGuiKey_F5, ImGuiKey_F6,
1497 ImGuiKey_F7, ImGuiKey_F8, ImGuiKey_F9, ImGuiKey_F10, ImGuiKey_F11, ImGuiKey_F12,
1498 ImGuiKey_F13, ImGuiKey_F14, ImGuiKey_F15, ImGuiKey_F16, ImGuiKey_F17, ImGuiKey_F18,
1499 ImGuiKey_F19, ImGuiKey_F20, ImGuiKey_F21, ImGuiKey_F22, ImGuiKey_F23, ImGuiKey_F24,
1500 ImGuiKey_Apostrophe, // '
1501 ImGuiKey_Comma, // ,
1502 ImGuiKey_Minus, // -
1503 ImGuiKey_Period, // .
1504 ImGuiKey_Slash, // /
1505 ImGuiKey_Semicolon, // ;
1506 ImGuiKey_Equal, // =
1507 ImGuiKey_LeftBracket, // [
1508 ImGuiKey_Backslash, // \ (this text inhibit multiline comment caused by backslash)
1509 ImGuiKey_RightBracket, // ]
1510 ImGuiKey_GraveAccent, // `
1511 ImGuiKey_CapsLock,
1512 ImGuiKey_ScrollLock,
1513 ImGuiKey_NumLock,
1514 ImGuiKey_PrintScreen,
1515 ImGuiKey_Pause,
1516 ImGuiKey_Keypad0, ImGuiKey_Keypad1, ImGuiKey_Keypad2, ImGuiKey_Keypad3, ImGuiKey_Keypad4,
1517 ImGuiKey_Keypad5, ImGuiKey_Keypad6, ImGuiKey_Keypad7, ImGuiKey_Keypad8, ImGuiKey_Keypad9,
1518 ImGuiKey_KeypadDecimal,
1519 ImGuiKey_KeypadDivide,
1520 ImGuiKey_KeypadMultiply,
1521 ImGuiKey_KeypadSubtract,
1522 ImGuiKey_KeypadAdd,
1523 ImGuiKey_KeypadEnter,
1524 ImGuiKey_KeypadEqual,
1525 ImGuiKey_AppBack, // Available on some keyboard/mouses. Often referred as "Browser Back"
1526 ImGuiKey_AppForward,
1527
1528 // Gamepad (some of those are analog values, 0.0f to 1.0f) // NAVIGATION ACTION
1529 // (download controller mapping PNG/PSD at http://dearimgui.com/controls_sheets)
1530 ImGuiKey_GamepadStart, // Menu (Xbox) + (Switch) Start/Options (PS)
1531 ImGuiKey_GamepadBack, // View (Xbox) - (Switch) Share (PS)
1532 ImGuiKey_GamepadFaceLeft, // X (Xbox) Y (Switch) Square (PS) // Tap: Toggle Menu. Hold: Windowing mode (Focus/Move/Resize windows)
1533 ImGuiKey_GamepadFaceRight, // B (Xbox) A (Switch) Circle (PS) // Cancel / Close / Exit
1534 ImGuiKey_GamepadFaceUp, // Y (Xbox) X (Switch) Triangle (PS) // Text Input / On-screen Keyboard
1535 ImGuiKey_GamepadFaceDown, // A (Xbox) B (Switch) Cross (PS) // Activate / Open / Toggle / Tweak
1536 ImGuiKey_GamepadDpadLeft, // D-pad Left // Move / Tweak / Resize Window (in Windowing mode)
1537 ImGuiKey_GamepadDpadRight, // D-pad Right // Move / Tweak / Resize Window (in Windowing mode)
1538 ImGuiKey_GamepadDpadUp, // D-pad Up // Move / Tweak / Resize Window (in Windowing mode)
1539 ImGuiKey_GamepadDpadDown, // D-pad Down // Move / Tweak / Resize Window (in Windowing mode)
1540 ImGuiKey_GamepadL1, // L Bumper (Xbox) L (Switch) L1 (PS) // Tweak Slower / Focus Previous (in Windowing mode)
1541 ImGuiKey_GamepadR1, // R Bumper (Xbox) R (Switch) R1 (PS) // Tweak Faster / Focus Next (in Windowing mode)
1542 ImGuiKey_GamepadL2, // L Trig. (Xbox) ZL (Switch) L2 (PS) [Analog]
1543 ImGuiKey_GamepadR2, // R Trig. (Xbox) ZR (Switch) R2 (PS) [Analog]
1544 ImGuiKey_GamepadL3, // L Stick (Xbox) L3 (Switch) L3 (PS)
1545 ImGuiKey_GamepadR3, // R Stick (Xbox) R3 (Switch) R3 (PS)
1546 ImGuiKey_GamepadLStickLeft, // [Analog] // Move Window (in Windowing mode)
1547 ImGuiKey_GamepadLStickRight, // [Analog] // Move Window (in Windowing mode)
1548 ImGuiKey_GamepadLStickUp, // [Analog] // Move Window (in Windowing mode)
1549 ImGuiKey_GamepadLStickDown, // [Analog] // Move Window (in Windowing mode)
1550 ImGuiKey_GamepadRStickLeft, // [Analog]
1551 ImGuiKey_GamepadRStickRight, // [Analog]
1552 ImGuiKey_GamepadRStickUp, // [Analog]
1553 ImGuiKey_GamepadRStickDown, // [Analog]
1554
1555 // Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls)
1556 // - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
1557 ImGuiKey_MouseLeft, ImGuiKey_MouseRight, ImGuiKey_MouseMiddle, ImGuiKey_MouseX1, ImGuiKey_MouseX2, ImGuiKey_MouseWheelX, ImGuiKey_MouseWheelY,
1558
1559 // [Internal] Reserved for mod storage
1560 ImGuiKey_ReservedForModCtrl, ImGuiKey_ReservedForModShift, ImGuiKey_ReservedForModAlt, ImGuiKey_ReservedForModSuper,
1561 ImGuiKey_COUNT,
1562
1563 // Keyboard Modifiers (explicitly submitted by backend via AddKeyEvent() calls)
1564 // - This is mirroring the data also written to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper, in a format allowing
1565 // them to be accessed via standard key API, allowing calls such as IsKeyPressed(), IsKeyReleased(), querying duration etc.
1566 // - Code polling every key (e.g. an interface to detect a key press for input mapping) might want to ignore those
1567 // and prefer using the real keys (e.g. ImGuiKey_LeftCtrl, ImGuiKey_RightCtrl instead of ImGuiMod_Ctrl).
1568 // - In theory the value of keyboard modifiers should be roughly equivalent to a logical or of the equivalent left/right keys.
1569 // In practice: it's complicated; mods are often provided from different sources. Keyboard layout, IME, sticky keys and
1570 // backends tend to interfere and break that equivalence. The safer decision is to relay that ambiguity down to the end-user...
1571 // - On macOS, we swap Cmd(Super) and Ctrl keys at the time of the io.AddKeyEvent() call.
1572 ImGuiMod_None = 0,
1573 ImGuiMod_Ctrl = 1 << 12, // Ctrl (non-macOS), Cmd (macOS)
1574 ImGuiMod_Shift = 1 << 13, // Shift
1575 ImGuiMod_Alt = 1 << 14, // Option/Menu
1576 ImGuiMod_Super = 1 << 15, // Windows/Super (non-macOS), Ctrl (macOS)
1577 ImGuiMod_Mask_ = 0xF000, // 4-bits
1578
1579 // [Internal] Prior to 1.87 we required user to fill io.KeysDown[512] using their own native index + the io.KeyMap[] array.
1580 // We are ditching this method but keeping a legacy path for user code doing e.g. IsKeyPressed(MY_NATIVE_KEY_CODE)
1581 // If you need to iterate all keys (for e.g. an input mapper) you may use ImGuiKey_NamedKey_BEGIN..ImGuiKey_NamedKey_END.
1582 ImGuiKey_NamedKey_BEGIN = 512,
1583 ImGuiKey_NamedKey_END = ImGuiKey_COUNT,
1584 ImGuiKey_NamedKey_COUNT = ImGuiKey_NamedKey_END - ImGuiKey_NamedKey_BEGIN,
1585#ifdef IMGUI_DISABLE_OBSOLETE_KEYIO
1586 ImGuiKey_KeysData_SIZE = ImGuiKey_NamedKey_COUNT, // Size of KeysData[]: only hold named keys
1587 ImGuiKey_KeysData_OFFSET = ImGuiKey_NamedKey_BEGIN, // Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET) index.
1588#else
1589 ImGuiKey_KeysData_SIZE = ImGuiKey_COUNT, // Size of KeysData[]: hold legacy 0..512 keycodes + named keys
1590 ImGuiKey_KeysData_OFFSET = 0, // Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET) index.
1591#endif
1592
1593#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1594 ImGuiMod_Shortcut = ImGuiMod_Ctrl, // Removed in 1.90.7, you can now simply use ImGuiMod_Ctrl
1595 ImGuiKey_ModCtrl = ImGuiMod_Ctrl, ImGuiKey_ModShift = ImGuiMod_Shift, ImGuiKey_ModAlt = ImGuiMod_Alt, ImGuiKey_ModSuper = ImGuiMod_Super, // Renamed in 1.89
1596 //ImGuiKey_KeyPadEnter = ImGuiKey_KeypadEnter, // Renamed in 1.87
1597#endif
1598};
1599
1600// Flags for Shortcut(), SetNextItemShortcut(),
1601// (and for upcoming extended versions of IsKeyPressed(), IsMouseClicked(), Shortcut(), SetKeyOwner(), SetItemKeyOwner() that are still in imgui_internal.h)
1602// Don't mistake with ImGuiInputTextFlags! (which is for ImGui::InputText() function)
1603enum ImGuiInputFlags_
1604{
1605 ImGuiInputFlags_None = 0,
1606 ImGuiInputFlags_Repeat = 1 << 0, // Enable repeat. Return true on successive repeats. Default for legacy IsKeyPressed(). NOT Default for legacy IsMouseClicked(). MUST BE == 1.
1607
1608 // Flags for Shortcut(), SetNextItemShortcut()
1609 // - Routing policies: RouteGlobal+OverActive >> RouteActive or RouteFocused (if owner is active item) >> RouteGlobal+OverFocused >> RouteFocused (if in focused window stack) >> RouteGlobal.
1610 // - Default policy is RouteFocused. Can select only 1 policy among all available.
1611 ImGuiInputFlags_RouteActive = 1 << 10, // Route to active item only.
1612 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.
1613 ImGuiInputFlags_RouteGlobal = 1 << 12, // Global route (unless a focused window or active item registered the route).
1614 ImGuiInputFlags_RouteAlways = 1 << 13, // Do not register route, poll keys directly.
1615 // - Routing options
1616 ImGuiInputFlags_RouteOverFocused = 1 << 14, // Option: global route: higher priority than focused route (unless active item in focused route).
1617 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.
1618 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.
1619 ImGuiInputFlags_RouteFromRootWindow = 1 << 17, // Option: route evaluated from the point of view of root window rather than current window.
1620
1621 // Flags for SetNextItemShortcut()
1622 ImGuiInputFlags_Tooltip = 1 << 18, // Automatically display a tooltip when hovering item [BETA] Unsure of right api (opt-in/opt-out)
1623};
1624
1625#ifndef IMGUI_DISABLE_OBSOLETE_KEYIO
1626// OBSOLETED in 1.88 (from July 2022): ImGuiNavInput and io.NavInputs[].
1627// 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.
1628// Custom backends: feed gamepad inputs via io.AddKeyEvent() and ImGuiKey_GamepadXXX enums.
1629enum ImGuiNavInput
1630{
1631 ImGuiNavInput_Activate, ImGuiNavInput_Cancel, ImGuiNavInput_Input, ImGuiNavInput_Menu, ImGuiNavInput_DpadLeft, ImGuiNavInput_DpadRight, ImGuiNavInput_DpadUp, ImGuiNavInput_DpadDown,
1632 ImGuiNavInput_LStickLeft, ImGuiNavInput_LStickRight, ImGuiNavInput_LStickUp, ImGuiNavInput_LStickDown, ImGuiNavInput_FocusPrev, ImGuiNavInput_FocusNext, ImGuiNavInput_TweakSlow, ImGuiNavInput_TweakFast,
1633 ImGuiNavInput_COUNT,
1634};
1635#endif
1636
1637// Configuration flags stored in io.ConfigFlags. Set by user/application.
1638enum ImGuiConfigFlags_
1639{
1640 ImGuiConfigFlags_None = 0,
1641 ImGuiConfigFlags_NavEnableKeyboard = 1 << 0, // Master keyboard navigation enable flag. Enable full Tabbing + directional arrows + space/enter to activate.
1642 ImGuiConfigFlags_NavEnableGamepad = 1 << 1, // Master gamepad navigation enable flag. Backend also needs to set ImGuiBackendFlags_HasGamepad.
1643 ImGuiConfigFlags_NavEnableSetMousePos = 1 << 2, // Instruct navigation to move the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is awkward. Will update io.MousePos and set io.WantSetMousePos=true. If enabled you MUST honor io.WantSetMousePos requests in your backend, otherwise ImGui will react as if the mouse is jumping around back and forth.
1644 ImGuiConfigFlags_NavNoCaptureKeyboard = 1 << 3, // Instruct navigation to not set the io.WantCaptureKeyboard flag when io.NavActive is set.
1645 ImGuiConfigFlags_NoMouse = 1 << 4, // Instruct dear imgui to disable mouse inputs and interactions.
1646 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.
1647 ImGuiConfigFlags_NoKeyboard = 1 << 6, // Instruct dear imgui to disable keyboard inputs and interactions. This is done by ignoring keyboard events and clearing existing states.
1648
1649 // [BETA] Docking
1650 ImGuiConfigFlags_DockingEnable = 1 << 7, // Docking enable flags.
1651
1652 // [BETA] Viewports
1653 // 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.
1654 ImGuiConfigFlags_ViewportsEnable = 1 << 10, // Viewport enable flags (require both ImGuiBackendFlags_PlatformHasViewports + ImGuiBackendFlags_RendererHasViewports set by the respective backends)
1655 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.
1656 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.
1657
1658 // 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)
1659 ImGuiConfigFlags_IsSRGB = 1 << 20, // Application is SRGB-aware.
1660 ImGuiConfigFlags_IsTouchScreen = 1 << 21, // Application is using a touch screen instead of a mouse.
1661};
1662
1663// Backend capabilities flags stored in io.BackendFlags. Set by imgui_impl_xxx or custom backend.
1664enum ImGuiBackendFlags_
1665{
1666 ImGuiBackendFlags_None = 0,
1667 ImGuiBackendFlags_HasGamepad = 1 << 0, // Backend Platform supports gamepad and currently has one connected.
1668 ImGuiBackendFlags_HasMouseCursors = 1 << 1, // Backend Platform supports honoring GetMouseCursor() value to change the OS cursor shape.
1669 ImGuiBackendFlags_HasSetMousePos = 1 << 2, // Backend Platform supports io.WantSetMousePos requests to reposition the OS mouse position (only used if ImGuiConfigFlags_NavEnableSetMousePos is set).
1670 ImGuiBackendFlags_RendererHasVtxOffset = 1 << 3, // Backend Renderer supports ImDrawCmd::VtxOffset. This enables output of large meshes (64K+ vertices) while still using 16-bit indices.
1671
1672 // [BETA] Viewports
1673 ImGuiBackendFlags_PlatformHasViewports = 1 << 10, // Backend Platform supports multiple viewports.
1674 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.
1675 ImGuiBackendFlags_RendererHasViewports = 1 << 12, // Backend Renderer supports multiple viewports.
1676};
1677
1678// Enumeration for PushStyleColor() / PopStyleColor()
1679enum ImGuiCol_
1680{
1681 ImGuiCol_Text,
1682 ImGuiCol_TextDisabled,
1683 ImGuiCol_WindowBg, // Background of normal windows
1684 ImGuiCol_ChildBg, // Background of child windows
1685 ImGuiCol_PopupBg, // Background of popups, menus, tooltips windows
1686 ImGuiCol_Border,
1687 ImGuiCol_BorderShadow,
1688 ImGuiCol_FrameBg, // Background of checkbox, radio button, plot, slider, text input
1689 ImGuiCol_FrameBgHovered,
1690 ImGuiCol_FrameBgActive,
1691 ImGuiCol_TitleBg, // Title bar
1692 ImGuiCol_TitleBgActive, // Title bar when focused
1693 ImGuiCol_TitleBgCollapsed, // Title bar when collapsed
1694 ImGuiCol_MenuBarBg,
1695 ImGuiCol_ScrollbarBg,
1696 ImGuiCol_ScrollbarGrab,
1697 ImGuiCol_ScrollbarGrabHovered,
1698 ImGuiCol_ScrollbarGrabActive,
1699 ImGuiCol_CheckMark, // Checkbox tick and RadioButton circle
1700 ImGuiCol_SliderGrab,
1701 ImGuiCol_SliderGrabActive,
1702 ImGuiCol_Button,
1703 ImGuiCol_ButtonHovered,
1704 ImGuiCol_ButtonActive,
1705 ImGuiCol_Header, // Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem
1706 ImGuiCol_HeaderHovered,
1707 ImGuiCol_HeaderActive,
1708 ImGuiCol_Separator,
1709 ImGuiCol_SeparatorHovered,
1710 ImGuiCol_SeparatorActive,
1711 ImGuiCol_ResizeGrip, // Resize grip in lower-right and lower-left corners of windows.
1712 ImGuiCol_ResizeGripHovered,
1713 ImGuiCol_ResizeGripActive,
1714 ImGuiCol_TabHovered, // Tab background, when hovered
1715 ImGuiCol_Tab, // Tab background, when tab-bar is focused & tab is unselected
1716 ImGuiCol_TabSelected, // Tab background, when tab-bar is focused & tab is selected
1717 ImGuiCol_TabSelectedOverline, // Tab horizontal overline, when tab-bar is focused & tab is selected
1718 ImGuiCol_TabDimmed, // Tab background, when tab-bar is unfocused & tab is unselected
1719 ImGuiCol_TabDimmedSelected, // Tab background, when tab-bar is unfocused & tab is selected
1720 ImGuiCol_TabDimmedSelectedOverline,//..horizontal overline, when tab-bar is unfocused & tab is selected
1721 ImGuiCol_DockingPreview, // Preview overlay color when about to docking something
1722 ImGuiCol_DockingEmptyBg, // Background color for empty node (e.g. CentralNode with no window docked into it)
1723 ImGuiCol_PlotLines,
1724 ImGuiCol_PlotLinesHovered,
1725 ImGuiCol_PlotHistogram,
1726 ImGuiCol_PlotHistogramHovered,
1727 ImGuiCol_TableHeaderBg, // Table header background
1728 ImGuiCol_TableBorderStrong, // Table outer and header borders (prefer using Alpha=1.0 here)
1729 ImGuiCol_TableBorderLight, // Table inner borders (prefer using Alpha=1.0 here)
1730 ImGuiCol_TableRowBg, // Table row background (even rows)
1731 ImGuiCol_TableRowBgAlt, // Table row background (odd rows)
1732 ImGuiCol_TextLink, // Hyperlink color
1733 ImGuiCol_TextSelectedBg,
1734 ImGuiCol_DragDropTarget, // Rectangle highlighting a drop target
1735 ImGuiCol_NavHighlight, // Gamepad/keyboard: current highlighted item
1736 ImGuiCol_NavWindowingHighlight, // Highlight window when using CTRL+TAB
1737 ImGuiCol_NavWindowingDimBg, // Darken/colorize entire screen behind the CTRL+TAB window list, when active
1738 ImGuiCol_ModalWindowDimBg, // Darken/colorize entire screen behind a modal window, when one is active
1739 ImGuiCol_COUNT,
1740
1741#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1742 ImGuiCol_TabActive = ImGuiCol_TabSelected, // [renamed in 1.90.9]
1743 ImGuiCol_TabUnfocused = ImGuiCol_TabDimmed, // [renamed in 1.90.9]
1744 ImGuiCol_TabUnfocusedActive = ImGuiCol_TabDimmedSelected, // [renamed in 1.90.9]
1745#endif
1746};
1747
1748// Enumeration for PushStyleVar() / PopStyleVar() to temporarily modify the ImGuiStyle structure.
1749// - The enum only refers to fields of ImGuiStyle which makes sense to be pushed/popped inside UI code.
1750// During initialization or between frames, feel free to just poke into ImGuiStyle directly.
1751// - Tip: Use your programming IDE navigation facilities on the names in the _second column_ below to find the actual members and their description.
1752// - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
1753// - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
1754// - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
1755// - 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.
1756enum ImGuiStyleVar_
1757{
1758 // Enum name -------------------------- // Member in ImGuiStyle structure (see ImGuiStyle for descriptions)
1759 ImGuiStyleVar_Alpha, // float Alpha
1760 ImGuiStyleVar_DisabledAlpha, // float DisabledAlpha
1761 ImGuiStyleVar_WindowPadding, // ImVec2 WindowPadding
1762 ImGuiStyleVar_WindowRounding, // float WindowRounding
1763 ImGuiStyleVar_WindowBorderSize, // float WindowBorderSize
1764 ImGuiStyleVar_WindowMinSize, // ImVec2 WindowMinSize
1765 ImGuiStyleVar_WindowTitleAlign, // ImVec2 WindowTitleAlign
1766 ImGuiStyleVar_ChildRounding, // float ChildRounding
1767 ImGuiStyleVar_ChildBorderSize, // float ChildBorderSize
1768 ImGuiStyleVar_PopupRounding, // float PopupRounding
1769 ImGuiStyleVar_PopupBorderSize, // float PopupBorderSize
1770 ImGuiStyleVar_FramePadding, // ImVec2 FramePadding
1771 ImGuiStyleVar_FrameRounding, // float FrameRounding
1772 ImGuiStyleVar_FrameBorderSize, // float FrameBorderSize
1773 ImGuiStyleVar_ItemSpacing, // ImVec2 ItemSpacing
1774 ImGuiStyleVar_ItemInnerSpacing, // ImVec2 ItemInnerSpacing
1775 ImGuiStyleVar_IndentSpacing, // float IndentSpacing
1776 ImGuiStyleVar_CellPadding, // ImVec2 CellPadding
1777 ImGuiStyleVar_ScrollbarSize, // float ScrollbarSize
1778 ImGuiStyleVar_ScrollbarRounding, // float ScrollbarRounding
1779 ImGuiStyleVar_GrabMinSize, // float GrabMinSize
1780 ImGuiStyleVar_GrabRounding, // float GrabRounding
1781 ImGuiStyleVar_TabRounding, // float TabRounding
1782 ImGuiStyleVar_TabBorderSize, // float TabBorderSize
1783 ImGuiStyleVar_TabBarBorderSize, // float TabBarBorderSize
1784 ImGuiStyleVar_TableAngledHeadersAngle, // float TableAngledHeadersAngle
1785 ImGuiStyleVar_TableAngledHeadersTextAlign,// ImVec2 TableAngledHeadersTextAlign
1786 ImGuiStyleVar_ButtonTextAlign, // ImVec2 ButtonTextAlign
1787 ImGuiStyleVar_SelectableTextAlign, // ImVec2 SelectableTextAlign
1788 ImGuiStyleVar_SeparatorTextBorderSize, // float SeparatorTextBorderSize
1789 ImGuiStyleVar_SeparatorTextAlign, // ImVec2 SeparatorTextAlign
1790 ImGuiStyleVar_SeparatorTextPadding, // ImVec2 SeparatorTextPadding
1791 ImGuiStyleVar_DockingSeparatorSize, // float DockingSeparatorSize
1792 ImGuiStyleVar_COUNT
1793};
1794
1795// Flags for InvisibleButton() [extended in imgui_internal.h]
1796enum ImGuiButtonFlags_
1797{
1798 ImGuiButtonFlags_None = 0,
1799 ImGuiButtonFlags_MouseButtonLeft = 1 << 0, // React on left mouse button (default)
1800 ImGuiButtonFlags_MouseButtonRight = 1 << 1, // React on right mouse button
1801 ImGuiButtonFlags_MouseButtonMiddle = 1 << 2, // React on center mouse button
1802 ImGuiButtonFlags_MouseButtonMask_ = ImGuiButtonFlags_MouseButtonLeft | ImGuiButtonFlags_MouseButtonRight | ImGuiButtonFlags_MouseButtonMiddle, // [Internal]
1803 //ImGuiButtonFlags_MouseButtonDefault_ = ImGuiButtonFlags_MouseButtonLeft,
1804};
1805
1806// Flags for ColorEdit3() / ColorEdit4() / ColorPicker3() / ColorPicker4() / ColorButton()
1807enum ImGuiColorEditFlags_
1808{
1809 ImGuiColorEditFlags_None = 0,
1810 ImGuiColorEditFlags_NoAlpha = 1 << 1, // // ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer).
1811 ImGuiColorEditFlags_NoPicker = 1 << 2, // // ColorEdit: disable picker when clicking on color square.
1812 ImGuiColorEditFlags_NoOptions = 1 << 3, // // ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
1813 ImGuiColorEditFlags_NoSmallPreview = 1 << 4, // // ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs)
1814 ImGuiColorEditFlags_NoInputs = 1 << 5, // // ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square).
1815 ImGuiColorEditFlags_NoTooltip = 1 << 6, // // ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
1816 ImGuiColorEditFlags_NoLabel = 1 << 7, // // ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).
1817 ImGuiColorEditFlags_NoSidePreview = 1 << 8, // // ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead.
1818 ImGuiColorEditFlags_NoDragDrop = 1 << 9, // // ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.
1819 ImGuiColorEditFlags_NoBorder = 1 << 10, // // ColorButton: disable border (which is enforced by default)
1820
1821 // User Options (right-click on widget to change some of them).
1822 ImGuiColorEditFlags_AlphaBar = 1 << 16, // // ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
1823 ImGuiColorEditFlags_AlphaPreview = 1 << 17, // // ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.
1824 ImGuiColorEditFlags_AlphaPreviewHalf= 1 << 18, // // ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.
1825 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).
1826 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.
1827 ImGuiColorEditFlags_DisplayHSV = 1 << 21, // [Display] // "
1828 ImGuiColorEditFlags_DisplayHex = 1 << 22, // [Display] // "
1829 ImGuiColorEditFlags_Uint8 = 1 << 23, // [DataType] // ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255.
1830 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.
1831 ImGuiColorEditFlags_PickerHueBar = 1 << 25, // [Picker] // ColorPicker: bar for Hue, rectangle for Sat/Value.
1832 ImGuiColorEditFlags_PickerHueWheel = 1 << 26, // [Picker] // ColorPicker: wheel for Hue, triangle for Sat/Value.
1833 ImGuiColorEditFlags_InputRGB = 1 << 27, // [Input] // ColorEdit, ColorPicker: input and output data in RGB format.
1834 ImGuiColorEditFlags_InputHSV = 1 << 28, // [Input] // ColorEdit, ColorPicker: input and output data in HSV format.
1835
1836 // Defaults Options. You can set application defaults using SetColorEditOptions(). The intent is that you probably don't want to
1837 // override them in most of your calls. Let the user choose via the option menu and/or call SetColorEditOptions() once during startup.
1838 ImGuiColorEditFlags_DefaultOptions_ = ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_InputRGB | ImGuiColorEditFlags_PickerHueBar,
1839
1840 // [Internal] Masks
1841 ImGuiColorEditFlags_DisplayMask_ = ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_DisplayHSV | ImGuiColorEditFlags_DisplayHex,
1842 ImGuiColorEditFlags_DataTypeMask_ = ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_Float,
1843 ImGuiColorEditFlags_PickerMask_ = ImGuiColorEditFlags_PickerHueWheel | ImGuiColorEditFlags_PickerHueBar,
1844 ImGuiColorEditFlags_InputMask_ = ImGuiColorEditFlags_InputRGB | ImGuiColorEditFlags_InputHSV,
1845
1846 // Obsolete names
1847 //ImGuiColorEditFlags_RGB = ImGuiColorEditFlags_DisplayRGB, ImGuiColorEditFlags_HSV = ImGuiColorEditFlags_DisplayHSV, ImGuiColorEditFlags_HEX = ImGuiColorEditFlags_DisplayHex // [renamed in 1.69]
1848};
1849
1850// Flags for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
1851// 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.
1852// (Those are per-item flags. There are shared flags in ImGuiIO: io.ConfigDragClickToInputText)
1853enum ImGuiSliderFlags_
1854{
1855 ImGuiSliderFlags_None = 0,
1856 ImGuiSliderFlags_AlwaysClamp = 1 << 4, // Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.
1857 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.
1858 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).
1859 ImGuiSliderFlags_NoInput = 1 << 7, // Disable CTRL+Click or Enter key allowing to input text directly into the widget.
1860 ImGuiSliderFlags_WrapAround = 1 << 8, // Enable wrapping around from max to min and from min to max (only supported by DragXXX() functions for now.
1861 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.
1862
1863 // Obsolete names
1864 //ImGuiSliderFlags_ClampOnInput = ImGuiSliderFlags_AlwaysClamp, // [renamed in 1.79]
1865};
1866
1867// Identify a mouse button.
1868// Those values are guaranteed to be stable and we frequently use 0/1 directly. Named enums provided for convenience.
1869enum ImGuiMouseButton_
1870{
1871 ImGuiMouseButton_Left = 0,
1872 ImGuiMouseButton_Right = 1,
1873 ImGuiMouseButton_Middle = 2,
1874 ImGuiMouseButton_COUNT = 5
1875};
1876
1877// Enumeration for GetMouseCursor()
1878// User code may request backend to display given cursor by calling SetMouseCursor(), which is why we have some cursors that are marked unused here
1879enum ImGuiMouseCursor_
1880{
1881 ImGuiMouseCursor_None = -1,
1882 ImGuiMouseCursor_Arrow = 0,
1883 ImGuiMouseCursor_TextInput, // When hovering over InputText, etc.
1884 ImGuiMouseCursor_ResizeAll, // (Unused by Dear ImGui functions)
1885 ImGuiMouseCursor_ResizeNS, // When hovering over a horizontal border
1886 ImGuiMouseCursor_ResizeEW, // When hovering over a vertical border or a column
1887 ImGuiMouseCursor_ResizeNESW, // When hovering over the bottom-left corner of a window
1888 ImGuiMouseCursor_ResizeNWSE, // When hovering over the bottom-right corner of a window
1889 ImGuiMouseCursor_Hand, // (Unused by Dear ImGui functions. Use for e.g. hyperlinks)
1890 ImGuiMouseCursor_NotAllowed, // When hovering something with disallowed interaction. Usually a crossed circle.
1891 ImGuiMouseCursor_COUNT
1892};
1893
1894// Enumeration for AddMouseSourceEvent() actual source of Mouse Input data.
1895// Historically we use "Mouse" terminology everywhere to indicate pointer data, e.g. MousePos, IsMousePressed(), io.AddMousePosEvent()
1896// But that "Mouse" data can come from different source which occasionally may be useful for application to know about.
1897// You can submit a change of pointer type using io.AddMouseSourceEvent().
1898enum ImGuiMouseSource : int
1899{
1900 ImGuiMouseSource_Mouse = 0, // Input is coming from an actual mouse.
1901 ImGuiMouseSource_TouchScreen, // Input is coming from a touch screen (no hovering prior to initial press, less precise initial press aiming, dual-axis wheeling possible).
1902 ImGuiMouseSource_Pen, // Input is coming from a pressure/magnetic pen (often used in conjunction with high-sampling rates).
1903 ImGuiMouseSource_COUNT
1904};
1905
1906// Enumeration for ImGui::SetNextWindow***(), SetWindow***(), SetNextItem***() functions
1907// Represent a condition.
1908// 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.
1909enum ImGuiCond_
1910{
1911 ImGuiCond_None = 0, // No condition (always set the variable), same as _Always
1912 ImGuiCond_Always = 1 << 0, // No condition (always set the variable), same as _None
1913 ImGuiCond_Once = 1 << 1, // Set the variable once per runtime session (only the first call will succeed)
1914 ImGuiCond_FirstUseEver = 1 << 2, // Set the variable if the object/window has no persistently saved data (no entry in .ini file)
1915 ImGuiCond_Appearing = 1 << 3, // Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
1916};
1917
1918//-----------------------------------------------------------------------------
1919// [SECTION] Tables API flags and structures (ImGuiTableFlags, ImGuiTableColumnFlags, ImGuiTableRowFlags, ImGuiTableBgTarget, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs)
1920//-----------------------------------------------------------------------------
1921
1922// Flags for ImGui::BeginTable()
1923// - Important! Sizing policies have complex and subtle side effects, much more so than you would expect.
1924// Read comments/demos carefully + experiment with live demos to get acquainted with them.
1925// - The DEFAULT sizing policies are:
1926// - Default to ImGuiTableFlags_SizingFixedFit if ScrollX is on, or if host window has ImGuiWindowFlags_AlwaysAutoResize.
1927// - Default to ImGuiTableFlags_SizingStretchSame if ScrollX is off.
1928// - When ScrollX is off:
1929// - Table defaults to ImGuiTableFlags_SizingStretchSame -> all Columns defaults to ImGuiTableColumnFlags_WidthStretch with same weight.
1930// - Columns sizing policy allowed: Stretch (default), Fixed/Auto.
1931// - Fixed Columns (if any) will generally obtain their requested width (unless the table cannot fit them all).
1932// - Stretch Columns will share the remaining width according to their respective weight.
1933// - Mixed Fixed/Stretch columns is possible but has various side-effects on resizing behaviors.
1934// The typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns.
1935// (this is because the visible order of columns have subtle but necessary effects on how they react to manual resizing).
1936// - When ScrollX is on:
1937// - Table defaults to ImGuiTableFlags_SizingFixedFit -> all Columns defaults to ImGuiTableColumnFlags_WidthFixed
1938// - Columns sizing policy allowed: Fixed/Auto mostly.
1939// - Fixed Columns can be enlarged as needed. Table will show a horizontal scrollbar if needed.
1940// - 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.
1941// - Using Stretch columns OFTEN DOES NOT MAKE SENSE if ScrollX is on, UNLESS you have specified a value for 'inner_width' in BeginTable().
1942// 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.
1943// - Read on documentation at the top of imgui_tables.cpp for details.
1944enum ImGuiTableFlags_
1945{
1946 // Features
1947 ImGuiTableFlags_None = 0,
1948 ImGuiTableFlags_Resizable = 1 << 0, // Enable resizing columns.
1949 ImGuiTableFlags_Reorderable = 1 << 1, // Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)
1950 ImGuiTableFlags_Hideable = 1 << 2, // Enable hiding/disabling columns in context menu.
1951 ImGuiTableFlags_Sortable = 1 << 3, // Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.
1952 ImGuiTableFlags_NoSavedSettings = 1 << 4, // Disable persisting columns order, width and sort settings in the .ini file.
1953 ImGuiTableFlags_ContextMenuInBody = 1 << 5, // Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().
1954 // Decorations
1955 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)
1956 ImGuiTableFlags_BordersInnerH = 1 << 7, // Draw horizontal borders between rows.
1957 ImGuiTableFlags_BordersOuterH = 1 << 8, // Draw horizontal borders at the top and bottom.
1958 ImGuiTableFlags_BordersInnerV = 1 << 9, // Draw vertical borders between columns.
1959 ImGuiTableFlags_BordersOuterV = 1 << 10, // Draw vertical borders on the left and right sides.
1960 ImGuiTableFlags_BordersH = ImGuiTableFlags_BordersInnerH | ImGuiTableFlags_BordersOuterH, // Draw horizontal borders.
1961 ImGuiTableFlags_BordersV = ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_BordersOuterV, // Draw vertical borders.
1962 ImGuiTableFlags_BordersInner = ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_BordersInnerH, // Draw inner borders.
1963 ImGuiTableFlags_BordersOuter = ImGuiTableFlags_BordersOuterV | ImGuiTableFlags_BordersOuterH, // Draw outer borders.
1964 ImGuiTableFlags_Borders = ImGuiTableFlags_BordersInner | ImGuiTableFlags_BordersOuter, // Draw all borders.
1965 ImGuiTableFlags_NoBordersInBody = 1 << 11, // [ALPHA] Disable vertical borders in columns Body (borders will always appear in Headers). -> May move to style
1966 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
1967 // Sizing Policy (read above for defaults)
1968 ImGuiTableFlags_SizingFixedFit = 1 << 13, // Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width.
1969 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.
1970 ImGuiTableFlags_SizingStretchProp = 3 << 13, // Columns default to _WidthStretch with default weights proportional to each columns contents widths.
1971 ImGuiTableFlags_SizingStretchSame = 4 << 13, // Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn().
1972 // Sizing Extra Options
1973 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.
1974 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.
1975 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.
1976 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.
1977 // Clipping
1978 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().
1979 // Padding
1980 ImGuiTableFlags_PadOuterX = 1 << 21, // Default if BordersOuterV is on. Enable outermost padding. Generally desirable if you have headers.
1981 ImGuiTableFlags_NoPadOuterX = 1 << 22, // Default if BordersOuterV is off. Disable outermost padding.
1982 ImGuiTableFlags_NoPadInnerX = 1 << 23, // Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).
1983 // Scrolling
1984 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.
1985 ImGuiTableFlags_ScrollY = 1 << 25, // Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size.
1986 // Sorting
1987 ImGuiTableFlags_SortMulti = 1 << 26, // Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).
1988 ImGuiTableFlags_SortTristate = 1 << 27, // Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).
1989 // Miscellaneous
1990 ImGuiTableFlags_HighlightHoveredColumn = 1 << 28, // Highlight column headers when hovered (may evolve into a fuller highlight)
1991
1992 // [Internal] Combinations and masks
1993 ImGuiTableFlags_SizingMask_ = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_SizingFixedSame | ImGuiTableFlags_SizingStretchProp | ImGuiTableFlags_SizingStretchSame,
1994};
1995
1996// Flags for ImGui::TableSetupColumn()
1997enum ImGuiTableColumnFlags_
1998{
1999 // Input configuration flags
2000 ImGuiTableColumnFlags_None = 0,
2001 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)
2002 ImGuiTableColumnFlags_DefaultHide = 1 << 1, // Default as a hidden/disabled column.
2003 ImGuiTableColumnFlags_DefaultSort = 1 << 2, // Default as a sorting column.
2004 ImGuiTableColumnFlags_WidthStretch = 1 << 3, // Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
2005 ImGuiTableColumnFlags_WidthFixed = 1 << 4, // Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).
2006 ImGuiTableColumnFlags_NoResize = 1 << 5, // Disable manual resizing.
2007 ImGuiTableColumnFlags_NoReorder = 1 << 6, // Disable manual reordering this column, this will also prevent other columns from crossing over this column.
2008 ImGuiTableColumnFlags_NoHide = 1 << 7, // Disable ability to hide/disable this column.
2009 ImGuiTableColumnFlags_NoClip = 1 << 8, // Disable clipping for this column (all NoClip columns will render in a same draw command).
2010 ImGuiTableColumnFlags_NoSort = 1 << 9, // Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table).
2011 ImGuiTableColumnFlags_NoSortAscending = 1 << 10, // Disable ability to sort in the ascending direction.
2012 ImGuiTableColumnFlags_NoSortDescending = 1 << 11, // Disable ability to sort in the descending direction.
2013 ImGuiTableColumnFlags_NoHeaderLabel = 1 << 12, // TableHeadersRow() will not submit horizontal label for this column. Convenient for some small columns. Name will still appear in context menu or in angled headers.
2014 ImGuiTableColumnFlags_NoHeaderWidth = 1 << 13, // Disable header text width contribution to automatic column width.
2015 ImGuiTableColumnFlags_PreferSortAscending = 1 << 14, // Make the initial sort direction Ascending when first sorting on this column (default).
2016 ImGuiTableColumnFlags_PreferSortDescending = 1 << 15, // Make the initial sort direction Descending when first sorting on this column.
2017 ImGuiTableColumnFlags_IndentEnable = 1 << 16, // Use current Indent value when entering cell (default for column 0).
2018 ImGuiTableColumnFlags_IndentDisable = 1 << 17, // Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored.
2019 ImGuiTableColumnFlags_AngledHeader = 1 << 18, // TableHeadersRow() will submit an angled header row for this column. Note this will add an extra row.
2020
2021 // Output status flags, read-only via TableGetColumnFlags()
2022 ImGuiTableColumnFlags_IsEnabled = 1 << 24, // Status: is enabled == not hidden by user/api (referred to as "Hide" in _DefaultHide and _NoHide) flags.
2023 ImGuiTableColumnFlags_IsVisible = 1 << 25, // Status: is visible == is enabled AND not clipped by scrolling.
2024 ImGuiTableColumnFlags_IsSorted = 1 << 26, // Status: is currently part of the sort specs
2025 ImGuiTableColumnFlags_IsHovered = 1 << 27, // Status: is hovered by mouse
2026
2027 // [Internal] Combinations and masks
2028 ImGuiTableColumnFlags_WidthMask_ = ImGuiTableColumnFlags_WidthStretch | ImGuiTableColumnFlags_WidthFixed,
2029 ImGuiTableColumnFlags_IndentMask_ = ImGuiTableColumnFlags_IndentEnable | ImGuiTableColumnFlags_IndentDisable,
2030 ImGuiTableColumnFlags_StatusMask_ = ImGuiTableColumnFlags_IsEnabled | ImGuiTableColumnFlags_IsVisible | ImGuiTableColumnFlags_IsSorted | ImGuiTableColumnFlags_IsHovered,
2031 ImGuiTableColumnFlags_NoDirectResize_ = 1 << 30, // [Internal] Disable user resizing this column directly (it may however we resized indirectly from its left edge)
2032};
2033
2034// Flags for ImGui::TableNextRow()
2035enum ImGuiTableRowFlags_
2036{
2037 ImGuiTableRowFlags_None = 0,
2038 ImGuiTableRowFlags_Headers = 1 << 0, // Identify header row (set default background color + width of its contents accounted differently for auto column width)
2039};
2040
2041// Enum for ImGui::TableSetBgColor()
2042// Background colors are rendering in 3 layers:
2043// - Layer 0: draw with RowBg0 color if set, otherwise draw with ColumnBg0 if set.
2044// - Layer 1: draw with RowBg1 color if set, otherwise draw with ColumnBg1 if set.
2045// - Layer 2: draw with CellBg color if set.
2046// 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.
2047// When using ImGuiTableFlags_RowBg on the table, each row has the RowBg0 color automatically set for odd/even rows.
2048// If you set the color of RowBg0 target, your color will override the existing RowBg0 color.
2049// If you set the color of RowBg1 or ColumnBg1 target, your color will blend over the RowBg0 color.
2050enum ImGuiTableBgTarget_
2051{
2052 ImGuiTableBgTarget_None = 0,
2053 ImGuiTableBgTarget_RowBg0 = 1, // Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used)
2054 ImGuiTableBgTarget_RowBg1 = 2, // Set row background color 1 (generally used for selection marking)
2055 ImGuiTableBgTarget_CellBg = 3, // Set cell background color (top-most color)
2056};
2057
2058// Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
2059// Obtained by calling TableGetSortSpecs().
2060// When 'SpecsDirty == true' you can sort your data. It will be true with sorting specs have changed since last call, or the first time.
2061// Make sure to set 'SpecsDirty = false' after sorting, else you may wastefully sort your data every frame!
2063{
2064 const ImGuiTableColumnSortSpecs* Specs; // Pointer to sort spec array.
2065 int SpecsCount; // Sort spec count. Most often 1. May be > 1 when ImGuiTableFlags_SortMulti is enabled. May be == 0 when ImGuiTableFlags_SortTristate is enabled.
2066 bool SpecsDirty; // Set to true when specs have changed since last time! Use this to sort again, then clear the flag.
2067
2068 ImGuiTableSortSpecs() { memset(this, 0, sizeof(*this)); }
2069};
2070
2071// Sorting specification for one column of a table (sizeof == 12 bytes)
2073{
2074 ImGuiID ColumnUserID; // User id of the column (if specified by a TableSetupColumn() call)
2075 ImS16 ColumnIndex; // Index of the column
2076 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)
2077 ImGuiSortDirection SortDirection; // ImGuiSortDirection_Ascending or ImGuiSortDirection_Descending
2078
2079 ImGuiTableColumnSortSpecs() { memset(this, 0, sizeof(*this)); }
2080};
2081
2082//-----------------------------------------------------------------------------
2083// [SECTION] Helpers: Debug log, memory allocations macros, ImVector<>
2084//-----------------------------------------------------------------------------
2085
2086//-----------------------------------------------------------------------------
2087// Debug Logging into ShowDebugLogWindow(), tty and more.
2088//-----------------------------------------------------------------------------
2089
2090#ifndef IMGUI_DISABLE_DEBUG_TOOLS
2091#define IMGUI_DEBUG_LOG(...) ImGui::DebugLog(__VA_ARGS__)
2092#else
2093#define IMGUI_DEBUG_LOG(...) ((void)0)
2094#endif
2095
2096//-----------------------------------------------------------------------------
2097// IM_MALLOC(), IM_FREE(), IM_NEW(), IM_PLACEMENT_NEW(), IM_DELETE()
2098// We call C++ constructor on own allocated memory via the placement "new(ptr) Type()" syntax.
2099// 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.
2100//-----------------------------------------------------------------------------
2101
2103inline void* operator new(size_t, ImNewWrapper, void* ptr) { return ptr; }
2104inline void operator delete(void*, ImNewWrapper, void*) {} // This is only required so we can use the symmetrical new()
2105#define IM_ALLOC(_SIZE) ImGui::MemAlloc(_SIZE)
2106#define IM_FREE(_PTR) ImGui::MemFree(_PTR)
2107#define IM_PLACEMENT_NEW(_PTR) new(ImNewWrapper(), _PTR)
2108#define IM_NEW(_TYPE) new(ImNewWrapper(), ImGui::MemAlloc(sizeof(_TYPE))) _TYPE
2109template<typename T> void IM_DELETE(T* p) { if (p) { p->~T(); ImGui::MemFree(p); } }
2110
2111//-----------------------------------------------------------------------------
2112// ImVector<>
2113// 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).
2114//-----------------------------------------------------------------------------
2115// - 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.
2116// - We use std-like naming convention here, which is a little unusual for this codebase.
2117// - 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.
2118// - Important: our implementation does NOT call C++ constructors/destructors, we treat everything as raw data! This is intentional but be extra mindful of that,
2119// 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.
2120//-----------------------------------------------------------------------------
2121
2122IM_MSVC_RUNTIME_CHECKS_OFF
2123template<typename T>
2125{
2126 int Size;
2129
2130 // Provide standard typedefs but we don't use them ourselves.
2131 typedef T value_type;
2134
2135 // Constructors, destructor
2136 inline ImVector() { Size = Capacity = 0; Data = NULL; }
2137 inline ImVector(const ImVector<T>& src) { Size = Capacity = 0; Data = NULL; operator=(src); }
2138 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; }
2139 inline ~ImVector() { if (Data) IM_FREE(Data); } // Important: does not destruct anything
2140
2141 inline void clear() { if (Data) { Size = Capacity = 0; IM_FREE(Data); Data = NULL; } } // Important: does not destruct anything
2142 inline void clear_delete() { for (int n = 0; n < Size; n++) IM_DELETE(Data[n]); clear(); } // Important: never called automatically! always explicit.
2143 inline void clear_destruct() { for (int n = 0; n < Size; n++) Data[n].~T(); clear(); } // Important: never called automatically! always explicit.
2144
2145 inline bool empty() const { return Size == 0; }
2146 inline int size() const { return Size; }
2147 inline int size_in_bytes() const { return Size * (int)sizeof(T); }
2148 inline int max_size() const { return 0x7FFFFFFF / (int)sizeof(T); }
2149 inline int capacity() const { return Capacity; }
2150 inline T& operator[](int i) { IM_ASSERT(i >= 0 && i < Size); return Data[i]; }
2151 inline const T& operator[](int i) const { IM_ASSERT(i >= 0 && i < Size); return Data[i]; }
2152
2153 inline T* begin() { return Data; }
2154 inline const T* begin() const { return Data; }
2155 inline T* end() { return Data + Size; }
2156 inline const T* end() const { return Data + Size; }
2157 inline T& front() { IM_ASSERT(Size > 0); return Data[0]; }
2158 inline const T& front() const { IM_ASSERT(Size > 0); return Data[0]; }
2159 inline T& back() { IM_ASSERT(Size > 0); return Data[Size - 1]; }
2160 inline const T& back() const { IM_ASSERT(Size > 0); return Data[Size - 1]; }
2161 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; }
2162
2163 inline int _grow_capacity(int sz) const { int new_capacity = Capacity ? (Capacity + Capacity / 2) : 8; return new_capacity > sz ? new_capacity : sz; }
2164 inline void resize(int new_size) { if (new_size > Capacity) reserve(_grow_capacity(new_size)); Size = new_size; }
2165 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; }
2166 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
2167 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; }
2168 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; }
2169
2170 // 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.
2171 inline void push_back(const T& v) { if (Size == Capacity) reserve(_grow_capacity(Size + 1)); memcpy(&Data[Size], &v, sizeof(v)); Size++; }
2172 inline void pop_back() { IM_ASSERT(Size > 0); Size--; }
2173 inline void push_front(const T& v) { if (Size == 0) push_back(v); else insert(Data, v); }
2174 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; }
2175 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; }
2176 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; }
2177 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; }
2178 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; }
2179 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; }
2180 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; }
2181 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; }
2182 inline bool find_erase(const T& v) { const T* it = find(v); if (it < Data + Size) { erase(it); return true; } return false; }
2183 inline bool find_erase_unsorted(const T& v) { const T* it = find(v); if (it < Data + Size) { erase_unsorted(it); return true; } return false; }
2184 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; }
2185};
2186IM_MSVC_RUNTIME_CHECKS_RESTORE
2187
2188//-----------------------------------------------------------------------------
2189// [SECTION] ImGuiStyle
2190//-----------------------------------------------------------------------------
2191// You may modify the ImGui::GetStyle() main instance during initialization and before NewFrame().
2192// During the frame, use ImGui::PushStyleVar(ImGuiStyleVar_XXXX)/PopStyleVar() to alter the main style values,
2193// and ImGui::PushStyleColor(ImGuiCol_XXX)/PopStyleColor() for colors.
2194//-----------------------------------------------------------------------------
2195
2197{
2198 float Alpha; // Global alpha applies to everything in Dear ImGui.
2199 float DisabledAlpha; // Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha.
2200 ImVec2 WindowPadding; // Padding within a window.
2201 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.
2202 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).
2203 ImVec2 WindowMinSize; // Minimum window size. This is a global setting. If you want to constrain individual windows, use SetNextWindowSizeConstraints().
2204 ImVec2 WindowTitleAlign; // Alignment for title bar text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.
2205 ImGuiDir WindowMenuButtonPosition; // Side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to ImGuiDir_Left.
2206 float ChildRounding; // Radius of child window corners rounding. Set to 0.0f to have rectangular windows.
2207 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).
2208 float PopupRounding; // Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding)
2209 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).
2210 ImVec2 FramePadding; // Padding within a framed rectangle (used by most widgets).
2211 float FrameRounding; // Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets).
2212 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).
2213 ImVec2 ItemSpacing; // Horizontal and vertical spacing between widgets/lines.
2214 ImVec2 ItemInnerSpacing; // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).
2215 ImVec2 CellPadding; // Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows.
2216 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!
2217 float IndentSpacing; // Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).
2218 float ColumnsMinSpacing; // Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
2219 float ScrollbarSize; // Width of the vertical scrollbar, Height of the horizontal scrollbar.
2220 float ScrollbarRounding; // Radius of grab corners for scrollbar.
2221 float GrabMinSize; // Minimum width/height of a grab box for slider/scrollbar.
2222 float GrabRounding; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
2223 float LogSliderDeadzone; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
2224 float TabRounding; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
2225 float TabBorderSize; // Thickness of border around tabs.
2226 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.
2227 float TabBarBorderSize; // Thickness of tab-bar separator, which takes on the tab active color to denote focus.
2228 float TableAngledHeadersAngle; // Angle of angled headers (supported values range from -50.0f degrees to +50.0f degrees).
2229 ImVec2 TableAngledHeadersTextAlign;// Alignment of angled headers within the cell
2230 ImGuiDir ColorButtonPosition; // Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right.
2231 ImVec2 ButtonTextAlign; // Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered).
2232 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.
2233 float SeparatorTextBorderSize; // Thickkness of border in SeparatorText()
2234 ImVec2 SeparatorTextAlign; // Alignment of text within the separator. Defaults to (0.0f, 0.5f) (left aligned, center).
2235 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.
2236 ImVec2 DisplayWindowPadding; // Apply to regular windows: amount which we enforce to keep visible when moving near edges of your screen.
2237 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).
2238 float DockingSeparatorSize; // Thickness of resizing border between docked windows
2239 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.
2240 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).
2241 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).
2242 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).
2243 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.
2244 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.
2245 ImVec4 Colors[ImGuiCol_COUNT];
2246
2247 // Behaviors
2248 // (It is possible to modify those fields mid-frame if specific behavior need it, unlike e.g. configuration fields in ImGuiIO)
2249 float HoverStationaryDelay; // Delay for IsItemHovered(ImGuiHoveredFlags_Stationary). Time required to consider mouse stationary.
2250 float HoverDelayShort; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayShort). Usually used along with HoverStationaryDelay.
2251 float HoverDelayNormal; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayNormal). "
2252 ImGuiHoveredFlags HoverFlagsForTooltipMouse;// Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using mouse.
2253 ImGuiHoveredFlags HoverFlagsForTooltipNav; // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using keyboard/gamepad.
2254
2255 IMGUI_API ImGuiStyle();
2256 IMGUI_API void ScaleAllSizes(float scale_factor);
2257};
2258
2259//-----------------------------------------------------------------------------
2260// [SECTION] ImGuiIO
2261//-----------------------------------------------------------------------------
2262// Communicate most settings and inputs/outputs to Dear ImGui using this structure.
2263// Access via ImGui::GetIO(). Read 'Programmer guide' section in .cpp file for general usage.
2264// It is generally expected that:
2265// - initialization: backends and user code writes to ImGuiIO.
2266// - main loop: backends writes to ImGuiIO, user code and imgui code reads from ImGuiIO.
2267//-----------------------------------------------------------------------------
2268
2269// [Internal] Storage used by IsKeyDown(), IsKeyPressed() etc functions.
2270// 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.
2272{
2273 bool Down; // True for if key is down
2274 float DownDuration; // Duration the key has been down (<0.0f: not pressed, 0.0f: just pressed, >0.0f: time held)
2275 float DownDurationPrev; // Last frame duration the key has been down
2276 float AnalogValue; // 0.0f..1.0f for gamepad values
2277};
2278
2280{
2281 //------------------------------------------------------------------
2282 // Configuration // Default value
2283 //------------------------------------------------------------------
2284
2285 ImGuiConfigFlags ConfigFlags; // = 0 // See ImGuiConfigFlags_ enum. Set by user/application. Gamepad/keyboard navigation options, etc.
2286 ImGuiBackendFlags BackendFlags; // = 0 // See ImGuiBackendFlags_ enum. Set by backend (imgui_impl_xxx files or custom backend) to communicate features supported by the backend.
2287 ImVec2 DisplaySize; // <unset> // Main display size, in pixels (generally == GetMainViewport()->Size). May change every frame.
2288 float DeltaTime; // = 1.0f/60.0f // Time elapsed since last frame, in seconds. May change every frame.
2289 float IniSavingRate; // = 5.0f // Minimum time between saving positions/sizes to .ini file, in seconds.
2290 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.
2291 const char* LogFilename; // = "imgui_log.txt"// Path to .log file (default parameter to ImGui::LogToFile when no file is specified).
2292 void* UserData; // = NULL // Store your own data.
2293
2294 ImFontAtlas*Fonts; // <auto> // Font atlas: load, rasterize and pack one or more fonts into a single texture.
2295 float FontGlobalScale; // = 1.0f // Global scale all fonts
2296 bool FontAllowUserScaling; // = false // Allow user scaling text of individual window with CTRL+Wheel.
2297 ImFont* FontDefault; // = NULL // Font to use on NewFrame(). Use NULL to uses Fonts->Fonts[0].
2298 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.
2299
2300 // Docking options (when ImGuiConfigFlags_DockingEnable is set)
2301 bool ConfigDockingNoSplit; // = false // Simplified docking mode: disable window splitting, so docking is limited to merging multiple windows together into tab-bars.
2302 bool ConfigDockingWithShift; // = false // Enable docking with holding Shift key (reduce visual noise, allows dropping in wider space)
2303 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.
2304 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.
2305
2306 // Viewport options (when ImGuiConfigFlags_ViewportsEnable is set)
2307 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.
2308 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.
2309 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).
2310 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.
2311
2312 // Miscellaneous options
2313 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.
2314 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.
2315 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.
2316 bool ConfigInputTextCursorBlink; // = true // Enable blinking cursor (optional as some users consider it to be distracting).
2317 bool ConfigInputTextEnterKeepActive; // = false // [BETA] Pressing Enter will keep item active and select contents (single-line only).
2318 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.
2319 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)
2320 bool ConfigWindowsMoveFromTitleBarOnly; // = false // Enable allowing to move windows only when clicking on their title bar. Does not apply to windows without a title bar.
2321 float ConfigMemoryCompactTimer; // = 60.0f // Timer (in seconds) to free transient windows/tables memory buffers when unused. Set to -1.0f to disable.
2322
2323 // Inputs Behaviors
2324 // (other variables, ones which are expected to be tweaked within UI code, are exposed in ImGuiStyle)
2325 float MouseDoubleClickTime; // = 0.30f // Time for a double-click, in seconds.
2326 float MouseDoubleClickMaxDist; // = 6.0f // Distance threshold to stay in to validate a double-click, in pixels.
2327 float MouseDragThreshold; // = 6.0f // Distance threshold before considering we are dragging.
2328 float KeyRepeatDelay; // = 0.275f // When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).
2329 float KeyRepeatRate; // = 0.050f // When holding a key/button, rate at which it repeats, in seconds.
2330
2331 //------------------------------------------------------------------
2332 // Debug options
2333 //------------------------------------------------------------------
2334
2335 // Option to enable various debug tools showing buttons that will call the IM_DEBUG_BREAK() macro.
2336 // - The Item Picker tool will be available regardless of this being enabled, in order to maximize its discoverability.
2337 // - Requires a debugger being attached, otherwise IM_DEBUG_BREAK() options will appear to crash your application.
2338 // e.g. io.ConfigDebugIsDebuggerPresent = ::IsDebuggerPresent() on Win32, or refer to ImOsIsDebuggerPresent() imgui_test_engine/imgui_te_utils.cpp for a Unix compatible version).
2339 bool ConfigDebugIsDebuggerPresent; // = false // Enable various tools calling IM_DEBUG_BREAK().
2340
2341 // Tools to test correct Begin/End and BeginChild/EndChild behaviors.
2342 // - Presently Begin()/End() and BeginChild()/EndChild() needs to ALWAYS be called in tandem, regardless of return value of BeginXXX()
2343 // - This is inconsistent with other BeginXXX functions and create confusion for many users.
2344 // - We expect to update the API eventually. In the meanwhile we provide tools to facilitate checking user-code behavior.
2345 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.
2346 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.
2347
2348 // Option to deactivate io.AddFocusEvent(false) handling.
2349 // - May facilitate interactions with a debugger when focus loss leads to clearing inputs data.
2350 // - Backends may have other side-effects on focus loss, so this will reduce side-effects but not necessary remove all of them.
2351 bool ConfigDebugIgnoreFocusLoss; // = false // Ignore io.AddFocusEvent(false), consequently not calling io.ClearInputKeys()/io.ClearInputMouse() in input processing.
2352
2353 // Option to audit .ini data
2354 bool ConfigDebugIniSettings; // = false // Save .ini data with extra comments (particularly helpful for Docking, but makes saving slower)
2355
2356 //------------------------------------------------------------------
2357 // Platform Functions
2358 // (the imgui_impl_xxxx backend files are setting those up for you)
2359 //------------------------------------------------------------------
2360
2361 // Optional: Platform/Renderer backend name (informational only! will be displayed in About Window) + User data for backend/wrappers to store their own stuff.
2362 const char* BackendPlatformName; // = NULL
2363 const char* BackendRendererName; // = NULL
2364 void* BackendPlatformUserData; // = NULL // User data for platform backend
2365 void* BackendRendererUserData; // = NULL // User data for renderer backend
2366 void* BackendLanguageUserData; // = NULL // User data for non C++ programming language backend
2367
2368 // Optional: Access OS clipboard
2369 // (default to use native Win32 clipboard on Windows, otherwise uses a private clipboard. Override to access OS clipboard on other architectures)
2370 const char* (*GetClipboardTextFn)(void* user_data);
2371 void (*SetClipboardTextFn)(void* user_data, const char* text);
2373
2374 // Optional: Open link/folder/file in OS Shell
2375 // (default to use ShellExecuteA() on Windows, system() on Linux/Mac)
2376 bool (*PlatformOpenInShellFn)(ImGuiContext* ctx, const char* path);
2378
2379 // 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)
2380 // (default to use native imm32 api on Windows)
2382 //void (*SetPlatformImeDataFn)(ImGuiViewport* viewport, ImGuiPlatformImeData* data); // [Renamed to io.PlatformSetImeDataFn in 1.91.0]
2383
2384 // Optional: Platform locale
2385 ImWchar PlatformLocaleDecimalPoint; // '.' // [Experimental] Configure decimal point e.g. '.' or ',' useful for some languages (e.g. German), generally pulled from *localeconv()->decimal_point
2386
2387 //------------------------------------------------------------------
2388 // Input - Call before calling NewFrame()
2389 //------------------------------------------------------------------
2390
2391 // Input Functions
2392 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)
2393 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.
2394 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)
2395 IMGUI_API void AddMouseButtonEvent(int button, bool down); // Queue a mouse button change
2396 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.
2397 IMGUI_API void AddMouseSourceEvent(ImGuiMouseSource source); // Queue a mouse source change (Mouse/TouchScreen/Pen)
2398 IMGUI_API void AddMouseViewportEvent(ImGuiID id); // Queue a mouse hovered viewport. Requires backend to set ImGuiBackendFlags_HasMouseHoveredViewport to call this (for multi-viewport support).
2399 IMGUI_API void AddFocusEvent(bool focused); // Queue a gain/loss of focus for the application (generally based on OS/platform focus of your window)
2400 IMGUI_API void AddInputCharacter(unsigned int c); // Queue a new character input
2401 IMGUI_API void AddInputCharacterUTF16(ImWchar16 c); // Queue a new character input from a UTF-16 character, it can be a surrogate
2402 IMGUI_API void AddInputCharactersUTF8(const char* str); // Queue a new characters input from a UTF-8 string
2403
2404 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.
2405 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.
2406 IMGUI_API void ClearEventsQueue(); // Clear all incoming events.
2407 IMGUI_API void ClearInputKeys(); // Clear current keyboard/gamepad state + current frame text input buffer. Equivalent to releasing all keys/buttons.
2408 IMGUI_API void ClearInputMouse(); // Clear current mouse state.
2409#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2410 IMGUI_API void ClearInputCharacters(); // [Obsoleted in 1.89.8] Clear the current frame text input buffer. Now included within ClearInputKeys().
2411#endif
2412
2413 //------------------------------------------------------------------
2414 // Output - Updated by NewFrame() or EndFrame()/Render()
2415 // (when reading from the io.WantCaptureMouse, io.WantCaptureKeyboard flags to dispatch your inputs, it is
2416 // generally easier and more correct to use their state BEFORE calling NewFrame(). See FAQ for details!)
2417 //------------------------------------------------------------------
2418
2419 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.).
2420 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.).
2421 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).
2422 bool WantSetMousePos; // MousePos has been altered, backend should reposition mouse on next frame. Rarely used! Set only when ImGuiConfigFlags_NavEnableSetMousePos flag is enabled.
2423 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!
2424 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.
2425 bool NavVisible; // Keyboard/Gamepad navigation is visible and allowed (will handle ImGuiKey_NavXXX events).
2426 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.
2427 int MetricsRenderVertices; // Vertices output during last call to Render()
2428 int MetricsRenderIndices; // Indices output during last call to Render() = number of triangles * 3
2429 int MetricsRenderWindows; // Number of visible windows
2430 int MetricsActiveWindows; // Number of active windows
2431 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.
2432
2433 //------------------------------------------------------------------
2434 // [Internal] Dear ImGui will maintain those fields. Forward compatibility not guaranteed!
2435 //------------------------------------------------------------------
2436
2437 ImGuiContext* Ctx; // Parent UI context (needs to be set explicitly by parent).
2438
2439 // Main Input State
2440 // (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)
2441 // (reading from those variables is fair game, as they are extremely unlikely to be moving anywhere)
2442 ImVec2 MousePos; // Mouse position, in pixels. Set to ImVec2(-FLT_MAX, -FLT_MAX) if mouse is unavailable (on another screen, etc.)
2443 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.
2444 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.
2445 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.
2446 ImGuiMouseSource MouseSource; // Mouse actual input peripheral (Mouse/TouchScreen/Pen).
2447 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).
2448 bool KeyCtrl; // Keyboard modifier down: Control
2449 bool KeyShift; // Keyboard modifier down: Shift
2450 bool KeyAlt; // Keyboard modifier down: Alt
2451 bool KeySuper; // Keyboard modifier down: Cmd/Super/Windows
2452
2453 // Other state maintained from data above + IO function calls
2454 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()
2455 ImGuiKeyData KeysData[ImGuiKey_KeysData_SIZE]; // Key state for all known keys. Use IsKeyXXX() functions to access this.
2456 bool WantCaptureMouseUnlessPopupClose; // Alternative to WantCaptureMouse: (WantCaptureMouse == true && WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup.
2457 ImVec2 MousePosPrev; // Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
2458 ImVec2 MouseClickedPos[5]; // Position at time of clicking
2459 double MouseClickedTime[5]; // Time of last click (used to figure out double-click)
2460 bool MouseClicked[5]; // Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
2461 bool MouseDoubleClicked[5]; // Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
2462 ImU16 MouseClickedCount[5]; // == 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc. when going from !Down to Down
2463 ImU16 MouseClickedLastCount[5]; // Count successive number of clicks. Stays valid after mouse release. Reset after another click is done.
2464 bool MouseReleased[5]; // Mouse button went from Down to !Down
2465 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.
2466 bool MouseDownOwnedUnlessPopupClose[5]; // Track if button was clicked inside a dear imgui window.
2467 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.
2468 bool MouseCtrlLeftAsRightClick; // (OSX) Set to true when the current click was a ctrl-click that spawned a simulated right click
2469 float MouseDownDuration[5]; // Duration the mouse button has been down (0.0f == just clicked)
2470 float MouseDownDurationPrev[5]; // Previous time the mouse button has been down
2471 ImVec2 MouseDragMaxDistanceAbs[5]; // Maximum distance, absolute, on each axis, of how much mouse has traveled from the clicking point
2472 float MouseDragMaxDistanceSqr[5]; // Squared maximum distance of how much mouse has traveled from the clicking point (used for moving thresholds)
2473 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.
2474 bool AppFocusLost; // Only modify via AddFocusEvent()
2475 bool AppAcceptingEvents; // Only modify via SetAppAcceptingEvents()
2476 ImS8 BackendUsingLegacyKeyArrays; // -1: unknown, 0: using AddKeyEvent(), 1: using legacy io.KeysDown[]
2477 bool BackendUsingLegacyNavInputArray; // 0: using AddKeyAnalogEvent(), 1: writing to legacy io.NavInputs[] directly
2478 ImWchar16 InputQueueSurrogate; // For AddInputCharacterUTF16()
2479 ImVector<ImWchar> InputQueueCharacters; // Queue of _characters_ input (obtained by platform backend). Fill using AddInputCharacter() helper.
2480
2481 // Legacy: before 1.87, we required backend to fill io.KeyMap[] (imgui->native map) during initialization and io.KeysDown[] (native indices) every frame.
2482 // This is still temporarily supported as a legacy feature. However the new preferred scheme is for backend to call io.AddKeyEvent().
2483 // Old (<1.87): ImGui::IsKeyPressed(ImGui::GetIO().KeyMap[ImGuiKey_Space]) --> New (1.87+) ImGui::IsKeyPressed(ImGuiKey_Space)
2484#ifndef IMGUI_DISABLE_OBSOLETE_KEYIO
2485 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.
2486 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.
2487 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.
2488 //void* ImeWindowHandle; // [Obsoleted in 1.87] Set ImGuiViewport::PlatformHandleRaw instead. Set this to your HWND to get automatic IME cursor positioning.
2489#endif
2490
2491 IMGUI_API ImGuiIO();
2492};
2493
2494//-----------------------------------------------------------------------------
2495// [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiPayload)
2496//-----------------------------------------------------------------------------
2497
2498// Shared state of InputText(), passed as an argument to your callback when a ImGuiInputTextFlags_Callback* flag is used.
2499// The callback function should return 0 by default.
2500// Callbacks (follow a flag name and see comments in ImGuiInputTextFlags_ declarations for more details)
2501// - 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)
2502// - ImGuiInputTextFlags_CallbackAlways: Callback on each iteration
2503// - ImGuiInputTextFlags_CallbackCompletion: Callback on pressing TAB
2504// - ImGuiInputTextFlags_CallbackHistory: Callback on pressing Up/Down arrows
2505// - ImGuiInputTextFlags_CallbackCharFilter: Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
2506// - ImGuiInputTextFlags_CallbackResize: Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow.
2508{
2509 ImGuiContext* Ctx; // Parent UI context
2510 ImGuiInputTextFlags EventFlag; // One ImGuiInputTextFlags_Callback* // Read-only
2511 ImGuiInputTextFlags Flags; // What user passed to InputText() // Read-only
2512 void* UserData; // What user passed to InputText() // Read-only
2513
2514 // Arguments for the different callback events
2515 // - During Resize callback, Buf will be same as your input buffer.
2516 // - 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.
2517 // - 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.
2518 // - 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.
2519 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;
2520 ImGuiKey EventKey; // Key pressed (Up/Down/TAB) // Read-only // [Completion,History]
2521 char* Buf; // Text buffer // Read-write // [Resize] Can replace pointer / [Completion,History,Always] Only write to pointed data, don't replace the actual pointer!
2522 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()
2523 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
2524 bool BufDirty; // Set if you modify Buf/BufTextLen! // Write // [Completion,History,Always]
2525 int CursorPos; // // Read-write // [Completion,History,Always]
2526 int SelectionStart; // // Read-write // [Completion,History,Always] == to SelectionEnd when no selection)
2527 int SelectionEnd; // // Read-write // [Completion,History,Always]
2528
2529 // Helper functions for text manipulation.
2530 // Use those function to benefit from the CallbackResize behaviors. Calling those function reset the selection.
2531 IMGUI_API ImGuiInputTextCallbackData();
2532 IMGUI_API void DeleteChars(int pos, int bytes_count);
2533 IMGUI_API void InsertChars(int pos, const char* text, const char* text_end = NULL);
2536 bool HasSelection() const { return SelectionStart != SelectionEnd; }
2537};
2538
2539// Resizing callback data to apply custom constraint. As enabled by SetNextWindowSizeConstraints(). Callback is called during the next Begin().
2540// NB: For basic min/max size constraint on each axis you don't need to use the callback! The SetNextWindowSizeConstraints() parameters are enough.
2542{
2543 void* UserData; // Read-only. What user passed to SetNextWindowSizeConstraints(). Generally store an integer or float in here (need reinterpret_cast<>).
2544 ImVec2 Pos; // Read-only. Window position, for reference.
2545 ImVec2 CurrentSize; // Read-only. Current window size.
2546 ImVec2 DesiredSize; // Read-write. Desired size, based on user's mouse position. Write to this field to restrain resizing.
2547};
2548
2549// [ALPHA] Rarely used / very advanced uses only. Use with SetNextWindowClass() and DockSpace() functions.
2550// Important: the content of this class is still highly WIP and likely to change and be refactored
2551// before we stabilize Docking features. Please be mindful if using this.
2552// Provide hints:
2553// - To the platform backend via altered viewport flags (enable/disable OS decoration, OS task bar icons, etc.)
2554// - To the platform backend for OS level parent/child relationships of viewport.
2555// - To the docking system for various options and filtering.
2557{
2558 ImGuiID ClassId; // User data. 0 = Default class (unclassed). Windows of different classes cannot be docked with each others.
2559 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.
2560 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.
2561 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.
2562 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.
2563 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.
2564 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!)
2565 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)
2566 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?
2567
2568 ImGuiWindowClass() { memset(this, 0, sizeof(*this)); ParentViewportId = (ImGuiID)-1; DockingAllowUnclassed = true; }
2569};
2570
2571// Data payload for Drag and Drop operations: AcceptDragDropPayload(), GetDragDropPayload()
2573{
2574 // Members
2575 void* Data; // Data (copied and owned by dear imgui)
2576 int DataSize; // Data size
2577
2578 // [Internal]
2579 ImGuiID SourceId; // Source item id
2580 ImGuiID SourceParentId; // Source parent id (if available)
2581 int DataFrameCount; // Data timestamp
2582 char DataType[32 + 1]; // Data type tag (short user-supplied string, 32 characters max)
2583 bool Preview; // Set when AcceptDragDropPayload() was called and mouse has been hovering the target item (nb: handle overlapping drag targets)
2584 bool Delivery; // Set when AcceptDragDropPayload() was called and mouse button is released over the target item.
2585
2587 void Clear() { SourceId = SourceParentId = 0; Data = NULL; DataSize = 0; memset(DataType, 0, sizeof(DataType)); DataFrameCount = -1; Preview = Delivery = false; }
2588 bool IsDataType(const char* type) const { return DataFrameCount != -1 && strcmp(type, DataType) == 0; }
2589 bool IsPreview() const { return Preview; }
2590 bool IsDelivery() const { return Delivery; }
2591};
2592
2593//-----------------------------------------------------------------------------
2594// [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, Math Operators, ImColor)
2595//-----------------------------------------------------------------------------
2596
2597// Helper: Unicode defines
2598#define IM_UNICODE_CODEPOINT_INVALID 0xFFFD // Invalid Unicode code point (standard value).
2599#ifdef IMGUI_USE_WCHAR32
2600#define IM_UNICODE_CODEPOINT_MAX 0x10FFFF // Maximum Unicode code point supported by this build.
2601#else
2602#define IM_UNICODE_CODEPOINT_MAX 0xFFFF // Maximum Unicode code point supported by this build.
2603#endif
2604
2605// 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.
2606// Usage: static ImGuiOnceUponAFrame oaf; if (oaf) ImGui::Text("This will be called only once per frame");
2608{
2610 mutable int RefFrame;
2611 operator bool() const { int current_frame = ImGui::GetFrameCount(); if (RefFrame == current_frame) return false; RefFrame = current_frame; return true; }
2612};
2613
2614// Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]"
2616{
2617 IMGUI_API ImGuiTextFilter(const char* default_filter = "");
2618 IMGUI_API bool Draw(const char* label = "Filter (inc,-exc)", float width = 0.0f); // Helper calling InputText+Build
2619 IMGUI_API bool PassFilter(const char* text, const char* text_end = NULL) const;
2620 IMGUI_API void Build();
2621 void Clear() { InputBuf[0] = 0; Build(); }
2622 bool IsActive() const { return !Filters.empty(); }
2623
2624 // [Internal]
2626 {
2627 const char* b;
2628 const char* e;
2629
2630 ImGuiTextRange() { b = e = NULL; }
2631 ImGuiTextRange(const char* _b, const char* _e) { b = _b; e = _e; }
2632 bool empty() const { return b == e; }
2633 IMGUI_API void split(char separator, ImVector<ImGuiTextRange>* out) const;
2634 };
2635 char InputBuf[256];
2638};
2639
2640// Helper: Growable text buffer for logging/accumulating text
2641// (this could be called 'ImGuiTextBuilder' / 'ImGuiStringBuilder')
2643{
2645 IMGUI_API static char EmptyString[1];
2646
2648 inline char operator[](int i) const { IM_ASSERT(Buf.Data != NULL); return Buf.Data[i]; }
2649 const char* begin() const { return Buf.Data ? &Buf.front() : EmptyString; }
2650 const char* end() const { return Buf.Data ? &Buf.back() : EmptyString; } // Buf is zero-terminated, so end() will point on the zero-terminator
2651 int size() const { return Buf.Size ? Buf.Size - 1 : 0; }
2652 bool empty() const { return Buf.Size <= 1; }
2653 void clear() { Buf.clear(); }
2654 void reserve(int capacity) { Buf.reserve(capacity); }
2655 const char* c_str() const { return Buf.Data ? Buf.Data : EmptyString; }
2656 IMGUI_API void append(const char* str, const char* str_end = NULL);
2657 IMGUI_API void appendf(const char* fmt, ...) IM_FMTARGS(2);
2658 IMGUI_API void appendfv(const char* fmt, va_list args) IM_FMTLIST(2);
2659};
2660
2661// [Internal] Key+Value for ImGuiStorage
2663{
2664 ImGuiID key;
2665 union { int val_i; float val_f; void* val_p; };
2666 ImGuiStoragePair(ImGuiID _key, int _val) { key = _key; val_i = _val; }
2667 ImGuiStoragePair(ImGuiID _key, float _val) { key = _key; val_f = _val; }
2668 ImGuiStoragePair(ImGuiID _key, void* _val) { key = _key; val_p = _val; }
2669};
2670
2671// Helper: Key->Value storage
2672// Typically you don't have to worry about this since a storage is held within each Window.
2673// We use it to e.g. store collapse state for a tree (Int 0/1)
2674// This is optimized for efficient lookup (dichotomy into a contiguous buffer) and rare insertion (typically tied to user interactions aka max once a frame)
2675// You can use it as custom user storage for temporary values. Declare your own storage if, for example:
2676// - 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).
2677// - You want to store custom debug data easily without adding or editing structures in your code (probably not efficient, but convenient)
2678// Types are NOT stored, so it is up to you to make sure your Key don't collide with different types.
2680{
2681 // [Internal]
2683
2684 // - Get***() functions find pair, never add/allocate. Pairs are sorted so a query is O(log N)
2685 // - Set***() functions find pair, insertion on demand if missing.
2686 // - Sorted insertion is costly, paid once. A typical frame shouldn't need to insert any new pair.
2687 void Clear() { Data.clear(); }
2688 IMGUI_API int GetInt(ImGuiID key, int default_val = 0) const;
2689 IMGUI_API void SetInt(ImGuiID key, int val);
2690 IMGUI_API bool GetBool(ImGuiID key, bool default_val = false) const;
2691 IMGUI_API void SetBool(ImGuiID key, bool val);
2692 IMGUI_API float GetFloat(ImGuiID key, float default_val = 0.0f) const;
2693 IMGUI_API void SetFloat(ImGuiID key, float val);
2694 IMGUI_API void* GetVoidPtr(ImGuiID key) const; // default_val is NULL
2695 IMGUI_API void SetVoidPtr(ImGuiID key, void* val);
2696
2697 // - Get***Ref() functions finds pair, insert on demand if missing, return pointer. Useful if you intend to do Get+Set.
2698 // - 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.
2699 // - 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)
2700 // float* pvar = ImGui::GetFloatRef(key); ImGui::SliderFloat("var", pvar, 0, 100.0f); some_var += *pvar;
2701 IMGUI_API int* GetIntRef(ImGuiID key, int default_val = 0);
2702 IMGUI_API bool* GetBoolRef(ImGuiID key, bool default_val = false);
2703 IMGUI_API float* GetFloatRef(ImGuiID key, float default_val = 0.0f);
2704 IMGUI_API void** GetVoidPtrRef(ImGuiID key, void* default_val = NULL);
2705
2706 // Advanced: for quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once.
2707 IMGUI_API void BuildSortByKey();
2708 // Obsolete: use on your own storage if you know only integer are being stored (open/close all tree nodes)
2709 IMGUI_API void SetAllInt(int val);
2710
2711#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2712 //typedef ::ImGuiStoragePair ImGuiStoragePair; // 1.90.8: moved type outside struct
2713#endif
2714};
2715
2716// Helper: Manually clip large list of items.
2717// If you have lots evenly spaced items and you have random access to the list, you can perform coarse
2718// clipping based on visibility to only submit items that are in view.
2719// The clipper calculates the range of visible items and advance the cursor to compensate for the non-visible items we have skipped.
2720// (Dear ImGui already clip items based on their bounds but: it needs to first layout the item to do so, and generally
2721// fetching/submitting your own data incurs additional cost. Coarse clipping using ImGuiListClipper allows you to easily
2722// scale using lists with tens of thousands of items without a problem)
2723// Usage:
2724// ImGuiListClipper clipper;
2725// clipper.Begin(1000); // We have 1000 elements, evenly spaced.
2726// while (clipper.Step())
2727// for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++)
2728// ImGui::Text("line number %d", i);
2729// Generally what happens is:
2730// - Clipper lets you process the first element (DisplayStart = 0, DisplayEnd = 1) regardless of it being visible or not.
2731// - User code submit that one element.
2732// - Clipper can measure the height of the first element
2733// - Clipper calculate the actual range of elements to display based on the current clipping rectangle, position the cursor before the first visible element.
2734// - User code submit visible elements.
2735// - The clipper also handles various subtleties related to keyboard/gamepad navigation, wrapping etc.
2737{
2738 ImGuiContext* Ctx; // Parent UI context
2739 int DisplayStart; // First item to display, updated by each call to Step()
2740 int DisplayEnd; // End of items to display (exclusive)
2741 int ItemsCount; // [Internal] Number of items
2742 float ItemsHeight; // [Internal] Height of item after a first step and item submission can calculate it
2743 float StartPosY; // [Internal] Cursor position at the time of Begin() or after table frozen rows are all processed
2744 double StartSeekOffsetY; // [Internal] Account for frozen rows in a table and initial loss of precision in very large windows.
2745 void* TempData; // [Internal] Internal data
2746
2747 // 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)
2748 // items_height: Use -1.0f to be calculated automatically on first step. Otherwise pass in the distance between your items, typically GetTextLineHeightWithSpacing() or GetFrameHeightWithSpacing().
2749 IMGUI_API ImGuiListClipper();
2750 IMGUI_API ~ImGuiListClipper();
2751 IMGUI_API void Begin(int items_count, float items_height = -1.0f);
2752 IMGUI_API void End(); // Automatically called on the last call of Step() that returns false.
2753 IMGUI_API bool Step(); // Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items.
2754
2755 // Call IncludeItemByIndex() or IncludeItemsByIndex() *BEFORE* first call to Step() if you need a range of items to not be clipped, regardless of their visibility.
2756 // (Due to alignment / padding of certain items it is possible that an extra item may be included on either end of the display range).
2757 inline void IncludeItemByIndex(int item_index) { IncludeItemsByIndex(item_index, item_index + 1); }
2758 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.
2759
2760 // Seek cursor toward given item. This is automatically called while stepping.
2761 // - The only reason to call this is: you can use ImGuiListClipper::Begin(INT_MAX) if you don't know item count ahead of time.
2762 // - In this case, after all steps are done, you'll want to call SeekCursorForItem(item_count).
2763 IMGUI_API void SeekCursorForItem(int item_index);
2764
2765#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2766 inline void IncludeRangeByIndices(int item_begin, int item_end) { IncludeItemsByIndex(item_begin, item_end); } // [renamed in 1.89.9]
2767 inline void ForceDisplayRangeByIndices(int item_begin, int item_end) { IncludeItemsByIndex(item_begin, item_end); } // [renamed in 1.89.6]
2768 //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]
2769#endif
2770};
2771
2772// Helpers: ImVec2/ImVec4 operators
2773// - It is important that we are keeping those disabled by default so they don't leak in user space.
2774// - 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)
2775// - You can use '#define IMGUI_DEFINE_MATH_OPERATORS' to import our operators, provided as a courtesy.
2776#ifdef IMGUI_DEFINE_MATH_OPERATORS
2777#define IMGUI_DEFINE_MATH_OPERATORS_IMPLEMENTED
2778IM_MSVC_RUNTIME_CHECKS_OFF
2779static inline ImVec2 operator*(const ImVec2& lhs, const float rhs) { return ImVec2(lhs.x * rhs, lhs.y * rhs); }
2780static inline ImVec2 operator/(const ImVec2& lhs, const float rhs) { return ImVec2(lhs.x / rhs, lhs.y / rhs); }
2781static inline ImVec2 operator+(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x + rhs.x, lhs.y + rhs.y); }
2782static inline ImVec2 operator-(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x - rhs.x, lhs.y - rhs.y); }
2783static inline ImVec2 operator*(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x * rhs.x, lhs.y * rhs.y); }
2784static inline ImVec2 operator/(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x / rhs.x, lhs.y / rhs.y); }
2785static inline ImVec2 operator-(const ImVec2& lhs) { return ImVec2(-lhs.x, -lhs.y); }
2786static inline ImVec2& operator*=(ImVec2& lhs, const float rhs) { lhs.x *= rhs; lhs.y *= rhs; return lhs; }
2787static inline ImVec2& operator/=(ImVec2& lhs, const float rhs) { lhs.x /= rhs; lhs.y /= rhs; return lhs; }
2788static inline ImVec2& operator+=(ImVec2& lhs, const ImVec2& rhs) { lhs.x += rhs.x; lhs.y += rhs.y; return lhs; }
2789static inline ImVec2& operator-=(ImVec2& lhs, const ImVec2& rhs) { lhs.x -= rhs.x; lhs.y -= rhs.y; return lhs; }
2790static inline ImVec2& operator*=(ImVec2& lhs, const ImVec2& rhs) { lhs.x *= rhs.x; lhs.y *= rhs.y; return lhs; }
2791static inline ImVec2& operator/=(ImVec2& lhs, const ImVec2& rhs) { lhs.x /= rhs.x; lhs.y /= rhs.y; return lhs; }
2792static inline bool operator==(const ImVec2& lhs, const ImVec2& rhs) { return lhs.x == rhs.x && lhs.y == rhs.y; }
2793static inline bool operator!=(const ImVec2& lhs, const ImVec2& rhs) { return lhs.x != rhs.x || lhs.y != rhs.y; }
2794static 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); }
2795static 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); }
2796static 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); }
2797static 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; }
2798static 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; }
2799IM_MSVC_RUNTIME_CHECKS_RESTORE
2800#endif
2801
2802// Helpers macros to generate 32-bit encoded colors
2803// User can declare their own format by #defining the 5 _SHIFT/_MASK macros in their imconfig file.
2804#ifndef IM_COL32_R_SHIFT
2805#ifdef IMGUI_USE_BGRA_PACKED_COLOR
2806#define IM_COL32_R_SHIFT 16
2807#define IM_COL32_G_SHIFT 8
2808#define IM_COL32_B_SHIFT 0
2809#define IM_COL32_A_SHIFT 24
2810#define IM_COL32_A_MASK 0xFF000000
2811#else
2812#define IM_COL32_R_SHIFT 0
2813#define IM_COL32_G_SHIFT 8
2814#define IM_COL32_B_SHIFT 16
2815#define IM_COL32_A_SHIFT 24
2816#define IM_COL32_A_MASK 0xFF000000
2817#endif
2818#endif
2819#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))
2820#define IM_COL32_WHITE IM_COL32(255,255,255,255) // Opaque white = 0xFFFFFFFF
2821#define IM_COL32_BLACK IM_COL32(0,0,0,255) // Opaque black
2822#define IM_COL32_BLACK_TRANS IM_COL32(0,0,0,0) // Transparent black = 0x00000000
2823
2824// Helper: ImColor() implicitly converts colors to either ImU32 (packed 4x1 byte) or ImVec4 (4x1 float)
2825// Prefer using IM_COL32() macros if you want a guaranteed compile-time ImU32 for usage with ImDrawList API.
2826// **Avoid storing ImColor! Store either u32 of ImVec4. This is not a full-featured color class. MAY OBSOLETE.
2827// **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.
2829{
2831
2832 constexpr ImColor() { }
2833 constexpr ImColor(float r, float g, float b, float a = 1.0f) : Value(r, g, b, a) { }
2834 constexpr ImColor(const ImVec4& col) : Value(col) {}
2835 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)) {}
2836 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)) {}
2837 inline operator ImU32() const { return ImGui::ColorConvertFloat4ToU32(Value); }
2838 inline operator ImVec4() const { return Value; }
2839
2840 // FIXME-OBSOLETE: May need to obsolete/cleanup those helpers.
2841 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; }
2842 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); }
2843};
2844
2845//-----------------------------------------------------------------------------
2846// [SECTION] Multi-Select API flags and structures (ImGuiMultiSelectFlags, ImGuiSelectionRequestType, ImGuiSelectionRequest, ImGuiMultiSelectIO, ImGuiSelectionBasicStorage)
2847//-----------------------------------------------------------------------------
2848
2849// Multi-selection system
2850// Documentation at: https://github.com/ocornut/imgui/wiki/Multi-Select
2851// - Refer to 'Demo->Widgets->Selection State & Multi-Select' for demos using this.
2852// - This system implements standard multi-selection idioms (CTRL+Mouse/Keyboard, SHIFT+Mouse/Keyboard, etc)
2853// with support for clipper (skipping non-visible items), box-select and many other details.
2854// - Selectable(), Checkbox() are supported but custom widgets may use it as well.
2855// - TreeNode() is technically supported but... using this correctly is more complicated: you need some sort of linear/random access to your tree,
2856// which is suited to advanced trees setups also implementing filters and clipper. We will work toward simplifying and demoing it.
2857// - In the spirit of Dear ImGui design, your code owns actual selection data.
2858// This is designed to allow all kinds of selection storage you may use in your application e.g. set/map/hash.
2859// About ImGuiSelectionBasicStorage:
2860// - This is an optional helper to store a selection state and apply selection requests.
2861// - It is used by our demos and provided as a convenience to quickly implement multi-selection.
2862// Usage:
2863// - Identify submitted items with SetNextItemSelectionUserData(), most likely using an index into your current data-set.
2864// - Store and maintain actual selection data using persistent object identifiers.
2865// - Usage flow:
2866// BEGIN - (1) Call BeginMultiSelect() and retrieve the ImGuiMultiSelectIO* result.
2867// - (2) Honor request list (SetAll/SetRange requests) by updating your selection data. Same code as Step 6.
2868// - (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.
2869// LOOP - (4) Submit your items with SetNextItemSelectionUserData() + Selectable()/TreeNode() calls.
2870// END - (5) Call EndMultiSelect() and retrieve the ImGuiMultiSelectIO* result.
2871// - (6) Honor request list (SetAll/SetRange requests) by updating your selection data. Same code as Step 2.
2872// 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.
2873// About ImGuiSelectionUserData:
2874// - This can store an application-defined identifier (e.g. index or pointer) submitted via SetNextItemSelectionUserData().
2875// - In return we store them into RangeSrcItem/RangeFirstItem/RangeLastItem and other fields in ImGuiMultiSelectIO.
2876// - Most applications will store an object INDEX, hence the chosen name and type. Storing an index is natural, because
2877// SetRange requests will give you two end-points and you will need to iterate/interpolate between them to update your selection.
2878// - However it is perfectly possible to store a POINTER or another IDENTIFIER inside ImGuiSelectionUserData.
2879// Our system never assume that you identify items by indices, it never attempts to interpolate between two values.
2880// - As most users will want to store an index, for convenience and to reduce confusion we use ImS64 instead of void*,
2881// being syntactically easier to downcast. Feel free to reinterpret_cast and store a pointer inside.
2882
2883// Flags for BeginMultiSelect()
2884enum ImGuiMultiSelectFlags_
2885{
2886 ImGuiMultiSelectFlags_None = 0,
2887 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!
2888 ImGuiMultiSelectFlags_NoSelectAll = 1 << 1, // Disable CTRL+A shortcut to select all.
2889 ImGuiMultiSelectFlags_NoRangeSelect = 1 << 2, // Disable Shift+selection mouse/keyboard support (useful for unordered 2D selection).
2890 ImGuiMultiSelectFlags_NoAutoSelect = 1 << 3, // Disable selecting items when navigating (useful for e.g. supporting range-select in a list of checkboxes)
2891 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)
2892 ImGuiMultiSelectFlags_NoAutoClearOnReselect = 1 << 5, // Disable clearing selection when clicking/selecting an already selected item
2893 ImGuiMultiSelectFlags_BoxSelect1d = 1 << 6, // Enable box-selection with same width and same x pos items (e.g. only 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.
2894 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.
2895 ImGuiMultiSelectFlags_BoxSelectNoScroll = 1 << 8, // Disable scrolling when box-selecting near edges of scope.
2896 ImGuiMultiSelectFlags_ClearOnEscape = 1 << 9, // Clear selection when pressing Escape while scope is focused.
2897 ImGuiMultiSelectFlags_ClearOnClickVoid = 1 << 10, // Clear selection when clicking on empty location within scope.
2898 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.
2899 ImGuiMultiSelectFlags_ScopeRect = 1 << 12, // Scope for _BoxSelect and _ClearOnClickVoid is rectangle encompassing BeginMultiSelect()/EndMultiSelect(). Use if BeginMultiSelect() is called multiple times in same window.
2900 ImGuiMultiSelectFlags_SelectOnClick = 1 << 13, // Apply selection on mouse down when clicking on unselected item. (Default)
2901 ImGuiMultiSelectFlags_SelectOnClickRelease = 1 << 14, // Apply selection on mouse release when clicking an unselected item. Allow dragging an unselected item without altering selection.
2902 //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.
2903 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.
2904};
2905
2906// Main IO structure returned by BeginMultiSelect()/EndMultiSelect().
2907// This mainly contains a list of selection requests.
2908// - Use 'Demo->Tools->Debug Log->Selection' to see requests as they happen.
2909// - Some fields are only useful if your list is dynamic and allows deletion (getting post-deletion focus/state right is shown in the demo)
2910// - Below: who reads/writes each fields? 'r'=read, 'w'=write, 'ms'=multi-select code, 'app'=application/user code.
2912{
2913 //------------------------------------------// BeginMultiSelect / EndMultiSelect
2914 ImVector<ImGuiSelectionRequest> Requests; // ms:w, app:r / ms:w app:r // Requests to apply to your selection data.
2915 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.
2916 ImGuiSelectionUserData NavIdItem; // ms:w, app:r / // (If using deletion) Last known SetNextItemSelectionUserData() value for NavId (if part of submitted items).
2917 bool NavIdSelected; // ms:w, app:r / app:r // (If using deletion) Last known selection state for NavId (if part of submitted items).
2918 bool RangeSrcReset; // app:w / ms:r // (If using deletion) Set before EndMultiSelect() to reset ResetSrcItem (e.g. if deleted selection).
2919 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.
2920};
2921
2922// Selection request type
2923enum ImGuiSelectionRequestType
2924{
2925 ImGuiSelectionRequestType_None = 0,
2926 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)
2927 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.
2928};
2929
2930// Selection request item
2932{
2933 //------------------------------------------// BeginMultiSelect / EndMultiSelect
2934 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.
2935 bool Selected; // ms:w, app:r / ms:w, app:r // Parameter for SetAll/SetRange requests (true = select, false = unselect)
2936 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.
2937 ImGuiSelectionUserData RangeFirstItem; // / ms:w, app:r // Parameter for SetRange request (this is generally == RangeSrcItem when shift selecting from top to bottom).
2938 ImGuiSelectionUserData RangeLastItem; // / ms:w, app:r // Parameter for SetRange request (this is generally == RangeSrcItem when shift selecting from bottom to top). Inclusive!
2939};
2940
2941// Optional helper to store multi-selection state + apply multi-selection requests.
2942// - Used by our demos and provided as a convenience to easily implement basic multi-selection.
2943// - Iterate selection with 'void* it = NULL; ImGuiID id; while (selection.GetNextSelectedItem(&it, &id)) { ... }'
2944// Or you can check 'if (Contains(id)) { ... }' for each possible object if their number is not too high to iterate.
2945// - USING THIS IS NOT MANDATORY. This is only a helper and not a required API.
2946// To store a multi-selection, in your application you could:
2947// - Use this helper as a convenience. We use our simple key->value ImGuiStorage as a std::set<ImGuiID> replacement.
2948// - Use your own external storage: e.g. std::set<MyObjectId>, std::vector<MyObjectId>, interval trees, intrusively stored selection etc.
2949// In ImGuiSelectionBasicStorage we:
2950// - always use indices in the multi-selection API (passed to SetNextItemSelectionUserData(), retrieved in ImGuiMultiSelectIO)
2951// - use the AdapterIndexToStorageId() indirection layer to abstract how persistent selection data is derived from an index.
2952// - use decently optimized logic to allow queries and insertion of very large selection sets.
2953// - do not preserve selection order.
2954// Many combinations are possible depending on how you prefer to store your items and how you prefer to store your selection.
2955// Large applications are likely to eventually want to get rid of this indirection layer and do their own thing.
2956// See https://github.com/ocornut/imgui/wiki/Multi-Select for details and pseudo-code using this helper.
2958{
2959 // Members
2960 int Size; // // Number of selected items, maintained by this helper.
2961 bool PreserveOrder; // = false // GetNextSelectedItem() will return ordered selection (currently implemented by two additional sorts of selection. Could be improved)
2962 void* UserData; // = NULL // User data for use by adapter function // e.g. selection.UserData = (void*)my_items;
2963 ImGuiID (*AdapterIndexToStorageId)(ImGuiSelectionBasicStorage* self, int idx); // e.g. selection.AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage* self, int idx) { return ((MyItems**)self->UserData)[idx]->ID; };
2964 int _SelectionOrder;// [Internal] Increasing counter to store selection order
2965 ImGuiStorage _Storage; // [Internal] Selection set. Think of this as similar to e.g. std::set<ImGuiID>. Prefer not accessing directly: iterate with GetNextSelectedItem().
2966
2967 // Methods
2969 IMGUI_API void ApplyRequests(ImGuiMultiSelectIO* ms_io); // Apply selection requests coming from BeginMultiSelect() and EndMultiSelect() functions. It uses 'items_count' passed to BeginMultiSelect()
2970 IMGUI_API bool Contains(ImGuiID id) const; // Query if an item id is in selection.
2971 IMGUI_API void Clear(); // Clear selection
2972 IMGUI_API void Swap(ImGuiSelectionBasicStorage& r); // Swap two selections
2973 IMGUI_API void SetItemSelected(ImGuiID id, bool selected); // Add/remove an item from selection (generally done by ApplyRequests() function)
2974 IMGUI_API bool GetNextSelectedItem(void** opaque_it, ImGuiID* out_id); // Iterate selection with 'void* it = NULL; ImGuiId id; while (selection.GetNextSelectedItem(&it, &id)) { ... }'
2975 inline ImGuiID GetStorageIdFromIndex(int idx) { return AdapterIndexToStorageId(this, idx); } // Convert index to item id based on provided adapter.
2976};
2977
2978// Optional helper to apply multi-selection requests to existing randomly accessible storage.
2979// Convenient if you want to quickly wire multi-select API on e.g. an array of bool or items storing their own selection state.
2981{
2982 // Members
2983 void* UserData; // User data for use by adapter function // e.g. selection.UserData = (void*)my_items;
2984 void (*AdapterSetItemSelected)(ImGuiSelectionExternalStorage* self, int idx, bool selected); // e.g. AdapterSetItemSelected = [](ImGuiSelectionExternalStorage* self, int idx, bool selected) { ((MyItems**)self->UserData)[idx]->Selected = selected; }
2985
2986 // Methods
2988 IMGUI_API void ApplyRequests(ImGuiMultiSelectIO* ms_io); // Apply selection requests by using AdapterSetItemSelected() calls
2989};
2990
2991//-----------------------------------------------------------------------------
2992// [SECTION] Drawing API (ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawListFlags, ImDrawList, ImDrawData)
2993// Hold a series of drawing commands. The user provides a renderer for ImDrawData which essentially contains an array of ImDrawList.
2994//-----------------------------------------------------------------------------
2995
2996// The maximum line width to bake anti-aliased textures for. Build atlas with ImFontAtlasFlags_NoBakedLines to disable baking.
2997#ifndef IM_DRAWLIST_TEX_LINES_WIDTH_MAX
2998#define IM_DRAWLIST_TEX_LINES_WIDTH_MAX (63)
2999#endif
3000
3001// ImDrawCallback: Draw callbacks for advanced uses [configurable type: override in imconfig.h]
3002// NB: You most likely do NOT need to use draw callbacks just to create your own widget or customized UI rendering,
3003// you can poke into the draw list for that! Draw callback may be useful for example to:
3004// A) Change your GPU render state,
3005// B) render a complex 3D scene inside a UI element without an intermediate texture/render target, etc.
3006// The expected behavior from your rendering function is 'if (cmd.UserCallback != NULL) { cmd.UserCallback(parent_list, cmd); } else { RenderTriangles() }'
3007// 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.
3008#ifndef ImDrawCallback
3009typedef void (*ImDrawCallback)(const ImDrawList* parent_list, const ImDrawCmd* cmd);
3010#endif
3011
3012// Special Draw callback value to request renderer backend to reset the graphics/render state.
3013// The renderer backend needs to handle this special value, otherwise it will crash trying to call a function at this address.
3014// This is useful, for example, if you submitted callbacks which you know have altered the render state and you want it to be restored.
3015// 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).
3016#define ImDrawCallback_ResetRenderState (ImDrawCallback)(-8)
3017
3018// Typically, 1 command = 1 GPU draw call (unless command is a callback)
3019// - VtxOffset: When 'io.BackendFlags & ImGuiBackendFlags_RendererHasVtxOffset' is enabled,
3020// this fields allow us to render meshes larger than 64K vertices while keeping 16-bit indices.
3021// Backends made for <1.71. will typically ignore the VtxOffset fields.
3022// - The ClipRect/TextureId/VtxOffset fields must be contiguous as we memcmp() them together (this is asserted for).
3024{
3025 ImVec4 ClipRect; // 4*4 // Clipping rectangle (x1, y1, x2, y2). Subtract ImDrawData->DisplayPos to get clipping rectangle in "viewport" coordinates
3026 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.
3027 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.
3028 unsigned int IdxOffset; // 4 // Start offset in index buffer.
3029 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[].
3030 ImDrawCallback UserCallback; // 4-8 // If != NULL, call the function instead of rendering the vertices. clip_rect and texture_id will be set normally.
3031 void* UserCallbackData; // 4-8 // The draw callback code can access this.
3032
3033 ImDrawCmd() { memset(this, 0, sizeof(*this)); } // Also ensure our padding fields are zeroed
3034
3035 // 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)
3036 inline ImTextureID GetTexID() const { return TextureId; }
3037};
3038
3039// Vertex layout
3040#ifndef IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT
3042{
3045 ImU32 col;
3046};
3047#else
3048// You can override the vertex format layout by defining IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT in imconfig.h
3049// 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.
3050// 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.
3051// 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.
3052IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT;
3053#endif
3054
3055// [Internal] For use by ImDrawList
3057{
3059 ImTextureID TextureId;
3060 unsigned int VtxOffset;
3061};
3062
3063// [Internal] For use by ImDrawListSplitter
3069
3070
3071// Split/Merge functions are used to split the draw list into different layers which can be drawn into out of order.
3072// This is used by the Columns/Tables API, so items of each column can be batched together in a same draw call.
3074{
3075 int _Current; // Current channel number (0)
3076 int _Count; // Number of active channels (1+)
3077 ImVector<ImDrawChannel> _Channels; // Draw channels (not resized down so _Count might be < Channels.Size)
3078
3079 inline ImDrawListSplitter() { memset(this, 0, sizeof(*this)); }
3081 inline void Clear() { _Current = 0; _Count = 1; } // Do not clear Channels[] so our allocations are reused next frame
3082 IMGUI_API void ClearFreeMemory();
3083 IMGUI_API void Split(ImDrawList* draw_list, int count);
3084 IMGUI_API void Merge(ImDrawList* draw_list);
3085 IMGUI_API void SetCurrentChannel(ImDrawList* draw_list, int channel_idx);
3086};
3087
3088// Flags for ImDrawList functions
3089// (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)
3090enum ImDrawFlags_
3091{
3092 ImDrawFlags_None = 0,
3093 ImDrawFlags_Closed = 1 << 0, // PathStroke(), AddPolyline(): specify that shape should be closed (Important: this is always == 1 for legacy reason)
3094 ImDrawFlags_RoundCornersTopLeft = 1 << 4, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-left corner only (when rounding > 0.0f, we default to all corners). Was 0x01.
3095 ImDrawFlags_RoundCornersTopRight = 1 << 5, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-right corner only (when rounding > 0.0f, we default to all corners). Was 0x02.
3096 ImDrawFlags_RoundCornersBottomLeft = 1 << 6, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners). Was 0x04.
3097 ImDrawFlags_RoundCornersBottomRight = 1 << 7, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners). Wax 0x08.
3098 ImDrawFlags_RoundCornersNone = 1 << 8, // AddRect(), AddRectFilled(), PathRect(): disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag!
3099 ImDrawFlags_RoundCornersTop = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersTopRight,
3100 ImDrawFlags_RoundCornersBottom = ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersBottomRight,
3101 ImDrawFlags_RoundCornersLeft = ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersTopLeft,
3102 ImDrawFlags_RoundCornersRight = ImDrawFlags_RoundCornersBottomRight | ImDrawFlags_RoundCornersTopRight,
3103 ImDrawFlags_RoundCornersAll = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersTopRight | ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersBottomRight,
3104 ImDrawFlags_RoundCornersDefault_ = ImDrawFlags_RoundCornersAll, // Default to ALL corners if none of the _RoundCornersXX flags are specified.
3105 ImDrawFlags_RoundCornersMask_ = ImDrawFlags_RoundCornersAll | ImDrawFlags_RoundCornersNone,
3106};
3107
3108// Flags for ImDrawList instance. Those are set automatically by ImGui:: functions from ImGuiIO settings, and generally not manipulated directly.
3109// It is however possible to temporarily alter flags between calls to ImDrawList:: functions.
3110enum ImDrawListFlags_
3111{
3112 ImDrawListFlags_None = 0,
3113 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)
3114 ImDrawListFlags_AntiAliasedLinesUseTex = 1 << 1, // Enable anti-aliased lines/borders using textures when possible. Require backend to render with bilinear filtering (NOT point/nearest filtering).
3115 ImDrawListFlags_AntiAliasedFill = 1 << 2, // Enable anti-aliased edge around filled shapes (rounded rectangles, circles).
3116 ImDrawListFlags_AllowVtxOffset = 1 << 3, // Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
3117};
3118
3119// Draw command list
3120// This is the low-level list of polygons that ImGui:: functions are filling. At the end of the frame,
3121// all command lists are passed to your ImGuiIO::RenderDrawListFn function for rendering.
3122// Each dear imgui window contains its own ImDrawList. You can use ImGui::GetWindowDrawList() to
3123// access the current window draw list and draw custom primitives.
3124// You can interleave normal ImGui:: calls and adding primitives to the current draw list.
3125// In single viewport mode, top-left is == GetMainViewport()->Pos (generally 0,0), bottom-right is == GetMainViewport()->Pos+Size (generally io.DisplaySize).
3126// 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!)
3127// 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.
3129{
3130 // This is what you have to render
3131 ImVector<ImDrawCmd> CmdBuffer; // Draw commands. Typically 1 command = 1 GPU draw call, unless the command is a callback.
3132 ImVector<ImDrawIdx> IdxBuffer; // Index buffer. Each command consume ImDrawCmd::ElemCount of those
3134 ImDrawListFlags Flags; // Flags, you may poke into these to adjust anti-aliasing settings per-primitive.
3135
3136 // [Internal, used while building lists]
3137 unsigned int _VtxCurrentIdx; // [Internal] generally == VtxBuffer.Size unless we are past 64K vertices, in which case this gets reset to 0.
3138 ImDrawListSharedData* _Data; // Pointer to shared draw data (you can use ImGui::GetDrawListSharedData() to get the one from current ImGui context)
3139 ImDrawVert* _VtxWritePtr; // [Internal] point within VtxBuffer.Data after each add command (to avoid using the ImVector<> operators too much)
3140 ImDrawIdx* _IdxWritePtr; // [Internal] point within IdxBuffer.Data after each add command (to avoid using the ImVector<> operators too much)
3141 ImVector<ImVec2> _Path; // [Internal] current path building
3142 ImDrawCmdHeader _CmdHeader; // [Internal] template of active commands. Fields should match those of CmdBuffer.back().
3143 ImDrawListSplitter _Splitter; // [Internal] for channels api (note: prefer using your own persistent instance of ImDrawListSplitter!)
3146 float _FringeScale; // [Internal] anti-alias fringe is scaled by this value, this helps to keep things sharp while zooming at vertex buffer content
3147 const char* _OwnerName; // Pointer to owner window's name for debugging
3148
3149 // 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)
3150 ImDrawList(ImDrawListSharedData* shared_data) { memset(this, 0, sizeof(*this)); _Data = shared_data; }
3151
3153 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)
3154 IMGUI_API void PushClipRectFullScreen();
3155 IMGUI_API void PopClipRect();
3156 IMGUI_API void PushTextureID(ImTextureID texture_id);
3157 IMGUI_API void PopTextureID();
3158 inline ImVec2 GetClipRectMin() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.x, cr.y); }
3159 inline ImVec2 GetClipRectMax() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.z, cr.w); }
3160
3161 // Primitives
3162 // - Filled shapes must always use clockwise winding order. The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
3163 // - For rectangular primitives, "p_min" and "p_max" represent the upper-left and lower-right corners.
3164 // - For circle primitives, use "num_segments == 0" to automatically calculate tessellation (preferred).
3165 // In older versions (until Dear ImGui 1.77) the AddCircle functions defaulted to num_segments == 12.
3166 // In future versions we will use textures to provide cheaper and higher-quality circles.
3167 // Use AddNgon() and AddNgonFilled() functions if you need to guarantee a specific number of sides.
3168 IMGUI_API void AddLine(const ImVec2& p1, const ImVec2& p2, ImU32 col, float thickness = 1.0f);
3169 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)
3170 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)
3171 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);
3172 IMGUI_API void AddQuad(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness = 1.0f);
3173 IMGUI_API void AddQuadFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col);
3174 IMGUI_API void AddTriangle(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness = 1.0f);
3175 IMGUI_API void AddTriangleFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col);
3176 IMGUI_API void AddCircle(const ImVec2& center, float radius, ImU32 col, int num_segments = 0, float thickness = 1.0f);
3177 IMGUI_API void AddCircleFilled(const ImVec2& center, float radius, ImU32 col, int num_segments = 0);
3178 IMGUI_API void AddNgon(const ImVec2& center, float radius, ImU32 col, int num_segments, float thickness = 1.0f);
3179 IMGUI_API void AddNgonFilled(const ImVec2& center, float radius, ImU32 col, int num_segments);
3180 IMGUI_API void AddEllipse(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot = 0.0f, int num_segments = 0, float thickness = 1.0f);
3181 IMGUI_API void AddEllipseFilled(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot = 0.0f, int num_segments = 0);
3182 IMGUI_API void AddText(const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end = NULL);
3183 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);
3184 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)
3185 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)
3186
3187 // General polygon
3188 // - Only simple polygons are supported by filling functions (no self-intersections, no holes).
3189 // - 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.
3190 IMGUI_API void AddPolyline(const ImVec2* points, int num_points, ImU32 col, ImDrawFlags flags, float thickness);
3191 IMGUI_API void AddConvexPolyFilled(const ImVec2* points, int num_points, ImU32 col);
3192 IMGUI_API void AddConcavePolyFilled(const ImVec2* points, int num_points, ImU32 col);
3193
3194 // Image primitives
3195 // - Read FAQ to understand what ImTextureID is.
3196 // - "p_min" and "p_max" represent the upper-left and lower-right corners of the rectangle.
3197 // - "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.
3198 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);
3199 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);
3200 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);
3201
3202 // Stateful path API, add points then finish with PathFillConvex() or PathStroke()
3203 // - Important: filled shapes must always use clockwise winding order! The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
3204 // 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().
3205 inline void PathClear() { _Path.Size = 0; }
3206 inline void PathLineTo(const ImVec2& pos) { _Path.push_back(pos); }
3207 inline void PathLineToMergeDuplicate(const ImVec2& pos) { if (_Path.Size == 0 || memcmp(&_Path.Data[_Path.Size - 1], &pos, 8) != 0) _Path.push_back(pos); }
3208 inline void PathFillConvex(ImU32 col) { AddConvexPolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; }
3209 inline void PathFillConcave(ImU32 col) { AddConcavePolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; }
3210 inline void PathStroke(ImU32 col, ImDrawFlags flags = 0, float thickness = 1.0f) { AddPolyline(_Path.Data, _Path.Size, col, flags, thickness); _Path.Size = 0; }
3211 IMGUI_API void PathArcTo(const ImVec2& center, float radius, float a_min, float a_max, int num_segments = 0);
3212 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
3213 IMGUI_API void PathEllipticalArcTo(const ImVec2& center, const ImVec2& radius, float rot, float a_min, float a_max, int num_segments = 0); // Ellipse
3214 IMGUI_API void PathBezierCubicCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments = 0); // Cubic Bezier (4 control points)
3215 IMGUI_API void PathBezierQuadraticCurveTo(const ImVec2& p2, const ImVec2& p3, int num_segments = 0); // Quadratic Bezier (3 control points)
3216 IMGUI_API void PathRect(const ImVec2& rect_min, const ImVec2& rect_max, float rounding = 0.0f, ImDrawFlags flags = 0);
3217
3218 // Advanced
3219 IMGUI_API void AddCallback(ImDrawCallback callback, void* callback_data); // Your rendering function must check for 'UserCallback' in ImDrawCmd and call the function instead of rendering triangles.
3220 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
3221 IMGUI_API ImDrawList* CloneOutput() const; // Create a clone of the CmdBuffer/IdxBuffer/VtxBuffer.
3222
3223 // Advanced: Channels
3224 // - Use to split render into layers. By switching channels to can render out-of-order (e.g. submit FG primitives before BG primitives)
3225 // - 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)
3226 // - This API shouldn't have been in ImDrawList in the first place!
3227 // Prefer using your own persistent instance of ImDrawListSplitter as you can stack them.
3228 // Using the ImDrawList::ChannelsXXXX you cannot stack a split over another.
3229 inline void ChannelsSplit(int count) { _Splitter.Split(this, count); }
3230 inline void ChannelsMerge() { _Splitter.Merge(this); }
3231 inline void ChannelsSetCurrent(int n) { _Splitter.SetCurrentChannel(this, n); }
3232
3233 // Advanced: Primitives allocations
3234 // - We render triangles (three vertices)
3235 // - All primitives needs to be reserved via PrimReserve() beforehand.
3236 IMGUI_API void PrimReserve(int idx_count, int vtx_count);
3237 IMGUI_API void PrimUnreserve(int idx_count, int vtx_count);
3238 IMGUI_API void PrimRect(const ImVec2& a, const ImVec2& b, ImU32 col); // Axis aligned rectangle (composed of two triangles)
3239 IMGUI_API void PrimRectUV(const ImVec2& a, const ImVec2& b, const ImVec2& uv_a, const ImVec2& uv_b, ImU32 col);
3240 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);
3241 inline void PrimWriteVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col) { _VtxWritePtr->pos = pos; _VtxWritePtr->uv = uv; _VtxWritePtr->col = col; _VtxWritePtr++; _VtxCurrentIdx++; }
3242 inline void PrimWriteIdx(ImDrawIdx idx) { *_IdxWritePtr = idx; _IdxWritePtr++; }
3243 inline void PrimVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col) { PrimWriteIdx((ImDrawIdx)_VtxCurrentIdx); PrimWriteVtx(pos, uv, col); } // Write vertex with unique index
3244
3245 // Obsolete names
3246 //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)
3247 //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)
3248 //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)
3249 //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)
3250 //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)
3251
3252 // [Internal helpers]
3253 IMGUI_API void _ResetForNewFrame();
3254 IMGUI_API void _ClearFreeMemory();
3255 IMGUI_API void _PopUnusedDrawCmd();
3256 IMGUI_API void _TryMergeDrawCmds();
3257 IMGUI_API void _OnChangedClipRect();
3258 IMGUI_API void _OnChangedTextureID();
3259 IMGUI_API void _OnChangedVtxOffset();
3260 IMGUI_API int _CalcCircleAutoSegmentCount(float radius) const;
3261 IMGUI_API void _PathArcToFastEx(const ImVec2& center, float radius, int a_min_sample, int a_max_sample, int a_step);
3262 IMGUI_API void _PathArcToN(const ImVec2& center, float radius, float a_min, float a_max, int num_segments);
3263};
3264
3265// All draw data to render a Dear ImGui frame
3266// (NB: the style and the naming convention here is a little inconsistent, we currently preserve them for backward compatibility purpose,
3267// as this is one of the oldest structure exposed by the library! Basically, ImDrawList == CmdList)
3269{
3270 bool Valid; // Only valid after Render() is called and before the next NewFrame() is called.
3271 int CmdListsCount; // Number of ImDrawList* to render
3272 int TotalIdxCount; // For convenience, sum of all ImDrawList's IdxBuffer.Size
3273 int TotalVtxCount; // For convenience, sum of all ImDrawList's VtxBuffer.Size
3274 ImVector<ImDrawList*> CmdLists; // Array of ImDrawList* to render. The ImDrawLists are owned by ImGuiContext and only pointed to from here.
3275 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)
3276 ImVec2 DisplaySize; // Size of the viewport to render (== GetMainViewport()->Size for the main viewport, == io.DisplaySize in most single-viewport applications)
3277 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.
3278 ImGuiViewport* OwnerViewport; // Viewport carrying the ImDrawData instance, might be of use to the renderer (generally not).
3279
3280 // Functions
3282 IMGUI_API void Clear();
3283 IMGUI_API void AddDrawList(ImDrawList* draw_list); // Helper to add an external draw list into an existing ImDrawData.
3284 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!
3285 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.
3286};
3287
3288//-----------------------------------------------------------------------------
3289// [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontAtlasFlags, ImFontAtlas, ImFontGlyphRangesBuilder, ImFont)
3290//-----------------------------------------------------------------------------
3291
3293{
3294 void* FontData; // // TTF/OTF data
3295 int FontDataSize; // // TTF/OTF data size
3296 bool FontDataOwnedByAtlas; // true // TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
3297 int FontNo; // 0 // Index of font within TTF/OTF file
3298 float SizePixels; // // Size in pixels for rasterizer (more or less maps to the resulting font height).
3299 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.
3300 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.
3301 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.
3302 ImVec2 GlyphExtraSpacing; // 0, 0 // Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
3303 ImVec2 GlyphOffset; // 0, 0 // Offset all glyphs from this font input.
3304 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).
3305 float GlyphMinAdvanceX; // 0 // Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
3306 float GlyphMaxAdvanceX; // FLT_MAX // Maximum AdvanceX for glyphs
3307 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.
3308 unsigned int FontBuilderFlags; // 0 // Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure.
3309 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.
3310 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.
3311 ImWchar EllipsisChar; // -1 // Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.
3312
3313 // [Internal]
3314 char Name[40]; // Name (strictly to ease debugging)
3316
3317 IMGUI_API ImFontConfig();
3318};
3319
3320// Hold rendering data for one glyph.
3321// (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)
3323{
3324 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)
3325 unsigned int Visible : 1; // Flag to indicate glyph has no visible pixels (e.g. space). Allow early out when rendering.
3326 unsigned int Codepoint : 30; // 0x0000..0x10FFFF
3327 float AdvanceX; // Distance to next character (= data from font + ImFontConfig::GlyphExtraSpacing.x baked in)
3328 float X0, Y0, X1, Y1; // Glyph corners
3329 float U0, V0, U1, V1; // Texture coordinates
3330};
3331
3332// Helper to build glyph ranges from text/string data. Feed your application strings/characters to it then call BuildRanges().
3333// This is essentially a tightly packed of vector of 64k booleans = 8KB storage.
3335{
3336 ImVector<ImU32> UsedChars; // Store 1-bit per Unicode code point (0=unused, 1=used)
3337
3339 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); }
3340 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
3341 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
3342 inline void AddChar(ImWchar c) { SetBit(c); } // Add character
3343 IMGUI_API void AddText(const char* text, const char* text_end = NULL); // Add string (each character of the UTF-8 string are added)
3344 IMGUI_API void AddRanges(const ImWchar* ranges); // Add ranges, e.g. builder.AddRanges(ImFontAtlas::GetGlyphRangesDefault()) to force add all of ASCII/Latin+Ext
3345 IMGUI_API void BuildRanges(ImVector<ImWchar>* out_ranges); // Output new ranges
3346};
3347
3348// See ImFontAtlas::AddCustomRectXXX functions.
3350{
3351 unsigned short Width, Height; // Input // Desired rectangle dimension
3352 unsigned short X, Y; // Output // Packed position in Atlas
3353 unsigned int GlyphID; // Input // For custom font glyphs only (ID < 0x110000)
3354 float GlyphAdvanceX; // Input // For custom font glyphs only: glyph xadvance
3355 ImVec2 GlyphOffset; // Input // For custom font glyphs only: glyph display offset
3356 ImFont* Font; // Input // For custom font glyphs only: target font
3357 ImFontAtlasCustomRect() { Width = Height = 0; X = Y = 0xFFFF; GlyphID = 0; GlyphAdvanceX = 0.0f; GlyphOffset = ImVec2(0, 0); Font = NULL; }
3358 bool IsPacked() const { return X != 0xFFFF; }
3359};
3360
3361// Flags for ImFontAtlas build
3362enum ImFontAtlasFlags_
3363{
3364 ImFontAtlasFlags_None = 0,
3365 ImFontAtlasFlags_NoPowerOfTwoHeight = 1 << 0, // Don't round the height to next power of two
3366 ImFontAtlasFlags_NoMouseCursors = 1 << 1, // Don't build software mouse cursors into the atlas (save a little texture memory)
3367 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).
3368};
3369
3370// Load and rasterize multiple TTF/OTF fonts into a same texture. The font atlas will build a single texture holding:
3371// - One or more fonts.
3372// - Custom graphics data needed to render the shapes needed by Dear ImGui.
3373// - Mouse cursor shapes for software cursor rendering (unless setting 'Flags |= ImFontAtlasFlags_NoMouseCursors' in the font atlas).
3374// It is the user-code responsibility to setup/build the atlas, then upload the pixel data into a texture accessible by your graphics api.
3375// - 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.
3376// - Call GetTexDataAsAlpha8() or GetTexDataAsRGBA32() to build and retrieve pixels data.
3377// - Upload the pixels data into a texture within your graphics system (see imgui_impl_xxxx.cpp examples)
3378// - Call SetTexID(my_tex_id); and pass the pointer/identifier to your texture in a format natural to your graphics API.
3379// This value will be passed back to you during rendering to identify the texture. Read FAQ entry about ImTextureID for more details.
3380// Common pitfalls:
3381// - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the
3382// atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data.
3383// - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction.
3384// You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
3385// - Even though many functions are suffixed with "TTF", OTF data is supported just as well.
3386// - This is an old API and it is currently awkward for those and various other reasons! We will address them in the future!
3388{
3389 IMGUI_API ImFontAtlas();
3390 IMGUI_API ~ImFontAtlas();
3391 IMGUI_API ImFont* AddFont(const ImFontConfig* font_cfg);
3392 IMGUI_API ImFont* AddFontDefault(const ImFontConfig* font_cfg = NULL);
3393 IMGUI_API ImFont* AddFontFromFileTTF(const char* filename, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL);
3394 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.
3395 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.
3396 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.
3397 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.
3398 IMGUI_API void ClearTexData(); // Clear output texture data (CPU side). Saves RAM once the texture has been copied to graphics memory.
3399 IMGUI_API void ClearFonts(); // Clear output font data (glyphs storage, UV coordinates).
3400 IMGUI_API void Clear(); // Clear all input and output.
3401
3402 // Build atlas, retrieve pixel data.
3403 // 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().
3404 // The pitch is always = Width * BytesPerPixels (1 or 4)
3405 // Building in RGBA32 format is provided for convenience and compatibility, but note that unless you manually manipulate or copy color data into
3406 // the texture (e.g. when using the AddCustomRect*** api), then the RGB pixels emitted will always be white (~75% of memory/bandwidth waste.
3407 IMGUI_API bool Build(); // Build pixels data. This is called automatically for you by the GetTexData*** functions.
3408 IMGUI_API void GetTexDataAsAlpha8(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL); // 1 byte per-pixel
3409 IMGUI_API void GetTexDataAsRGBA32(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL); // 4 bytes-per-pixel
3410 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...
3411 void SetTexID(ImTextureID id) { TexID = id; }
3412
3413 //-------------------------------------------
3414 // Glyph Ranges
3415 //-------------------------------------------
3416
3417 // Helpers to retrieve list of common Unicode ranges (2 value per range, values are inclusive, zero-terminated list)
3418 // NB: Make sure that your string are UTF-8 and NOT in your local code page.
3419 // Read https://github.com/ocornut/imgui/blob/master/docs/FONTS.md/#about-utf-8-encoding for details.
3420 // NB: Consider using ImFontGlyphRangesBuilder to build glyph ranges from textual data.
3421 IMGUI_API const ImWchar* GetGlyphRangesDefault(); // Basic Latin, Extended Latin
3422 IMGUI_API const ImWchar* GetGlyphRangesGreek(); // Default + Greek and Coptic
3423 IMGUI_API const ImWchar* GetGlyphRangesKorean(); // Default + Korean characters
3424 IMGUI_API const ImWchar* GetGlyphRangesJapanese(); // Default + Hiragana, Katakana, Half-Width, Selection of 2999 Ideographs
3425 IMGUI_API const ImWchar* GetGlyphRangesChineseFull(); // Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs
3426 IMGUI_API const ImWchar* GetGlyphRangesChineseSimplifiedCommon();// Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese
3427 IMGUI_API const ImWchar* GetGlyphRangesCyrillic(); // Default + about 400 Cyrillic characters
3428 IMGUI_API const ImWchar* GetGlyphRangesThai(); // Default + Thai characters
3429 IMGUI_API const ImWchar* GetGlyphRangesVietnamese(); // Default + Vietnamese characters
3430
3431 //-------------------------------------------
3432 // [BETA] Custom Rectangles/Glyphs API
3433 //-------------------------------------------
3434
3435 // You can request arbitrary rectangles to be packed into the atlas, for your own purposes.
3436 // - After calling Build(), you can query the rectangle position and render your pixels.
3437 // - If you render colored output, set 'atlas->TexPixelsUseColors = true' as this may help some backends decide of preferred texture format.
3438 // - You can also request your rectangles to be mapped as font glyph (given a font + Unicode point),
3439 // so you can render e.g. custom colorful icons and use them as regular glyphs.
3440 // - Read docs/FONTS.md for more details about using colorful icons.
3441 // - Note: this API may be redesigned later in order to support multi-monitor varying DPI settings.
3442 IMGUI_API int AddCustomRectRegular(int width, int height);
3443 IMGUI_API int AddCustomRectFontGlyph(ImFont* font, ImWchar id, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
3444 ImFontAtlasCustomRect* GetCustomRectByIndex(int index) { IM_ASSERT(index >= 0); return &CustomRects[index]; }
3445
3446 // [Internal]
3447 IMGUI_API void CalcCustomRectUV(const ImFontAtlasCustomRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const;
3448 IMGUI_API bool GetMouseCursorTexData(ImGuiMouseCursor cursor, ImVec2* out_offset, ImVec2* out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2]);
3449
3450 //-------------------------------------------
3451 // Members
3452 //-------------------------------------------
3453
3454 ImFontAtlasFlags Flags; // Build flags (see ImFontAtlasFlags_)
3455 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.
3456 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.
3457 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).
3458 bool Locked; // Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.
3459 void* UserData; // Store your own atlas related user-data (if e.g. you have multiple font atlas).
3460
3461 // [Internal]
3462 // NB: Access texture data via GetTexData*() calls! Which will setup a default font for you.
3463 bool TexReady; // Set when texture was built matching current font input
3464 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.
3465 unsigned char* TexPixelsAlpha8; // 1 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight
3466 unsigned int* TexPixelsRGBA32; // 4 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight * 4
3467 int TexWidth; // Texture width calculated during Build().
3468 int TexHeight; // Texture height calculated during Build().
3469 ImVec2 TexUvScale; // = (1.0f/TexWidth, 1.0f/TexHeight)
3470 ImVec2 TexUvWhitePixel; // Texture coordinates to a white pixel
3471 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.
3472 ImVector<ImFontAtlasCustomRect> CustomRects; // Rectangles for packing custom texture data into the atlas.
3473 ImVector<ImFontConfig> ConfigData; // Configuration data
3474 ImVec4 TexUvLines[IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 1]; // UVs for baked anti-aliased lines
3475
3476 // [Internal] Font builder
3477 const ImFontBuilderIO* FontBuilderIO; // Opaque interface to a font builder (default to stb_truetype, can be changed to use FreeType by defining IMGUI_ENABLE_FREETYPE).
3478 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.
3479
3480 // [Internal] Packing data
3481 int PackIdMouseCursors; // Custom texture rectangle ID for white pixel and mouse cursors
3482 int PackIdLines; // Custom texture rectangle ID for baked anti-aliased lines
3483
3484 // [Obsolete]
3485 //typedef ImFontAtlasCustomRect CustomRect; // OBSOLETED in 1.72+
3486 //typedef ImFontGlyphRangesBuilder GlyphRangesBuilder; // OBSOLETED in 1.67+
3487};
3488
3489// Font runtime data and rendering
3490// ImFontAtlas automatically loads a default embedded font for you when you call GetTexDataAsAlpha8() or GetTexDataAsRGBA32().
3492{
3493 // Members: Hot ~20/24 bytes (for CalcTextSize)
3494 ImVector<float> IndexAdvanceX; // 12-16 // out // // Sparse. Glyphs->AdvanceX in a directly indexable way (cache-friendly for CalcTextSize functions which only this this info, and are often bottleneck in large UI).
3495 float FallbackAdvanceX; // 4 // out // = FallbackGlyph->AdvanceX
3496 float FontSize; // 4 // in // // Height of characters/line, set during loading (don't change after loading)
3497
3498 // Members: Hot ~28/40 bytes (for CalcTextSize + render loop)
3499 ImVector<ImWchar> IndexLookup; // 12-16 // out // // Sparse. Index glyphs by Unicode code-point.
3500 ImVector<ImFontGlyph> Glyphs; // 12-16 // out // // All glyphs.
3501 const ImFontGlyph* FallbackGlyph; // 4-8 // out // = FindGlyph(FontFallbackChar)
3502
3503 // Members: Cold ~32/40 bytes
3504 ImFontAtlas* ContainerAtlas; // 4-8 // out // // What we has been loaded into
3505 const ImFontConfig* ConfigData; // 4-8 // in // // Pointer within ContainerAtlas->ConfigData
3506 short ConfigDataCount; // 2 // in // ~ 1 // Number of ImFontConfig involved in creating this font. Bigger than 1 when merging multiple font sources into one ImFont.
3507 ImWchar FallbackChar; // 2 // out // = FFFD/'?' // Character used if a glyph isn't found.
3508 ImWchar EllipsisChar; // 2 // out // = '...'/'.'// Character used for ellipsis rendering.
3509 short EllipsisCharCount; // 1 // out // 1 or 3
3510 float EllipsisWidth; // 4 // out // Width
3511 float EllipsisCharStep; // 4 // out // Step between characters when EllipsisCount > 0
3512 bool DirtyLookupTables; // 1 // out //
3513 float Scale; // 4 // in // = 1.f // Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()
3514 float Ascent, Descent; // 4+4 // out // // Ascent: distance from top to bottom of e.g. 'A' [0..FontSize] (unscaled)
3515 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)
3516 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.
3517
3518 // Methods
3519 IMGUI_API ImFont();
3520 IMGUI_API ~ImFont();
3521 IMGUI_API const ImFontGlyph*FindGlyph(ImWchar c) const;
3522 IMGUI_API const ImFontGlyph*FindGlyphNoFallback(ImWchar c) const;
3523 float GetCharAdvance(ImWchar c) const { return ((int)c < IndexAdvanceX.Size) ? IndexAdvanceX[(int)c] : FallbackAdvanceX; }
3524 bool IsLoaded() const { return ContainerAtlas != NULL; }
3525 const char* GetDebugName() const { return ConfigData ? ConfigData->Name : "<unknown>"; }
3526
3527 // 'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable.
3528 // 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable.
3529 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
3530 IMGUI_API const char* CalcWordWrapPositionA(float scale, const char* text, const char* text_end, float wrap_width) const;
3531 IMGUI_API void RenderChar(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, ImWchar c) const;
3532 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;
3533
3534 // [Internal] Don't use!
3535 IMGUI_API void BuildLookupTable();
3536 IMGUI_API void ClearOutputData();
3537 IMGUI_API void GrowIndex(int new_size);
3538 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);
3539 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.
3540 IMGUI_API void SetGlyphVisible(ImWchar c, bool visible);
3541 IMGUI_API bool IsGlyphRangeUnused(unsigned int c_begin, unsigned int c_last);
3542};
3543
3544//-----------------------------------------------------------------------------
3545// [SECTION] Viewports
3546//-----------------------------------------------------------------------------
3547
3548// Flags stored in ImGuiViewport::Flags, giving indications to the platform backends.
3549enum ImGuiViewportFlags_
3550{
3551 ImGuiViewportFlags_None = 0,
3552 ImGuiViewportFlags_IsPlatformWindow = 1 << 0, // Represent a Platform Window
3553 ImGuiViewportFlags_IsPlatformMonitor = 1 << 1, // Represent a Platform Monitor (unused yet)
3554 ImGuiViewportFlags_OwnedByApp = 1 << 2, // Platform Window: Was created/managed by the user application? (rather than our backend)
3555 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)
3556 ImGuiViewportFlags_NoTaskBarIcon = 1 << 4, // Platform Window: Disable platform task bar icon (generally set on popups/tooltips, or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcon is set)
3557 ImGuiViewportFlags_NoFocusOnAppearing = 1 << 5, // Platform Window: Don't take focus when created.
3558 ImGuiViewportFlags_NoFocusOnClick = 1 << 6, // Platform Window: Don't take focus when clicked on.
3559 ImGuiViewportFlags_NoInputs = 1 << 7, // Platform Window: Make mouse pass through so we can drag this window while peaking behind it.
3560 ImGuiViewportFlags_NoRendererClear = 1 << 8, // Platform Window: Renderer doesn't need to clear the framebuffer ahead (because we will fill it entirely).
3561 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!).
3562 ImGuiViewportFlags_TopMost = 1 << 10, // Platform Window: Display on top (for tooltips only).
3563 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".
3564
3565 // Output status flags (from Platform)
3566 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.
3567 ImGuiViewportFlags_IsFocused = 1 << 13, // Platform Window: Window is focused (last call to Platform_GetWindowFocus() returned true)
3568};
3569
3570// - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.
3571// - With multi-viewport enabled, we extend this concept to have multiple active viewports.
3572// - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode.
3573// - About Main Area vs Work Area:
3574// - Main Area = entire viewport.
3575// - Work Area = entire viewport minus sections used by main menu bars (for platform windows), or by task bar (for platform monitor).
3576// - Windows are generally trying to stay within the Work Area of their host viewport.
3578{
3579 ImGuiID ID; // Unique identifier for the viewport
3580 ImGuiViewportFlags Flags; // See ImGuiViewportFlags_
3581 ImVec2 Pos; // Main Area: Position of the viewport (Dear ImGui coordinates are the same as OS desktop/native coordinates)
3582 ImVec2 Size; // Main Area: Size of the viewport.
3583 ImVec2 WorkPos; // Work Area: Position of the viewport minus task bars, menus bars, status bars (>= Pos)
3584 ImVec2 WorkSize; // Work Area: Size of the viewport minus task bars, menu bars, status bars (<= Size)
3585 float DpiScale; // 1.0f = 96 DPI = No extra scale.
3586 ImGuiID ParentViewportId; // (Advanced) 0: no parent. Instruct the platform backend to setup a parent/child relationship between platform windows.
3587 ImDrawData* DrawData; // The ImDrawData corresponding to this viewport. Valid after Render() and until the next call to NewFrame().
3588
3589 // Platform/Backend Dependent Data
3590 // Our design separate the Renderer and Platform backends to facilitate combining default backends with each others.
3591 // When our create your own backend for a custom engine, it is possible that both Renderer and Platform will be handled
3592 // by the same system and you may not need to use all the UserData/Handle fields.
3593 // The library never uses those fields, they are merely storage to facilitate backend implementation.
3594 void* RendererUserData; // void* to hold custom data structure for the renderer (e.g. swap chain, framebuffers etc.). generally set by your Renderer_CreateWindow function.
3595 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.
3596 void* PlatformHandle; // void* to hold higher-level, platform window handle (e.g. HWND, GLFWWindow*, SDL_Window*), for FindViewportByPlatformHandle().
3597 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*)
3598 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.
3599 bool PlatformRequestMove; // Platform window requested move (e.g. window was moved by the OS / host window manager, authoritative position will be OS window position)
3600 bool PlatformRequestResize; // Platform window requested resize (e.g. window was resized by the OS / host window manager, authoritative size will be OS window size)
3601 bool PlatformRequestClose; // Platform window requested closure (e.g. window was moved by the OS / host window manager, e.g. pressing ALT-F4)
3602
3603 ImGuiViewport() { memset(this, 0, sizeof(*this)); }
3604 ~ImGuiViewport() { IM_ASSERT(PlatformUserData == NULL && RendererUserData == NULL); }
3605
3606 // Helpers
3607 ImVec2 GetCenter() const { return ImVec2(Pos.x + Size.x * 0.5f, Pos.y + Size.y * 0.5f); }
3608 ImVec2 GetWorkCenter() const { return ImVec2(WorkPos.x + WorkSize.x * 0.5f, WorkPos.y + WorkSize.y * 0.5f); }
3609};
3610
3611//-----------------------------------------------------------------------------
3612// [SECTION] Platform Dependent Interfaces (for e.g. multi-viewport support)
3613//-----------------------------------------------------------------------------
3614// [BETA] (Optional) This is completely optional, for advanced users!
3615// If you are new to Dear ImGui and trying to integrate it into your engine, you can probably ignore this for now.
3616//
3617// This feature allows you to seamlessly drag Dear ImGui windows outside of your application viewport.
3618// This is achieved by creating new Platform/OS windows on the fly, and rendering into them.
3619// Dear ImGui manages the viewport structures, and the backend create and maintain one Platform/OS window for each of those viewports.
3620//
3621// See Glossary https://github.com/ocornut/imgui/wiki/Glossary for details about some of the terminology.
3622// See Thread https://github.com/ocornut/imgui/issues/1542 for gifs, news and questions about this evolving feature.
3623//
3624// About the coordinates system:
3625// - When multi-viewports are enabled, all Dear ImGui coordinates become absolute coordinates (same as OS coordinates!)
3626// - So e.g. ImGui::SetNextWindowPos(ImVec2(0,0)) will position a window relative to your primary monitor!
3627// - If you want to position windows relative to your main application viewport, use ImGui::GetMainViewport()->Pos as a base position.
3628//
3629// Steps to use multi-viewports in your application, when using a default backend from the examples/ folder:
3630// - Application: Enable feature with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
3631// - Backend: The backend initialization will setup all necessary ImGuiPlatformIO's functions and update monitors info every frame.
3632// - Application: In your main loop, call ImGui::UpdatePlatformWindows(), ImGui::RenderPlatformWindowsDefault() after EndFrame() or Render().
3633// - Application: Fix absolute coordinates used in ImGui::SetWindowPos() or ImGui::SetNextWindowPos() calls.
3634//
3635// Steps to use multi-viewports in your application, when using a custom backend:
3636// - Important: THIS IS NOT EASY TO DO and comes with many subtleties not described here!
3637// It's also an experimental feature, so some of the requirements may evolve.
3638// Consider using default backends if you can. Either way, carefully follow and refer to examples/ backends for details.
3639// - Application: Enable feature with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
3640// - Backend: Hook ImGuiPlatformIO's Platform_* and Renderer_* callbacks (see below).
3641// Set 'io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports' and 'io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports'.
3642// Update ImGuiPlatformIO's Monitors list every frame.
3643// Update MousePos every frame, in absolute coordinates.
3644// - Application: In your main loop, call ImGui::UpdatePlatformWindows(), ImGui::RenderPlatformWindowsDefault() after EndFrame() or Render().
3645// You may skip calling RenderPlatformWindowsDefault() if its API is not convenient for your needs. Read comments below.
3646// - Application: Fix absolute coordinates used in ImGui::SetWindowPos() or ImGui::SetNextWindowPos() calls.
3647//
3648// About ImGui::RenderPlatformWindowsDefault():
3649// - This function is a mostly a _helper_ for the common-most cases, and to facilitate using default backends.
3650// - You can check its simple source code to understand what it does.
3651// It basically iterates secondary viewports and call 4 functions that are setup in ImGuiPlatformIO, if available:
3652// Platform_RenderWindow(), Renderer_RenderWindow(), Platform_SwapBuffers(), Renderer_SwapBuffers()
3653// Those functions pointers exists only for the benefit of RenderPlatformWindowsDefault().
3654// - If you have very specific rendering needs (e.g. flipping multiple swap-chain simultaneously, unusual sync/threading issues, etc.),
3655// you may be tempted to ignore RenderPlatformWindowsDefault() and write customized code to perform your renderingg.
3656// You may decide to setup the platform_io's *RenderWindow and *SwapBuffers pointers and call your functions through those pointers,
3657// or you may decide to never setup those pointers and call your code directly. They are a convenience, not an obligatory interface.
3658//-----------------------------------------------------------------------------
3659
3660// (Optional) Access via ImGui::GetPlatformIO()
3662{
3663 //------------------------------------------------------------------
3664 // Input - Backend interface/functions + Monitor List
3665 //------------------------------------------------------------------
3666
3667 // (Optional) Platform functions (e.g. Win32, GLFW, SDL2)
3668 // For reference, the second column shows which function are generally calling the Platform Functions:
3669 // N = ImGui::NewFrame() ~ beginning of the dear imgui frame: read info from platform/OS windows (latest size/position)
3670 // F = ImGui::Begin(), ImGui::EndFrame() ~ during the dear imgui frame
3671 // U = ImGui::UpdatePlatformWindows() ~ after the dear imgui frame: create and update all platform/OS windows
3672 // R = ImGui::RenderPlatformWindowsDefault() ~ render
3673 // D = ImGui::DestroyPlatformWindows() ~ shutdown
3674 // The general idea is that NewFrame() we will read the current Platform/OS state, and UpdatePlatformWindows() will write to it.
3675 //
3676 // The functions are designed so we can mix and match 2 imgui_impl_xxxx files, one for the Platform (~window/input handling), one for Renderer.
3677 // Custom engine backends will often provide both Platform and Renderer interfaces and so may not need to use all functions.
3678 // Platform functions are typically called before their Renderer counterpart, apart from Destroy which are called the other way.
3679
3680 // Platform function --------------------------------------------------- Called by -----
3681 void (*Platform_CreateWindow)(ImGuiViewport* vp); // . . U . . // Create a new platform window for the given viewport
3682 void (*Platform_DestroyWindow)(ImGuiViewport* vp); // N . U . D //
3683 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
3684 void (*Platform_SetWindowPos)(ImGuiViewport* vp, ImVec2 pos); // . . U . . // Set platform window position (given the upper-left corner of client area)
3686 void (*Platform_SetWindowSize)(ImGuiViewport* vp, ImVec2 size); // . . U . . // Set platform window client area size (ignoring OS decorations such as OS title bar etc.)
3687 ImVec2 (*Platform_GetWindowSize)(ImGuiViewport* vp); // N . . . . // Get platform window client area size
3688 void (*Platform_SetWindowFocus)(ImGuiViewport* vp); // N . . . . // Move window to front and set input focus
3689 bool (*Platform_GetWindowFocus)(ImGuiViewport* vp); // . . U . . //
3690 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
3691 void (*Platform_SetWindowTitle)(ImGuiViewport* vp, const char* str); // . . U . . // Set platform window title (given an UTF-8 string)
3692 void (*Platform_SetWindowAlpha)(ImGuiViewport* vp, float alpha); // . . U . . // (Optional) Setup global transparency (not per-pixel transparency)
3693 void (*Platform_UpdateWindow)(ImGuiViewport* vp); // . . U . . // (Optional) Called by UpdatePlatformWindows(). Optional hook to allow the platform backend from doing general book-keeping every frame.
3694 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().
3695 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().
3696 float (*Platform_GetWindowDpiScale)(ImGuiViewport* vp); // N . . . . // (Optional) [BETA] FIXME-DPI: DPI handling: Return DPI scale for this viewport. 1.0f = 96 DPI.
3697 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.
3698 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).
3699
3700 // (Optional) Renderer functions (e.g. DirectX, OpenGL, Vulkan)
3701 void (*Renderer_CreateWindow)(ImGuiViewport* vp); // . . U . . // Create swap chain, frame buffers etc. (called after Platform_CreateWindow)
3702 void (*Renderer_DestroyWindow)(ImGuiViewport* vp); // N . U . D // Destroy swap chain, frame buffers etc. (called before Platform_DestroyWindow)
3703 void (*Renderer_SetWindowSize)(ImGuiViewport* vp, ImVec2 size); // . . U . . // Resize swap chain, frame buffers etc. (called after Platform_SetWindowSize)
3704 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().
3705 void (*Renderer_SwapBuffers)(ImGuiViewport* vp, void* render_arg); // . . . R . // (Optional) Call Present/SwapBuffers. 'render_arg' is the value passed to RenderPlatformWindowsDefault().
3706
3707 // (Optional) Monitor list
3708 // - Updated by: app/backend. Update every frame to dynamically support changing monitor or DPI configuration.
3709 // - Used by: dear imgui to query DPI info, clamp popups/tooltips within same monitor and not have them straddle monitors.
3711
3712 //------------------------------------------------------------------
3713 // Output - List of viewports to render into platform windows
3714 //------------------------------------------------------------------
3715
3716 // Viewports list (the list is updated by calling ImGui::EndFrame or ImGui::Render)
3717 // (in the future we will attempt to organize this feature to remove the need for a "main viewport")
3718 ImVector<ImGuiViewport*> Viewports; // Main viewports, followed by all secondary viewports.
3719 ImGuiPlatformIO() { memset(this, 0, sizeof(*this)); } // Zero clear
3720};
3721
3722// (Optional) This is required when enabling multi-viewport. Represent the bounds of each connected monitor/display and their DPI.
3723// We use this information for multiple DPI support + clamping the position of popups and tooltips so they don't straddle multiple monitors.
3725{
3726 ImVec2 MainPos, MainSize; // Coordinates of the area displayed on this monitor (Min = upper left, Max = bottom right)
3727 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.
3728 float DpiScale; // 1.0f = 96 DPI
3729 void* PlatformHandle; // Backend dependant data (e.g. HMONITOR, GLFWmonitor*, SDL Display Index, NSScreen*)
3731};
3732
3733// (Optional) Support for IME (Input Method Editor) via the io.PlatformSetImeDataFn() function.
3735{
3736 bool WantVisible; // A widget wants the IME to be visible
3737 ImVec2 InputPos; // Position of the input cursor
3738 float InputLineHeight; // Line height
3739
3740 ImGuiPlatformImeData() { memset(this, 0, sizeof(*this)); }
3741};
3742
3743//-----------------------------------------------------------------------------
3744// [SECTION] Obsolete functions and types
3745// (Will be removed! Read 'API BREAKING CHANGES' section in imgui.cpp for details)
3746// Please keep your copy of dear imgui up to date! Occasionally set '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in imconfig.h to stay ahead.
3747//-----------------------------------------------------------------------------
3748
3749#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
3750namespace ImGui
3751{
3752 // OBSOLETED in 1.91.0 (from July 2024)
3753 static inline void PushButtonRepeat(bool repeat) { PushItemFlag(ImGuiItemFlags_ButtonRepeat, repeat); }
3754 static inline void PopButtonRepeat() { PopItemFlag(); }
3755 static inline void PushTabStop(bool tab_stop) { PushItemFlag(ImGuiItemFlags_NoTabStop, !tab_stop); }
3756 static inline void PopTabStop() { PopItemFlag(); }
3757 // OBSOLETED in 1.90.0 (from September 2023)
3758 static inline bool BeginChildFrame(ImGuiID id, const ImVec2& size, ImGuiWindowFlags window_flags = 0) { return BeginChild(id, size, ImGuiChildFlags_FrameStyle, window_flags); }
3759 static inline void EndChildFrame() { EndChild(); }
3760 //static inline bool BeginChild(const char* str_id, const ImVec2& size_arg, bool border, ImGuiWindowFlags window_flags){ return BeginChild(str_id, size_arg, border ? ImGuiChildFlags_Border : ImGuiChildFlags_None, window_flags); } // Unnecessary as true == ImGuiChildFlags_Border
3761 //static inline bool BeginChild(ImGuiID id, const ImVec2& size_arg, bool border, ImGuiWindowFlags window_flags) { return BeginChild(id, size_arg, border ? ImGuiChildFlags_Border : ImGuiChildFlags_None, window_flags); } // Unnecessary as true == ImGuiChildFlags_Border
3762 static inline void ShowStackToolWindow(bool* p_open = NULL) { ShowIDStackToolWindow(p_open); }
3763 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);
3764 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);
3765 // OBSOLETED in 1.89.7 (from June 2023)
3766 IMGUI_API void SetItemAllowOverlap(); // Use SetNextItemAllowOverlap() before item.
3767 // OBSOLETED in 1.89.4 (from March 2023)
3768 static inline void PushAllowKeyboardFocus(bool tab_stop) { PushItemFlag(ImGuiItemFlags_NoTabStop, !tab_stop); }
3769 static inline void PopAllowKeyboardFocus() { PopItemFlag(); }
3770 // OBSOLETED in 1.89 (from August 2022)
3771 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)
3772 // OBSOLETED in 1.87 (from February 2022 but more formally obsoleted April 2024)
3773 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!
3774 //static inline ImGuiKey GetKeyIndex(ImGuiKey key) { IM_ASSERT(key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END); return key; }
3775
3776 // Some of the older obsolete names along with their replacement (commented out so they are not reported in IDE)
3777 //-- OBSOLETED in 1.88 (from May 2022)
3778 //static inline void CaptureKeyboardFromApp(bool want_capture_keyboard = true) { SetNextFrameWantCaptureKeyboard(want_capture_keyboard); } // Renamed as name was misleading + removed default value.
3779 //static inline void CaptureMouseFromApp(bool want_capture_mouse = true) { SetNextFrameWantCaptureMouse(want_capture_mouse); } // Renamed as name was misleading + removed default value.
3780 //-- OBSOLETED in 1.86 (from November 2021)
3781 //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.
3782 //-- OBSOLETED in 1.85 (from August 2021)
3783 //static inline float GetWindowContentRegionWidth() { return GetWindowContentRegionMax().x - GetWindowContentRegionMin().x; }
3784 //-- OBSOLETED in 1.81 (from February 2021)
3785 //static inline bool ListBoxHeader(const char* label, const ImVec2& size = ImVec2(0, 0)) { return BeginListBox(label, size); }
3786 //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
3787 //static inline void ListBoxFooter() { EndListBox(); }
3788 //-- OBSOLETED in 1.79 (from August 2020)
3789 //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!
3790 //-- 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.
3791 //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)
3792 //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)
3793 //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)
3794 //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)
3795 //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)
3796 //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)
3797 //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)
3798 //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)
3799 //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)
3800 //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)
3801 //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)
3802 //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)
3803 //-- OBSOLETED in 1.77 and before
3804 //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)
3805 //static inline void TreeAdvanceToLabelPos() { SetCursorPosX(GetCursorPosX() + GetTreeNodeToLabelSpacing()); } // OBSOLETED in 1.72 (from July 2019)
3806 //static inline void SetNextTreeNodeOpen(bool open, ImGuiCond cond = 0) { SetNextItemOpen(open, cond); } // OBSOLETED in 1.71 (from June 2019)
3807 //static inline float GetContentRegionAvailWidth() { return GetContentRegionAvail().x; } // OBSOLETED in 1.70 (from May 2019)
3808 //static inline ImDrawList* GetOverlayDrawList() { return GetForegroundDrawList(); } // OBSOLETED in 1.69 (from Mar 2019)
3809 //static inline void SetScrollHere(float ratio = 0.5f) { SetScrollHereY(ratio); } // OBSOLETED in 1.66 (from Nov 2018)
3810 //static inline bool IsItemDeactivatedAfterChange() { return IsItemDeactivatedAfterEdit(); } // OBSOLETED in 1.63 (from Aug 2018)
3811 //-- OBSOLETED in 1.60 and before
3812 //static inline bool IsAnyWindowFocused() { return IsWindowFocused(ImGuiFocusedFlags_AnyWindow); } // OBSOLETED in 1.60 (from Apr 2018)
3813 //static inline bool IsAnyWindowHovered() { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); } // OBSOLETED in 1.60 (between Dec 2017 and Apr 2018)
3814 //static inline void ShowTestWindow() { return ShowDemoWindow(); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3815 //static inline bool IsRootWindowFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootWindow); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3816 //static inline bool IsRootWindowOrAnyChildFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3817 //static inline void SetNextWindowContentWidth(float w) { SetNextWindowContentSize(ImVec2(w, 0.0f)); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3818 //static inline float GetItemsLineHeightWithSpacing() { return GetFrameHeightWithSpacing(); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3819 //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().
3820 //static inline bool IsRootWindowOrAnyChildHovered() { return IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows); } // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017)
3821 //static inline void AlignFirstTextHeightToWidgets() { AlignTextToFramePadding(); } // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017)
3822 //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)
3823 //static inline bool IsItemHoveredRect() { return IsItemHovered(ImGuiHoveredFlags_RectOnly); } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017)
3824 //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.
3825 //static inline bool IsMouseHoveringAnyWindow() { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017)
3826 //static inline bool IsMouseHoveringWindow() { return IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem); } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017)
3827 //-- OBSOLETED in 1.50 and before
3828 //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
3829 //static inline ImFont*GetWindowFont() { return GetFont(); } // OBSOLETED in 1.48
3830 //static inline float GetWindowFontSize() { return GetFontSize(); } // OBSOLETED in 1.48
3831 //static inline void SetScrollPosHere() { SetScrollHere(); } // OBSOLETED in 1.42
3832}
3833
3834//-- OBSOLETED in 1.82 (from Mars 2021): flags for AddRect(), AddRectFilled(), AddImageRounded(), PathRect()
3835//typedef ImDrawFlags ImDrawCornerFlags;
3836//enum ImDrawCornerFlags_
3837//{
3838// ImDrawCornerFlags_None = ImDrawFlags_RoundCornersNone, // Was == 0 prior to 1.82, this is now == ImDrawFlags_RoundCornersNone which is != 0 and not implicit
3839// ImDrawCornerFlags_TopLeft = ImDrawFlags_RoundCornersTopLeft, // Was == 0x01 (1 << 0) prior to 1.82. Order matches ImDrawFlags_NoRoundCorner* flag (we exploit this internally).
3840// ImDrawCornerFlags_TopRight = ImDrawFlags_RoundCornersTopRight, // Was == 0x02 (1 << 1) prior to 1.82.
3841// ImDrawCornerFlags_BotLeft = ImDrawFlags_RoundCornersBottomLeft, // Was == 0x04 (1 << 2) prior to 1.82.
3842// ImDrawCornerFlags_BotRight = ImDrawFlags_RoundCornersBottomRight, // Was == 0x08 (1 << 3) prior to 1.82.
3843// ImDrawCornerFlags_All = ImDrawFlags_RoundCornersAll, // Was == 0x0F prior to 1.82
3844// ImDrawCornerFlags_Top = ImDrawCornerFlags_TopLeft | ImDrawCornerFlags_TopRight,
3845// ImDrawCornerFlags_Bot = ImDrawCornerFlags_BotLeft | ImDrawCornerFlags_BotRight,
3846// ImDrawCornerFlags_Left = ImDrawCornerFlags_TopLeft | ImDrawCornerFlags_BotLeft,
3847// ImDrawCornerFlags_Right = ImDrawCornerFlags_TopRight | ImDrawCornerFlags_BotRight,
3848//};
3849
3850// RENAMED and MERGED both ImGuiKey_ModXXX and ImGuiModFlags_XXX into ImGuiMod_XXX (from September 2022)
3851// 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.
3852//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.
3853//enum ImGuiModFlags_ { ImGuiModFlags_None = 0, ImGuiModFlags_Ctrl = ImGuiMod_Ctrl, ImGuiModFlags_Shift = ImGuiMod_Shift, ImGuiModFlags_Alt = ImGuiMod_Alt, ImGuiModFlags_Super = ImGuiMod_Super };
3854//typedef ImGuiKeyChord ImGuiKeyModFlags; // == int
3855//enum ImGuiKeyModFlags_ { ImGuiKeyModFlags_None = 0, ImGuiKeyModFlags_Ctrl = ImGuiMod_Ctrl, ImGuiKeyModFlags_Shift = ImGuiMod_Shift, ImGuiKeyModFlags_Alt = ImGuiMod_Alt, ImGuiKeyModFlags_Super = ImGuiMod_Super };
3856
3857#define IM_OFFSETOF(_TYPE,_MEMBER) offsetof(_TYPE, _MEMBER) // OBSOLETED IN 1.90 (now using C++11 standard version)
3858
3859#endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
3860
3861// RENAMED IMGUI_DISABLE_METRICS_WINDOW > IMGUI_DISABLE_DEBUG_TOOLS in 1.88 (from June 2022)
3862#if defined(IMGUI_DISABLE_METRICS_WINDOW) && !defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS) && !defined(IMGUI_DISABLE_DEBUG_TOOLS)
3863#define IMGUI_DISABLE_DEBUG_TOOLS
3864#endif
3865#if defined(IMGUI_DISABLE_METRICS_WINDOW) && defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS)
3866#error IMGUI_DISABLE_METRICS_WINDOW was renamed to IMGUI_DISABLE_DEBUG_TOOLS, please use new name.
3867#endif
3868
3869//-----------------------------------------------------------------------------
3870
3871#if defined(__clang__)
3872#pragma clang diagnostic pop
3873#elif defined(__GNUC__)
3874#pragma GCC diagnostic pop
3875#endif
3876
3877#ifdef _MSC_VER
3878#pragma warning (pop)
3879#endif
3880
3881// Include imgui_user.h at the end of imgui.h
3882// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
3883#ifdef IMGUI_INCLUDE_IMGUI_USER_H
3884#ifdef IMGUI_USER_H_FILENAME
3885#include IMGUI_USER_H_FILENAME
3886#else
3887#include "imgui_user.h"
3888#endif
3889#endif
3890
3891#endif // #ifndef IMGUI_DISABLE
Definition imgui.cpp:1176
IMGUI_API void SetCursorPosY(float local_y)
Definition imgui.cpp:11152
static void PopAllowKeyboardFocus()
Definition imgui.h:3769
IMGUI_API int GetFrameCount()
Definition imgui.cpp:4564
IMGUI_API float GetCursorPosX()
Definition imgui.cpp:11124
IMGUI_API void EndDragDropSource()
Definition imgui.cpp:14107
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)
Definition imgui_widgets.cpp:3822
IMGUI_API bool IsAnyItemHovered()
Definition imgui.cpp:5778
IMGUI_API int TableGetColumnIndex()
Definition imgui_tables.cpp:2066
IMGUI_API bool BeginItemTooltip()
Definition imgui.cpp:11684
IMGUI_API void EndGroup()
Definition imgui.cpp:11367
IMGUI_API bool BeginTooltip()
Definition imgui.cpp:11679
IMGUI_API void ColorConvertHSVtoRGB(float h, float s, float v, float &out_r, float &out_g, float &out_b)
Definition imgui.cpp:2591
IMGUI_API void SetScrollX(float scroll_x)
Definition imgui.cpp:11599
IMGUI_API void PopTextWrapPos()
Definition imgui.cpp:8267
IMGUI_API ImVec2 GetContentRegionMax()
Definition imgui.cpp:11299
IMGUI_API void ShowFontSelector(const char *label)
Definition imgui_demo.cpp:7537
IMGUI_API void TableHeadersRow()
Definition imgui_tables.cpp:3031
IMGUI_API bool IsAnyMouseDown()
Definition imgui.cpp:9763
IMGUI_API ImU32 GetColorU32(ImGuiCol idx, float alpha_mul=1.0f)
Definition imgui.cpp:3260
IMGUI_API void Columns(int count=1, const char *id=NULL, bool border=true)
Definition imgui_tables.cpp:4450
IMGUI_API bool IsPopupOpen(const char *str_id, ImGuiPopupFlags flags=0)
Definition imgui.cpp:11806
IMGUI_API bool IsItemVisible()
Definition imgui.cpp:5796
IMGUI_API bool IsMouseDragging(ImGuiMouseButton button, float lock_threshold=-1.0f)
Definition imgui.cpp:9716
IMGUI_API ImGuiMultiSelectIO * BeginMultiSelect(ImGuiMultiSelectFlags flags, int selection_size=-1, int items_count=-1)
Definition imgui_widgets.cpp:7340
IMGUI_API ImGuiID GetItemID()
Definition imgui.cpp:5842
IMGUI_API void TextV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui_widgets.cpp:295
IMGUI_API bool BeginPopup(const char *str_id, ImGuiWindowFlags flags=0)
Definition imgui.cpp:12049
IMGUI_API const char * GetClipboardText()
Definition imgui.cpp:4521
IMGUI_API bool IsItemClicked(ImGuiMouseButton mouse_button=0)
Definition imgui.cpp:5752
IMGUI_API void PushClipRect(const ImVec2 &clip_rect_min, const ImVec2 &clip_rect_max, bool intersect_with_current_clip_rect)
Definition imgui.cpp:5295
IMGUI_API void SetWindowFontScale(float scale)
Definition imgui.cpp:8733
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)
Definition imgui_widgets.cpp:2680
IMGUI_API void SetNextItemWidth(float item_width)
Definition imgui.cpp:11183
IMGUI_API void PopStyleVar(int count=1)
Definition imgui.cpp:3410
IMGUI_API void EndMenu()
Definition imgui_widgets.cpp:8822
IMGUI_API void SetNextWindowSizeConstraints(const ImVec2 &size_min, const ImVec2 &size_max, ImGuiSizeCallback custom_callback=NULL, void *custom_callback_data=NULL)
Definition imgui.cpp:8621
IMGUI_API const ImGuiPayload * GetDragDropPayload()
Definition imgui.cpp:14289
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)
Definition imgui_widgets.cpp:2593
IMGUI_API void TableAngledHeadersRow()
Definition imgui_tables.cpp:3214
IMGUI_API void Separator()
Definition imgui_widgets.cpp:1616
IMGUI_API ImGuiMultiSelectIO * EndMultiSelect()
Definition imgui_widgets.cpp:7458
IMGUI_API int TableGetHoveredColumn()
Definition imgui_tables.cpp:1770
IMGUI_API ImGuiViewport * FindViewportByID(ImGuiID id)
Definition imgui.cpp:14992
IMGUI_API void Value(const char *prefix, bool b)
Definition imgui_widgets.cpp:8340
static void ShowStackToolWindow(bool *p_open=NULL)
Definition imgui.h:3762
IMGUI_API int TableGetRowIndex()
Definition imgui_tables.cpp:1844
IMGUI_API void StyleColorsClassic(ImGuiStyle *dst=NULL)
Definition imgui_draw.cpp:263
IMGUI_API const char * GetKeyName(ImGuiKey key)
Definition imgui.cpp:9184
IMGUI_API bool TabItemButton(const char *label, ImGuiTabItemFlags flags=0)
Definition imgui_widgets.cpp:9799
IMGUI_API bool BeginMenu(const char *label, bool enabled=true)
Definition imgui_widgets.cpp:8817
IMGUI_API bool InvisibleButton(const char *str_id, const ImVec2 &size, ImGuiButtonFlags flags=0)
Definition imgui_widgets.cpp:781
IMGUI_API bool TreeNodeEx(const char *label, ImGuiTreeNodeFlags flags=0)
Definition imgui_widgets.cpp:6259
IMGUI_API bool IsMousePosValid(const ImVec2 *mouse_pos=NULL)
Definition imgui.cpp:9752
IMGUI_API ImVec2 GetMouseDragDelta(ImGuiMouseButton button=0, float lock_threshold=-1.0f)
Definition imgui.cpp:9775
IMGUI_API void EndFrame()
Definition imgui.cpp:5433
static void PopButtonRepeat()
Definition imgui.h:3754
IMGUI_API bool TreeNodeExV(const char *str_id, ImGuiTreeNodeFlags flags, const char *fmt, va_list args) IM_FMTLIST(3)
Definition imgui_widgets.cpp:6286
IMGUI_API void Spacing()
Definition imgui_widgets.cpp:1502
IMGUI_API const char * GetStyleColorName(ImGuiCol idx)
Definition imgui.cpp:3431
IMGUI_API void MemFree(void *ptr)
Definition imgui.cpp:4485
IMGUI_API void StyleColorsDark(ImGuiStyle *dst=NULL)
Definition imgui_draw.cpp:198
IMGUI_API const char * SaveIniSettingsToMemory(size_t *out_ini_size=NULL)
Definition imgui.cpp:14750
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)
Definition imgui_widgets.cpp:2790
IMGUI_API void PushID(const char *str_id)
Definition imgui.cpp:8946
IMGUI_API void SetCurrentContext(ImGuiContext *ctx)
Definition imgui.cpp:3764
IMGUI_API ImGuiID DockSpaceOverViewport(ImGuiID dockspace_id=0, const ImGuiViewport *viewport=NULL, ImGuiDockNodeFlags flags=0, const ImGuiWindowClass *window_class=NULL)
Definition imgui.cpp:18896
IMGUI_API bool ColorPicker3(const char *label, float col[3], ImGuiColorEditFlags flags=0)
Definition imgui_widgets.cpp:5583
IMGUI_API ImDrawListSharedData * GetDrawListSharedData()
Definition imgui.cpp:4607
IMGUI_API bool IsWindowCollapsed()
Definition imgui.cpp:8561
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))
Definition imgui_widgets.cpp:8311
IMGUI_API bool IsMouseDoubleClicked(ImGuiMouseButton button)
Definition imgui.cpp:9664
IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, bool repeat=false)
Definition imgui.cpp:9623
IMGUI_API bool IsItemActive()
Definition imgui.cpp:5703
IMGUI_API void LogFinish()
Definition imgui.cpp:14490
IMGUI_API bool BeginListBox(const char *label, const ImVec2 &size=ImVec2(0, 0))
Definition imgui_widgets.cpp:8063
IMGUI_API bool IsItemToggledOpen()
Definition imgui.cpp:5757
IMGUI_API ImVec2 GetCursorPos()
Definition imgui.cpp:11118
IMGUI_API ImVec2 GetFontTexUvWhitePixel()
Definition imgui.cpp:8728
IMGUI_API void TreePush(const char *str_id)
Definition imgui_widgets.cpp:6642
IMGUI_API void SetTooltip(const char *fmt,...) IM_FMTARGS(1)
Definition imgui.cpp:11736
IMGUI_API ImGuiIO & GetIO()
Definition imgui.cpp:4539
IMGUI_API void SetScrollHereX(float center_x_ratio=0.5f)
Definition imgui.cpp:11650
IMGUI_API void DebugTextEncoding(const char *text)
Definition imgui.cpp:20270
IMGUI_API ImVec2 GetItemRectSize()
Definition imgui.cpp:5860
IMGUI_API ImGuiID GetID(const char *str_id)
Definition imgui.cpp:9022
IMGUI_API void TableNextRow(ImGuiTableRowFlags row_flags=0, float min_row_height=0.0f)
Definition imgui_tables.cpp:1854
IMGUI_API void SetNextWindowScroll(const ImVec2 &scroll)
Definition imgui.cpp:8639
IMGUI_API void SeparatorText(const char *label)
Definition imgui_widgets.cpp:1684
IMGUI_API void SetItemTooltip(const char *fmt,...) IM_FMTARGS(1)
Definition imgui.cpp:11754
IMGUI_API void TextColored(const ImVec4 &col, const char *fmt,...) IM_FMTARGS(2)
Definition imgui_widgets.cpp:306
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)
Definition imgui_widgets.cpp:3756
IMGUI_API bool InputInt(const char *label, int *v, int step=1, int step_fast=100, ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3776
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)
Definition imgui_widgets.cpp:2769
IMGUI_API void SetItemDefaultFocus()
Definition imgui.cpp:8853
IMGUI_API bool Button(const char *label, const ImVec2 &size=ImVec2(0, 0))
Definition imgui_widgets.cpp:763
IMGUI_API void OpenPopupOnItemClick(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
Definition imgui.cpp:12121
IMGUI_API void SetTooltipV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui.cpp:11744
IMGUI_API const char * TableGetColumnName(int column_n=-1)
Definition imgui_tables.cpp:1685
IMGUI_API bool InputInt4(const char *label, int v[4], ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3793
IMGUI_API ImGuiMouseCursor GetMouseCursor()
Definition imgui.cpp:9800
IMGUI_API void TableSetupScrollFreeze(int cols, int rows)
Definition imgui_tables.cpp:1635
IMGUI_API int GetColumnsCount()
Definition imgui_tables.cpp:4066
IMGUI_API float GetScrollY()
Definition imgui.cpp:11567
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)
Definition imgui_widgets.cpp:3418
IMGUI_API float GetColumnWidth(int column_index=-1)
Definition imgui_tables.cpp:4130
IMGUI_API ImVec2 GetItemRectMax()
Definition imgui.cpp:5854
IMGUI_API bool ColorPicker4(const char *label, float col[4], ImGuiColorEditFlags flags=0, const float *ref_col=NULL)
Definition imgui_widgets.cpp:5606
IMGUI_API ImGuiID DockSpace(ImGuiID dockspace_id, const ImVec2 &size=ImVec2(0, 0), ImGuiDockNodeFlags flags=0, const ImGuiWindowClass *window_class=NULL)
Definition imgui.cpp:18788
IMGUI_API void SetNextWindowCollapsed(bool collapsed, ImGuiCond cond=0)
Definition imgui.cpp:8646
IMGUI_API ImGuiPlatformIO & GetPlatformIO()
Definition imgui.cpp:4545
IMGUI_API double GetTime()
Definition imgui.cpp:4559
IMGUI_API ImVec2 GetContentRegionAvail()
Definition imgui.cpp:11316
IMGUI_API void ProgressBar(float fraction, const ImVec2 &size_arg=ImVec2(-FLT_MIN, 0), const char *overlay=NULL)
Definition imgui_widgets.cpp:1337
IMGUI_API ImVec2 GetWindowPos()
Definition imgui.cpp:8443
IMGUI_API void SetScrollY(float scroll_y)
Definition imgui.cpp:11605
IMGUI_API void TreePop()
Definition imgui_widgets.cpp:6667
static void PushTabStop(bool tab_stop)
Definition imgui.h:3755
IMGUI_API void BeginGroup()
Definition imgui.cpp:11338
IMGUI_API void EndTabItem()
Definition imgui_widgets.cpp:9780
IMGUI_API ImFont * GetFont()
Definition imgui.cpp:8718
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)
Definition imgui_widgets.cpp:2730
IMGUI_API bool BeginPopupContextItem(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
Definition imgui.cpp:12150
IMGUI_API bool ListBox(const char *label, int *current_item, const char *const items[], int items_count, int height_in_items=-1)
Definition imgui_widgets.cpp:8115
IMGUI_API float GetWindowHeight()
Definition imgui.cpp:8437
IMGUI_API bool SetDragDropPayload(const char *type, const void *data, size_t sz, ImGuiCond cond=0)
Definition imgui.cpp:14123
IMGUI_API float GetWindowWidth()
Definition imgui.cpp:8431
IMGUI_API bool IsKeyPressed(ImGuiKey key, bool repeat=true)
Definition imgui.cpp:9549
IMGUI_API int GetKeyPressedAmount(ImGuiKey key, float repeat_delay, float rate)
Definition imgui.cpp:9261
IMGUI_API bool BeginMenuBar()
Definition imgui_widgets.cpp:8430
IMGUI_API ImDrawList * GetBackgroundDrawList(ImGuiViewport *viewport=NULL)
Definition imgui.cpp:4593
IMGUI_API void SetNextItemOpen(bool is_open, ImGuiCond cond=0)
Definition imgui_widgets.cpp:6702
IMGUI_API void TableSetupColumn(const char *label, ImGuiTableColumnFlags flags=0, float init_width_or_weight=0.0f, ImGuiID user_id=0)
Definition imgui_tables.cpp:1561
IMGUI_API void PushItemWidth(float item_width)
Definition imgui.cpp:11191
IMGUI_API void LoadIniSettingsFromDisk(const char *ini_filename)
Definition imgui.cpp:14650
IMGUI_API bool BeginTabItem(const char *label, bool *p_open=NULL, ImGuiTabItemFlags flags=0)
Definition imgui_widgets.cpp:9756
IMGUI_API bool TreeNode(const char *label)
Definition imgui_widgets.cpp:6240
IMGUI_API ImGuiContext * CreateContext(ImFontAtlas *shared_font_atlas=NULL)
Definition imgui.cpp:3788
IMGUI_API void SetCursorPos(const ImVec2 &local_pos)
Definition imgui.cpp:11136
IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0)
Definition imgui.cpp:8388
IMGUI_API ImGuiViewport * FindViewportByPlatformHandle(void *platform_handle)
Definition imgui.cpp:15001
IMGUI_API void End()
Definition imgui.cpp:7903
IMGUI_API bool BeginMainMenuBar()
Definition imgui_widgets.cpp:8546
IMGUI_API void LabelTextV(const char *label, const char *fmt, va_list args) IM_FMTLIST(2)
Definition imgui_widgets.cpp:365
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)
Definition imgui_widgets.cpp:2774
IMGUI_API bool IsItemActivated()
Definition imgui.cpp:5711
IMGUI_API bool IsRectVisible(const ImVec2 &size)
Definition imgui.cpp:8883
IMGUI_API bool Checkbox(const char *label, bool *v)
Definition imgui_widgets.cpp:1151
IMGUI_API bool SliderInt(const char *label, int *v, int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3333
IMGUI_API bool Begin(const char *name, bool *p_open=NULL, ImGuiWindowFlags flags=0)
Definition imgui.cpp:6978
IMGUI_API bool Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags=0)
Definition imgui.cpp:10524
IMGUI_API bool ColorEdit3(const char *label, float col[3], ImGuiColorEditFlags flags=0)
Definition imgui_widgets.cpp:5299
IMGUI_API void TextDisabledV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui_widgets.cpp:329
IMGUI_API bool SmallButton(const char *label)
Definition imgui_widgets.cpp:769
IMGUI_API void SetStateStorage(ImGuiStorage *storage)
Definition imgui.cpp:8871
IMGUI_API float GetTreeNodeToLabelSpacing()
Definition imgui_widgets.cpp:6695
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)
Definition imgui_widgets.cpp:2784
IMGUI_API const ImGuiPayload * AcceptDragDropPayload(const char *type, ImGuiDragDropFlags flags=0)
Definition imgui.cpp:14232
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)
Definition imgui_widgets.cpp:2725
IMGUI_API void SetCursorScreenPos(const ImVec2 &pos)
Definition imgui.cpp:11108
IMGUI_API void EndCombo()
Definition imgui_widgets.cpp:1973
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)
Definition imgui_widgets.cpp:3268
IMGUI_API const char * GetVersion()
Definition imgui.cpp:4534
IMGUI_API bool IsItemEdited()
Definition imgui.cpp:5802
IMGUI_API void SetWindowSize(const ImVec2 &size, ImGuiCond cond=0)
Definition imgui.cpp:8521
static void PushAllowKeyboardFocus(bool tab_stop)
Definition imgui.h:3768
IMGUI_API ImVec2 GetItemRectMin()
Definition imgui.cpp:5848
IMGUI_API bool SliderFloat2(const char *label, float v[2], float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3308
IMGUI_API void TextLinkOpenURL(const char *label, const char *url=NULL)
Definition imgui_widgets.cpp:1472
IMGUI_API void SetScrollFromPosY(float local_y, float center_y_ratio=0.5f)
Definition imgui.cpp:11643
IMGUI_API bool BeginPopupContextVoid(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
Definition imgui.cpp:12178
IMGUI_API bool InputFloat4(const char *label, float v[4], const char *format="%.3f", ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3771
IMGUI_API void EndListBox()
Definition imgui_widgets.cpp:8104
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)
Definition imgui_widgets.cpp:3353
IMGUI_API void RenderPlatformWindowsDefault(void *platform_render_arg=NULL, void *renderer_render_arg=NULL)
Definition imgui.cpp:15828
IMGUI_API bool RadioButton(const char *label, bool active)
Definition imgui_widgets.cpp:1273
IMGUI_API void Indent(float indent_w=0.0f)
Definition imgui.cpp:11166
IMGUI_API bool BeginPopupModal(const char *name, bool *p_open=NULL, ImGuiWindowFlags flags=0)
Definition imgui.cpp:12066
IMGUI_API float GetScrollX()
Definition imgui.cpp:11561
IMGUI_API void LogToClipboard(int auto_open_depth=-1)
Definition imgui.cpp:14474
static void PushButtonRepeat(bool repeat)
Definition imgui.h:3753
IMGUI_API void PushTextWrapPos(float wrap_local_pos_x=0.0f)
Definition imgui.cpp:8260
IMGUI_API ImVec4 ColorConvertU32ToFloat4(ImU32 in)
Definition imgui.cpp:2547
IMGUI_API void ResetMouseDragDelta(ImGuiMouseButton button=0)
Definition imgui.cpp:9788
IMGUI_API void SetItemTooltipV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui.cpp:11763
IMGUI_API ImDrawList * GetForegroundDrawList(ImGuiViewport *viewport=NULL)
Definition imgui.cpp:4600
IMGUI_API void PushStyleColor(ImGuiCol idx, ImU32 col)
Definition imgui.cpp:3294
IMGUI_API void NewLine()
Definition imgui_widgets.cpp:1521
IMGUI_API ImVec2 GetWindowContentRegionMin()
Definition imgui.cpp:11323
IMGUI_API float GetColumnOffset(int column_index=-1)
Definition imgui_tables.cpp:4101
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)
Definition imgui_tables.cpp:326
IMGUI_API void SetNextWindowDockID(ImGuiID dock_id, ImGuiCond cond=0)
Definition imgui.cpp:8675
IMGUI_API void LogButtons()
Definition imgui.cpp:14526
IMGUI_API ImGuiViewport * GetMainViewport()
Definition imgui.cpp:14985
IMGUI_API void SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void *user_data=NULL)
Definition imgui.cpp:3773
IMGUI_API void SetNextWindowBgAlpha(float alpha)
Definition imgui.cpp:8661
IMGUI_API ImGuiTableColumnFlags TableGetColumnFlags(int column_n=-1)
Definition imgui_tables.cpp:1728
IMGUI_API bool IsKeyDown(ImGuiKey key)
Definition imgui.cpp:9534
IMGUI_API bool InputInt2(const char *label, int v[2], ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3783
IMGUI_API bool ShowStyleSelector(const char *label)
Definition imgui_demo.cpp:7563
IMGUI_API ImVec2 CalcTextSize(const char *text, const char *text_end=NULL, bool hide_text_after_double_hash=false, float wrap_width=-1.0f)
Definition imgui.cpp:5602
IMGUI_API bool InputFloat2(const char *label, float v[2], const char *format="%.3f", ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3761
IMGUI_API void GetAllocatorFunctions(ImGuiMemAllocFunc *p_alloc_func, ImGuiMemFreeFunc *p_free_func, void **p_user_data)
Definition imgui.cpp:3781
IMGUI_API void EndTabBar()
Definition imgui_widgets.cpp:9102
IMGUI_API bool SliderFloat(const char *label, float *v, float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3303
IMGUI_API float GetCursorPosY()
Definition imgui.cpp:11130
IMGUI_API bool IsItemToggledSelection()
Definition imgui.cpp:5768
IMGUI_API void TextColoredV(const ImVec4 &col, const char *fmt, va_list args) IM_FMTLIST(2)
Definition imgui_widgets.cpp:314
IMGUI_API bool TextLink(const char *label)
Definition imgui_widgets.cpp:1423
IMGUI_API bool IsAnyItemFocused()
Definition imgui.cpp:5790
IMGUI_API ImGuiViewport * GetWindowViewport()
Definition imgui.cpp:8711
IMGUI_API void Dummy(const ImVec2 &size)
Definition imgui_widgets.cpp:1510
IMGUI_API bool IsItemDeactivatedAfterEdit()
Definition imgui.cpp:5728
IMGUI_API void SetColumnOffset(int column_index, float offset_x)
Definition imgui_tables.cpp:4143
IMGUI_API float GetFrameHeightWithSpacing()
Definition imgui.cpp:11290
IMGUI_API void LoadIniSettingsFromMemory(const char *ini_data, size_t ini_size=0)
Definition imgui.cpp:14663
IMGUI_API ImGuiID GetWindowDockID()
Definition imgui.cpp:8411
IMGUI_API void TableSetColumnEnabled(int column_n, bool v)
Definition imgui_tables.cpp:1712
IMGUI_API ImVec2 GetCursorStartPos()
Definition imgui.cpp:11160
IMGUI_API void NextColumn()
Definition imgui_tables.cpp:4318
IMGUI_API void LogToFile(int auto_open_depth=-1, const char *filename=NULL)
Definition imgui.cpp:14449
IMGUI_API void TextWrappedV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui_widgets.cpp:345
static void PopTabStop()
Definition imgui.h:3756
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))
Definition imgui_widgets.cpp:1066
IMGUI_API void TextUnformatted(const char *text, const char *text_end=NULL)
Definition imgui_widgets.cpp:282
IMGUI_API ImVec2 GetWindowContentRegionMax()
Definition imgui.cpp:11329
IMGUI_API bool InputFloat3(const char *label, float v[3], const char *format="%.3f", ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3766
IMGUI_API void PopStyleColor(int count=1)
Definition imgui.cpp:3316
IMGUI_API float GetWindowDpiScale()
Definition imgui.cpp:8705
IMGUI_API void LogTextV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui.cpp:14341
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)
Definition imgui_widgets.cpp:3413
IMGUI_API bool SliderInt2(const char *label, int v[2], int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3338
IMGUI_API bool IsWindowAppearing()
Definition imgui.cpp:8567
IMGUI_API bool SliderInt4(const char *label, int v[4], int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3348
IMGUI_API bool TreeNodeV(const char *str_id, const char *fmt, va_list args) IM_FMTLIST(2)
Definition imgui_widgets.cpp:6249
IMGUI_API void EndTable()
Definition imgui_tables.cpp:1340
IMGUI_API void OpenPopup(const char *str_id, ImGuiPopupFlags popup_flags=0)
Definition imgui.cpp:11837
IMGUI_API void EndDisabled()
Definition imgui.cpp:8224
IMGUI_API void Text(const char *fmt,...) IM_FMTARGS(1)
Definition imgui_widgets.cpp:287
IMGUI_API bool SliderFloat3(const char *label, float v[3], float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3313
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)
Definition imgui.cpp:10580
IMGUI_API ImDrawList * GetWindowDrawList()
Definition imgui.cpp:8699
IMGUI_API float GetTextLineHeightWithSpacing()
Definition imgui.cpp:11278
IMGUI_API bool MenuItem(const char *label, const char *shortcut=NULL, bool selected=false, bool enabled=true)
Definition imgui_widgets.cpp:8916
IMGUI_API void EndMenuBar()
Definition imgui_widgets.cpp:8459
IMGUI_API bool Combo(const char *label, int *current_item, const char *const items[], int items_count, int popup_max_height_in_items=-1)
Definition imgui_widgets.cpp:2105
IMGUI_API ImGuiStorage * GetStateStorage()
Definition imgui.cpp:8877
IMGUI_API void SetClipboardText(const char *text)
Definition imgui.cpp:4527
IMGUI_API void LogText(const char *fmt,...) IM_FMTARGS(1)
Definition imgui.cpp:14329
IMGUI_API void EndPopup()
Definition imgui.cpp:12100
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)
Definition imgui_widgets.cpp:2736
IMGUI_API bool InputText(const char *label, char *buf, size_t buf_size, ImGuiInputTextFlags flags=0, ImGuiInputTextCallback callback=NULL, void *user_data=NULL)
Definition imgui_widgets.cpp:3816
IMGUI_API bool BeginCombo(const char *label, const char *preview_value, ImGuiComboFlags flags=0)
Definition imgui_widgets.cpp:1830
IMGUI_API void PopItemFlag()
Definition imgui.cpp:8195
IMGUI_API void TextDisabled(const char *fmt,...) IM_FMTARGS(1)
Definition imgui_widgets.cpp:321
IMGUI_API ImVec2 GetWindowSize()
Definition imgui.cpp:8486
IMGUI_API void DebugLog(const char *fmt,...) IM_FMTARGS(1)
Definition imgui.cpp:21650
IMGUI_API void SetWindowPos(const ImVec2 &pos, ImGuiCond cond=0)
Definition imgui.cpp:8474
static void EndChildFrame()
Definition imgui.h:3759
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)
Definition imgui_widgets.cpp:2715
IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val)
Definition imgui.cpp:3382
IMGUI_API float GetTextLineHeight()
Definition imgui.cpp:11272
IMGUI_API void SetTabItemClosed(const char *tab_or_docked_window_label)
Definition imgui_widgets.cpp:10108
IMGUI_API void SetNextWindowContentSize(const ImVec2 &size)
Definition imgui.cpp:8632
IMGUI_API bool IsWindowHovered(ImGuiHoveredFlags flags=0)
Definition imgui.cpp:8342
IMGUI_API void ColorConvertRGBtoHSV(float r, float g, float b, float &out_h, float &out_s, float &out_v)
Definition imgui.cpp:2569
IMGUI_API bool SliderInt3(const char *label, int v[3], int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3343
IMGUI_API void ShowStyleEditor(ImGuiStyle *ref=NULL)
Definition imgui_demo.cpp:7579
IMGUI_API void SetNextWindowSize(const ImVec2 &size, ImGuiCond cond=0)
Definition imgui.cpp:8608
IMGUI_API float GetScrollMaxY()
Definition imgui.cpp:11579
IMGUI_API float CalcItemWidth()
Definition imgui.cpp:11228
IMGUI_API bool IsKeyChordPressed(ImGuiKeyChord key_chord)
Definition imgui.cpp:10468
IMGUI_API void NewFrame()
Definition imgui.cpp:4909
IMGUI_API bool CheckboxFlags(const char *label, int *flags, int flags_value)
Definition imgui_widgets.cpp:1253
IMGUI_API void ShowIDStackToolWindow(bool *p_open=NULL)
Definition imgui.cpp:22021
IMGUI_API void Render()
Definition imgui.cpp:5534
IMGUI_API bool CollapsingHeader(const char *label, ImGuiTreeNodeFlags flags=0)
Definition imgui_widgets.cpp:6714
IMGUI_API void SetWindowCollapsed(bool collapsed, ImGuiCond cond=0)
Definition imgui.cpp:8556
IMGUI_API ImDrawData * GetDrawData()
Definition imgui.cpp:4552
IMGUI_API bool InputInt3(const char *label, int v[3], ImGuiInputTextFlags flags=0)
Definition imgui_widgets.cpp:3788
IMGUI_API void DestroyContext(ImGuiContext *ctx=NULL)
Definition imgui.cpp:3799
IMGUI_API void EndMainMenuBar()
Definition imgui_widgets.cpp:8570
IMGUI_API bool BeginTabBar(const char *str_id, ImGuiTabBarFlags flags=0)
Definition imgui_widgets.cpp:9023
IMGUI_API void PopID()
Definition imgui.cpp:9015
IMGUI_API ImGuiStyle & GetStyle()
Definition imgui.cpp:3254
IMGUI_API void DebugStartItemPicker()
Definition imgui.cpp:21875
IMGUI_API ImU32 ColorConvertFloat4ToU32(const ImVec4 &in)
Definition imgui.cpp:2557
IMGUI_API ImVec2 GetMousePos()
Definition imgui.cpp:9725
IMGUI_API bool IsWindowDocked()
Definition imgui.cpp:8417
IMGUI_API void SetNextFrameWantCaptureKeyboard(bool want_capture_keyboard)
Definition imgui.cpp:10191
IMGUI_API ImVec2 GetMousePosOnOpeningCurrentPopup()
Definition imgui.cpp:9743
IMGUI_API bool BeginDragDropSource(ImGuiDragDropFlags flags=0)
Definition imgui.cpp:13988
IMGUI_API void ShowAboutWindow(bool *p_open=NULL)
Definition imgui_demo.cpp:7348
IMGUI_API void SetNextWindowFocus()
Definition imgui.cpp:8655
IMGUI_API bool ColorEdit4(const char *label, float col[4], ImGuiColorEditFlags flags=0)
Definition imgui_widgets.cpp:5335
IMGUI_API bool BeginDragDropTarget()
Definition imgui.cpp:14195
IMGUI_API float GetFontSize()
Definition imgui.cpp:8723
IMGUI_API void PushFont(ImFont *font)
Definition imgui.cpp:8164
IMGUI_API void SetWindowFocus()
Definition imgui.cpp:8579
IMGUI_API void PushItemFlag(ImGuiItemFlags option, bool enabled)
Definition imgui.cpp:8182
IMGUI_API void SetScrollHereY(float center_y_ratio=0.5f)
Definition imgui.cpp:11663
IMGUI_API void SetColorEditOptions(ImGuiColorEditFlags flags)
Definition imgui_widgets.cpp:6060
IMGUI_API void EndTooltip()
Definition imgui.cpp:11730
IMGUI_API void SetNextWindowViewport(ImGuiID viewport_id)
Definition imgui.cpp:8668
IMGUI_API bool TableNextColumn()
Definition imgui_tables.cpp:2097
IMGUI_API bool IsItemHovered(ImGuiHoveredFlags flags=0)
Definition imgui.cpp:4251
IMGUI_API void SetMouseCursor(ImGuiMouseCursor cursor_type)
Definition imgui.cpp:9806
IMGUI_API ImGuiTableSortSpecs * TableGetSortSpecs()
Definition imgui_tables.cpp:2805
IMGUI_API int TableGetColumnCount()
Definition imgui_tables.cpp:1678
IMGUI_API int GetColumnIndex()
Definition imgui_tables.cpp:4060
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)
Definition imgui_widgets.cpp:3323
IMGUI_API bool IsAnyItemActive()
Definition imgui.cpp:5784
static bool BeginChildFrame(ImGuiID id, const ImVec2 &size, ImGuiWindowFlags window_flags=0)
Definition imgui.h:3758
IMGUI_API bool SliderFloat4(const char *label, float v[4], float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
Definition imgui_widgets.cpp:3318
IMGUI_API void LogToTTY(int auto_open_depth=-1)
Definition imgui.cpp:14436
IMGUI_API void SetScrollFromPosX(float local_x, float center_x_ratio=0.5f)
Definition imgui.cpp:11637
IMGUI_API void PopItemWidth()
Definition imgui.cpp:11219
IMGUI_API bool ArrowButton(const char *str_id, ImGuiDir dir)
Definition imgui_widgets.cpp:833
IMGUI_API void SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags=0)
Definition imgui.cpp:10491
IMGUI_API void Unindent(float indent_w=0.0f)
Definition imgui.cpp:11174
IMGUI_API void TextWrapped(const char *fmt,...) IM_FMTARGS(1)
Definition imgui_widgets.cpp:337
IMGUI_API void ShowUserGuide()
Definition imgui_demo.cpp:7869
IMGUI_API const ImVec4 & GetStyleColorVec4(ImGuiCol idx)
Definition imgui.cpp:3276
IMGUI_API void LabelText(const char *label, const char *fmt,...) IM_FMTARGS(2)
Definition imgui_widgets.cpp:356
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)
Definition imgui_widgets.cpp:3798
IMGUI_API bool IsItemDeactivated()
Definition imgui.cpp:5720
IMGUI_API ImVec2 GetCursorScreenPos()
Definition imgui.cpp:11102
IMGUI_API void SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data)
Definition imgui_widgets.cpp:7541
IMGUI_API bool IsItemFocused()
Definition imgui.cpp:5735
IMGUI_API void SameLine(float offset_from_start_x=0.0f, float spacing=-1.0f)
Definition imgui.cpp:11076
IMGUI_API bool TableSetColumnIndex(int column_n)
Definition imgui_tables.cpp:2076
IMGUI_API bool IsMouseHoveringRect(const ImVec2 &r_min, const ImVec2 &r_max, bool clip=true)
Definition imgui.cpp:9688
IMGUI_API void AlignTextToFramePadding()
Definition imgui_widgets.cpp:1538
IMGUI_API void StyleColorsLight(ImGuiStyle *dst=NULL)
Definition imgui_draw.cpp:329
IMGUI_API void Bullet()
Definition imgui_widgets.cpp:1396
IMGUI_API bool ColorButton(const char *desc_id, const ImVec4 &col, ImGuiColorEditFlags flags=0, const ImVec2 &size=ImVec2(0, 0))
Definition imgui_widgets.cpp:5979
IMGUI_API void TableHeader(const char *label)
Definition imgui_tables.cpp:3072
IMGUI_API bool IsMouseReleased(ImGuiMouseButton button)
Definition imgui.cpp:9650
IMGUI_API float GetFrameHeight()
Definition imgui.cpp:11284
IMGUI_API void SetCursorPosX(float local_x)
Definition imgui.cpp:11144
IMGUI_API void EndDragDropTarget()
Definition imgui.cpp:14295
IMGUI_API void SetKeyboardFocusHere(int offset=0)
Definition imgui.cpp:8820
IMGUI_API void TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n=-1)
Definition imgui_tables.cpp:1792
IMGUI_API void BeginDisabled(bool disabled=true)
Definition imgui.cpp:8209
IMGUI_API void CloseCurrentPopup()
Definition imgui.cpp:11994
IMGUI_API bool BeginChild(const char *str_id, const ImVec2 &size=ImVec2(0, 0), ImGuiChildFlags child_flags=0, ImGuiWindowFlags window_flags=0)
Definition imgui.cpp:5868
IMGUI_API void DestroyPlatformWindows()
Definition imgui.cpp:15938
IMGUI_API void UpdatePlatformWindows()
Definition imgui.cpp:15716
IMGUI_API void SetNextItemAllowOverlap()
Definition imgui.cpp:5811
IMGUI_API bool IsMouseDown(ImGuiMouseButton button)
Definition imgui.cpp:9609
IMGUI_API void * MemAlloc(size_t size)
Definition imgui.cpp:4474
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)
Definition imgui_widgets.cpp:3827
IMGUI_API void PopClipRect()
Definition imgui.cpp:5302
IMGUI_API bool BeginPopupContextWindow(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
Definition imgui.cpp:12164
IMGUI_API void SetColumnWidth(int column_index, float width)
Definition imgui_tables.cpp:4165
IMGUI_API void ShowDebugLogWindow(bool *p_open=NULL)
Definition imgui.cpp:21702
IMGUI_API bool IsKeyReleased(ImGuiKey key)
Definition imgui.cpp:9594
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))
Definition imgui_widgets.cpp:1115
IMGUI_API float GetScrollMaxX()
Definition imgui.cpp:11573
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)
Definition imgui_widgets.cpp:2779
IMGUI_API ImGuiContext * GetCurrentContext()
Definition imgui.cpp:3759
IMGUI_API void PopFont()
Definition imgui.cpp:8174
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))
Definition imgui_widgets.cpp:8322
IMGUI_API void BulletText(const char *fmt,...) IM_FMTARGS(1)
Definition imgui_widgets.cpp:393
IMGUI_API void EndChild()
Definition imgui.cpp:5988
IMGUI_API void BulletTextV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui_widgets.cpp:402
IMGUI_API void ShowDemoWindow(bool *p_open=NULL)
Definition imgui_demo.cpp:303
IMGUI_API bool Selectable(const char *label, bool selected=false, ImGuiSelectableFlags flags=0, const ImVec2 &size=ImVec2(0, 0))
Definition imgui_widgets.cpp:6770
IMGUI_API void DebugLogV(const char *fmt, va_list args) IM_FMTLIST(1)
Definition imgui.cpp:21658
IMGUI_API void SaveIniSettingsToDisk(const char *ini_filename)
Definition imgui.cpp:14733
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)
Definition imgui_widgets.cpp:3721
IMGUI_API void SetNextWindowPos(const ImVec2 &pos, ImGuiCond cond=0, const ImVec2 &pivot=ImVec2(0, 0))
Definition imgui.cpp:8597
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)
Definition imgui_widgets.cpp:2720
IMGUI_API void DebugFlashStyleColor(ImGuiCol idx)
Definition imgui.cpp:20314
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)
Definition imgui_widgets.cpp:3643
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)
Definition imgui_widgets.cpp:3185
IMGUI_API void ShowMetricsWindow(bool *p_open=NULL)
Definition imgui.cpp:20368
IMGUI_API void SetNextWindowClass(const ImGuiWindowClass *window_class)
Definition imgui.cpp:8683
IMGUI_API void SetNextFrameWantCaptureMouse(bool want_capture_mouse)
Definition imgui.cpp:10197
IMGUI_API int GetMouseClickedCount(ImGuiMouseButton button)
Definition imgui.cpp:9678
Definition imgui.h:2829
constexpr ImColor(int r, int g, int b, int a=255)
Definition imgui.h:2835
ImVec4 Value
Definition imgui.h:2830
constexpr ImColor(ImU32 rgba)
Definition imgui.h:2836
constexpr ImColor(const ImVec4 &col)
Definition imgui.h:2834
static ImColor HSV(float h, float s, float v, float a=1.0f)
Definition imgui.h:2842
constexpr ImColor(float r, float g, float b, float a=1.0f)
Definition imgui.h:2833
constexpr ImColor()
Definition imgui.h:2832
void SetHSV(float h, float s, float v, float a=1.0f)
Definition imgui.h:2841
Definition imgui.h:3065
ImVector< ImDrawCmd > _CmdBuffer
Definition imgui.h:3066
ImVector< ImDrawIdx > _IdxBuffer
Definition imgui.h:3067
Definition imgui.h:3057
ImTextureID TextureId
Definition imgui.h:3059
ImVec4 ClipRect
Definition imgui.h:3058
unsigned int VtxOffset
Definition imgui.h:3060
Definition imgui.h:3024
ImTextureID TextureId
Definition imgui.h:3026
unsigned int VtxOffset
Definition imgui.h:3027
ImVec4 ClipRect
Definition imgui.h:3025
ImTextureID GetTexID() const
Definition imgui.h:3036
unsigned int ElemCount
Definition imgui.h:3029
ImDrawCallback UserCallback
Definition imgui.h:3030
ImDrawCmd()
Definition imgui.h:3033
unsigned int IdxOffset
Definition imgui.h:3028
void * UserCallbackData
Definition imgui.h:3031
Definition imgui.h:3269
int TotalIdxCount
Definition imgui.h:3272
ImVec2 DisplayPos
Definition imgui.h:3275
ImVec2 DisplaySize
Definition imgui.h:3276
ImDrawData()
Definition imgui.h:3281
IMGUI_API void Clear()
Definition imgui_draw.cpp:2203
bool Valid
Definition imgui.h:3270
ImVec2 FramebufferScale
Definition imgui.h:3277
ImVector< ImDrawList * > CmdLists
Definition imgui.h:3274
int CmdListsCount
Definition imgui.h:3271
int TotalVtxCount
Definition imgui.h:3273
ImGuiViewport * OwnerViewport
Definition imgui.h:3278
Definition imgui_internal.h:790
Definition imgui.h:3074
ImDrawListSplitter()
Definition imgui.h:3079
~ImDrawListSplitter()
Definition imgui.h:3080
IMGUI_API void ClearFreeMemory()
Definition imgui_draw.cpp:2060
int _Current
Definition imgui.h:3075
ImVector< ImDrawChannel > _Channels
Definition imgui.h:3077
void Clear()
Definition imgui.h:3081
int _Count
Definition imgui.h:3076
Definition imgui.h:3129
~ImDrawList()
Definition imgui.h:3152
unsigned int _VtxCurrentIdx
Definition imgui.h:3137
ImDrawListSplitter _Splitter
Definition imgui.h:3143
void ChannelsMerge()
Definition imgui.h:3230
void PrimVtx(const ImVec2 &pos, const ImVec2 &uv, ImU32 col)
Definition imgui.h:3243
void PrimWriteIdx(ImDrawIdx idx)
Definition imgui.h:3242
ImVector< ImVec2 > _Path
Definition imgui.h:3141
void PathStroke(ImU32 col, ImDrawFlags flags=0, float thickness=1.0f)
Definition imgui.h:3210
IMGUI_API void _ClearFreeMemory()
Definition imgui_draw.cpp:451
ImDrawList(ImDrawListSharedData *shared_data)
Definition imgui.h:3150
const char * _OwnerName
Definition imgui.h:3147
ImVector< ImDrawCmd > CmdBuffer
Definition imgui.h:3131
ImDrawVert * _VtxWritePtr
Definition imgui.h:3139
ImDrawIdx * _IdxWritePtr
Definition imgui.h:3140
void PathLineTo(const ImVec2 &pos)
Definition imgui.h:3206
ImVector< ImTextureID > _TextureIdStack
Definition imgui.h:3145
ImDrawCmdHeader _CmdHeader
Definition imgui.h:3142
ImVec2 GetClipRectMax() const
Definition imgui.h:3159
ImVec2 GetClipRectMin() const
Definition imgui.h:3158
void PathLineToMergeDuplicate(const ImVec2 &pos)
Definition imgui.h:3207
float _FringeScale
Definition imgui.h:3146
ImVector< ImDrawVert > VtxBuffer
Definition imgui.h:3133
IMGUI_API void AddConcavePolyFilled(const ImVec2 *points, int num_points, ImU32 col)
Definition imgui_draw.cpp:1964
void ChannelsSetCurrent(int n)
Definition imgui.h:3231
void PathFillConcave(ImU32 col)
Definition imgui.h:3209
IMGUI_API void AddPolyline(const ImVec2 *points, int num_points, ImU32 col, ImDrawFlags flags, float thickness)
Definition imgui_draw.cpp:749
void ChannelsSplit(int count)
Definition imgui.h:3229
IMGUI_API void AddConvexPolyFilled(const ImVec2 *points, int num_points, ImU32 col)
Definition imgui_draw.cpp:1007
ImDrawListSharedData * _Data
Definition imgui.h:3138
ImDrawListFlags Flags
Definition imgui.h:3134
ImVector< ImDrawIdx > IdxBuffer
Definition imgui.h:3132
ImVector< ImVec4 > _ClipRectStack
Definition imgui.h:3144
void PathClear()
Definition imgui.h:3205
void PathFillConvex(ImU32 col)
Definition imgui.h:3208
void PrimWriteVtx(const ImVec2 &pos, const ImVec2 &uv, ImU32 col)
Definition imgui.h:3241
Definition imgui.h:3042
ImU32 col
Definition imgui.h:3045
ImVec2 uv
Definition imgui.h:3044
ImVec2 pos
Definition imgui.h:3043
Definition imgui.h:3350
ImVec2 GlyphOffset
Definition imgui.h:3355
float GlyphAdvanceX
Definition imgui.h:3354
unsigned short X
Definition imgui.h:3352
unsigned int GlyphID
Definition imgui.h:3353
bool IsPacked() const
Definition imgui.h:3358
unsigned short Height
Definition imgui.h:3351
unsigned short Width
Definition imgui.h:3351
ImFontAtlasCustomRect()
Definition imgui.h:3357
unsigned short Y
Definition imgui.h:3352
ImFont * Font
Definition imgui.h:3356
Definition imgui.h:3388
ImVector< ImFont * > Fonts
Definition imgui.h:3471
int PackIdLines
Definition imgui.h:3482
bool IsBuilt() const
Definition imgui.h:3410
ImTextureID TexID
Definition imgui.h:3455
bool Locked
Definition imgui.h:3458
IMGUI_API ImFont * AddFontFromFileTTF(const char *filename, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
Definition imgui_draw.cpp:2591
int TexWidth
Definition imgui.h:3467
int TexGlyphPadding
Definition imgui.h:3457
IMGUI_API void ClearTexData()
Definition imgui_draw.cpp:2456
IMGUI_API void ClearInputData()
Definition imgui_draw.cpp:2433
unsigned int * TexPixelsRGBA32
Definition imgui.h:3466
const ImFontBuilderIO * FontBuilderIO
Definition imgui.h:3477
unsigned char * TexPixelsAlpha8
Definition imgui.h:3465
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)
Definition imgui_draw.cpp:2627
bool TexPixelsUseColors
Definition imgui.h:3464
int TexHeight
Definition imgui.h:3468
ImFontAtlasCustomRect * GetCustomRectByIndex(int index)
Definition imgui.h:3444
IMGUI_API bool Build()
Definition imgui_draw.cpp:2708
IMGUI_API void GetTexDataAsRGBA32(unsigned char **out_pixels, int *out_width, int *out_height, int *out_bytes_per_pixel=NULL)
Definition imgui_draw.cpp:2495
IMGUI_API void Clear()
Definition imgui_draw.cpp:2476
IMGUI_API ImFont * AddFontFromMemoryTTF(void *font_data, int font_data_size, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
Definition imgui_draw.cpp:2613
void SetTexID(ImTextureID id)
Definition imgui.h:3411
bool TexReady
Definition imgui.h:3463
IMGUI_API ImFont * AddFontDefault(const ImFontConfig *font_cfg=NULL)
Definition imgui_draw.cpp:2570
int TexDesiredWidth
Definition imgui.h:3456
IMGUI_API ImFontAtlas()
Definition imgui_draw.cpp:2420
IMGUI_API ImFont * AddFontFromMemoryCompressedBase85TTF(const char *compressed_font_data_base85, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
Definition imgui_draw.cpp:2639
ImVec4 TexUvLines[IM_DRAWLIST_TEX_LINES_WIDTH_MAX+1]
Definition imgui.h:3474
void * UserData
Definition imgui.h:3459
IMGUI_API ImFont * AddFont(const ImFontConfig *font_cfg)
Definition imgui_draw.cpp:2519
unsigned int FontBuilderFlags
Definition imgui.h:3478
IMGUI_API void ClearFonts()
Definition imgui_draw.cpp:2469
ImVec2 TexUvScale
Definition imgui.h:3469
ImFontAtlasFlags Flags
Definition imgui.h:3454
ImVector< ImFontAtlasCustomRect > CustomRects
Definition imgui.h:3472
IMGUI_API void GetTexDataAsAlpha8(unsigned char **out_pixels, int *out_width, int *out_height, int *out_bytes_per_pixel=NULL)
Definition imgui_draw.cpp:2483
ImVec2 TexUvWhitePixel
Definition imgui.h:3470
ImVector< ImFontConfig > ConfigData
Definition imgui.h:3473
int PackIdMouseCursors
Definition imgui.h:3481
Definition imgui_internal.h:3976
Definition imgui.h:3293
void * FontData
Definition imgui.h:3294
char Name[40]
Definition imgui.h:3314
float RasterizerDensity
Definition imgui.h:3310
unsigned int FontBuilderFlags
Definition imgui.h:3308
ImVec2 GlyphOffset
Definition imgui.h:3303
float SizePixels
Definition imgui.h:3298
float GlyphMinAdvanceX
Definition imgui.h:3305
int FontDataSize
Definition imgui.h:3295
ImFont * DstFont
Definition imgui.h:3315
bool PixelSnapH
Definition imgui.h:3301
int OversampleV
Definition imgui.h:3300
ImVec2 GlyphExtraSpacing
Definition imgui.h:3302
float RasterizerMultiply
Definition imgui.h:3309
bool FontDataOwnedByAtlas
Definition imgui.h:3296
const ImWchar * GlyphRanges
Definition imgui.h:3304
int FontNo
Definition imgui.h:3297
int OversampleH
Definition imgui.h:3299
bool MergeMode
Definition imgui.h:3307
IMGUI_API ImFontConfig()
Definition imgui_draw.cpp:2354
ImWchar EllipsisChar
Definition imgui.h:3311
float GlyphMaxAdvanceX
Definition imgui.h:3306
Definition imgui.h:3335
void SetBit(size_t n)
Definition imgui.h:3341
bool GetBit(size_t n) const
Definition imgui.h:3340
void AddChar(ImWchar c)
Definition imgui.h:3342
void Clear()
Definition imgui.h:3339
ImFontGlyphRangesBuilder()
Definition imgui.h:3338
ImVector< ImU32 > UsedChars
Definition imgui.h:3336
Definition imgui.h:3323
float AdvanceX
Definition imgui.h:3327
float X1
Definition imgui.h:3328
float X0
Definition imgui.h:3328
unsigned int Codepoint
Definition imgui.h:3326
float V0
Definition imgui.h:3329
float U0
Definition imgui.h:3329
float V1
Definition imgui.h:3329
unsigned int Visible
Definition imgui.h:3325
unsigned int Colored
Definition imgui.h:3324
float Y1
Definition imgui.h:3328
float U1
Definition imgui.h:3329
float Y0
Definition imgui.h:3328
Definition imgui.h:3492
ImVector< ImWchar > IndexLookup
Definition imgui.h:3499
const ImFontGlyph * FallbackGlyph
Definition imgui.h:3501
ImVector< ImFontGlyph > Glyphs
Definition imgui.h:3500
IMGUI_API ImFont()
Definition imgui_draw.cpp:3598
float EllipsisWidth
Definition imgui.h:3510
bool DirtyLookupTables
Definition imgui.h:3512
float FontSize
Definition imgui.h:3496
short ConfigDataCount
Definition imgui.h:3506
ImWchar EllipsisChar
Definition imgui.h:3508
const char * GetDebugName() const
Definition imgui.h:3525
float Ascent
Definition imgui.h:3514
int MetricsTotalSurface
Definition imgui.h:3515
ImFontAtlas * ContainerAtlas
Definition imgui.h:3504
ImU8 Used4kPagesMap[(IM_UNICODE_CODEPOINT_MAX+1)/4096/8]
Definition imgui.h:3516
bool IsLoaded() const
Definition imgui.h:3524
float EllipsisCharStep
Definition imgui.h:3511
IMGUI_API const ImFontGlyph * FindGlyphNoFallback(ImWchar c) const
Definition imgui_draw.cpp:3828
short EllipsisCharCount
Definition imgui.h:3509
float Descent
Definition imgui.h:3514
IMGUI_API const ImFontGlyph * FindGlyph(ImWchar c) const
Definition imgui_draw.cpp:3818
float FallbackAdvanceX
Definition imgui.h:3495
float GetCharAdvance(ImWchar c) const
Definition imgui.h:3523
ImWchar FallbackChar
Definition imgui.h:3507
float Scale
Definition imgui.h:3513
ImVector< float > IndexAdvanceX
Definition imgui.h:3494
const ImFontConfig * ConfigData
Definition imgui.h:3505
Definition imgui_internal.h:2180
Definition imgui.h:2280
ImVec2 DisplaySize
Definition imgui.h:2287
IMGUI_API void AddFocusEvent(bool focused)
Definition imgui.cpp:1817
bool WantCaptureMouseUnlessPopupClose
Definition imgui.h:2456
IMGUI_API void AddInputCharacterUTF16(ImWchar16 c)
Definition imgui.cpp:1480
IMGUI_API ImGuiIO()
Definition imgui.cpp:1379
bool ConfigDebugBeginReturnValueOnce
Definition imgui.h:2345
IMGUI_API void AddInputCharacter(unsigned int c)
Definition imgui.cpp:1463
bool WantTextInput
Definition imgui.h:2421
ImVec2 MousePosPrev
Definition imgui.h:2457
ImFont * FontDefault
Definition imgui.h:2297
float MouseDoubleClickMaxDist
Definition imgui.h:2326
void * ClipboardUserData
Definition imgui.h:2372
bool ConfigDockingAlwaysTabBar
Definition imgui.h:2303
bool ConfigWindowsMoveFromTitleBarOnly
Definition imgui.h:2320
int MetricsRenderIndices
Definition imgui.h:2428
bool KeyAlt
Definition imgui.h:2450
float NavInputs[ImGuiNavInput_COUNT]
Definition imgui.h:2487
void(* SetClipboardTextFn)(void *user_data, const char *text)
Definition imgui.h:2371
float MouseWheel
Definition imgui.h:2444
ImVec2 MouseClickedPos[5]
Definition imgui.h:2458
ImFontAtlas * Fonts
Definition imgui.h:2294
float MouseWheelH
Definition imgui.h:2445
float KeyRepeatDelay
Definition imgui.h:2328
bool(* PlatformOpenInShellFn)(ImGuiContext *ctx, const char *path)
Definition imgui.h:2376
bool MouseReleased[5]
Definition imgui.h:2464
IMGUI_API void AddMouseWheelEvent(float wheel_x, float wheel_y)
Definition imgui.cpp:1768
bool KeyShift
Definition imgui.h:2449
ImVec2 MouseDragMaxDistanceAbs[5]
Definition imgui.h:2471
bool WantCaptureKeyboard
Definition imgui.h:2420
ImWchar16 InputQueueSurrogate
Definition imgui.h:2478
ImVector< ImWchar > InputQueueCharacters
Definition imgui.h:2479
float DeltaTime
Definition imgui.h:2288
IMGUI_API void AddKeyEvent(ImGuiKey key, bool down)
Definition imgui.cpp:1654
bool KeyCtrl
Definition imgui.h:2448
const char * BackendPlatformName
Definition imgui.h:2362
float MouseDownDurationPrev[5]
Definition imgui.h:2470
bool KeysDown[ImGuiKey_COUNT]
Definition imgui.h:2486
ImVec2 MouseDelta
Definition imgui.h:2431
void * PlatformOpenInShellUserData
Definition imgui.h:2377
IMGUI_API void ClearInputKeys()
Definition imgui.cpp:1535
bool MouseDownOwnedUnlessPopupClose[5]
Definition imgui.h:2466
ImGuiConfigFlags ConfigFlags
Definition imgui.h:2285
IMGUI_API void AddMouseViewportEvent(ImGuiID id)
Definition imgui.cpp:1796
bool ConfigDebugIgnoreFocusLoss
Definition imgui.h:2351
bool ConfigDebugBeginReturnValueLoop
Definition imgui.h:2346
void(* PlatformSetImeDataFn)(ImGuiContext *ctx, ImGuiViewport *viewport, ImGuiPlatformImeData *data)
Definition imgui.h:2381
bool MouseDownOwned[5]
Definition imgui.h:2465
bool WantSaveIniSettings
Definition imgui.h:2423
IMGUI_API void SetKeyEventNativeData(ImGuiKey key, int native_keycode, int native_scancode, int native_legacy_index=-1)
Definition imgui.cpp:1664
void * BackendPlatformUserData
Definition imgui.h:2364
ImGuiKeyData KeysData[ImGuiKey_KeysData_SIZE]
Definition imgui.h:2455
bool AppFocusLost
Definition imgui.h:2474
ImVec2 DisplayFramebufferScale
Definition imgui.h:2298
ImS8 BackendUsingLegacyKeyArrays
Definition imgui.h:2476
bool ConfigDebugIsDebuggerPresent
Definition imgui.h:2339
float FontGlobalScale
Definition imgui.h:2295
ImGuiKeyChord KeyMods
Definition imgui.h:2454
bool ConfigViewportsNoDecoration
Definition imgui.h:2309
bool ConfigDockingTransparentPayload
Definition imgui.h:2304
IMGUI_API void ClearInputCharacters()
Definition imgui.cpp:1574
bool MouseClicked[5]
Definition imgui.h:2460
float MouseDragMaxDistanceSqr[5]
Definition imgui.h:2472
bool WantSetMousePos
Definition imgui.h:2422
const char * IniFilename
Definition imgui.h:2290
bool MouseDoubleClicked[5]
Definition imgui.h:2461
void * UserData
Definition imgui.h:2292
float Framerate
Definition imgui.h:2426
IMGUI_API void SetAppAcceptingEvents(bool accepting_events)
Definition imgui.cpp:1687
int MetricsRenderVertices
Definition imgui.h:2427
bool ConfigDragClickToInputText
Definition imgui.h:2318
bool MouseDown[5]
Definition imgui.h:2443
ImGuiContext * Ctx
Definition imgui.h:2437
bool NavVisible
Definition imgui.h:2425
ImGuiBackendFlags BackendFlags
Definition imgui.h:2286
ImWchar PlatformLocaleDecimalPoint
Definition imgui.h:2385
bool MouseDrawCursor
Definition imgui.h:2313
float IniSavingRate
Definition imgui.h:2289
bool MouseCtrlLeftAsRightClick
Definition imgui.h:2468
void * BackendRendererUserData
Definition imgui.h:2365
IMGUI_API void ClearInputMouse()
Definition imgui.cpp:1553
IMGUI_API void AddMouseButtonEvent(int button, bool down)
Definition imgui.cpp:1719
int KeyMap[ImGuiKey_COUNT]
Definition imgui.h:2485
bool NavActive
Definition imgui.h:2424
bool BackendUsingLegacyNavInputArray
Definition imgui.h:2477
bool ConfigWindowsResizeFromEdges
Definition imgui.h:2319
bool AppAcceptingEvents
Definition imgui.h:2475
bool ConfigMacOSXBehaviors
Definition imgui.h:2314
bool ConfigDebugIniSettings
Definition imgui.h:2354
float MouseDownDuration[5]
Definition imgui.h:2469
IMGUI_API void AddMousePosEvent(float x, float y)
Definition imgui.cpp:1693
bool ConfigViewportsNoAutoMerge
Definition imgui.h:2307
bool ConfigInputTextEnterKeepActive
Definition imgui.h:2317
IMGUI_API void AddInputCharactersUTF8(const char *str)
Definition imgui.cpp:1514
ImU16 MouseClickedCount[5]
Definition imgui.h:2462
bool ConfigDockingWithShift
Definition imgui.h:2302
IMGUI_API void AddKeyAnalogEvent(ImGuiKey key, bool down, float v)
Definition imgui.cpp:1603
bool MouseWheelRequestAxisSwap
Definition imgui.h:2467
float KeyRepeatRate
Definition imgui.h:2329
bool ConfigDockingNoSplit
Definition imgui.h:2301
const char * BackendRendererName
Definition imgui.h:2363
bool ConfigInputTextCursorBlink
Definition imgui.h:2316
ImVec2 MousePos
Definition imgui.h:2442
void * BackendLanguageUserData
Definition imgui.h:2366
float MouseDragThreshold
Definition imgui.h:2327
float PenPressure
Definition imgui.h:2473
IMGUI_API void AddMouseSourceEvent(ImGuiMouseSource source)
Definition imgui.cpp:1789
ImGuiMouseSource MouseSource
Definition imgui.h:2446
bool ConfigViewportsNoDefaultParent
Definition imgui.h:2310
int MetricsActiveWindows
Definition imgui.h:2430
const char * LogFilename
Definition imgui.h:2291
ImGuiID MouseHoveredViewport
Definition imgui.h:2447
int MetricsRenderWindows
Definition imgui.h:2429
float ConfigMemoryCompactTimer
Definition imgui.h:2321
float MouseDoubleClickTime
Definition imgui.h:2325
ImU16 MouseClickedLastCount[5]
Definition imgui.h:2463
IMGUI_API void ClearEventsQueue()
Definition imgui.cpp:1527
bool ConfigInputTrickleEventQueue
Definition imgui.h:2315
bool WantCaptureMouse
Definition imgui.h:2419
bool FontAllowUserScaling
Definition imgui.h:2296
bool ConfigViewportsNoTaskBarIcon
Definition imgui.h:2308
double MouseClickedTime[5]
Definition imgui.h:2459
bool KeySuper
Definition imgui.h:2451
Definition imgui.h:2508
int BufSize
Definition imgui.h:2523
void ClearSelection()
Definition imgui.h:2535
ImGuiKey EventKey
Definition imgui.h:2520
int CursorPos
Definition imgui.h:2525
int SelectionEnd
Definition imgui.h:2527
ImGuiInputTextFlags EventFlag
Definition imgui.h:2510
int SelectionStart
Definition imgui.h:2526
ImWchar EventChar
Definition imgui.h:2519
IMGUI_API void InsertChars(int pos, const char *text, const char *text_end=NULL)
Definition imgui_widgets.cpp:4073
bool BufDirty
Definition imgui.h:2524
int BufTextLen
Definition imgui.h:2522
void SelectAll()
Definition imgui.h:2534
ImGuiInputTextFlags Flags
Definition imgui.h:2511
bool HasSelection() const
Definition imgui.h:2536
IMGUI_API void DeleteChars(int pos, int bytes_count)
Definition imgui_widgets.cpp:4055
ImGuiContext * Ctx
Definition imgui.h:2509
char * Buf
Definition imgui.h:2521
IMGUI_API ImGuiInputTextCallbackData()
Definition imgui_widgets.cpp:4047
void * UserData
Definition imgui.h:2512
Definition imgui.h:2272
bool Down
Definition imgui.h:2273
float DownDurationPrev
Definition imgui.h:2275
float DownDuration
Definition imgui.h:2274
float AnalogValue
Definition imgui.h:2276
Definition imgui.h:2737
float ItemsHeight
Definition imgui.h:2742
void ForceDisplayRangeByIndices(int item_begin, int item_end)
Definition imgui.h:2767
void IncludeItemByIndex(int item_index)
Definition imgui.h:2757
IMGUI_API void End()
Definition imgui.cpp:3038
ImGuiContext * Ctx
Definition imgui.h:2738
int ItemsCount
Definition imgui.h:2741
void * TempData
Definition imgui.h:2745
void IncludeRangeByIndices(int item_begin, int item_end)
Definition imgui.h:2766
IMGUI_API void Begin(int items_count, float items_height=-1.0f)
Definition imgui.cpp:3009
IMGUI_API void IncludeItemsByIndex(int item_begin, int item_end)
Definition imgui.cpp:3061
double StartSeekOffsetY
Definition imgui.h:2744
int DisplayStart
Definition imgui.h:2739
int DisplayEnd
Definition imgui.h:2740
IMGUI_API bool Step()
Definition imgui.cpp:3227
IMGUI_API ImGuiListClipper()
Definition imgui.cpp:2999
float StartPosY
Definition imgui.h:2743
Definition imgui.h:2912
bool NavIdSelected
Definition imgui.h:2917
int ItemsCount
Definition imgui.h:2919
bool RangeSrcReset
Definition imgui.h:2918
ImGuiSelectionUserData RangeSrcItem
Definition imgui.h:2915
ImGuiSelectionUserData NavIdItem
Definition imgui.h:2916
ImVector< ImGuiSelectionRequest > Requests
Definition imgui.h:2914
Definition imgui.h:2608
int RefFrame
Definition imgui.h:2610
ImGuiOnceUponAFrame()
Definition imgui.h:2609
Definition imgui.h:2573
ImGuiID SourceParentId
Definition imgui.h:2580
bool Preview
Definition imgui.h:2583
ImGuiPayload()
Definition imgui.h:2586
bool IsPreview() const
Definition imgui.h:2589
bool Delivery
Definition imgui.h:2584
int DataSize
Definition imgui.h:2576
char DataType[32+1]
Definition imgui.h:2582
bool IsDataType(const char *type) const
Definition imgui.h:2588
void Clear()
Definition imgui.h:2587
ImGuiID SourceId
Definition imgui.h:2579
int DataFrameCount
Definition imgui.h:2581
bool IsDelivery() const
Definition imgui.h:2590
void * Data
Definition imgui.h:2575
Definition imgui.h:3662
void(* Renderer_SwapBuffers)(ImGuiViewport *vp, void *render_arg)
Definition imgui.h:3705
int(* Platform_CreateVkSurface)(ImGuiViewport *vp, ImU64 vk_inst, const void *vk_allocators, ImU64 *out_vk_surface)
Definition imgui.h:3698
ImVec2(* Platform_GetWindowSize)(ImGuiViewport *vp)
Definition imgui.h:3687
void(* Platform_OnChangedViewport)(ImGuiViewport *vp)
Definition imgui.h:3697
void(* Platform_SetWindowPos)(ImGuiViewport *vp, ImVec2 pos)
Definition imgui.h:3684
void(* Platform_SetWindowSize)(ImGuiViewport *vp, ImVec2 size)
Definition imgui.h:3686
void(* Platform_SwapBuffers)(ImGuiViewport *vp, void *render_arg)
Definition imgui.h:3695
ImVector< ImGuiViewport * > Viewports
Definition imgui.h:3718
void(* Platform_RenderWindow)(ImGuiViewport *vp, void *render_arg)
Definition imgui.h:3694
void(* Platform_SetWindowAlpha)(ImGuiViewport *vp, float alpha)
Definition imgui.h:3692
ImVec2(* Platform_GetWindowPos)(ImGuiViewport *vp)
Definition imgui.h:3685
void(* Renderer_SetWindowSize)(ImGuiViewport *vp, ImVec2 size)
Definition imgui.h:3703
void(* Renderer_CreateWindow)(ImGuiViewport *vp)
Definition imgui.h:3701
bool(* Platform_GetWindowMinimized)(ImGuiViewport *vp)
Definition imgui.h:3690
float(* Platform_GetWindowDpiScale)(ImGuiViewport *vp)
Definition imgui.h:3696
void(* Platform_SetWindowTitle)(ImGuiViewport *vp, const char *str)
Definition imgui.h:3691
ImVector< ImGuiPlatformMonitor > Monitors
Definition imgui.h:3710
void(* Renderer_RenderWindow)(ImGuiViewport *vp, void *render_arg)
Definition imgui.h:3704
void(* Platform_UpdateWindow)(ImGuiViewport *vp)
Definition imgui.h:3693
ImGuiPlatformIO()
Definition imgui.h:3719
void(* Platform_SetWindowFocus)(ImGuiViewport *vp)
Definition imgui.h:3688
bool(* Platform_GetWindowFocus)(ImGuiViewport *vp)
Definition imgui.h:3689
void(* Platform_CreateWindow)(ImGuiViewport *vp)
Definition imgui.h:3681
void(* Platform_ShowWindow)(ImGuiViewport *vp)
Definition imgui.h:3683
void(* Platform_DestroyWindow)(ImGuiViewport *vp)
Definition imgui.h:3682
void(* Renderer_DestroyWindow)(ImGuiViewport *vp)
Definition imgui.h:3702
Definition imgui.h:3735
ImGuiPlatformImeData()
Definition imgui.h:3740
float InputLineHeight
Definition imgui.h:3738
ImVec2 InputPos
Definition imgui.h:3737
bool WantVisible
Definition imgui.h:3736
Definition imgui.h:3725
ImVec2 WorkSize
Definition imgui.h:3727
ImVec2 MainSize
Definition imgui.h:3726
ImGuiPlatformMonitor()
Definition imgui.h:3730
ImVec2 WorkPos
Definition imgui.h:3727
float DpiScale
Definition imgui.h:3728
ImVec2 MainPos
Definition imgui.h:3726
void * PlatformHandle
Definition imgui.h:3729
Definition imgui.h:2958
IMGUI_API void SetItemSelected(ImGuiID id, bool selected)
Definition imgui_widgets.cpp:7924
IMGUI_API void Swap(ImGuiSelectionBasicStorage &r)
Definition imgui_widgets.cpp:7883
ImGuiID GetStorageIdFromIndex(int idx)
Definition imgui.h:2975
IMGUI_API void ApplyRequests(ImGuiMultiSelectIO *ms_io)
Definition imgui_widgets.cpp:7969
bool PreserveOrder
Definition imgui.h:2961
int Size
Definition imgui.h:2960
IMGUI_API bool GetNextSelectedItem(void **opaque_it, ImGuiID *out_id)
Definition imgui_widgets.cpp:7904
IMGUI_API void Clear()
Definition imgui_widgets.cpp:7876
IMGUI_API bool Contains(ImGuiID id) const
Definition imgui_widgets.cpp:7890
int _SelectionOrder
Definition imgui.h:2964
ImGuiSelectionBasicStorage()
Definition imgui_widgets.cpp:7867
void * UserData
Definition imgui.h:2962
ImGuiStorage _Storage
Definition imgui.h:2965
ImGuiID(* AdapterIndexToStorageId)(ImGuiSelectionBasicStorage *self, int idx)
Definition imgui.h:2963
Definition imgui.h:2981
IMGUI_API ImGuiSelectionExternalStorage()
Definition imgui_widgets.cpp:8029
IMGUI_API void ApplyRequests(ImGuiMultiSelectIO *ms_io)
Definition imgui_widgets.cpp:8038
void(* AdapterSetItemSelected)(ImGuiSelectionExternalStorage *self, int idx, bool selected)
Definition imgui.h:2984
void * UserData
Definition imgui.h:2983
Definition imgui.h:2932
bool Selected
Definition imgui.h:2935
ImGuiSelectionUserData RangeFirstItem
Definition imgui.h:2937
ImGuiSelectionUserData RangeLastItem
Definition imgui.h:2938
ImGuiSelectionRequestType Type
Definition imgui.h:2934
ImS8 RangeDirection
Definition imgui.h:2936
Definition imgui.h:2542
ImVec2 DesiredSize
Definition imgui.h:2546
ImVec2 Pos
Definition imgui.h:2544
ImVec2 CurrentSize
Definition imgui.h:2545
void * UserData
Definition imgui.h:2543
Definition imgui.h:2663
ImGuiID key
Definition imgui.h:2664
ImGuiStoragePair(ImGuiID _key, float _val)
Definition imgui.h:2667
void * val_p
Definition imgui.h:2665
int val_i
Definition imgui.h:2665
ImGuiStoragePair(ImGuiID _key, void *_val)
Definition imgui.h:2668
ImGuiStoragePair(ImGuiID _key, int _val)
Definition imgui.h:2666
float val_f
Definition imgui.h:2665
Definition imgui.h:2680
ImVector< ImGuiStoragePair > Data
Definition imgui.h:2682
void Clear()
Definition imgui.h:2687
Definition imgui.h:2197
float ScrollbarRounding
Definition imgui.h:2220
bool AntiAliasedLines
Definition imgui.h:2240
float GrabMinSize
Definition imgui.h:2221
ImVec2 WindowMinSize
Definition imgui.h:2203
float FrameRounding
Definition imgui.h:2211
ImVec2 ButtonTextAlign
Definition imgui.h:2231
ImVec2 ItemInnerSpacing
Definition imgui.h:2214
bool AntiAliasedFill
Definition imgui.h:2242
float FrameBorderSize
Definition imgui.h:2212
float TabRounding
Definition imgui.h:2224
float TabBorderSize
Definition imgui.h:2225
ImVec4 Colors[ImGuiCol_COUNT]
Definition imgui.h:2245
ImGuiHoveredFlags HoverFlagsForTooltipNav
Definition imgui.h:2253
float IndentSpacing
Definition imgui.h:2217
ImVec2 WindowPadding
Definition imgui.h:2200
float DockingSeparatorSize
Definition imgui.h:2238
ImVec2 WindowTitleAlign
Definition imgui.h:2204
float CurveTessellationTol
Definition imgui.h:2243
float GrabRounding
Definition imgui.h:2222
float PopupRounding
Definition imgui.h:2208
float WindowBorderSize
Definition imgui.h:2202
float ChildBorderSize
Definition imgui.h:2207
float MouseCursorScale
Definition imgui.h:2239
ImGuiDir ColorButtonPosition
Definition imgui.h:2230
ImVec2 ItemSpacing
Definition imgui.h:2213
float LogSliderDeadzone
Definition imgui.h:2223
IMGUI_API void ScaleAllSizes(float scale_factor)
Definition imgui.cpp:1350
float SeparatorTextBorderSize
Definition imgui.h:2233
ImVec2 DisplaySafeAreaPadding
Definition imgui.h:2237
float ColumnsMinSpacing
Definition imgui.h:2218
float ScrollbarSize
Definition imgui.h:2219
float Alpha
Definition imgui.h:2198
ImGuiHoveredFlags HoverFlagsForTooltipMouse
Definition imgui.h:2252
float HoverDelayNormal
Definition imgui.h:2251
ImVec2 CellPadding
Definition imgui.h:2215
ImVec2 DisplayWindowPadding
Definition imgui.h:2236
IMGUI_API ImGuiStyle()
Definition imgui.cpp:1287
ImVec2 SeparatorTextAlign
Definition imgui.h:2234
ImVec2 TouchExtraPadding
Definition imgui.h:2216
ImGuiDir WindowMenuButtonPosition
Definition imgui.h:2205
float ChildRounding
Definition imgui.h:2206
ImVec2 TableAngledHeadersTextAlign
Definition imgui.h:2229
float PopupBorderSize
Definition imgui.h:2209
float DisabledAlpha
Definition imgui.h:2199
float CircleTessellationMaxError
Definition imgui.h:2244
float HoverStationaryDelay
Definition imgui.h:2249
bool AntiAliasedLinesUseTex
Definition imgui.h:2241
float WindowRounding
Definition imgui.h:2201
float TabMinWidthForCloseButton
Definition imgui.h:2226
ImVec2 SeparatorTextPadding
Definition imgui.h:2235
float TableAngledHeadersAngle
Definition imgui.h:2228
ImVec2 SelectableTextAlign
Definition imgui.h:2232
ImVec2 FramePadding
Definition imgui.h:2210
float HoverDelayShort
Definition imgui.h:2250
float TabBarBorderSize
Definition imgui.h:2227
Definition imgui.h:2073
ImS16 SortOrder
Definition imgui.h:2076
ImGuiID ColumnUserID
Definition imgui.h:2074
ImGuiSortDirection SortDirection
Definition imgui.h:2077
ImS16 ColumnIndex
Definition imgui.h:2075
ImGuiTableColumnSortSpecs()
Definition imgui.h:2079
Definition imgui.h:2063
int SpecsCount
Definition imgui.h:2065
ImGuiTableSortSpecs()
Definition imgui.h:2068
bool SpecsDirty
Definition imgui.h:2066
const ImGuiTableColumnSortSpecs * Specs
Definition imgui.h:2064
Definition imgui.h:2643
char operator[](int i) const
Definition imgui.h:2648
IMGUI_API void appendf(const char *fmt,...) IM_FMTARGS(2)
Definition imgui.cpp:2889
int size() const
Definition imgui.h:2651
void reserve(int capacity)
Definition imgui.h:2654
static IMGUI_API char EmptyString[1]
Definition imgui.h:2869
ImGuiTextBuffer()
Definition imgui.h:2647
const char * end() const
Definition imgui.h:2650
IMGUI_API void append(const char *str, const char *str_end=NULL)
Definition imgui.cpp:2871
void clear()
Definition imgui.h:2653
ImVector< char > Buf
Definition imgui.h:2644
const char * c_str() const
Definition imgui.h:2655
IMGUI_API void appendfv(const char *fmt, va_list args) IM_FMTLIST(2)
Definition imgui.cpp:2898
const char * begin() const
Definition imgui.h:2649
bool empty() const
Definition imgui.h:2652
bool empty() const
Definition imgui.h:2632
const char * b
Definition imgui.h:2627
ImGuiTextRange()
Definition imgui.h:2630
const char * e
Definition imgui.h:2628
ImGuiTextRange(const char *_b, const char *_e)
Definition imgui.h:2631
IMGUI_API void split(char separator, ImVector< ImGuiTextRange > *out) const
Definition imgui.cpp:2784
Definition imgui.h:2616
IMGUI_API ImGuiTextFilter(const char *default_filter="")
Definition imgui.cpp:2763
ImVector< ImGuiTextRange > Filters
Definition imgui.h:2636
bool IsActive() const
Definition imgui.h:2622
IMGUI_API bool PassFilter(const char *text, const char *text_end=NULL) const
Definition imgui.cpp:2822
void Clear()
Definition imgui.h:2621
IMGUI_API bool Draw(const char *label="Filter (inc,-exc)", float width=0.0f)
Definition imgui.cpp:2774
int CountGrep
Definition imgui.h:2637
char InputBuf[256]
Definition imgui.h:2635
IMGUI_API void Build()
Definition imgui.cpp:2802
Definition imgui.h:3578
void * PlatformUserData
Definition imgui.h:3595
ImGuiViewportFlags Flags
Definition imgui.h:3580
ImVec2 Pos
Definition imgui.h:3581
ImGuiID ParentViewportId
Definition imgui.h:3586
ImGuiID ID
Definition imgui.h:3579
ImVec2 GetWorkCenter() const
Definition imgui.h:3608
bool PlatformRequestMove
Definition imgui.h:3599
bool PlatformWindowCreated
Definition imgui.h:3598
float DpiScale
Definition imgui.h:3585
ImVec2 WorkPos
Definition imgui.h:3583
void * PlatformHandle
Definition imgui.h:3596
~ImGuiViewport()
Definition imgui.h:3604
ImGuiViewport()
Definition imgui.h:3603
void * RendererUserData
Definition imgui.h:3594
void * PlatformHandleRaw
Definition imgui.h:3597
ImVec2 Size
Definition imgui.h:3582
ImVec2 WorkSize
Definition imgui.h:3584
bool PlatformRequestClose
Definition imgui.h:3601
ImDrawData * DrawData
Definition imgui.h:3587
bool PlatformRequestResize
Definition imgui.h:3600
ImVec2 GetCenter() const
Definition imgui.h:3607
Definition imgui.h:2557
ImGuiDockNodeFlags DockNodeFlagsOverrideSet
Definition imgui.h:2564
ImGuiID ClassId
Definition imgui.h:2558
ImGuiViewportFlags ViewportFlagsOverrideSet
Definition imgui.h:2561
ImGuiViewportFlags ViewportFlagsOverrideClear
Definition imgui.h:2562
ImGuiID FocusRouteParentWindowId
Definition imgui.h:2560
bool DockingAlwaysTabBar
Definition imgui.h:2565
ImGuiID ParentViewportId
Definition imgui.h:2559
bool DockingAllowUnclassed
Definition imgui.h:2566
ImGuiTabItemFlags TabItemFlagsOverrideSet
Definition imgui.h:2563
ImGuiWindowClass()
Definition imgui.h:2568
Definition imgui.h:2102
Definition imgui.h:293
float y
Definition imgui.h:294
float x
Definition imgui.h:294
float & operator[](size_t idx)
Definition imgui.h:297
constexpr ImVec2()
Definition imgui.h:295
constexpr ImVec2(float _x, float _y)
Definition imgui.h:296
Definition imgui.h:306
float x
Definition imgui.h:307
constexpr ImVec4()
Definition imgui.h:308
float y
Definition imgui.h:307
float z
Definition imgui.h:307
constexpr ImVec4(float _x, float _y, float _z, float _w)
Definition imgui.h:309
float w
Definition imgui.h:307
Definition imgui.h:2125
bool find_erase_unsorted(const T &v)
Definition imgui.h:2183
void reserve(int new_capacity)
Definition imgui.h:2167
void push_front(const T &v)
Definition imgui.h:2173
const T & operator[](int i) const
Definition imgui.h:2151
const T * begin() const
Definition imgui.h:2154
const T * find(const T &v) const
Definition imgui.h:2180
T * end()
Definition imgui.h:2155
T & back()
Definition imgui.h:2159
bool contains(const T &v) const
Definition imgui.h:2178
T * erase(const T *it)
Definition imgui.h:2174
int find_index(const T &v) const
Definition imgui.h:2181
int _grow_capacity(int sz) const
Definition imgui.h:2163
void pop_back()
Definition imgui.h:2172
int index_from_ptr(const T *it) const
Definition imgui.h:2184
T * find(const T &v)
Definition imgui.h:2179
void reserve_discard(int new_capacity)
Definition imgui.h:2168
const T * end() const
Definition imgui.h:2156
bool find_erase(const T &v)
Definition imgui.h:2182
T * insert(const T *it, const T &v)
Definition imgui.h:2177
ImVector()
Definition imgui.h:2136
T & front()
Definition imgui.h:2157
int max_size() const
Definition imgui.h:2148
ImVector(const ImVector< T > &src)
Definition imgui.h:2137
const T & front() const
Definition imgui.h:2158
value_type * iterator
Definition imgui.h:2132
T * erase_unsorted(const T *it)
Definition imgui.h:2176
T value_type
Definition imgui.h:2131
int size() const
Definition imgui.h:2146
void shrink(int new_size)
Definition imgui.h:2166
T * erase(const T *it, const T *it_last)
Definition imgui.h:2175
~ImVector()
Definition imgui.h:2139
bool empty() const
Definition imgui.h:2145
ImVector< T > & operator=(const ImVector< T > &src)
Definition imgui.h:2138
void push_back(const T &v)
Definition imgui.h:2171
const T & back() const
Definition imgui.h:2160
T * begin()
Definition imgui.h:2153
int Size
Definition imgui.h:2126
int Capacity
Definition imgui.h:2127
void resize(int new_size, const T &v)
Definition imgui.h:2165
T * Data
Definition imgui.h:2128
int capacity() const
Definition imgui.h:2149
void clear_destruct()
Definition imgui.h:2143
void resize(int new_size)
Definition imgui.h:2164
int size_in_bytes() const
Definition imgui.h:2147
void clear()
Definition imgui.h:2141
T & operator[](int i)
Definition imgui.h:2150
void clear_delete()
Definition imgui.h:2142
const value_type * const_iterator
Definition imgui.h:2133
void swap(ImVector< T > &rhs)
Definition imgui.h:2161
Untitled