PURE API 0.5
PR00F's Ultimate Rendering Engine full documentation
Loading...
Searching...
No Matches
imgui.h
Go to the documentation of this file.
1// ===========================================
2// PR00F88 (West Whiskhyll) change starts here
3//
4// The original location of this file is in the internal include directory:
5// include/internal/GUI/imgui-1.88/
6// However, it has been moved to the external include directory:
7// include/external/GUI/imgui-1.88/
8//
9// This is because we are shipping PURE with this Dear ImGui header file, we want to expose
10// Dear ImGui's public API to the application, but we want to avoid file duplication too.
11// So this header is used for 2 things:
12// - to build PURE/PGE;
13// - to be included by the application.
14//
15// PR00F88 (West Whiskhyll) change ends here
16// =========================================
17
18// dear imgui, v1.88
19// (headers)
20
21// Help:
22// - Read FAQ at http://dearimgui.org/faq
23// - Newcomers, read 'Programmer guide' in imgui.cpp for notes on how to setup Dear ImGui in your codebase.
24// - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that.
25// Read imgui.cpp for details, links and comments.
26
27// Resources:
28// - FAQ http://dearimgui.org/faq
29// - Homepage & latest https://github.com/ocornut/imgui
30// - Releases & changelog https://github.com/ocornut/imgui/releases
31// - Gallery https://github.com/ocornut/imgui/issues/5243 (please post your screenshots/video there!)
32// - Wiki https://github.com/ocornut/imgui/wiki (lots of good stuff there)
33// - Glossary https://github.com/ocornut/imgui/wiki/Glossary
34// - Issues & support https://github.com/ocornut/imgui/issues
35
36// Getting Started?
37// - For first-time users having issues compiling/linking/running or issues loading fonts:
38// please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above.
39
40/*
41
42Index of this file:
43// [SECTION] Header mess
44// [SECTION] Forward declarations and basic types
45// [SECTION] Dear ImGui end-user API functions
46// [SECTION] Flags & Enumerations
47// [SECTION] Helpers: Memory allocations macros, ImVector<>
48// [SECTION] ImGuiStyle
49// [SECTION] ImGuiIO
50// [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiPayload, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs)
51// [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, ImColor)
52// [SECTION] Drawing API (ImDrawCallback, ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawFlags, ImDrawListFlags, ImDrawList, ImDrawData)
53// [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontGlyphRangesBuilder, ImFontAtlasFlags, ImFontAtlas, ImFont)
54// [SECTION] Viewports (ImGuiViewportFlags, ImGuiViewport)
55// [SECTION] Platform Dependent Interfaces (ImGuiPlatformImeData)
56// [SECTION] Obsolete functions and types
57
58*/
59
60#pragma once
61
62// Configuration file with compile-time options (edit imconfig.h or '#define IMGUI_USER_CONFIG "myfilename.h" from your build system')
63#ifdef IMGUI_USER_CONFIG
64#include IMGUI_USER_CONFIG
65#endif
66#if !defined(IMGUI_DISABLE_INCLUDE_IMCONFIG_H) || defined(IMGUI_INCLUDE_IMCONFIG_H)
67#include "imconfig.h"
68#endif
69
70#ifndef IMGUI_DISABLE
71
72//-----------------------------------------------------------------------------
73// [SECTION] Header mess
74//-----------------------------------------------------------------------------
75
76// Includes
77#include <float.h> // FLT_MIN, FLT_MAX
78#include <stdarg.h> // va_list, va_start, va_end
79#include <stddef.h> // ptrdiff_t, NULL
80#include <string.h> // memset, memmove, memcpy, strlen, strchr, strcpy, strcmp
81
82// Version
83// (Integer encoded as XYYZZ for use in #if preprocessor conditionals. Work in progress versions typically starts at XYY99 then bounce up to XYY00, XYY01 etc. when release tagging happens)
84#define IMGUI_VERSION "1.88"
85#define IMGUI_VERSION_NUM 18800
86#define IMGUI_CHECKVERSION() ImGui::DebugCheckVersionAndDataLayout(IMGUI_VERSION, sizeof(ImGuiIO), sizeof(ImGuiStyle), sizeof(ImVec2), sizeof(ImVec4), sizeof(ImDrawVert), sizeof(ImDrawIdx))
87#define IMGUI_HAS_TABLE
88
89// Define attributes of all API symbols declarations (e.g. for DLL under Windows)
90// IMGUI_API is used for core imgui functions, IMGUI_IMPL_API is used for the default backends files (imgui_impl_xxx.h)
91// Using dear imgui via a shared library is not recommended, because we don't guarantee backward nor forward ABI compatibility (also function call overhead, as dear imgui is a call-heavy API)
92#ifndef IMGUI_API
93#define IMGUI_API
94#endif
95#ifndef IMGUI_IMPL_API
96#define IMGUI_IMPL_API IMGUI_API
97#endif
98
99// Helper Macros
100#ifndef IM_ASSERT
101#include <assert.h>
102#define IM_ASSERT(_EXPR) assert(_EXPR) // You can override the default assert handler by editing imconfig.h
103#endif
104#define IM_ARRAYSIZE(_ARR) ((int)(sizeof(_ARR) / sizeof(*(_ARR)))) // Size of a static C-style array. Don't use on pointers!
105#define IM_UNUSED(_VAR) ((void)(_VAR)) // Used to silence "unused variable warnings". Often useful as asserts may be stripped out from final builds.
106#define IM_OFFSETOF(_TYPE,_MEMBER) offsetof(_TYPE, _MEMBER) // Offset of _MEMBER within _TYPE. Standardized as offsetof() in C++11
107
108// Helper Macros - IM_FMTARGS, IM_FMTLIST: Apply printf-style warnings to our formatting functions.
109#if !defined(IMGUI_USE_STB_SPRINTF) && defined(__MINGW32__) && !defined(__clang__)
110#define IM_FMTARGS(FMT) __attribute__((format(gnu_printf, FMT, FMT+1)))
111#define IM_FMTLIST(FMT) __attribute__((format(gnu_printf, FMT, 0)))
112#elif !defined(IMGUI_USE_STB_SPRINTF) && (defined(__clang__) || defined(__GNUC__))
113#define IM_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1)))
114#define IM_FMTLIST(FMT) __attribute__((format(printf, FMT, 0)))
115#else
116#define IM_FMTARGS(FMT)
117#define IM_FMTLIST(FMT)
118#endif
119
120// Disable some of MSVC most aggressive Debug runtime checks in function header/footer (used in some simple/low-level functions)
121#if defined(_MSC_VER) && !defined(__clang__) && !defined(__INTEL_COMPILER) && !defined(IMGUI_DEBUG_PARANOID)
122#define IM_MSVC_RUNTIME_CHECKS_OFF __pragma(runtime_checks("",off)) __pragma(check_stack(off)) __pragma(strict_gs_check(push,off))
123#define IM_MSVC_RUNTIME_CHECKS_RESTORE __pragma(runtime_checks("",restore)) __pragma(check_stack()) __pragma(strict_gs_check(pop))
124#else
125#define IM_MSVC_RUNTIME_CHECKS_OFF
126#define IM_MSVC_RUNTIME_CHECKS_RESTORE
127#endif
128
129// Warnings
130#ifdef _MSC_VER
131#pragma warning (push)
132#pragma warning (disable: 26495) // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6).
133#endif
134#if defined(__clang__)
135#pragma clang diagnostic push
136#pragma clang diagnostic ignored "-Wold-style-cast"
137#if __has_warning("-Wzero-as-null-pointer-constant")
138#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant"
139#endif
140#elif defined(__GNUC__)
141#pragma GCC diagnostic push
142#pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind
143#pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead
144#endif
145
146//-----------------------------------------------------------------------------
147// [SECTION] Forward declarations and basic types
148//-----------------------------------------------------------------------------
149
150// Forward declarations
151struct ImDrawChannel; // Temporary storage to output draw commands out of order, used by ImDrawListSplitter and ImDrawList::ChannelsSplit()
152struct ImDrawCmd; // A single draw command within a parent ImDrawList (generally maps to 1 GPU draw call, unless it is a callback)
153struct ImDrawData; // All draw command lists required to render the frame + pos/size coordinates to use for the projection matrix.
154struct ImDrawList; // A single draw command list (generally one per window, conceptually you may see this as a dynamic "mesh" builder)
155struct ImDrawListSharedData; // Data shared among multiple draw lists (typically owned by parent ImGui context, but you may create one yourself)
156struct ImDrawListSplitter; // Helper to split a draw list into different layers which can be drawn into out of order, then flattened back.
157struct ImDrawVert; // A single vertex (pos + uv + col = 20 bytes by default. Override layout with IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT)
158struct ImFont; // Runtime data for a single font within a parent ImFontAtlas
159struct ImFontAtlas; // Runtime data for multiple fonts, bake multiple fonts into a single texture, TTF/OTF font loader
160struct ImFontBuilderIO; // Opaque interface to a font builder (stb_truetype or FreeType).
161struct ImFontConfig; // Configuration data when adding a font or merging fonts
162struct ImFontGlyph; // A single font glyph (code point + coordinates within in ImFontAtlas + offset)
163struct ImFontGlyphRangesBuilder; // Helper to build glyph ranges from text/string data
164struct ImColor; // Helper functions to create a color that can be converted to either u32 or float4 (*OBSOLETE* please avoid using)
165struct ImGuiContext; // Dear ImGui context (opaque structure, unless including imgui_internal.h)
166struct ImGuiIO; // Main configuration and I/O between your application and ImGui
167struct ImGuiInputTextCallbackData; // Shared state of InputText() when using custom ImGuiInputTextCallback (rare/advanced use)
168struct ImGuiKeyData; // Storage for ImGuiIO and IsKeyDown(), IsKeyPressed() etc functions.
169struct ImGuiListClipper; // Helper to manually clip large list of items
170struct ImGuiOnceUponAFrame; // Helper for running a block of code not more than once a frame
171struct ImGuiPayload; // User data payload for drag and drop operations
172struct ImGuiPlatformImeData; // Platform IME data for io.SetPlatformImeDataFn() function.
173struct ImGuiSizeCallbackData; // Callback data when using SetNextWindowSizeConstraints() (rare/advanced use)
174struct ImGuiStorage; // Helper for key->value storage
175struct ImGuiStyle; // Runtime data for styling/colors
176struct ImGuiTableSortSpecs; // Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
177struct ImGuiTableColumnSortSpecs; // Sorting specification for one column of a table
178struct ImGuiTextBuffer; // Helper to hold and append into a text buffer (~string builder)
179struct ImGuiTextFilter; // Helper to parse and apply text filters (e.g. "aaaaa[,bbbbb][,ccccc]")
180struct ImGuiViewport; // A Platform Window (always only one in 'master' branch), in the future may represent Platform Monitor
181
182// Enums/Flags (declared as int for compatibility with old C++, to allow using as flags without overhead, and to not pollute the top of this file)
183// - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists!
184// In Visual Studio IDE: CTRL+comma ("Edit.GoToAll") can follow symbols in comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
185// With Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols in comments.
186typedef int ImGuiCol; // -> enum ImGuiCol_ // Enum: A color identifier for styling
187typedef int ImGuiCond; // -> enum ImGuiCond_ // Enum: A condition for many Set*() functions
188typedef int ImGuiDataType; // -> enum ImGuiDataType_ // Enum: A primary data type
189typedef int ImGuiDir; // -> enum ImGuiDir_ // Enum: A cardinal direction
190typedef int ImGuiKey; // -> enum ImGuiKey_ // Enum: A key identifier
191typedef int ImGuiNavInput; // -> enum ImGuiNavInput_ // Enum: An input identifier for navigation
192typedef int ImGuiMouseButton; // -> enum ImGuiMouseButton_ // Enum: A mouse button identifier (0=left, 1=right, 2=middle)
193typedef int ImGuiMouseCursor; // -> enum ImGuiMouseCursor_ // Enum: A mouse cursor identifier
194typedef int ImGuiSortDirection; // -> enum ImGuiSortDirection_ // Enum: A sorting direction (ascending or descending)
195typedef int ImGuiStyleVar; // -> enum ImGuiStyleVar_ // Enum: A variable identifier for styling
196typedef int ImGuiTableBgTarget; // -> enum ImGuiTableBgTarget_ // Enum: A color target for TableSetBgColor()
197typedef int ImDrawFlags; // -> enum ImDrawFlags_ // Flags: for ImDrawList functions
198typedef int ImDrawListFlags; // -> enum ImDrawListFlags_ // Flags: for ImDrawList instance
199typedef int ImFontAtlasFlags; // -> enum ImFontAtlasFlags_ // Flags: for ImFontAtlas build
200typedef int ImGuiBackendFlags; // -> enum ImGuiBackendFlags_ // Flags: for io.BackendFlags
201typedef int ImGuiButtonFlags; // -> enum ImGuiButtonFlags_ // Flags: for InvisibleButton()
202typedef int ImGuiColorEditFlags; // -> enum ImGuiColorEditFlags_ // Flags: for ColorEdit4(), ColorPicker4() etc.
203typedef int ImGuiConfigFlags; // -> enum ImGuiConfigFlags_ // Flags: for io.ConfigFlags
204typedef int ImGuiComboFlags; // -> enum ImGuiComboFlags_ // Flags: for BeginCombo()
205typedef int ImGuiDragDropFlags; // -> enum ImGuiDragDropFlags_ // Flags: for BeginDragDropSource(), AcceptDragDropPayload()
206typedef int ImGuiFocusedFlags; // -> enum ImGuiFocusedFlags_ // Flags: for IsWindowFocused()
207typedef int ImGuiHoveredFlags; // -> enum ImGuiHoveredFlags_ // Flags: for IsItemHovered(), IsWindowHovered() etc.
208typedef int ImGuiInputTextFlags; // -> enum ImGuiInputTextFlags_ // Flags: for InputText(), InputTextMultiline()
209typedef int ImGuiModFlags; // -> enum ImGuiModFlags_ // Flags: for io.KeyMods (Ctrl/Shift/Alt/Super)
210typedef int ImGuiPopupFlags; // -> enum ImGuiPopupFlags_ // Flags: for OpenPopup*(), BeginPopupContext*(), IsPopupOpen()
211typedef int ImGuiSelectableFlags; // -> enum ImGuiSelectableFlags_ // Flags: for Selectable()
212typedef int ImGuiSliderFlags; // -> enum ImGuiSliderFlags_ // Flags: for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
213typedef int ImGuiTabBarFlags; // -> enum ImGuiTabBarFlags_ // Flags: for BeginTabBar()
214typedef int ImGuiTabItemFlags; // -> enum ImGuiTabItemFlags_ // Flags: for BeginTabItem()
215typedef int ImGuiTableFlags; // -> enum ImGuiTableFlags_ // Flags: For BeginTable()
216typedef int ImGuiTableColumnFlags; // -> enum ImGuiTableColumnFlags_// Flags: For TableSetupColumn()
217typedef int ImGuiTableRowFlags; // -> enum ImGuiTableRowFlags_ // Flags: For TableNextRow()
218typedef int ImGuiTreeNodeFlags; // -> enum ImGuiTreeNodeFlags_ // Flags: for TreeNode(), TreeNodeEx(), CollapsingHeader()
219typedef int ImGuiViewportFlags; // -> enum ImGuiViewportFlags_ // Flags: for ImGuiViewport
220typedef int ImGuiWindowFlags; // -> enum ImGuiWindowFlags_ // Flags: for Begin(), BeginChild()
221
222// ImTexture: user data for renderer backend to identify a texture [Compile-time configurable type]
223// - To use something else than an opaque void* pointer: override with e.g. '#define ImTextureID MyTextureType*' in your imconfig.h file.
224// - This can be whatever to you want it to be! read the FAQ about ImTextureID for details.
225#ifndef ImTextureID
226typedef void* ImTextureID; // Default: store a pointer or an integer fitting in a pointer (most renderer backends are ok with that)
227#endif
228
229// ImDrawIdx: vertex index. [Compile-time configurable type]
230// - To use 16-bit indices + allow large meshes: backend need to set 'io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset' and handle ImDrawCmd::VtxOffset (recommended).
231// - To use 32-bit indices: override with '#define ImDrawIdx unsigned int' in your imconfig.h file.
232#ifndef ImDrawIdx
233typedef unsigned short ImDrawIdx; // Default: 16-bit (for maximum compatibility with renderer backends)
234#endif
235
236// Scalar data types
237typedef unsigned int ImGuiID;// A unique ID used by widgets (typically the result of hashing a stack of string)
238typedef signed char ImS8; // 8-bit signed integer
239typedef unsigned char ImU8; // 8-bit unsigned integer
240typedef signed short ImS16; // 16-bit signed integer
241typedef unsigned short ImU16; // 16-bit unsigned integer
242typedef signed int ImS32; // 32-bit signed integer == int
243typedef unsigned int ImU32; // 32-bit unsigned integer (often used to store packed colors)
244typedef signed long long ImS64; // 64-bit signed integer
245typedef unsigned long long ImU64; // 64-bit unsigned integer
246
247// Character types
248// (we generally use UTF-8 encoded string in the API. This is storage specifically for a decoded character used for keyboard input and display)
249typedef unsigned short ImWchar16; // A single decoded U16 character/code point. We encode them as multi bytes UTF-8 when used in strings.
250typedef unsigned int ImWchar32; // A single decoded U32 character/code point. We encode them as multi bytes UTF-8 when used in strings.
251#ifdef IMGUI_USE_WCHAR32 // ImWchar [configurable type: override in imconfig.h with '#define IMGUI_USE_WCHAR32' to support Unicode planes 1-16]
252typedef ImWchar32 ImWchar;
253#else
255#endif
256
257// Callback and functions types
258typedef int (*ImGuiInputTextCallback)(ImGuiInputTextCallbackData* data); // Callback function for ImGui::InputText()
259typedef void (*ImGuiSizeCallback)(ImGuiSizeCallbackData* data); // Callback function for ImGui::SetNextWindowSizeConstraints()
260typedef void* (*ImGuiMemAllocFunc)(size_t sz, void* user_data); // Function signature for ImGui::SetAllocatorFunctions()
261typedef void (*ImGuiMemFreeFunc)(void* ptr, void* user_data); // Function signature for ImGui::SetAllocatorFunctions()
262
263// ImVec2: 2D vector used to store positions, sizes etc. [Compile-time configurable type]
264// This is a frequently used type in the API. Consider using IM_VEC2_CLASS_EXTRA to create implicit cast from/to our preferred type.
266struct ImVec2
267{
268 float x, y;
269 constexpr ImVec2() : x(0.0f), y(0.0f) { }
270 constexpr ImVec2(float _x, float _y) : x(_x), y(_y) { }
271 float operator[] (size_t idx) const { IM_ASSERT(idx <= 1); return (&x)[idx]; } // We very rarely use this [] operator, the assert overhead is fine.
272 float& operator[] (size_t idx) { IM_ASSERT(idx <= 1); return (&x)[idx]; } // We very rarely use this [] operator, the assert overhead is fine.
273#ifdef IM_VEC2_CLASS_EXTRA
274 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.
275#endif
276};
277
278// ImVec4: 4D vector used to store clipping rectangles, colors etc. [Compile-time configurable type]
279struct ImVec4
280{
281 float x, y, z, w;
282 constexpr ImVec4() : x(0.0f), y(0.0f), z(0.0f), w(0.0f) { }
283 constexpr ImVec4(float _x, float _y, float _z, float _w) : x(_x), y(_y), z(_z), w(_w) { }
284#ifdef IM_VEC4_CLASS_EXTRA
285 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.
286#endif
287};
289
290//-----------------------------------------------------------------------------
291// [SECTION] Dear ImGui end-user API functions
292// (Note that ImGui:: being a namespace, you can add extra ImGui:: functions in your own separate file. Please don't modify imgui source files!)
293//-----------------------------------------------------------------------------
294
295namespace ImGui
296{
297 // Context creation and access
298 // - 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.
299 // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
300 // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for details.
301 IMGUI_API ImGuiContext* CreateContext(ImFontAtlas* shared_font_atlas = NULL);
302 IMGUI_API void DestroyContext(ImGuiContext* ctx = NULL); // NULL = destroy current context
304 IMGUI_API void SetCurrentContext(ImGuiContext* ctx);
305
306 // Main
307 IMGUI_API ImGuiIO& GetIO(); // access the IO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)
308 IMGUI_API ImGuiStyle& GetStyle(); // access the Style structure (colors, sizes). Always use PushStyleCol(), PushStyleVar() to modify style mid-frame!
309 IMGUI_API void NewFrame(); // start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().
310 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!
311 IMGUI_API void Render(); // ends the Dear ImGui frame, finalize the draw data. You can then get call GetDrawData().
312 IMGUI_API ImDrawData* GetDrawData(); // valid after Render() and until the next call to NewFrame(). this is what you have to render.
313
314 // Demo, Debug, Information
315 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!
316 IMGUI_API void ShowMetricsWindow(bool* p_open = NULL); // create Metrics/Debugger window. display Dear ImGui internals: windows, draw commands, various internal state, etc.
317 IMGUI_API void ShowDebugLogWindow(bool* p_open = NULL); // create Debug Log window. display a simplified log of important dear imgui events.
318 IMGUI_API void ShowStackToolWindow(bool* p_open = NULL); // create Stack Tool window. hover items with mouse to query information about the source of their unique ID.
319 IMGUI_API void ShowAboutWindow(bool* p_open = NULL); // create About window. display Dear ImGui version, credits and build/system information.
320 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)
321 IMGUI_API bool ShowStyleSelector(const char* label); // add style selector block (not a window), essentially a combo listing the default styles.
322 IMGUI_API void ShowFontSelector(const char* label); // add font selector block (not a window), essentially a combo listing the loaded fonts.
323 IMGUI_API void ShowUserGuide(); // add basic help/info block (not a window): how to manipulate ImGui as a end-user (mouse/keyboard controls).
324 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)
325
326 // Styles
327 IMGUI_API void StyleColorsDark(ImGuiStyle* dst = NULL); // new, recommended style (default)
328 IMGUI_API void StyleColorsLight(ImGuiStyle* dst = NULL); // best used with borders and a custom, thicker font
329 IMGUI_API void StyleColorsClassic(ImGuiStyle* dst = NULL); // classic imgui style
330
331 // Windows
332 // - Begin() = push window to the stack and start appending to it. End() = pop window from the stack.
333 // - Passing 'bool* p_open != NULL' shows a window-closing widget in the upper-right corner of the window,
334 // which clicking will set the boolean to false when clicked.
335 // - You may append multiple times to the same window during the same frame by calling Begin()/End() pairs multiple times.
336 // Some information such as 'flags' or 'p_open' will only be considered by the first call to Begin().
337 // - Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting
338 // anything to the window. Always call a matching End() for each Begin() call, regardless of its return value!
339 // [Important: due to legacy reason, this is inconsistent with most other functions such as BeginMenu/EndMenu,
340 // BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding BeginXXX function
341 // returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
342 // - Note that the bottom of window stack always contains a window called "Debug".
343 IMGUI_API bool Begin(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0);
345
346 // Child Windows
347 // - Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child.
348 // - For each independent axis of 'size': ==0.0f: use remaining host window size / >0.0f: fixed size / <0.0f: use remaining window size minus abs(size) / Each axis can use a different mode, e.g. ImVec2(0,400).
349 // - BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.
350 // Always call a matching EndChild() for each BeginChild() call, regardless of its return value.
351 // [Important: due to legacy reason, this is inconsistent with most other functions such as BeginMenu/EndMenu,
352 // BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding BeginXXX function
353 // returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
354 IMGUI_API bool BeginChild(const char* str_id, const ImVec2& size = ImVec2(0, 0), bool border = false, ImGuiWindowFlags flags = 0);
355 IMGUI_API bool BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0, 0), bool border = false, ImGuiWindowFlags flags = 0);
357
358 // Windows Utilities
359 // - 'current window' = the window we are appending into while inside a Begin()/End() block. 'next window' = next window we will Begin() into.
362 IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0); // is current window focused? or its root/child, depending on flags. see flags for options.
363 IMGUI_API bool IsWindowHovered(ImGuiHoveredFlags flags=0); // is current window hovered (and typically: not blocked by a popup/modal)? see flags for options. NB: If you are trying to check whether your mouse should be dispatched to imgui or to your app, you should use the 'io.WantCaptureMouse' boolean for that! Please read the FAQ!
364 IMGUI_API ImDrawList* GetWindowDrawList(); // get draw list associated to the current window, to append your own drawing primitives
365 IMGUI_API ImVec2 GetWindowPos(); // get current window position in screen space (useful if you want to do your own drawing via the DrawList API)
366 IMGUI_API ImVec2 GetWindowSize(); // get current window size
367 IMGUI_API float GetWindowWidth(); // get current window width (shortcut for GetWindowSize().x)
368 IMGUI_API float GetWindowHeight(); // get current window height (shortcut for GetWindowSize().y)
369
370 // Window manipulation
371 // - Prefer using SetNextXXX functions (before Begin) rather that SetXXX functions (after Begin).
372 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.
373 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()
374 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 -1,-1 on either X/Y axis to preserve the current size. Sizes will be rounded down. Use callback to apply non-trivial programmatic constraints.
375 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()
376 IMGUI_API void SetNextWindowCollapsed(bool collapsed, ImGuiCond cond = 0); // set next window collapsed state. call before Begin()
377 IMGUI_API void SetNextWindowFocus(); // set next window to be focused / top-most. call before Begin()
378 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.
379 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.
380 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.
381 IMGUI_API void SetWindowCollapsed(bool collapsed, ImGuiCond cond = 0); // (not recommended) set current window collapsed state. prefer using SetNextWindowCollapsed().
382 IMGUI_API void SetWindowFocus(); // (not recommended) set current window to be focused / top-most. prefer using SetNextWindowFocus().
383 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().
384 IMGUI_API void SetWindowPos(const char* name, const ImVec2& pos, ImGuiCond cond = 0); // set named window position.
385 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.
386 IMGUI_API void SetWindowCollapsed(const char* name, bool collapsed, ImGuiCond cond = 0); // set named window collapsed state
387 IMGUI_API void SetWindowFocus(const char* name); // set named window to be focused / top-most. use NULL to remove focus.
388
389 // Content region
390 // - Retrieve available space from a given point. GetContentRegionAvail() is frequently useful.
391 // - 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)
392 IMGUI_API ImVec2 GetContentRegionAvail(); // == GetContentRegionMax() - GetCursorPos()
393 IMGUI_API ImVec2 GetContentRegionMax(); // current content boundaries (typically window boundaries including scrolling, or current column boundaries), in windows coordinates
394 IMGUI_API ImVec2 GetWindowContentRegionMin(); // content boundaries min for the full window (roughly (0,0)-Scroll), in window coordinates
395 IMGUI_API ImVec2 GetWindowContentRegionMax(); // content boundaries max for the full window (roughly (0,0)+Size-Scroll) where Size can be override with SetNextWindowContentSize(), in window coordinates
396
397 // Windows Scrolling
398 IMGUI_API float GetScrollX(); // get scrolling amount [0 .. GetScrollMaxX()]
399 IMGUI_API float GetScrollY(); // get scrolling amount [0 .. GetScrollMaxY()]
400 IMGUI_API void SetScrollX(float scroll_x); // set scrolling amount [0 .. GetScrollMaxX()]
401 IMGUI_API void SetScrollY(float scroll_y); // set scrolling amount [0 .. GetScrollMaxY()]
402 IMGUI_API float GetScrollMaxX(); // get maximum scrolling amount ~~ ContentSize.x - WindowSize.x - DecorationsSize.x
403 IMGUI_API float GetScrollMaxY(); // get maximum scrolling amount ~~ ContentSize.y - WindowSize.y - DecorationsSize.y
404 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.
405 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.
406 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.
407 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.
408
409 // Parameters stacks (shared)
410 IMGUI_API void PushFont(ImFont* font); // use NULL as a shortcut to push default font
412 IMGUI_API void PushStyleColor(ImGuiCol idx, ImU32 col); // modify a style color. always use this if you modify the style after NewFrame().
414 IMGUI_API void PopStyleColor(int count = 1);
415 IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val); // modify a style float variable. always use this if you modify the style after NewFrame().
416 IMGUI_API void PushStyleVar(ImGuiStyleVar idx, const ImVec2& val); // modify a style ImVec2 variable. always use this if you modify the style after NewFrame().
417 IMGUI_API void PopStyleVar(int count = 1);
418 IMGUI_API void PushAllowKeyboardFocus(bool allow_keyboard_focus); // == tab stop enable. Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets
420 IMGUI_API void PushButtonRepeat(bool repeat); // in 'repeat' mode, Button*() functions return repeated true in a typematic manner (using io.KeyRepeatDelay/io.KeyRepeatRate setting). Note that you can call IsItemActive() after any Button() to tell if the button is held in the current frame.
422
423 // Parameters stacks (current window)
424 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).
426 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)
427 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.
428 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
430
431 // Style read access
432 // - Use the style editor (ShowStyleEditor() function) to interactively see what the colors are)
433 IMGUI_API ImFont* GetFont(); // get current font
434 IMGUI_API float GetFontSize(); // get current font size (= height in pixels) of current font with current scale applied
435 IMGUI_API ImVec2 GetFontTexUvWhitePixel(); // get UV coordinate for a while pixel, useful to draw custom shapes via the ImDrawList API
436 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
437 IMGUI_API ImU32 GetColorU32(const ImVec4& col); // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList
438 IMGUI_API ImU32 GetColorU32(ImU32 col); // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList
439 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.
440
441 // Cursor / Layout
442 // - By "cursor" we mean the current output position.
443 // - The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
444 // - You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceding widget.
445 // - Attention! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:
446 // Window-local coordinates: SameLine(), GetCursorPos(), SetCursorPos(), GetCursorStartPos(), GetContentRegionMax(), GetWindowContentRegion*(), PushTextWrapPos()
447 // Absolute coordinate: GetCursorScreenPos(), SetCursorScreenPos(), all ImDrawList:: functions.
448 IMGUI_API void Separator(); // separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.
449 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.
450 IMGUI_API void NewLine(); // undo a SameLine() or force a new line when in an horizontal-layout context.
451 IMGUI_API void Spacing(); // add vertical spacing.
452 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.
453 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
454 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
455 IMGUI_API void BeginGroup(); // lock horizontal starting position
456 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.)
457 IMGUI_API ImVec2 GetCursorPos(); // cursor position in window coordinates (relative to window position)
458 IMGUI_API float GetCursorPosX(); // (some functions are using window-relative coordinates, such as: GetCursorPos, GetCursorStartPos, GetContentRegionMax, GetWindowContentRegion* etc.
459 IMGUI_API float GetCursorPosY(); // other functions such as GetCursorScreenPos or everything in ImDrawList::
460 IMGUI_API void SetCursorPos(const ImVec2& local_pos); // are using the main, absolute coordinate system.
461 IMGUI_API void SetCursorPosX(float local_x); // GetWindowPos() + GetCursorPos() == GetCursorScreenPos() etc.)
462 IMGUI_API void SetCursorPosY(float local_y); //
463 IMGUI_API ImVec2 GetCursorStartPos(); // initial cursor position in window coordinates
464 IMGUI_API ImVec2 GetCursorScreenPos(); // cursor position in absolute coordinates (useful to work with ImDrawList API). generally top-left == GetMainViewport()->Pos == (0,0) in single viewport mode, and bottom-right == GetMainViewport()->Pos+Size == io.DisplaySize in single-viewport mode.
465 IMGUI_API void SetCursorScreenPos(const ImVec2& pos); // cursor position in absolute coordinates
466 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)
467 IMGUI_API float GetTextLineHeight(); // ~ FontSize
468 IMGUI_API float GetTextLineHeightWithSpacing(); // ~ FontSize + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of text)
469 IMGUI_API float GetFrameHeight(); // ~ FontSize + style.FramePadding.y * 2
470 IMGUI_API float GetFrameHeightWithSpacing(); // ~ FontSize + style.FramePadding.y * 2 + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets)
471
472 // ID stack/scopes
473 // Read the FAQ (docs/FAQ.md or http://dearimgui.org/faq) for more details about how ID are handled in dear imgui.
474 // - Those questions are answered and impacted by understanding of the ID stack system:
475 // - "Q: Why is my widget not reacting when I click on it?"
476 // - "Q: How can I have widgets with an empty label?"
477 // - "Q: How can I have multiple widgets with the same label?"
478 // - Short version: ID are hashes of the entire ID stack. If you are creating widgets in a loop you most likely
479 // want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them.
480 // - You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
481 // - In this header file we use the "label"/"name" terminology to denote a string that will be displayed + used as an ID,
482 // whereas "str_id" denote a string that is only used as an ID and not normally displayed.
483 IMGUI_API void PushID(const char* str_id); // push string into the ID stack (will hash string).
484 IMGUI_API void PushID(const char* str_id_begin, const char* str_id_end); // push string into the ID stack (will hash string).
485 IMGUI_API void PushID(const void* ptr_id); // push pointer into the ID stack (will hash pointer).
486 IMGUI_API void PushID(int int_id); // push integer into the ID stack (will hash integer).
487 IMGUI_API void PopID(); // pop from the ID stack.
488 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
489 IMGUI_API ImGuiID GetID(const char* str_id_begin, const char* str_id_end);
490 IMGUI_API ImGuiID GetID(const void* ptr_id);
491
492 // Widgets: Text
493 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.
494 IMGUI_API void Text(const char* fmt, ...) IM_FMTARGS(1); // formatted text
495 IMGUI_API void TextV(const char* fmt, va_list args) IM_FMTLIST(1);
496 IMGUI_API void TextColored(const ImVec4& col, const char* fmt, ...) IM_FMTARGS(2); // shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor();
497 IMGUI_API void TextColoredV(const ImVec4& col, const char* fmt, va_list args) IM_FMTLIST(2);
498 IMGUI_API void TextDisabled(const char* fmt, ...) IM_FMTARGS(1); // shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(fmt, ...); PopStyleColor();
499 IMGUI_API void TextDisabledV(const char* fmt, va_list args) IM_FMTLIST(1);
500 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().
501 IMGUI_API void TextWrappedV(const char* fmt, va_list args) IM_FMTLIST(1);
502 IMGUI_API void LabelText(const char* label, const char* fmt, ...) IM_FMTARGS(2); // display text+label aligned the same way as value+label widgets
503 IMGUI_API void LabelTextV(const char* label, const char* fmt, va_list args) IM_FMTLIST(2);
504 IMGUI_API void BulletText(const char* fmt, ...) IM_FMTARGS(1); // shortcut for Bullet()+Text()
505 IMGUI_API void BulletTextV(const char* fmt, va_list args) IM_FMTLIST(1);
506 IMGUI_API bool TextHyperLink(const char* label, bool underlineWhenHoveredOnly = false); // copied from: https://github.com/ocornut/imgui/issues/7660
507
508 // Widgets: Main
509 // - Most widgets return true when the value has been changed or when pressed/selected
510 // - You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state.
511 IMGUI_API bool Button(const char* label, const ImVec2& size = ImVec2(0, 0)); // button
512 IMGUI_API bool SmallButton(const char* label); // button with FramePadding=(0,0) to easily embed within text
513 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.)
514 IMGUI_API bool ArrowButton(const char* str_id, ImGuiDir dir); // square button with an arrow shape
515 IMGUI_API void Image(ImTextureID user_texture_id, const ImVec2& 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));
516 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)); // <0 frame_padding uses default frame padding settings. 0 for no padding
517 IMGUI_API bool Checkbox(const char* label, bool* v);
518 IMGUI_API bool CheckboxFlags(const char* label, int* flags, int flags_value);
519 IMGUI_API bool CheckboxFlags(const char* label, unsigned int* flags, unsigned int flags_value);
520 IMGUI_API bool RadioButton(const char* label, bool active); // use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; }
521 IMGUI_API bool RadioButton(const char* label, int* v, int v_button); // shortcut to handle the above pattern when value is an integer
522 IMGUI_API void ProgressBar(float fraction, const ImVec2& size_arg = ImVec2(-FLT_MIN, 0), const char* overlay = NULL);
523 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
524
525 // Widgets: Combo Box
526 // - The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.
527 // - The old Combo() api are helpers over BeginCombo()/EndCombo() which are kept available for convenience purpose. This is analogous to how ListBox are created.
528 IMGUI_API bool BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags = 0);
529 IMGUI_API void EndCombo(); // only call EndCombo() if BeginCombo() returns true!
530 IMGUI_API bool Combo(const char* label, int* current_item, const char* const items[], int items_count, int popup_max_height_in_items = -1);
531 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"
532 IMGUI_API bool Combo(const char* label, int* current_item, bool(*items_getter)(void* data, int idx, const char** out_text), void* data, int items_count, int popup_max_height_in_items = -1);
533
534 // Widgets: Drag Sliders
535 // - 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.
536 // - For all the Float2/Float3/Float4/Int2/Int3/Int4 versions of every functions, note that a 'float v[X]' function argument is the same as 'float* v',
537 // 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
538 // - 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.
539 // - Format string may also be set to NULL or use the default format ("%f" or "%d").
540 // - 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).
541 // - 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.
542 // - 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.
543 // - 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.
544 // - Legacy: Pre-1.78 there are DragXXX() function signatures that takes a final `float power=1.0f' argument instead of the `ImGuiSliderFlags flags=0' argument.
545 // If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
546 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
547 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);
548 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);
549 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);
550 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);
551 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
552 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);
553 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);
554 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);
555 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);
556 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);
557 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);
558
559 // Widgets: Regular Sliders
560 // - 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.
561 // - 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.
562 // - Format string may also be set to NULL or use the default format ("%f" or "%d").
563 // - Legacy: Pre-1.78 there are SliderXXX() function signatures that takes a final `float power=1.0f' argument instead of the `ImGuiSliderFlags flags=0' argument.
564 // If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
565 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.
566 IMGUI_API bool SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
567 IMGUI_API bool SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
568 IMGUI_API bool SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0);
569 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);
570 IMGUI_API bool SliderInt(const char* label, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
571 IMGUI_API bool SliderInt2(const char* label, int v[2], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
572 IMGUI_API bool SliderInt3(const char* label, int v[3], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
573 IMGUI_API bool SliderInt4(const char* label, int v[4], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0);
574 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);
575 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);
576 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);
577 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);
578 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);
579
580 // Widgets: Input with Keyboard
581 // - 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.
582 // - Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc.
583 IMGUI_API bool InputText(const char* label, char* buf, size_t buf_size, ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL);
584 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);
585 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);
586 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);
587 IMGUI_API bool InputFloat2(const char* label, float v[2], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
588 IMGUI_API bool InputFloat3(const char* label, float v[3], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
589 IMGUI_API bool InputFloat4(const char* label, float v[4], const char* format = "%.3f", ImGuiInputTextFlags flags = 0);
590 IMGUI_API bool InputInt(const char* label, int* v, int step = 1, int step_fast = 100, ImGuiInputTextFlags flags = 0);
591 IMGUI_API bool InputInt2(const char* label, int v[2], ImGuiInputTextFlags flags = 0);
592 IMGUI_API bool InputInt3(const char* label, int v[3], ImGuiInputTextFlags flags = 0);
593 IMGUI_API bool InputInt4(const char* label, int v[4], ImGuiInputTextFlags flags = 0);
594 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);
595 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);
596 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);
597
598 // 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.)
599 // - 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.
600 // - You can pass the address of a first float element out of a contiguous structure, e.g. &myvector.x
601 IMGUI_API bool ColorEdit3(const char* label, float col[3], ImGuiColorEditFlags flags = 0);
602 IMGUI_API bool ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags = 0);
603 IMGUI_API bool ColorPicker3(const char* label, float col[3], ImGuiColorEditFlags flags = 0);
604 IMGUI_API bool ColorPicker4(const char* label, float col[4], ImGuiColorEditFlags flags = 0, const float* ref_col = NULL);
605 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.
606 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.
607
608 // Widgets: Trees
609 // - 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.
610 IMGUI_API bool TreeNode(const char* label);
611 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().
612 IMGUI_API bool TreeNode(const void* ptr_id, const char* fmt, ...) IM_FMTARGS(2); // "
613 IMGUI_API bool TreeNodeV(const char* str_id, const char* fmt, va_list args) IM_FMTLIST(2);
614 IMGUI_API bool TreeNodeV(const void* ptr_id, const char* fmt, va_list args) IM_FMTLIST(2);
615 IMGUI_API bool TreeNodeEx(const char* label, ImGuiTreeNodeFlags flags = 0);
616 IMGUI_API bool TreeNodeEx(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3);
617 IMGUI_API bool TreeNodeEx(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3);
618 IMGUI_API bool TreeNodeExV(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3);
619 IMGUI_API bool TreeNodeExV(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3);
620 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.
621 IMGUI_API void TreePush(const void* ptr_id = NULL); // "
622 IMGUI_API void TreePop(); // ~ Unindent()+PopId()
623 IMGUI_API float GetTreeNodeToLabelSpacing(); // horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode
624 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().
625 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.
626 IMGUI_API void SetNextItemOpen(bool is_open, ImGuiCond cond = 0); // set next TreeNode/CollapsingHeader open state.
627
628 // Widgets: Selectables
629 // - A selectable highlights when hovered, and can display another color when selected.
630 // - Neighbors selectable extend their highlight bounds in order to leave no gap between them. This is so a series of selected Selectable appear contiguous.
631 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
632 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.
633
634 // Widgets: List Boxes
635 // - This is essentially a thin wrapper to using BeginChild/EndChild with some stylistic changes.
636 // - The BeginListBox()/EndListBox() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() or any items.
637 // - 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.
638 // - 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
639 // - 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
640 IMGUI_API bool BeginListBox(const char* label, const ImVec2& size = ImVec2(0, 0)); // open a framed scrolling region
641 IMGUI_API void EndListBox(); // only call EndListBox() if BeginListBox() returned true!
642 IMGUI_API bool ListBox(const char* label, int* current_item, const char* const items[], int items_count, int height_in_items = -1);
643 IMGUI_API bool ListBox(const char* label, int* current_item, bool (*items_getter)(void* data, int idx, const char** out_text), void* data, int items_count, int height_in_items = -1);
644
645 // Widgets: Data Plotting
646 // - Consider using ImPlot (https://github.com/epezent/implot) which is much better!
647 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));
648 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));
649 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));
650 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));
651
652 // Widgets: Value() Helpers.
653 // - 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)
654 IMGUI_API void Value(const char* prefix, bool b);
655 IMGUI_API void Value(const char* prefix, int v);
656 IMGUI_API void Value(const char* prefix, unsigned int v);
657 IMGUI_API void Value(const char* prefix, float v, const char* float_format = NULL);
658
659 // Widgets: Menus
660 // - Use BeginMenuBar() on a window ImGuiWindowFlags_MenuBar to append to its menu bar.
661 // - Use BeginMainMenuBar() to create a menu bar at the top of the screen and append to it.
662 // - Use BeginMenu() to create a menu. You can call BeginMenu() multiple time with the same identifier to append more items to it.
663 // - Not that MenuItem() keyboardshortcuts are displayed as a convenience but _not processed_ by Dear ImGui at the moment.
664 IMGUI_API bool BeginMenuBar(); // append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).
665 IMGUI_API void EndMenuBar(); // only call EndMenuBar() if BeginMenuBar() returns true!
666 IMGUI_API bool BeginMainMenuBar(); // create and append to a full screen menu-bar.
667 IMGUI_API void EndMainMenuBar(); // only call EndMainMenuBar() if BeginMainMenuBar() returns true!
668 IMGUI_API bool BeginMenu(const char* label, bool enabled = true); // create a sub-menu entry. only call EndMenu() if this returns true!
669 IMGUI_API void EndMenu(); // only call EndMenu() if BeginMenu() returns true!
670 IMGUI_API bool MenuItem(const char* label, const char* shortcut = NULL, bool selected = false, bool enabled = true); // return true when activated.
671 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
672
673 // Tooltips
674 // - Tooltip are windows following the mouse. They do not take focus away.
675 IMGUI_API void BeginTooltip(); // begin/append a tooltip window. to create full-featured tooltip (with any kind of items).
677 IMGUI_API void SetTooltip(const char* fmt, ...) IM_FMTARGS(1); // set a text-only tooltip, typically use with ImGui::IsItemHovered(). override any previous call to SetTooltip().
678 IMGUI_API void SetTooltipV(const char* fmt, va_list args) IM_FMTLIST(1);
679
680 // Popups, Modals
681 // - They block normal mouse hovering detection (and therefore most mouse interactions) behind them.
682 // - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
683 // - Their visibility state (~bool) is held internally instead of being held by the programmer as we are used to with regular Begin*() calls.
684 // - The 3 properties above are related: we need to retain popup visibility state in the library because popups may be closed as any time.
685 // - You can bypass the hovering restriction by using ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered().
686 // - 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.
687 // This is sometimes leading to confusing mistakes. May rework this in the future.
688
689 // Popups: begin/end functions
690 // - BeginPopup(): query popup state, if open start appending into the window. Call EndPopup() afterwards. ImGuiWindowFlags are forwarded to the window.
691 // - BeginPopupModal(): block every interactions behind the window, cannot be closed by user, add a dimming background, has a title bar.
692 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.
693 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.
694 IMGUI_API void EndPopup(); // only call EndPopup() if BeginPopupXXX() returns true!
695
696 // Popups: open/close functions
697 // - OpenPopup(): set popup state to open. ImGuiPopupFlags are available for opening options.
698 // - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
699 // - CloseCurrentPopup(): use inside the BeginPopup()/EndPopup() scope to close manually.
700 // - CloseCurrentPopup() is called by default by Selectable()/MenuItem() when activated (FIXME: need some options).
701 // - 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().
702 // - Use IsWindowAppearing() after BeginPopup() to tell if a window just opened.
703 // - 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
704 IMGUI_API void OpenPopup(const char* str_id, ImGuiPopupFlags popup_flags = 0); // call to mark popup as open (don't call every frame!).
705 IMGUI_API void OpenPopup(ImGuiID id, ImGuiPopupFlags popup_flags = 0); // id overload to facilitate calling from nested stacks
706 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)
707 IMGUI_API void CloseCurrentPopup(); // manually close the popup we have begin-ed into.
708
709 // Popups: open+begin combined functions helpers
710 // - Helpers to do OpenPopup+BeginPopup where the Open action is triggered by e.g. hovering an item and right-clicking.
711 // - They are convenient to easily create context menus, hence the name.
712 // - 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.
713 // - 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.
714 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!
715 IMGUI_API bool BeginPopupContextWindow(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);// open+begin popup when clicked on current window.
716 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).
717
718 // Popups: query functions
719 // - IsPopupOpen(): return true if the popup is open at the current BeginPopup() level of the popup stack.
720 // - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId: return true if any popup is open at the current BeginPopup() level of the popup stack.
721 // - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId + ImGuiPopupFlags_AnyPopupLevel: return true if any popup is open.
722 IMGUI_API bool IsPopupOpen(const char* str_id, ImGuiPopupFlags flags = 0); // return true if the popup is open.
723
724 // Tables
725 // - Full-featured replacement for old Columns API.
726 // - See Demo->Tables for demo code. See top of imgui_tables.cpp for general commentary.
727 // - See ImGuiTableFlags_ and ImGuiTableColumnFlags_ enums for a description of available flags.
728 // The typical call flow is:
729 // - 1. Call BeginTable(), early out if returning false.
730 // - 2. Optionally call TableSetupColumn() to submit column name/flags/defaults.
731 // - 3. Optionally call TableSetupScrollFreeze() to request scroll freezing of columns/rows.
732 // - 4. Optionally call TableHeadersRow() to submit a header row. Names are pulled from TableSetupColumn() data.
733 // - 5. Populate contents:
734 // - In most situations you can use TableNextRow() + TableSetColumnIndex(N) to start appending into a column.
735 // - If you are using tables as a sort of grid, where every columns is holding the same type of contents,
736 // you may prefer using TableNextColumn() instead of TableNextRow() + TableSetColumnIndex().
737 // TableNextColumn() will automatically wrap-around into the next row if needed.
738 // - IMPORTANT: Comparatively to the old Columns() API, we need to call TableNextColumn() for the first column!
739 // - Summary of possible call flow:
740 // --------------------------------------------------------------------------------------------------------
741 // TableNextRow() -> TableSetColumnIndex(0) -> Text("Hello 0") -> TableSetColumnIndex(1) -> Text("Hello 1") // OK
742 // TableNextRow() -> TableNextColumn() -> Text("Hello 0") -> TableNextColumn() -> Text("Hello 1") // OK
743 // TableNextColumn() -> Text("Hello 0") -> TableNextColumn() -> Text("Hello 1") // OK: TableNextColumn() automatically gets to next row!
744 // TableNextRow() -> Text("Hello 0") // Not OK! Missing TableSetColumnIndex() or TableNextColumn()! Text will not appear!
745 // --------------------------------------------------------------------------------------------------------
746 // - 5. Call EndTable()
747 IMGUI_API bool BeginTable(const char* str_id, int column, ImGuiTableFlags flags = 0, const ImVec2& outer_size = ImVec2(0.0f, 0.0f), float inner_width = 0.0f);
748 IMGUI_API void EndTable(); // only call EndTable() if BeginTable() returns true!
749 IMGUI_API void TableNextRow(ImGuiTableRowFlags row_flags = 0, float min_row_height = 0.0f); // append into the first cell of a new row.
750 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.
751 IMGUI_API bool TableSetColumnIndex(int column_n); // append into the specified column. Return true when column is visible.
752
753 // Tables: Headers & Columns declaration
754 // - Use TableSetupColumn() to specify label, resizing policy, default width/weight, id, various other flags etc.
755 // - Use TableHeadersRow() to create a header row and automatically submit a TableHeader() for each column.
756 // Headers are required to perform: reordering, sorting, and opening the context menu.
757 // The context menu can also be made available in columns body using ImGuiTableFlags_ContextMenuInBody.
758 // - You may manually submit headers using TableNextRow() + TableHeader() calls, but this is only useful in
759 // some advanced use cases (e.g. adding custom widgets in header row).
760 // - Use TableSetupScrollFreeze() to lock columns/rows so they stay visible when scrolled.
761 IMGUI_API void TableSetupColumn(const char* label, ImGuiTableColumnFlags flags = 0, float init_width_or_weight = 0.0f, ImGuiID user_id = 0);
762 IMGUI_API void TableSetupScrollFreeze(int cols, int rows); // lock columns/rows so they stay visible when scrolled.
763 IMGUI_API void TableHeadersRow(); // submit all headers cells based on data provided to TableSetupColumn() + submit context menu
764 IMGUI_API void TableHeader(const char* label); // submit one header cell manually (rarely used)
765
766 // Tables: Sorting & Miscellaneous functions
767 // - Sorting: call TableGetSortSpecs() to retrieve latest sort specs for the table. NULL when not sorting.
768 // When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have
769 // changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting,
770 // else you may wastefully sort your data every frame!
771 // - Functions args 'int column_n' treat the default value of -1 as the same as passing the current column index.
772 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().
773 IMGUI_API int TableGetColumnCount(); // return number of columns (value passed to BeginTable)
774 IMGUI_API int TableGetColumnIndex(); // return current column index.
775 IMGUI_API int TableGetRowIndex(); // return current row index.
776 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.
777 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.
778 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)
779 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.
780
781 // Legacy Columns API (prefer using Tables!)
782 // - You can also use SameLine(pos_x) to mimic simplified columns.
783 IMGUI_API void Columns(int count = 1, const char* id = NULL, bool border = true);
784 IMGUI_API void NextColumn(); // next column, defaults to current row or next row if the current row is finished
785 IMGUI_API int GetColumnIndex(); // get current column index
786 IMGUI_API float GetColumnWidth(int column_index = -1); // get column width (in pixels). pass -1 to use current column
787 IMGUI_API void SetColumnWidth(int column_index, float width); // set column width (in pixels). pass -1 to use current column
788 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
789 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
791
792 // Tab Bars, Tabs
793 IMGUI_API bool BeginTabBar(const char* str_id, ImGuiTabBarFlags flags = 0); // create and append into a TabBar
794 IMGUI_API void EndTabBar(); // only call EndTabBar() if BeginTabBar() returns true!
795 IMGUI_API bool BeginTabItem(const char* label, bool* p_open = NULL, ImGuiTabItemFlags flags = 0); // create a Tab. Returns true if the Tab is selected.
796 IMGUI_API void EndTabItem(); // only call EndTabItem() if BeginTabItem() returns true!
797 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.
798 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.
799
800 // Logging/Capture
801 // - All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.
802 IMGUI_API void LogToTTY(int auto_open_depth = -1); // start logging to tty (stdout)
803 IMGUI_API void LogToFile(int auto_open_depth = -1, const char* filename = NULL); // start logging to file
804 IMGUI_API void LogToClipboard(int auto_open_depth = -1); // start logging to OS clipboard
805 IMGUI_API void LogFinish(); // stop logging (close file, etc.)
806 IMGUI_API void LogButtons(); // helper to display buttons for logging to tty/file/clipboard
807 IMGUI_API void LogText(const char* fmt, ...) IM_FMTARGS(1); // pass text data straight to log (without being displayed)
808 IMGUI_API void LogTextV(const char* fmt, va_list args) IM_FMTLIST(1);
809
810 // Drag and Drop
811 // - On source items, call BeginDragDropSource(), if it returns true also call SetDragDropPayload() + EndDragDropSource().
812 // - On target candidates, call BeginDragDropTarget(), if it returns true also call AcceptDragDropPayload() + EndDragDropTarget().
813 // - 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)
814 // - An item can be both drag source and drop target.
815 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()
816 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.
817 IMGUI_API void EndDragDropSource(); // only call EndDragDropSource() if BeginDragDropSource() returns true!
818 IMGUI_API bool BeginDragDropTarget(); // call after submitting an item that may receive a payload. If this returns true, you can call AcceptDragDropPayload() + EndDragDropTarget()
819 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.
820 IMGUI_API void EndDragDropTarget(); // only call EndDragDropTarget() if BeginDragDropTarget() returns true!
821 IMGUI_API const ImGuiPayload* GetDragDropPayload(); // peek directly into the current payload from anywhere. may return NULL. use ImGuiPayload::IsDataType() to test for the payload type.
822
823 // Disabling [BETA API]
824 // - Disable all user interactions and dim items visuals (applying style.DisabledAlpha over current colors)
825 // - 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)
826 // - 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.
827 IMGUI_API void BeginDisabled(bool disabled = true);
829
830 // Clipping
831 // - Mouse hovering is affected by ImGui::PushClipRect() calls, unlike direct calls to ImDrawList::PushClipRect() which are render only.
832 IMGUI_API void PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect);
834
835 // Focus, Activation
836 // - Prefer using "SetItemDefaultFocus()" over "if (IsWindowAppearing()) SetScrollHereY()" when applicable to signify "this is the default item"
837 IMGUI_API void SetItemDefaultFocus(); // make last item the default focused item of a window.
838 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.
839
840 // Item/Widgets Utilities and Query Functions
841 // - Most of the functions are referring to the previous Item that has been submitted.
842 // - See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions.
843 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.
844 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)
845 IMGUI_API bool IsItemFocused(); // is the last item focused for keyboard/gamepad navigation?
846 IMGUI_API bool IsItemClicked(ImGuiMouseButton mouse_button = 0); // is the last item hovered and mouse clicked on? (**) == IsMouseClicked(mouse_button) && IsItemHovered()Important. (**) this it NOT equivalent to the behavior of e.g. Button(). Read comments in function definition.
847 IMGUI_API bool IsItemVisible(); // is the last item visible? (items may be out of sight because of clipping/scrolling)
848 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.
849 IMGUI_API bool IsItemActivated(); // was the last item just made active (item was previously inactive).
850 IMGUI_API bool IsItemDeactivated(); // was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that requires continuous editing.
851 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 requires 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).
852 IMGUI_API bool IsItemToggledOpen(); // was the last item open state toggled? set by TreeNode().
853 IMGUI_API bool IsAnyItemHovered(); // is any item hovered?
854 IMGUI_API bool IsAnyItemActive(); // is any item active?
855 IMGUI_API bool IsAnyItemFocused(); // is any item focused?
856 IMGUI_API ImVec2 GetItemRectMin(); // get upper-left bounding rectangle of the last item (screen space)
857 IMGUI_API ImVec2 GetItemRectMax(); // get lower-right bounding rectangle of the last item (screen space)
858 IMGUI_API ImVec2 GetItemRectSize(); // get size of last item
859 IMGUI_API void SetItemAllowOverlap(); // allow last item to be overlapped by a subsequent item. sometimes useful with invisible buttons, selectables, etc. to catch unused area.
860
861 // Viewports
862 // - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.
863 // - In 'docking' branch with multi-viewport enabled, we extend this concept to have multiple active viewports.
864 // - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode.
865 IMGUI_API ImGuiViewport* GetMainViewport(); // return primary/default viewport. This can never be NULL.
866
867 // Background/Foreground Draw Lists
868 IMGUI_API ImDrawList* GetBackgroundDrawList(); // this draw list will be the first rendered one. Useful to quickly draw shapes/text behind dear imgui contents.
869 IMGUI_API ImDrawList* GetForegroundDrawList(); // this draw list will be the last rendered one. Useful to quickly draw shapes/text over dear imgui contents.
870
871 // Miscellaneous Utilities
872 IMGUI_API bool IsRectVisible(const ImVec2& size); // test if rectangle (of given size, starting from cursor position) is visible / not clipped.
873 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.
874 IMGUI_API double GetTime(); // get global imgui time. incremented by io.DeltaTime every frame.
875 IMGUI_API int GetFrameCount(); // get global imgui frame count. incremented by 1 every frame.
876 IMGUI_API ImDrawListSharedData* GetDrawListSharedData(); // you may use this when creating your own ImDrawList instances.
877 IMGUI_API const char* GetStyleColorName(ImGuiCol idx); // get a string corresponding to the enum value (for display, saving, etc.).
878 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)
880 IMGUI_API bool BeginChildFrame(ImGuiID id, const ImVec2& size, ImGuiWindowFlags flags = 0); // helper to create a child window / scrolling region that looks like a normal widget frame
881 IMGUI_API void EndChildFrame(); // always call EndChildFrame() regardless of BeginChildFrame() return values (which indicates a collapsed/clipped window)
882
883 // Text Utilities
884 IMGUI_API ImVec2 CalcTextSize(const char* text, const char* text_end = NULL, bool hide_text_after_double_hash = false, float wrap_width = -1.0f);
885
886 // Color Utilities
889 IMGUI_API void ColorConvertRGBtoHSV(float r, float g, float b, float& out_h, float& out_s, float& out_v);
890 IMGUI_API void ColorConvertHSVtoRGB(float h, float s, float v, float& out_r, float& out_g, float& out_b);
891
892 // Inputs Utilities: Keyboard
893 // Without IMGUI_DISABLE_OBSOLETE_KEYIO: (legacy support)
894 // - For 'ImGuiKey key' you can still use your legacy native/user indices according to how your backend/engine stored them in io.KeysDown[].
895 // With IMGUI_DISABLE_OBSOLETE_KEYIO: (this is the way forward)
896 // - Any use of 'ImGuiKey' will assert when key < 512 will be passed, previously reserved as native/user keys indices
897 // - GetKeyIndex() is pass-through and therefore deprecated (gone if IMGUI_DISABLE_OBSOLETE_KEYIO is defined)
898 IMGUI_API bool IsKeyDown(ImGuiKey key); // is key being held.
899 IMGUI_API bool IsKeyPressed(ImGuiKey key, bool repeat = true); // was key pressed (went from !Down to Down)? if repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate
900 IMGUI_API bool IsKeyReleased(ImGuiKey key); // was key released (went from Down to !Down)?
901 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
902 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.
903 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.
904
905 // Inputs Utilities: Mouse
906 // - To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.
907 // - You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.
908 // - Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see 'lock_threshold' and 'io.MouseDraggingThreshold')
909 IMGUI_API bool IsMouseDown(ImGuiMouseButton button); // is mouse button held?
910 IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, bool repeat = false); // did mouse button clicked? (went from !Down to Down). Same as GetMouseClickedCount() == 1.
911 IMGUI_API bool IsMouseReleased(ImGuiMouseButton button); // did mouse button released? (went from Down to !Down)
912 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)
913 IMGUI_API int GetMouseClickedCount(ImGuiMouseButton button); // return the number of successive mouse-clicks at the time where a click happen (otherwise 0).
914 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.
915 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
916 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.
917 IMGUI_API ImVec2 GetMousePos(); // shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls
918 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)
919 IMGUI_API bool IsMouseDragging(ImGuiMouseButton button, float lock_threshold = -1.0f); // is mouse dragging? (if lock_threshold < -1.0f, uses io.MouseDraggingThreshold)
920 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 (if lock_threshold < -1.0f, uses io.MouseDraggingThreshold)
922 IMGUI_API ImGuiMouseCursor GetMouseCursor(); // get desired cursor type, 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
923 IMGUI_API void SetMouseCursor(ImGuiMouseCursor cursor_type); // set desired cursor type
924 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.
925
926 // Clipboard Utilities
927 // - Also see the LogToClipboard() function to capture GUI into clipboard, or easily output text data to the clipboard.
929 IMGUI_API void SetClipboardText(const char* text);
930
931 // Settings/.Ini Utilities
932 // - The disk functions are automatically called if io.IniFilename != NULL (default is "imgui.ini").
933 // - Set io.IniFilename to NULL to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually.
934 // - 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).
935 IMGUI_API void LoadIniSettingsFromDisk(const char* ini_filename); // call after CreateContext() and before the first call to NewFrame(). NewFrame() automatically calls LoadIniSettingsFromDisk(io.IniFilename).
936 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.
937 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).
938 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.
939
940 // Debug Utilities
941 IMGUI_API void DebugTextEncoding(const char* text);
942 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.
943
944 // Memory Allocators
945 // - Those functions are not reliant on the current context.
946 // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
947 // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details.
948 IMGUI_API void SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void* user_data = NULL);
949 IMGUI_API void GetAllocatorFunctions(ImGuiMemAllocFunc* p_alloc_func, ImGuiMemFreeFunc* p_free_func, void** p_user_data);
950 IMGUI_API void* MemAlloc(size_t size);
951 IMGUI_API void MemFree(void* ptr);
952
953} // namespace ImGui
954
955//-----------------------------------------------------------------------------
956// [SECTION] Flags & Enumerations
957//-----------------------------------------------------------------------------
958
959// Flags for ImGui::Begin()
961{
963 ImGuiWindowFlags_NoTitleBar = 1 << 0, // Disable title-bar
964 ImGuiWindowFlags_NoResize = 1 << 1, // Disable user resizing with the lower-right grip
965 ImGuiWindowFlags_NoMove = 1 << 2, // Disable user moving the window
966 ImGuiWindowFlags_NoScrollbar = 1 << 3, // Disable scrollbars (window can still scroll with mouse or programmatically)
967 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.
968 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).
969 ImGuiWindowFlags_AlwaysAutoResize = 1 << 6, // Resize every window to its content every frame
970 ImGuiWindowFlags_NoBackground = 1 << 7, // Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
971 ImGuiWindowFlags_NoSavedSettings = 1 << 8, // Never load/save settings in .ini file
972 ImGuiWindowFlags_NoMouseInputs = 1 << 9, // Disable catching mouse, hovering test with pass through.
973 ImGuiWindowFlags_MenuBar = 1 << 10, // Has a menu-bar
974 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.
975 ImGuiWindowFlags_NoFocusOnAppearing = 1 << 12, // Disable taking focus when transitioning from hidden to visible state
976 ImGuiWindowFlags_NoBringToFrontOnFocus = 1 << 13, // Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)
977 ImGuiWindowFlags_AlwaysVerticalScrollbar= 1 << 14, // Always show vertical scrollbar (even if ContentSize.y < Size.y)
978 ImGuiWindowFlags_AlwaysHorizontalScrollbar=1<< 15, // Always show horizontal scrollbar (even if ContentSize.x < Size.x)
979 ImGuiWindowFlags_AlwaysUseWindowPadding = 1 << 16, // Ensure child windows without border uses style.WindowPadding (ignored by default for non-bordered child windows, because more convenient)
980 ImGuiWindowFlags_NoNavInputs = 1 << 18, // No gamepad/keyboard navigation within the window
981 ImGuiWindowFlags_NoNavFocus = 1 << 19, // No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)
982 ImGuiWindowFlags_UnsavedDocument = 1 << 20, // 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.
986
987 // [Internal]
988 ImGuiWindowFlags_NavFlattened = 1 << 23, // [BETA] On child window: allow gamepad/keyboard navigation to cross over parent border to this child or between sibling child windows.
989 ImGuiWindowFlags_ChildWindow = 1 << 24, // Don't use! For internal use by BeginChild()
990 ImGuiWindowFlags_Tooltip = 1 << 25, // Don't use! For internal use by BeginTooltip()
991 ImGuiWindowFlags_Popup = 1 << 26, // Don't use! For internal use by BeginPopup()
992 ImGuiWindowFlags_Modal = 1 << 27, // Don't use! For internal use by BeginPopupModal()
993 ImGuiWindowFlags_ChildMenu = 1 << 28 // Don't use! For internal use by BeginMenu()
994 //ImGuiWindowFlags_ResizeFromAnySide = 1 << 17, // [Obsolete] --> Set io.ConfigWindowsResizeFromEdges=true and make sure mouse cursors are supported by backend (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors)
996
997// Flags for ImGui::InputText()
999{
1001 ImGuiInputTextFlags_CharsDecimal = 1 << 0, // Allow 0123456789.+-*/
1002 ImGuiInputTextFlags_CharsHexadecimal = 1 << 1, // Allow 0123456789ABCDEFabcdef
1003 ImGuiInputTextFlags_CharsUppercase = 1 << 2, // Turn a..z into A..Z
1004 ImGuiInputTextFlags_CharsNoBlank = 1 << 3, // Filter out spaces, tabs
1005 ImGuiInputTextFlags_AutoSelectAll = 1 << 4, // Select entire text when first taking mouse focus
1006 ImGuiInputTextFlags_EnterReturnsTrue = 1 << 5, // Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider looking at the IsItemDeactivatedAfterEdit() function.
1007 ImGuiInputTextFlags_CallbackCompletion = 1 << 6, // Callback on pressing TAB (for completion handling)
1008 ImGuiInputTextFlags_CallbackHistory = 1 << 7, // Callback on pressing Up/Down arrows (for history handling)
1009 ImGuiInputTextFlags_CallbackAlways = 1 << 8, // Callback on each iteration. User code may query cursor position, modify text buffer.
1010 ImGuiInputTextFlags_CallbackCharFilter = 1 << 9, // Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
1011 ImGuiInputTextFlags_AllowTabInput = 1 << 10, // Pressing TAB input a '\t' character into the text field
1012 ImGuiInputTextFlags_CtrlEnterForNewLine = 1 << 11, // In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).
1013 ImGuiInputTextFlags_NoHorizontalScroll = 1 << 12, // Disable following the cursor horizontally
1014 ImGuiInputTextFlags_AlwaysOverwrite = 1 << 13, // Overwrite mode
1015 ImGuiInputTextFlags_ReadOnly = 1 << 14, // Read-only mode
1016 ImGuiInputTextFlags_Password = 1 << 15, // Password mode, display all characters as '*'
1017 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().
1018 ImGuiInputTextFlags_CharsScientific = 1 << 17, // Allow 0123456789.+-*/eE (Scientific notation input)
1019 ImGuiInputTextFlags_CallbackResize = 1 << 18, // 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)
1020 ImGuiInputTextFlags_CallbackEdit = 1 << 19 // 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)
1021
1022 // Obsolete names (will be removed soon)
1023#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1024 , ImGuiInputTextFlags_AlwaysInsertMode = ImGuiInputTextFlags_AlwaysOverwrite // [renamed in 1.82] name was not matching behavior
1025#endif
1027
1028// Flags for ImGui::TreeNodeEx(), ImGui::CollapsingHeader*()
1030{
1032 ImGuiTreeNodeFlags_Selected = 1 << 0, // Draw as selected
1033 ImGuiTreeNodeFlags_Framed = 1 << 1, // Draw frame with background (e.g. for CollapsingHeader)
1034 ImGuiTreeNodeFlags_AllowItemOverlap = 1 << 2, // Hit testing to allow subsequent widgets to overlap this one
1035 ImGuiTreeNodeFlags_NoTreePushOnOpen = 1 << 3, // Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack
1036 ImGuiTreeNodeFlags_NoAutoOpenOnLog = 1 << 4, // Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)
1037 ImGuiTreeNodeFlags_DefaultOpen = 1 << 5, // Default node to be open
1038 ImGuiTreeNodeFlags_OpenOnDoubleClick = 1 << 6, // Need double-click to open node
1039 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.
1040 ImGuiTreeNodeFlags_Leaf = 1 << 8, // No collapsing, no arrow (use as a convenience for leaf nodes).
1041 ImGuiTreeNodeFlags_Bullet = 1 << 9, // Display a bullet instead of arrow
1042 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().
1043 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. In the future we may refactor the hit system to be front-to-back, allowing natural overlaps and then this can become the default.
1044 ImGuiTreeNodeFlags_SpanFullWidth = 1 << 12, // Extend hit box to the left-most and right-most edges (bypass the indented area).
1045 ImGuiTreeNodeFlags_NavLeftJumpsBackHere = 1 << 13, // (WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)
1046 //ImGuiTreeNodeFlags_NoScrollOnOpen = 1 << 14, // FIXME: TODO: Disable automatic scroll on TreePop() if node got just open and contents is not visible
1049
1050// Flags for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() functions.
1051// - To be backward compatible with older API which took an 'int mouse_button = 1' argument, we need to treat
1052// small flags values as a mouse button index, so we encode the mouse button in the first few bits of the flags.
1053// It is therefore guaranteed to be legal to pass a mouse button index in ImGuiPopupFlags.
1054// - For the same reason, we exceptionally default the ImGuiPopupFlags argument of BeginPopupContextXXX functions to 1 instead of 0.
1055// IMPORTANT: because the default parameter is 1 (==ImGuiPopupFlags_MouseButtonRight), if you rely on the default parameter
1056// and want to another another flag, you need to pass in the ImGuiPopupFlags_MouseButtonRight flag.
1057// - Multiple buttons currently cannot be combined/or-ed in those functions (we could allow it later).
1059{
1061 ImGuiPopupFlags_MouseButtonLeft = 0, // For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left)
1062 ImGuiPopupFlags_MouseButtonRight = 1, // For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right)
1063 ImGuiPopupFlags_MouseButtonMiddle = 2, // For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle)
1066 ImGuiPopupFlags_NoOpenOverExistingPopup = 1 << 5, // For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack
1067 ImGuiPopupFlags_NoOpenOverItems = 1 << 6, // For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space
1068 ImGuiPopupFlags_AnyPopupId = 1 << 7, // For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.
1069 ImGuiPopupFlags_AnyPopupLevel = 1 << 8, // For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)
1072
1073// Flags for ImGui::Selectable()
1075{
1077 ImGuiSelectableFlags_DontClosePopups = 1 << 0, // Clicking this don't close parent popup window
1078 ImGuiSelectableFlags_SpanAllColumns = 1 << 1, // Selectable frame can span all columns (text will still fit in current column)
1079 ImGuiSelectableFlags_AllowDoubleClick = 1 << 2, // Generate press events on double clicks too
1080 ImGuiSelectableFlags_Disabled = 1 << 3, // Cannot be selected, display grayed out text
1081 ImGuiSelectableFlags_AllowItemOverlap = 1 << 4 // (WIP) Hit testing to allow subsequent widgets to overlap this one
1083
1084// Flags for ImGui::BeginCombo()
1086{
1088 ImGuiComboFlags_PopupAlignLeft = 1 << 0, // Align the popup toward the left by default
1089 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()
1090 ImGuiComboFlags_HeightRegular = 1 << 2, // Max ~8 items visible (default)
1091 ImGuiComboFlags_HeightLarge = 1 << 3, // Max ~20 items visible
1092 ImGuiComboFlags_HeightLargest = 1 << 4, // As many fitting items as possible
1093 ImGuiComboFlags_NoArrowButton = 1 << 5, // Display on the preview box without the square arrow button
1094 ImGuiComboFlags_NoPreview = 1 << 6, // Display only a square arrow button
1097
1098// Flags for ImGui::BeginTabBar()
1100{
1102 ImGuiTabBarFlags_Reorderable = 1 << 0, // Allow manually dragging tabs to re-order them + New tabs are appended at the end of list
1103 ImGuiTabBarFlags_AutoSelectNewTabs = 1 << 1, // Automatically select new tabs when they appear
1104 ImGuiTabBarFlags_TabListPopupButton = 1 << 2, // Disable buttons to open the tab list popup
1105 ImGuiTabBarFlags_NoCloseWithMiddleMouseButton = 1 << 3, // Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
1106 ImGuiTabBarFlags_NoTabListScrollingButtons = 1 << 4, // Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)
1107 ImGuiTabBarFlags_NoTooltip = 1 << 5, // Disable tooltips when hovering a tab
1108 ImGuiTabBarFlags_FittingPolicyResizeDown = 1 << 6, // Resize tabs when they don't fit
1109 ImGuiTabBarFlags_FittingPolicyScroll = 1 << 7, // Add scroll buttons when tabs don't fit
1113
1114// Flags for ImGui::BeginTabItem()
1116{
1118 ImGuiTabItemFlags_UnsavedDocument = 1 << 0, // Display a dot next to the title + 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.
1119 ImGuiTabItemFlags_SetSelected = 1 << 1, // Trigger flag to programmatically make the tab selected when calling BeginTabItem()
1120 ImGuiTabItemFlags_NoCloseWithMiddleMouseButton = 1 << 2, // Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
1121 ImGuiTabItemFlags_NoPushId = 1 << 3, // Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
1122 ImGuiTabItemFlags_NoTooltip = 1 << 4, // Disable tooltip for the given tab
1123 ImGuiTabItemFlags_NoReorder = 1 << 5, // Disable reordering this tab or having another tab cross over this tab
1124 ImGuiTabItemFlags_Leading = 1 << 6, // Enforce the tab position to the left of the tab bar (after the tab list popup button)
1125 ImGuiTabItemFlags_Trailing = 1 << 7 // Enforce the tab position to the right of the tab bar (before the scrolling buttons)
1127
1128// Flags for ImGui::BeginTable()
1129// - Important! Sizing policies have complex and subtle side effects, much more so than you would expect.
1130// Read comments/demos carefully + experiment with live demos to get acquainted with them.
1131// - The DEFAULT sizing policies are:
1132// - Default to ImGuiTableFlags_SizingFixedFit if ScrollX is on, or if host window has ImGuiWindowFlags_AlwaysAutoResize.
1133// - Default to ImGuiTableFlags_SizingStretchSame if ScrollX is off.
1134// - When ScrollX is off:
1135// - Table defaults to ImGuiTableFlags_SizingStretchSame -> all Columns defaults to ImGuiTableColumnFlags_WidthStretch with same weight.
1136// - Columns sizing policy allowed: Stretch (default), Fixed/Auto.
1137// - Fixed Columns (if any) will generally obtain their requested width (unless the table cannot fit them all).
1138// - Stretch Columns will share the remaining width according to their respective weight.
1139// - Mixed Fixed/Stretch columns is possible but has various side-effects on resizing behaviors.
1140// The typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns.
1141// (this is because the visible order of columns have subtle but necessary effects on how they react to manual resizing).
1142// - When ScrollX is on:
1143// - Table defaults to ImGuiTableFlags_SizingFixedFit -> all Columns defaults to ImGuiTableColumnFlags_WidthFixed
1144// - Columns sizing policy allowed: Fixed/Auto mostly.
1145// - Fixed Columns can be enlarged as needed. Table will show an horizontal scrollbar if needed.
1146// - 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.
1147// - Using Stretch columns OFTEN DOES NOT MAKE SENSE if ScrollX is on, UNLESS you have specified a value for 'inner_width' in BeginTable().
1148// 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.
1149// - Read on documentation at the top of imgui_tables.cpp for details.
1151{
1152 // Features
1154 ImGuiTableFlags_Resizable = 1 << 0, // Enable resizing columns.
1155 ImGuiTableFlags_Reorderable = 1 << 1, // Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)
1156 ImGuiTableFlags_Hideable = 1 << 2, // Enable hiding/disabling columns in context menu.
1157 ImGuiTableFlags_Sortable = 1 << 3, // Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.
1158 ImGuiTableFlags_NoSavedSettings = 1 << 4, // Disable persisting columns order, width and sort settings in the .ini file.
1159 ImGuiTableFlags_ContextMenuInBody = 1 << 5, // Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().
1160 // Decorations
1161 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)
1162 ImGuiTableFlags_BordersInnerH = 1 << 7, // Draw horizontal borders between rows.
1163 ImGuiTableFlags_BordersOuterH = 1 << 8, // Draw horizontal borders at the top and bottom.
1164 ImGuiTableFlags_BordersInnerV = 1 << 9, // Draw vertical borders between columns.
1165 ImGuiTableFlags_BordersOuterV = 1 << 10, // Draw vertical borders on the left and right sides.
1171 ImGuiTableFlags_NoBordersInBody = 1 << 11, // [ALPHA] Disable vertical borders in columns Body (borders will always appears in Headers). -> May move to style
1172 ImGuiTableFlags_NoBordersInBodyUntilResize = 1 << 12, // [ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appears in Headers). -> May move to style
1173 // Sizing Policy (read above for defaults)
1174 ImGuiTableFlags_SizingFixedFit = 1 << 13, // Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width.
1175 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.
1176 ImGuiTableFlags_SizingStretchProp = 3 << 13, // Columns default to _WidthStretch with default weights proportional to each columns contents widths.
1177 ImGuiTableFlags_SizingStretchSame = 4 << 13, // Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn().
1178 // Sizing Extra Options
1179 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.
1180 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.
1181 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.
1182 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.
1183 // Clipping
1184 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().
1185 // Padding
1186 ImGuiTableFlags_PadOuterX = 1 << 21, // Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.
1187 ImGuiTableFlags_NoPadOuterX = 1 << 22, // Default if BordersOuterV is off. Disable outer-most padding.
1188 ImGuiTableFlags_NoPadInnerX = 1 << 23, // Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).
1189 // Scrolling
1190 ImGuiTableFlags_ScrollX = 1 << 24, // Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this create a child window, ScrollY is currently generally recommended when using ScrollX.
1191 ImGuiTableFlags_ScrollY = 1 << 25, // Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size.
1192 // Sorting
1193 ImGuiTableFlags_SortMulti = 1 << 26, // Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).
1194 ImGuiTableFlags_SortTristate = 1 << 27, // Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).
1195
1196 // [Internal] Combinations and masks
1198
1199 // Obsolete names (will be removed soon)
1200#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1201 //, ImGuiTableFlags_ColumnsWidthFixed = ImGuiTableFlags_SizingFixedFit, ImGuiTableFlags_ColumnsWidthStretch = ImGuiTableFlags_SizingStretchSame // WIP Tables 2020/12
1202 //, ImGuiTableFlags_SizingPolicyFixed = ImGuiTableFlags_SizingFixedFit, ImGuiTableFlags_SizingPolicyStretch = ImGuiTableFlags_SizingStretchSame // WIP Tables 2021/01
1203#endif
1205
1206// Flags for ImGui::TableSetupColumn()
1208{
1209 // Input configuration flags
1211 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)
1212 ImGuiTableColumnFlags_DefaultHide = 1 << 1, // Default as a hidden/disabled column.
1213 ImGuiTableColumnFlags_DefaultSort = 1 << 2, // Default as a sorting column.
1214 ImGuiTableColumnFlags_WidthStretch = 1 << 3, // Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
1215 ImGuiTableColumnFlags_WidthFixed = 1 << 4, // Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).
1216 ImGuiTableColumnFlags_NoResize = 1 << 5, // Disable manual resizing.
1217 ImGuiTableColumnFlags_NoReorder = 1 << 6, // Disable manual reordering this column, this will also prevent other columns from crossing over this column.
1218 ImGuiTableColumnFlags_NoHide = 1 << 7, // Disable ability to hide/disable this column.
1219 ImGuiTableColumnFlags_NoClip = 1 << 8, // Disable clipping for this column (all NoClip columns will render in a same draw command).
1220 ImGuiTableColumnFlags_NoSort = 1 << 9, // Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table).
1221 ImGuiTableColumnFlags_NoSortAscending = 1 << 10, // Disable ability to sort in the ascending direction.
1222 ImGuiTableColumnFlags_NoSortDescending = 1 << 11, // Disable ability to sort in the descending direction.
1223 ImGuiTableColumnFlags_NoHeaderLabel = 1 << 12, // TableHeadersRow() will not submit label for this column. Convenient for some small columns. Name will still appear in context menu.
1224 ImGuiTableColumnFlags_NoHeaderWidth = 1 << 13, // Disable header text width contribution to automatic column width.
1225 ImGuiTableColumnFlags_PreferSortAscending = 1 << 14, // Make the initial sort direction Ascending when first sorting on this column (default).
1226 ImGuiTableColumnFlags_PreferSortDescending = 1 << 15, // Make the initial sort direction Descending when first sorting on this column.
1227 ImGuiTableColumnFlags_IndentEnable = 1 << 16, // Use current Indent value when entering cell (default for column 0).
1228 ImGuiTableColumnFlags_IndentDisable = 1 << 17, // Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored.
1229
1230 // Output status flags, read-only via TableGetColumnFlags()
1231 ImGuiTableColumnFlags_IsEnabled = 1 << 24, // Status: is enabled == not hidden by user/api (referred to as "Hide" in _DefaultHide and _NoHide) flags.
1232 ImGuiTableColumnFlags_IsVisible = 1 << 25, // Status: is visible == is enabled AND not clipped by scrolling.
1233 ImGuiTableColumnFlags_IsSorted = 1 << 26, // Status: is currently part of the sort specs
1234 ImGuiTableColumnFlags_IsHovered = 1 << 27, // Status: is hovered by mouse
1235
1236 // [Internal] Combinations and masks
1240 ImGuiTableColumnFlags_NoDirectResize_ = 1 << 30 // [Internal] Disable user resizing this column directly (it may however we resized indirectly from its left edge)
1241
1242 // Obsolete names (will be removed soon)
1243#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1244 //ImGuiTableColumnFlags_WidthAuto = ImGuiTableColumnFlags_WidthFixed | ImGuiTableColumnFlags_NoResize, // Column will not stretch and keep resizing based on submitted contents.
1245#endif
1247
1248// Flags for ImGui::TableNextRow()
1250{
1252 ImGuiTableRowFlags_Headers = 1 << 0 // Identify header row (set default background color + width of its contents accounted differently for auto column width)
1254
1255// Enum for ImGui::TableSetBgColor()
1256// Background colors are rendering in 3 layers:
1257// - Layer 0: draw with RowBg0 color if set, otherwise draw with ColumnBg0 if set.
1258// - Layer 1: draw with RowBg1 color if set, otherwise draw with ColumnBg1 if set.
1259// - Layer 2: draw with CellBg color if set.
1260// The purpose of the two row/columns layers is to let you decide if a background color changes should override or blend with the existing color.
1261// When using ImGuiTableFlags_RowBg on the table, each row has the RowBg0 color automatically set for odd/even rows.
1262// If you set the color of RowBg0 target, your color will override the existing RowBg0 color.
1263// If you set the color of RowBg1 or ColumnBg1 target, your color will blend over the RowBg0 color.
1265{
1267 ImGuiTableBgTarget_RowBg0 = 1, // Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used)
1268 ImGuiTableBgTarget_RowBg1 = 2, // Set row background color 1 (generally used for selection marking)
1269 ImGuiTableBgTarget_CellBg = 3 // Set cell background color (top-most color)
1271
1272// Flags for ImGui::IsWindowFocused()
1274{
1276 ImGuiFocusedFlags_ChildWindows = 1 << 0, // Return true if any children of the window is focused
1277 ImGuiFocusedFlags_RootWindow = 1 << 1, // Test from root window (top most parent of the current hierarchy)
1278 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!
1279 ImGuiFocusedFlags_NoPopupHierarchy = 1 << 3, // Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow)
1280 //ImGuiFocusedFlags_DockHierarchy = 1 << 4, // Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow)
1283
1284// Flags for ImGui::IsItemHovered(), ImGui::IsWindowHovered()
1285// 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!
1286// Note: windows with the ImGuiWindowFlags_NoInputs flag are ignored by IsWindowHovered() calls.
1288{
1289 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.
1290 ImGuiHoveredFlags_ChildWindows = 1 << 0, // IsWindowHovered() only: Return true if any children of the window is hovered
1291 ImGuiHoveredFlags_RootWindow = 1 << 1, // IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)
1292 ImGuiHoveredFlags_AnyWindow = 1 << 2, // IsWindowHovered() only: Return true if any window is hovered
1293 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)
1294 //ImGuiHoveredFlags_DockHierarchy = 1 << 4, // IsWindowHovered() only: Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow)
1295 ImGuiHoveredFlags_AllowWhenBlockedByPopup = 1 << 5, // Return true even if a popup window is normally blocking access to this item/window
1296 //ImGuiHoveredFlags_AllowWhenBlockedByModal = 1 << 6, // Return true even if a modal popup window is normally blocking access to this item/window. FIXME-TODO: Unavailable yet.
1297 ImGuiHoveredFlags_AllowWhenBlockedByActiveItem = 1 << 7, // Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
1298 ImGuiHoveredFlags_AllowWhenOverlapped = 1 << 8, // IsItemHovered() only: Return true even if the position is obstructed or overlapped by another window
1299 ImGuiHoveredFlags_AllowWhenDisabled = 1 << 9, // IsItemHovered() only: Return true even if the item is disabled
1300 ImGuiHoveredFlags_NoNavOverride = 1 << 10, // Disable using gamepad/keyboard navigation state when active, always query mouse.
1304
1305// Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload()
1307{
1309 // BeginDragDropSource() flags
1310 ImGuiDragDropFlags_SourceNoPreviewTooltip = 1 << 0, // By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.
1311 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 disable this behavior so you can still call IsItemHovered() on the source item.
1312 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.
1313 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.
1314 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.
1315 ImGuiDragDropFlags_SourceAutoExpirePayload = 1 << 5, // Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
1316 // AcceptDragDropPayload() flags
1317 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.
1318 ImGuiDragDropFlags_AcceptNoDrawDefaultRect = 1 << 11, // Do not draw the default highlight rectangle when hovering over target.
1319 ImGuiDragDropFlags_AcceptNoPreviewTooltip = 1 << 12, // Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
1320 ImGuiDragDropFlags_AcceptPeekOnly = ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoDrawDefaultRect // For peeking ahead and inspecting the payload before delivery.
1322
1323// Standard Drag and Drop payload types. You can define you own payload types using short strings. Types starting with '_' are defined by Dear ImGui.
1324#define IMGUI_PAYLOAD_TYPE_COLOR_3F "_COL3F" // float[3]: Standard type for colors, without alpha. User code may use this type.
1325#define IMGUI_PAYLOAD_TYPE_COLOR_4F "_COL4F" // float[4]: Standard type for colors. User code may use this type.
1326
1327// A primary data type
1329{
1330 ImGuiDataType_S8, // signed char / char (with sensible compilers)
1331 ImGuiDataType_U8, // unsigned char
1333 ImGuiDataType_U16, // unsigned short
1335 ImGuiDataType_U32, // unsigned int
1336 ImGuiDataType_S64, // long long / __int64
1337 ImGuiDataType_U64, // unsigned long long / unsigned __int64
1342
1343// A cardinal direction
1353
1354// A sorting direction
1356{
1358 ImGuiSortDirection_Ascending = 1, // Ascending = 0->9, A->Z etc.
1359 ImGuiSortDirection_Descending = 2 // Descending = 9->0, Z->A etc.
1361
1362// Keys value 0 to 511 are left unused as legacy native/opaque key values (< 1.87)
1363// Keys value >= 512 are named keys (>= 1.87)
1365{
1366 // Keyboard
1368 ImGuiKey_Tab = 512, // == ImGuiKey_NamedKey_BEGIN
1400 ImGuiKey_Backslash, // \ (this text inhibit multiline comment caused by backslash)
1417
1418 // Gamepad (some of those are analog values, 0.0f to 1.0f) // NAVIGATION action
1419 ImGuiKey_GamepadStart, // Menu (Xbox) + (Switch) Start/Options (PS) // --
1420 ImGuiKey_GamepadBack, // View (Xbox) - (Switch) Share (PS) // --
1421 ImGuiKey_GamepadFaceUp, // Y (Xbox) X (Switch) Triangle (PS) // -> ImGuiNavInput_Input
1422 ImGuiKey_GamepadFaceDown, // A (Xbox) B (Switch) Cross (PS) // -> ImGuiNavInput_Activate
1423 ImGuiKey_GamepadFaceLeft, // X (Xbox) Y (Switch) Square (PS) // -> ImGuiNavInput_Menu
1424 ImGuiKey_GamepadFaceRight, // B (Xbox) A (Switch) Circle (PS) // -> ImGuiNavInput_Cancel
1425 ImGuiKey_GamepadDpadUp, // D-pad Up // -> ImGuiNavInput_DpadUp
1426 ImGuiKey_GamepadDpadDown, // D-pad Down // -> ImGuiNavInput_DpadDown
1427 ImGuiKey_GamepadDpadLeft, // D-pad Left // -> ImGuiNavInput_DpadLeft
1428 ImGuiKey_GamepadDpadRight, // D-pad Right // -> ImGuiNavInput_DpadRight
1429 ImGuiKey_GamepadL1, // L Bumper (Xbox) L (Switch) L1 (PS) // -> ImGuiNavInput_FocusPrev + ImGuiNavInput_TweakSlow
1430 ImGuiKey_GamepadR1, // R Bumper (Xbox) R (Switch) R1 (PS) // -> ImGuiNavInput_FocusNext + ImGuiNavInput_TweakFast
1431 ImGuiKey_GamepadL2, // L Trigger (Xbox) ZL (Switch) L2 (PS) [Analog]
1432 ImGuiKey_GamepadR2, // R Trigger (Xbox) ZR (Switch) R2 (PS) [Analog]
1433 ImGuiKey_GamepadL3, // L Thumbstick (Xbox) L3 (Switch) L3 (PS)
1434 ImGuiKey_GamepadR3, // R Thumbstick (Xbox) R3 (Switch) R3 (PS)
1435 ImGuiKey_GamepadLStickUp, // [Analog] // -> ImGuiNavInput_LStickUp
1436 ImGuiKey_GamepadLStickDown, // [Analog] // -> ImGuiNavInput_LStickDown
1437 ImGuiKey_GamepadLStickLeft, // [Analog] // -> ImGuiNavInput_LStickLeft
1438 ImGuiKey_GamepadLStickRight, // [Analog] // -> ImGuiNavInput_LStickRight
1443
1444 // Keyboard Modifiers (explicitly submitted by backend via AddKeyEvent() calls)
1445 // - This is mirroring the data also written to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper, in a format allowing
1446 // them to be accessed via standard key API, allowing calls such as IsKeyPressed(), IsKeyReleased(), querying duration etc.
1447 // - Code polling every keys (e.g. an interface to detect a key press for input mapping) might want to ignore those
1448 // and prefer using the real keys (e.g. ImGuiKey_LeftCtrl, ImGuiKey_RightCtrl instead of ImGuiKey_ModCtrl).
1449 // - In theory the value of keyboard modifiers should be roughly equivalent to a logical or of the equivalent left/right keys.
1450 // In practice: it's complicated; mods are often provided from different sources. Keyboard layout, IME, sticky keys and
1451 // backends tend to interfere and break that equivalence. The safer decision is to relay that ambiguity down to the end-user...
1453
1454 // End of list
1455 ImGuiKey_COUNT, // No valid ImGuiKey is ever greater than this value
1456
1457 // [Internal] Prior to 1.87 we required user to fill io.KeysDown[512] using their own native index + a io.KeyMap[] array.
1458 // We are ditching this method but keeping a legacy path for user code doing e.g. IsKeyPressed(MY_NATIVE_KEY_CODE)
1462#ifdef IMGUI_DISABLE_OBSOLETE_KEYIO
1463 ImGuiKey_KeysData_SIZE = ImGuiKey_NamedKey_COUNT, // Size of KeysData[]: only hold named keys
1464 ImGuiKey_KeysData_OFFSET = ImGuiKey_NamedKey_BEGIN // First key stored in io.KeysData[0]. Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET).
1465#else
1466 ImGuiKey_KeysData_SIZE = ImGuiKey_COUNT, // Size of KeysData[]: hold legacy 0..512 keycodes + named keys
1467 ImGuiKey_KeysData_OFFSET = 0 // First key stored in io.KeysData[0]. Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET).
1468#endif
1469
1470#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1472#endif
1474
1475// Helper "flags" version of key-mods to store and compare multiple key-mods easily. Sometimes used for storage (e.g. io.KeyMods) but otherwise not much used in public API.
1477{
1481 ImGuiModFlags_Alt = 1 << 2, // Menu
1482 ImGuiModFlags_Super = 1 << 3 // Cmd/Super/Windows key
1484
1485// Gamepad/Keyboard navigation
1486// Since >= 1.87 backends you generally don't need to care about this enum since io.NavInputs[] is setup automatically. This might become private/internal some day.
1487// Keyboard: Set io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard to enable. NewFrame() will automatically fill io.NavInputs[] based on your io.AddKeyEvent() calls.
1488// Gamepad: Set io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad to enable. Backend: set ImGuiBackendFlags_HasGamepad and fill the io.NavInputs[] fields before calling NewFrame(). Note that io.NavInputs[] is cleared by EndFrame().
1489// Read instructions in imgui.cpp for more details. Download PNG/PSD at http://dearimgui.org/controls_sheets.
1491{
1492 // Gamepad Mapping
1493 ImGuiNavInput_Activate, // Activate / Open / Toggle / Tweak value // e.g. Cross (PS4), A (Xbox), A (Switch), Space (Keyboard)
1494 ImGuiNavInput_Cancel, // Cancel / Close / Exit // e.g. Circle (PS4), B (Xbox), B (Switch), Escape (Keyboard)
1495 ImGuiNavInput_Input, // Text input / On-Screen keyboard // e.g. Triang.(PS4), Y (Xbox), X (Switch), Return (Keyboard)
1496 ImGuiNavInput_Menu, // Tap: Toggle menu / Hold: Focus, Move, Resize // e.g. Square (PS4), X (Xbox), Y (Switch), Alt (Keyboard)
1497 ImGuiNavInput_DpadLeft, // Move / Tweak / Resize window (w/ PadMenu) // e.g. D-pad Left/Right/Up/Down (Gamepads), Arrow keys (Keyboard)
1501 ImGuiNavInput_LStickLeft, // Scroll / Move window (w/ PadMenu) // e.g. Left Analog Stick Left/Right/Up/Down
1505 ImGuiNavInput_FocusPrev, // Focus Next window (w/ PadMenu) // e.g. L1 or L2 (PS4), LB or LT (Xbox), L or ZL (Switch)
1506 ImGuiNavInput_FocusNext, // Focus Prev window (w/ PadMenu) // e.g. R1 or R2 (PS4), RB or RT (Xbox), R or ZL (Switch)
1507 ImGuiNavInput_TweakSlow, // Slower tweaks // e.g. L1 or L2 (PS4), LB or LT (Xbox), L or ZL (Switch)
1508 ImGuiNavInput_TweakFast, // Faster tweaks // e.g. R1 or R2 (PS4), RB or RT (Xbox), R or ZL (Switch)
1509
1510 // [Internal] Don't use directly! This is used internally to differentiate keyboard from gamepad inputs for behaviors that require to differentiate them.
1511 // Keyboard behavior that have no corresponding gamepad mapping (e.g. CTRL+TAB) will be directly reading from keyboard keys instead of io.NavInputs[].
1512 ImGuiNavInput_KeyLeft_, // Move left // = Arrow keys
1518
1519// Configuration flags stored in io.ConfigFlags. Set by user/application.
1521{
1523 ImGuiConfigFlags_NavEnableKeyboard = 1 << 0, // Master keyboard navigation enable flag. NewFrame() will automatically fill io.NavInputs[] based on io.AddKeyEvent() calls
1524 ImGuiConfigFlags_NavEnableGamepad = 1 << 1, // Master gamepad navigation enable flag. This is mostly to instruct your imgui backend to fill io.NavInputs[]. Backend also needs to set ImGuiBackendFlags_HasGamepad.
1525 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.
1526 ImGuiConfigFlags_NavNoCaptureKeyboard = 1 << 3, // Instruct navigation to not set the io.WantCaptureKeyboard flag when io.NavActive is set.
1527 ImGuiConfigFlags_NoMouse = 1 << 4, // Instruct imgui to clear mouse position/buttons in NewFrame(). This allows ignoring the mouse information set by the backend.
1528 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.
1529
1530 // 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)
1531 ImGuiConfigFlags_IsSRGB = 1 << 20, // Application is SRGB-aware.
1532 ImGuiConfigFlags_IsTouchScreen = 1 << 21 // Application is using a touch screen instead of a mouse.
1534
1535// Backend capabilities flags stored in io.BackendFlags. Set by imgui_impl_xxx or custom backend.
1537{
1539 ImGuiBackendFlags_HasGamepad = 1 << 0, // Backend Platform supports gamepad and currently has one connected.
1540 ImGuiBackendFlags_HasMouseCursors = 1 << 1, // Backend Platform supports honoring GetMouseCursor() value to change the OS cursor shape.
1541 ImGuiBackendFlags_HasSetMousePos = 1 << 2, // Backend Platform supports io.WantSetMousePos requests to reposition the OS mouse position (only used if ImGuiConfigFlags_NavEnableSetMousePos is set).
1542 ImGuiBackendFlags_RendererHasVtxOffset = 1 << 3 // Backend Renderer supports ImDrawCmd::VtxOffset. This enables output of large meshes (64K+ vertices) while still using 16-bit indices.
1544
1545// Enumeration for PushStyleColor() / PopStyleColor()
1547{
1550 ImGuiCol_WindowBg, // Background of normal windows
1551 ImGuiCol_ChildBg, // Background of child windows
1552 ImGuiCol_PopupBg, // Background of popups, menus, tooltips windows
1555 ImGuiCol_FrameBg, // Background of checkbox, radio button, plot, slider, text input
1572 ImGuiCol_Header, // Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem
1578 ImGuiCol_ResizeGrip, // Resize grip in lower-right and lower-left corners of windows.
1581 ImGuiCol_Tab, // TabItem in a TabBar
1590 ImGuiCol_TableHeaderBg, // Table header background
1591 ImGuiCol_TableBorderStrong, // Table outer and header borders (prefer using Alpha=1.0 here)
1592 ImGuiCol_TableBorderLight, // Table inner borders (prefer using Alpha=1.0 here)
1593 ImGuiCol_TableRowBg, // Table row background (even rows)
1594 ImGuiCol_TableRowBgAlt, // Table row background (odd rows)
1596 ImGuiCol_DragDropTarget, // Rectangle highlighting a drop target
1597 ImGuiCol_NavHighlight, // Gamepad/keyboard: current highlighted item
1598 ImGuiCol_NavWindowingHighlight, // Highlight window when using CTRL+TAB
1599 ImGuiCol_NavWindowingDimBg, // Darken/colorize entire screen behind the CTRL+TAB window list, when active
1600 ImGuiCol_ModalWindowDimBg, // Darken/colorize entire screen behind a modal window, when one is active
1603
1604// Enumeration for PushStyleVar() / PopStyleVar() to temporarily modify the ImGuiStyle structure.
1605// - The enum only refers to fields of ImGuiStyle which makes sense to be pushed/popped inside UI code.
1606// During initialization or between frames, feel free to just poke into ImGuiStyle directly.
1607// - Tip: Use your programming IDE navigation facilities on the names in the _second column_ below to find the actual members and their description.
1608// In Visual Studio IDE: CTRL+comma ("Edit.GoToAll") can follow symbols in comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
1609// With Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols in comments.
1610// - 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.
1612{
1613 // Enum name --------------------- // Member in ImGuiStyle structure (see ImGuiStyle for descriptions)
1614 ImGuiStyleVar_Alpha, // float Alpha
1615 ImGuiStyleVar_DisabledAlpha, // float DisabledAlpha
1616 ImGuiStyleVar_WindowPadding, // ImVec2 WindowPadding
1617 ImGuiStyleVar_WindowRounding, // float WindowRounding
1618 ImGuiStyleVar_WindowBorderSize, // float WindowBorderSize
1619 ImGuiStyleVar_WindowMinSize, // ImVec2 WindowMinSize
1620 ImGuiStyleVar_WindowTitleAlign, // ImVec2 WindowTitleAlign
1621 ImGuiStyleVar_ChildRounding, // float ChildRounding
1622 ImGuiStyleVar_ChildBorderSize, // float ChildBorderSize
1623 ImGuiStyleVar_PopupRounding, // float PopupRounding
1624 ImGuiStyleVar_PopupBorderSize, // float PopupBorderSize
1625 ImGuiStyleVar_FramePadding, // ImVec2 FramePadding
1626 ImGuiStyleVar_FrameRounding, // float FrameRounding
1627 ImGuiStyleVar_FrameBorderSize, // float FrameBorderSize
1628 ImGuiStyleVar_ItemSpacing, // ImVec2 ItemSpacing
1629 ImGuiStyleVar_ItemInnerSpacing, // ImVec2 ItemInnerSpacing
1630 ImGuiStyleVar_IndentSpacing, // float IndentSpacing
1631 ImGuiStyleVar_CellPadding, // ImVec2 CellPadding
1632 ImGuiStyleVar_ScrollbarSize, // float ScrollbarSize
1633 ImGuiStyleVar_ScrollbarRounding, // float ScrollbarRounding
1634 ImGuiStyleVar_GrabMinSize, // float GrabMinSize
1635 ImGuiStyleVar_GrabRounding, // float GrabRounding
1636 ImGuiStyleVar_TabRounding, // float TabRounding
1637 ImGuiStyleVar_ButtonTextAlign, // ImVec2 ButtonTextAlign
1638 ImGuiStyleVar_SelectableTextAlign, // ImVec2 SelectableTextAlign
1641
1642// Flags for InvisibleButton() [extended in imgui_internal.h]
1654
1655// Flags for ColorEdit3() / ColorEdit4() / ColorPicker3() / ColorPicker4() / ColorButton()
1657{
1659 ImGuiColorEditFlags_NoAlpha = 1 << 1, // // ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer).
1660 ImGuiColorEditFlags_NoPicker = 1 << 2, // // ColorEdit: disable picker when clicking on color square.
1661 ImGuiColorEditFlags_NoOptions = 1 << 3, // // ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
1662 ImGuiColorEditFlags_NoSmallPreview = 1 << 4, // // ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs)
1663 ImGuiColorEditFlags_NoInputs = 1 << 5, // // ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square).
1664 ImGuiColorEditFlags_NoTooltip = 1 << 6, // // ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
1665 ImGuiColorEditFlags_NoLabel = 1 << 7, // // ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).
1666 ImGuiColorEditFlags_NoSidePreview = 1 << 8, // // ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead.
1667 ImGuiColorEditFlags_NoDragDrop = 1 << 9, // // ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.
1668 ImGuiColorEditFlags_NoBorder = 1 << 10, // // ColorButton: disable border (which is enforced by default)
1669
1670 // User Options (right-click on widget to change some of them).
1671 ImGuiColorEditFlags_AlphaBar = 1 << 16, // // ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
1672 ImGuiColorEditFlags_AlphaPreview = 1 << 17, // // ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.
1673 ImGuiColorEditFlags_AlphaPreviewHalf= 1 << 18, // // ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.
1674 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).
1675 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.
1676 ImGuiColorEditFlags_DisplayHSV = 1 << 21, // [Display] // "
1677 ImGuiColorEditFlags_DisplayHex = 1 << 22, // [Display] // "
1678 ImGuiColorEditFlags_Uint8 = 1 << 23, // [DataType] // ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255.
1679 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.
1680 ImGuiColorEditFlags_PickerHueBar = 1 << 25, // [Picker] // ColorPicker: bar for Hue, rectangle for Sat/Value.
1681 ImGuiColorEditFlags_PickerHueWheel = 1 << 26, // [Picker] // ColorPicker: wheel for Hue, triangle for Sat/Value.
1682 ImGuiColorEditFlags_InputRGB = 1 << 27, // [Input] // ColorEdit, ColorPicker: input and output data in RGB format.
1683 ImGuiColorEditFlags_InputHSV = 1 << 28, // [Input] // ColorEdit, ColorPicker: input and output data in HSV format.
1684
1685 // Defaults Options. You can set application defaults using SetColorEditOptions(). The intent is that you probably don't want to
1686 // override them in most of your calls. Let the user choose via the option menu and/or call SetColorEditOptions() once during startup.
1688
1689 // [Internal] Masks
1694
1695 // Obsolete names (will be removed)
1696 // ImGuiColorEditFlags_RGB = ImGuiColorEditFlags_DisplayRGB, ImGuiColorEditFlags_HSV = ImGuiColorEditFlags_DisplayHSV, ImGuiColorEditFlags_HEX = ImGuiColorEditFlags_DisplayHex // [renamed in 1.69]
1698
1699// Flags for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
1700// 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.
1702{
1704 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.
1705 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.
1706 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)
1707 ImGuiSliderFlags_NoInput = 1 << 7, // Disable CTRL+Click or Enter key allowing to input text directly into the widget
1708 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.
1709
1710 // Obsolete names (will be removed)
1711#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1713#endif
1715
1716// Identify a mouse button.
1717// Those values are guaranteed to be stable and we frequently use 0/1 directly. Named enums provided for convenience.
1725
1726// Enumeration for GetMouseCursor()
1727// User code may request backend to display given cursor by calling SetMouseCursor(), which is why we have some cursors that are marked unused here
1729{
1732 ImGuiMouseCursor_TextInput, // When hovering over InputText, etc.
1733 ImGuiMouseCursor_ResizeAll, // (Unused by Dear ImGui functions)
1734 ImGuiMouseCursor_ResizeNS, // When hovering over an horizontal border
1735 ImGuiMouseCursor_ResizeEW, // When hovering over a vertical border or a column
1736 ImGuiMouseCursor_ResizeNESW, // When hovering over the bottom-left corner of a window
1737 ImGuiMouseCursor_ResizeNWSE, // When hovering over the bottom-right corner of a window
1738 ImGuiMouseCursor_Hand, // (Unused by Dear ImGui functions. Use for e.g. hyperlinks)
1739 ImGuiMouseCursor_NotAllowed, // When hovering something with disallowed interaction. Usually a crossed circle.
1742
1743// Enumeration for ImGui::SetWindow***(), SetNextWindow***(), SetNextItem***() functions
1744// Represent a condition.
1745// 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.
1747{
1748 ImGuiCond_None = 0, // No condition (always set the variable), same as _Always
1749 ImGuiCond_Always = 1 << 0, // No condition (always set the variable)
1750 ImGuiCond_Once = 1 << 1, // Set the variable once per runtime session (only the first call will succeed)
1751 ImGuiCond_FirstUseEver = 1 << 2, // Set the variable if the object/window has no persistently saved data (no entry in .ini file)
1752 ImGuiCond_Appearing = 1 << 3 // Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
1754
1755//-----------------------------------------------------------------------------
1756// [SECTION] Helpers: Memory allocations macros, ImVector<>
1757//-----------------------------------------------------------------------------
1758
1759//-----------------------------------------------------------------------------
1760// IM_MALLOC(), IM_FREE(), IM_NEW(), IM_PLACEMENT_NEW(), IM_DELETE()
1761// We call C++ constructor on own allocated memory via the placement "new(ptr) Type()" syntax.
1762// 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.
1763//-----------------------------------------------------------------------------
1764
1766inline void* operator new(size_t, ImNewWrapper, void* ptr) { return ptr; }
1767inline void operator delete(void*, ImNewWrapper, void*) {} // This is only required so we can use the symmetrical new()
1768#define IM_ALLOC(_SIZE) ImGui::MemAlloc(_SIZE)
1769#define IM_FREE(_PTR) ImGui::MemFree(_PTR)
1770#define IM_PLACEMENT_NEW(_PTR) new(ImNewWrapper(), _PTR)
1771#define IM_NEW(_TYPE) new(ImNewWrapper(), ImGui::MemAlloc(sizeof(_TYPE))) _TYPE
1772template<typename T> void IM_DELETE(T* p) { if (p) { p->~T(); ImGui::MemFree(p); } }
1773
1774//-----------------------------------------------------------------------------
1775// ImVector<>
1776// 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).
1777//-----------------------------------------------------------------------------
1778// - 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.
1779// - We use std-like naming convention here, which is a little unusual for this codebase.
1780// - 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.
1781// - Important: our implementation does NOT call C++ constructors/destructors, we treat everything as raw data! This is intentional but be extra mindful of that,
1782// 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.
1783//-----------------------------------------------------------------------------
1784
1786template<typename T>
1788{
1789 int Size;
1792
1793 // Provide standard typedefs but we don't use them ourselves.
1794 typedef T value_type;
1797
1798 // Constructors, destructor
1799 inline ImVector() { Size = Capacity = 0; Data = NULL; }
1800 inline ImVector(const ImVector<T>& src) { Size = Capacity = 0; Data = NULL; operator=(src); }
1801 inline ImVector<T>& operator=(const ImVector<T>& src) { clear(); resize(src.Size); memcpy(Data, src.Data, (size_t)Size * sizeof(T)); return *this; }
1802 inline ~ImVector() { if (Data) IM_FREE(Data); } // Important: does not destruct anything
1803
1804 inline void clear() { if (Data) { Size = Capacity = 0; IM_FREE(Data); Data = NULL; } } // Important: does not destruct anything
1805 inline void clear_delete() { for (int n = 0; n < Size; n++) IM_DELETE(Data[n]); clear(); } // Important: never called automatically! always explicit.
1806 inline void clear_destruct() { for (int n = 0; n < Size; n++) Data[n].~T(); clear(); } // Important: never called automatically! always explicit.
1807
1808 inline bool empty() const { return Size == 0; }
1809 inline int size() const { return Size; }
1810 inline int size_in_bytes() const { return Size * (int)sizeof(T); }
1811 inline int max_size() const { return 0x7FFFFFFF / (int)sizeof(T); }
1812 inline int capacity() const { return Capacity; }
1813 inline T& operator[](int i) { IM_ASSERT(i >= 0 && i < Size); return Data[i]; }
1814 inline const T& operator[](int i) const { IM_ASSERT(i >= 0 && i < Size); return Data[i]; }
1815
1816 inline T* begin() { return Data; }
1817 inline const T* begin() const { return Data; }
1818 inline T* end() { return Data + Size; }
1819 inline const T* end() const { return Data + Size; }
1820 inline T& front() { IM_ASSERT(Size > 0); return Data[0]; }
1821 inline const T& front() const { IM_ASSERT(Size > 0); return Data[0]; }
1822 inline T& back() { IM_ASSERT(Size > 0); return Data[Size - 1]; }
1823 inline const T& back() const { IM_ASSERT(Size > 0); return Data[Size - 1]; }
1824 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; }
1825
1826 inline int _grow_capacity(int sz) const { int new_capacity = Capacity ? (Capacity + Capacity / 2) : 8; return new_capacity > sz ? new_capacity : sz; }
1827 inline void resize(int new_size) { if (new_size > Capacity) reserve(_grow_capacity(new_size)); Size = new_size; }
1828 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; }
1829 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
1830 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; }
1831 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; }
1832
1833 // 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.
1834 inline void push_back(const T& v) { if (Size == Capacity) reserve(_grow_capacity(Size + 1)); memcpy(&Data[Size], &v, sizeof(v)); Size++; }
1835 inline void pop_back() { IM_ASSERT(Size > 0); Size--; }
1836 inline void push_front(const T& v) { if (Size == 0) push_back(v); else insert(Data, v); }
1837 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; }
1838 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; }
1839 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; }
1840 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; }
1841 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; }
1842 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; }
1843 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; }
1844 inline bool find_erase(const T& v) { const T* it = find(v); if (it < Data + Size) { erase(it); return true; } return false; }
1845 inline bool find_erase_unsorted(const T& v) { const T* it = find(v); if (it < Data + Size) { erase_unsorted(it); return true; } return false; }
1846 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; }
1847};
1849
1850//-----------------------------------------------------------------------------
1851// [SECTION] ImGuiStyle
1852//-----------------------------------------------------------------------------
1853// You may modify the ImGui::GetStyle() main instance during initialization and before NewFrame().
1854// During the frame, use ImGui::PushStyleVar(ImGuiStyleVar_XXXX)/PopStyleVar() to alter the main style values,
1855// and ImGui::PushStyleColor(ImGuiCol_XXX)/PopStyleColor() for colors.
1856//-----------------------------------------------------------------------------
1857
1859{
1860 float Alpha; // Global alpha applies to everything in Dear ImGui.
1861 float DisabledAlpha; // Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha.
1862 ImVec2 WindowPadding; // Padding within a window.
1863 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.
1864 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).
1865 ImVec2 WindowMinSize; // Minimum window size. This is a global setting. If you want to constraint individual windows, use SetNextWindowSizeConstraints().
1866 ImVec2 WindowTitleAlign; // Alignment for title bar text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.
1867 ImGuiDir WindowMenuButtonPosition; // Side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to ImGuiDir_Left.
1868 float ChildRounding; // Radius of child window corners rounding. Set to 0.0f to have rectangular windows.
1869 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).
1870 float PopupRounding; // Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding)
1871 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).
1872 ImVec2 FramePadding; // Padding within a framed rectangle (used by most widgets).
1873 float FrameRounding; // Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets).
1874 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).
1875 ImVec2 ItemSpacing; // Horizontal and vertical spacing between widgets/lines.
1876 ImVec2 ItemInnerSpacing; // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).
1877 ImVec2 CellPadding; // Padding within a table cell
1878 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!
1879 float IndentSpacing; // Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).
1880 float ColumnsMinSpacing; // Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
1881 float ScrollbarSize; // Width of the vertical scrollbar, Height of the horizontal scrollbar.
1882 float ScrollbarRounding; // Radius of grab corners for scrollbar.
1883 float GrabMinSize; // Minimum width/height of a grab box for slider/scrollbar.
1884 float GrabRounding; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
1885 float LogSliderDeadzone; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
1886 float TabRounding; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
1887 float TabBorderSize; // Thickness of border around tabs.
1888 float TabMinWidthForCloseButton; // Minimum width for close button to appears 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.
1889 ImGuiDir ColorButtonPosition; // Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right.
1890 ImVec2 ButtonTextAlign; // Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered).
1891 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.
1892 ImVec2 DisplayWindowPadding; // Window position are clamped to be visible within the display area or monitors by at least this amount. Only applies to regular windows.
1893 ImVec2 DisplaySafeAreaPadding; // If you cannot see the edges of your screen (e.g. on a TV) increase the safe area padding. Apply to popups/tooltips as well regular windows. NB: Prefer configuring your TV sets correctly!
1894 float MouseCursorScale; // Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). May be removed later.
1895 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).
1896 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).
1897 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).
1898 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.
1899 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.
1901
1903 IMGUI_API void ScaleAllSizes(float scale_factor);
1904};
1905
1906//-----------------------------------------------------------------------------
1907// [SECTION] ImGuiIO
1908//-----------------------------------------------------------------------------
1909// Communicate most settings and inputs/outputs to Dear ImGui using this structure.
1910// Access via ImGui::GetIO(). Read 'Programmer guide' section in .cpp file for general usage.
1911//-----------------------------------------------------------------------------
1912
1913// [Internal] Storage used by IsKeyDown(), IsKeyPressed() etc functions.
1914// 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.
1916{
1917 bool Down; // True for if key is down
1918 float DownDuration; // Duration the key has been down (<0.0f: not pressed, 0.0f: just pressed, >0.0f: time held)
1919 float DownDurationPrev; // Last frame duration the key has been down
1920 float AnalogValue; // 0.0f..1.0f for gamepad values
1921};
1922
1924{
1925 //------------------------------------------------------------------
1926 // Configuration // Default value
1927 //------------------------------------------------------------------
1928
1929 ImGuiConfigFlags ConfigFlags; // = 0 // See ImGuiConfigFlags_ enum. Set by user/application. Gamepad/keyboard navigation options, etc.
1930 ImGuiBackendFlags BackendFlags; // = 0 // See ImGuiBackendFlags_ enum. Set by backend (imgui_impl_xxx files or custom backend) to communicate features supported by the backend.
1931 ImVec2 DisplaySize; // <unset> // Main display size, in pixels (generally == GetMainViewport()->Size). May change every frame.
1932 float DeltaTime; // = 1.0f/60.0f // Time elapsed since last frame, in seconds. May change every frame.
1933 float IniSavingRate; // = 5.0f // Minimum time between saving positions/sizes to .ini file, in seconds.
1934 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.
1935 const char* LogFilename; // = "imgui_log.txt"// Path to .log file (default parameter to ImGui::LogToFile when no file is specified).
1936 float MouseDoubleClickTime; // = 0.30f // Time for a double-click, in seconds.
1937 float MouseDoubleClickMaxDist; // = 6.0f // Distance threshold to stay in to validate a double-click, in pixels.
1938 float MouseDragThreshold; // = 6.0f // Distance threshold before considering we are dragging.
1939 float KeyRepeatDelay; // = 0.250f // When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).
1940 float KeyRepeatRate; // = 0.050f // When holding a key/button, rate at which it repeats, in seconds.
1941 void* UserData; // = NULL // Store your own data for retrieval by callbacks.
1942
1943 ImFontAtlas*Fonts; // <auto> // Font atlas: load, rasterize and pack one or more fonts into a single texture.
1944 float FontGlobalScale; // = 1.0f // Global scale all fonts
1945 bool FontAllowUserScaling; // = false // Allow user scaling text of individual window with CTRL+Wheel.
1946 ImFont* FontDefault; // = NULL // Font to use on NewFrame(). Use NULL to uses Fonts->Fonts[0].
1947 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.
1948
1949 // Miscellaneous options
1950 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.
1951 bool ConfigMacOSXBehaviors; // = defined(__APPLE__) // 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.
1952 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.
1953 bool ConfigInputTextCursorBlink; // = true // Enable blinking cursor (optional as some users consider it to be distracting).
1954 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.
1955 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)
1956 bool ConfigWindowsMoveFromTitleBarOnly; // = false // Enable allowing to move windows only when clicking on their title bar. Does not apply to windows without a title bar.
1957 float ConfigMemoryCompactTimer; // = 60.0f // Timer (in seconds) to free transient windows/tables memory buffers when unused. Set to -1.0f to disable.
1958
1959 //------------------------------------------------------------------
1960 // Platform Functions
1961 // (the imgui_impl_xxxx backend files are setting those up for you)
1962 //------------------------------------------------------------------
1963
1964 // Optional: Platform/Renderer backend name (informational only! will be displayed in About Window) + User data for backend/wrappers to store their own stuff.
1965 const char* BackendPlatformName; // = NULL
1966 const char* BackendRendererName; // = NULL
1967 void* BackendPlatformUserData; // = NULL // User data for platform backend
1968 void* BackendRendererUserData; // = NULL // User data for renderer backend
1969 void* BackendLanguageUserData; // = NULL // User data for non C++ programming language backend
1970
1971 // Optional: Access OS clipboard
1972 // (default to use native Win32 clipboard on Windows, otherwise uses a private clipboard. Override to access OS clipboard on other architectures)
1973 const char* (*GetClipboardTextFn)(void* user_data);
1974 void (*SetClipboardTextFn)(void* user_data, const char* text);
1976
1977 // 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)
1978 // (default to use native imm32 api on Windows)
1979 void (*SetPlatformImeDataFn)(ImGuiViewport* viewport, ImGuiPlatformImeData* data);
1980#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1981 void* ImeWindowHandle; // = NULL // [Obsolete] Set ImGuiViewport::PlatformHandleRaw instead. Set this to your HWND to get automatic IME cursor positioning.
1982#else
1983 void* _UnusedPadding; // Unused field to keep data structure the same size.
1984#endif
1985
1986 //------------------------------------------------------------------
1987 // Input - Call before calling NewFrame()
1988 //------------------------------------------------------------------
1989
1990 // Input Functions
1991 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)
1992 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.
1993 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)
1994 IMGUI_API void AddMouseButtonEvent(int button, bool down); // Queue a mouse button change
1995 IMGUI_API void AddMouseWheelEvent(float wh_x, float wh_y); // Queue a mouse wheel update
1996 IMGUI_API void AddFocusEvent(bool focused); // Queue a gain/loss of focus for the application (generally based on OS/platform focus of your window)
1997 IMGUI_API void AddInputCharacter(unsigned int c); // Queue a new character input
1998 IMGUI_API void AddInputCharacterUTF16(ImWchar16 c); // Queue a new character input from an UTF-16 character, it can be a surrogate
1999 IMGUI_API void AddInputCharactersUTF8(const char* str); // Queue a new characters input from an UTF-8 string
2000
2001 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.
2002 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.
2003 IMGUI_API void ClearInputCharacters(); // [Internal] Clear the text input buffer manually
2004 IMGUI_API void ClearInputKeys(); // [Internal] Release all keys
2005
2006 //------------------------------------------------------------------
2007 // Output - Updated by NewFrame() or EndFrame()/Render()
2008 // (when reading from the io.WantCaptureMouse, io.WantCaptureKeyboard flags to dispatch your inputs, it is
2009 // generally easier and more correct to use their state BEFORE calling NewFrame(). See FAQ for details!)
2010 //------------------------------------------------------------------
2011
2012 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.).
2013 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.).
2014 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).
2015 bool WantSetMousePos; // MousePos has been altered, backend should reposition mouse on next frame. Rarely used! Set only when ImGuiConfigFlags_NavEnableSetMousePos flag is enabled.
2016 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!
2017 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.
2018 bool NavVisible; // Keyboard/Gamepad navigation is visible and allowed (will handle ImGuiKey_NavXXX events).
2019 float Framerate; // Rough estimate of application framerate, in frame per second. Solely for convenience. Rolling average estimation based on io.DeltaTime over 120 frames.
2020 int MetricsRenderVertices; // Vertices output during last call to Render()
2021 int MetricsRenderIndices; // Indices output during last call to Render() = number of triangles * 3
2022 int MetricsRenderWindows; // Number of visible windows
2023 int MetricsActiveWindows; // Number of active windows
2024 int MetricsActiveAllocations; // Number of active allocations, updated by MemAlloc/MemFree based on current context. May be off if you have multiple imgui contexts.
2025 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.
2026
2027 // Legacy: before 1.87, we required backend to fill io.KeyMap[] (imgui->native map) during initialization and io.KeysDown[] (native indices) every frame.
2028 // This is still temporarily supported as a legacy feature. However the new preferred scheme is for backend to call io.AddKeyEvent().
2029#ifndef IMGUI_DISABLE_OBSOLETE_KEYIO
2030 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.
2031 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.
2032#endif
2033
2034 //------------------------------------------------------------------
2035 // [Internal] Dear ImGui will maintain those fields. Forward compatibility not guaranteed!
2036 //------------------------------------------------------------------
2037
2038 // Main Input State
2039 // (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)
2040 // (reading from those variables is fair game, as they are extremely unlikely to be moving anywhere)
2041 ImVec2 MousePos; // Mouse position, in pixels. Set to ImVec2(-FLT_MAX, -FLT_MAX) if mouse is unavailable (on another screen, etc.)
2042 bool MouseDown[5]; // Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5). Dear ImGui mostly uses left and right buttons. Others buttons allows us to track if the mouse is being used by your application + available to user as a convenience via IsMouse** API.
2043 float MouseWheel; // Mouse wheel Vertical: 1 unit scrolls about 5 lines text.
2044 float MouseWheelH; // Mouse wheel Horizontal. Most users don't have a mouse with an horizontal wheel, may not be filled by all backends.
2045 bool KeyCtrl; // Keyboard modifier down: Control
2046 bool KeyShift; // Keyboard modifier down: Shift
2047 bool KeyAlt; // Keyboard modifier down: Alt
2048 bool KeySuper; // Keyboard modifier down: Cmd/Super/Windows
2049 float NavInputs[ImGuiNavInput_COUNT]; // Gamepad inputs. Cleared back to zero by EndFrame(). Keyboard keys will be auto-mapped and be written here by NewFrame().
2050
2051 // Other state maintained from data above + IO function calls
2052 ImGuiModFlags KeyMods; // Key mods flags (same as io.KeyCtrl/KeyShift/KeyAlt/KeySuper but merged into flags), updated by NewFrame()
2053 ImGuiKeyData KeysData[ImGuiKey_KeysData_SIZE]; // Key state for all known keys. Use IsKeyXXX() functions to access this.
2054 bool WantCaptureMouseUnlessPopupClose; // Alternative to WantCaptureMouse: (WantCaptureMouse == true && WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup.
2055 ImVec2 MousePosPrev; // Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
2056 ImVec2 MouseClickedPos[5]; // Position at time of clicking
2057 double MouseClickedTime[5]; // Time of last click (used to figure out double-click)
2058 bool MouseClicked[5]; // Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
2059 bool MouseDoubleClicked[5]; // Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
2060 ImU16 MouseClickedCount[5]; // == 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc. when going from !Down to Down
2061 ImU16 MouseClickedLastCount[5]; // Count successive number of clicks. Stays valid after mouse release. Reset after another click is done.
2062 bool MouseReleased[5]; // Mouse button went from Down to !Down
2063 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.
2064 bool MouseDownOwnedUnlessPopupClose[5]; // Track if button was clicked inside a dear imgui window.
2065 float MouseDownDuration[5]; // Duration the mouse button has been down (0.0f == just clicked)
2066 float MouseDownDurationPrev[5]; // Previous time the mouse button has been down
2067 float MouseDragMaxDistanceSqr[5]; // Squared maximum distance of how much mouse has traveled from the clicking point (used for moving thresholds)
2068 float NavInputsDownDuration[ImGuiNavInput_COUNT];
2069 float NavInputsDownDurationPrev[ImGuiNavInput_COUNT];
2070 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.
2071 bool AppFocusLost; // Only modify via AddFocusEvent()
2072 bool AppAcceptingEvents; // Only modify via SetAppAcceptingEvents()
2073 ImS8 BackendUsingLegacyKeyArrays; // -1: unknown, 0: using AddKeyEvent(), 1: using legacy io.KeysDown[]
2074 bool BackendUsingLegacyNavInputArray; // 0: using AddKeyAnalogEvent(), 1: writing to legacy io.NavInputs[] directly
2075 ImWchar16 InputQueueSurrogate; // For AddInputCharacterUTF16()
2076 ImVector<ImWchar> InputQueueCharacters; // Queue of _characters_ input (obtained by platform backend). Fill using AddInputCharacter() helper.
2077
2079};
2080
2081//-----------------------------------------------------------------------------
2082// [SECTION] Misc data structures
2083//-----------------------------------------------------------------------------
2084
2085// Shared state of InputText(), passed as an argument to your callback when a ImGuiInputTextFlags_Callback* flag is used.
2086// The callback function should return 0 by default.
2087// Callbacks (follow a flag name and see comments in ImGuiInputTextFlags_ declarations for more details)
2088// - 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)
2089// - ImGuiInputTextFlags_CallbackAlways: Callback on each iteration
2090// - ImGuiInputTextFlags_CallbackCompletion: Callback on pressing TAB
2091// - ImGuiInputTextFlags_CallbackHistory: Callback on pressing Up/Down arrows
2092// - ImGuiInputTextFlags_CallbackCharFilter: Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
2093// - ImGuiInputTextFlags_CallbackResize: Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow.
2095{
2096 ImGuiInputTextFlags EventFlag; // One ImGuiInputTextFlags_Callback* // Read-only
2097 ImGuiInputTextFlags Flags; // What user passed to InputText() // Read-only
2098 void* UserData; // What user passed to InputText() // Read-only
2099
2100 // Arguments for the different callback events
2101 // - 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.
2102 // - 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.
2103 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;
2104 ImGuiKey EventKey; // Key pressed (Up/Down/TAB) // Read-only // [Completion,History]
2105 char* Buf; // Text buffer // Read-write // [Resize] Can replace pointer / [Completion,History,Always] Only write to pointed data, don't replace the actual pointer!
2106 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()
2107 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
2108 bool BufDirty; // Set if you modify Buf/BufTextLen! // Write // [Completion,History,Always]
2109 int CursorPos; // // Read-write // [Completion,History,Always]
2110 int SelectionStart; // // Read-write // [Completion,History,Always] == to SelectionEnd when no selection)
2111 int SelectionEnd; // // Read-write // [Completion,History,Always]
2112
2113 // Helper functions for text manipulation.
2114 // Use those function to benefit from the CallbackResize behaviors. Calling those function reset the selection.
2116 IMGUI_API void DeleteChars(int pos, int bytes_count);
2117 IMGUI_API void InsertChars(int pos, const char* text, const char* text_end = NULL);
2118 void SelectAll() { SelectionStart = 0; SelectionEnd = BufTextLen; }
2119 void ClearSelection() { SelectionStart = SelectionEnd = BufTextLen; }
2120 bool HasSelection() const { return SelectionStart != SelectionEnd; }
2121};
2122
2123// Resizing callback data to apply custom constraint. As enabled by SetNextWindowSizeConstraints(). Callback is called during the next Begin().
2124// NB: For basic min/max size constraint on each axis you don't need to use the callback! The SetNextWindowSizeConstraints() parameters are enough.
2126{
2127 void* UserData; // Read-only. What user passed to SetNextWindowSizeConstraints()
2128 ImVec2 Pos; // Read-only. Window position, for reference.
2129 ImVec2 CurrentSize; // Read-only. Current window size.
2130 ImVec2 DesiredSize; // Read-write. Desired size, based on user's mouse position. Write to this field to restrain resizing.
2131};
2132
2133// Data payload for Drag and Drop operations: AcceptDragDropPayload(), GetDragDropPayload()
2135{
2136 // Members
2137 void* Data; // Data (copied and owned by dear imgui)
2138 int DataSize; // Data size
2139
2140 // [Internal]
2141 ImGuiID SourceId; // Source item id
2142 ImGuiID SourceParentId; // Source parent id (if available)
2143 int DataFrameCount; // Data timestamp
2144 char DataType[32 + 1]; // Data type tag (short user-supplied string, 32 characters max)
2145 bool Preview; // Set when AcceptDragDropPayload() was called and mouse has been hovering the target item (nb: handle overlapping drag targets)
2146 bool Delivery; // Set when AcceptDragDropPayload() was called and mouse button is released over the target item.
2147
2148 ImGuiPayload() { Clear(); }
2149 void Clear() { SourceId = SourceParentId = 0; Data = NULL; DataSize = 0; memset(DataType, 0, sizeof(DataType)); DataFrameCount = -1; Preview = Delivery = false; }
2150 bool IsDataType(const char* type) const { return DataFrameCount != -1 && strcmp(type, DataType) == 0; }
2151 bool IsPreview() const { return Preview; }
2152 bool IsDelivery() const { return Delivery; }
2153};
2154
2155// Sorting specification for one column of a table (sizeof == 12 bytes)
2157{
2158 ImGuiID ColumnUserID; // User id of the column (if specified by a TableSetupColumn() call)
2159 ImS16 ColumnIndex; // Index of the column
2160 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)
2161 ImGuiSortDirection SortDirection : 8; // ImGuiSortDirection_Ascending or ImGuiSortDirection_Descending (you can use this or SortSign, whichever is more convenient for your sort function)
2162
2163 ImGuiTableColumnSortSpecs() { memset(this, 0, sizeof(*this)); }
2164};
2165
2166// Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
2167// Obtained by calling TableGetSortSpecs().
2168// When 'SpecsDirty == true' you can sort your data. It will be true with sorting specs have changed since last call, or the first time.
2169// Make sure to set 'SpecsDirty = false' after sorting, else you may wastefully sort your data every frame!
2171{
2172 const ImGuiTableColumnSortSpecs* Specs; // Pointer to sort spec array.
2173 int SpecsCount; // Sort spec count. Most often 1. May be > 1 when ImGuiTableFlags_SortMulti is enabled. May be == 0 when ImGuiTableFlags_SortTristate is enabled.
2174 bool SpecsDirty; // Set to true when specs have changed since last time! Use this to sort again, then clear the flag.
2175
2176 ImGuiTableSortSpecs() { memset(this, 0, sizeof(*this)); }
2177};
2178
2179//-----------------------------------------------------------------------------
2180// [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, ImColor)
2181//-----------------------------------------------------------------------------
2182
2183// Helper: Unicode defines
2184#define IM_UNICODE_CODEPOINT_INVALID 0xFFFD // Invalid Unicode code point (standard value).
2185#ifdef IMGUI_USE_WCHAR32
2186#define IM_UNICODE_CODEPOINT_MAX 0x10FFFF // Maximum Unicode code point supported by this build.
2187#else
2188#define IM_UNICODE_CODEPOINT_MAX 0xFFFF // Maximum Unicode code point supported by this build.
2189#endif
2190
2191// Helper: Execute a block of code at maximum once a frame. Convenient if you want to quickly create an UI within deep-nested code that runs multiple times every frame.
2192// Usage: static ImGuiOnceUponAFrame oaf; if (oaf) ImGui::Text("This will be called only once per frame");
2194{
2195 ImGuiOnceUponAFrame() { RefFrame = -1; }
2196 mutable int RefFrame;
2197 operator bool() const { int current_frame = ImGui::GetFrameCount(); if (RefFrame == current_frame) return false; RefFrame = current_frame; return true; }
2198};
2199
2200// Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]"
2202{
2203 IMGUI_API ImGuiTextFilter(const char* default_filter = "");
2204 IMGUI_API bool Draw(const char* label = "Filter (inc,-exc)", float width = 0.0f); // Helper calling InputText+Build
2205 IMGUI_API bool PassFilter(const char* text, const char* text_end = NULL) const;
2207 void Clear() { InputBuf[0] = 0; Build(); }
2208 bool IsActive() const { return !Filters.empty(); }
2209
2210 // [Internal]
2212 {
2213 const char* b;
2214 const char* e;
2215
2216 ImGuiTextRange() { b = e = NULL; }
2217 ImGuiTextRange(const char* _b, const char* _e) { b = _b; e = _e; }
2218 bool empty() const { return b == e; }
2219 IMGUI_API void split(char separator, ImVector<ImGuiTextRange>* out) const;
2220 };
2221 char InputBuf[256];
2224};
2225
2226// Helper: Growable text buffer for logging/accumulating text
2227// (this could be called 'ImGuiTextBuilder' / 'ImGuiStringBuilder')
2229{
2231 IMGUI_API static char EmptyString[1];
2232
2234 inline char operator[](int i) const { IM_ASSERT(Buf.Data != NULL); return Buf.Data[i]; }
2235 const char* begin() const { return Buf.Data ? &Buf.front() : EmptyString; }
2236 const char* end() const { return Buf.Data ? &Buf.back() : EmptyString; } // Buf is zero-terminated, so end() will point on the zero-terminator
2237 int size() const { return Buf.Size ? Buf.Size - 1 : 0; }
2238 bool empty() const { return Buf.Size <= 1; }
2239 void clear() { Buf.clear(); }
2240 void reserve(int capacity) { Buf.reserve(capacity); }
2241 const char* c_str() const { return Buf.Data ? Buf.Data : EmptyString; }
2242 IMGUI_API void append(const char* str, const char* str_end = NULL);
2243 IMGUI_API void appendf(const char* fmt, ...) IM_FMTARGS(2);
2244 IMGUI_API void appendfv(const char* fmt, va_list args) IM_FMTLIST(2);
2245};
2246
2247// Helper: Key->Value storage
2248// Typically you don't have to worry about this since a storage is held within each Window.
2249// We use it to e.g. store collapse state for a tree (Int 0/1)
2250// This is optimized for efficient lookup (dichotomy into a contiguous buffer) and rare insertion (typically tied to user interactions aka max once a frame)
2251// You can use it as custom user storage for temporary values. Declare your own storage if, for example:
2252// - 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).
2253// - You want to store custom debug data easily without adding or editing structures in your code (probably not efficient, but convenient)
2254// Types are NOT stored, so it is up to you to make sure your Key don't collide with different types.
2256{
2257 // [Internal]
2259 {
2261 union { int val_i; float val_f; void* val_p; };
2262 ImGuiStoragePair(ImGuiID _key, int _val_i) { key = _key; val_i = _val_i; }
2263 ImGuiStoragePair(ImGuiID _key, float _val_f) { key = _key; val_f = _val_f; }
2264 ImGuiStoragePair(ImGuiID _key, void* _val_p) { key = _key; val_p = _val_p; }
2265 };
2266
2268
2269 // - Get***() functions find pair, never add/allocate. Pairs are sorted so a query is O(log N)
2270 // - Set***() functions find pair, insertion on demand if missing.
2271 // - Sorted insertion is costly, paid once. A typical frame shouldn't need to insert any new pair.
2272 void Clear() { Data.clear(); }
2273 IMGUI_API int GetInt(ImGuiID key, int default_val = 0) const;
2274 IMGUI_API void SetInt(ImGuiID key, int val);
2275 IMGUI_API bool GetBool(ImGuiID key, bool default_val = false) const;
2276 IMGUI_API void SetBool(ImGuiID key, bool val);
2277 IMGUI_API float GetFloat(ImGuiID key, float default_val = 0.0f) const;
2278 IMGUI_API void SetFloat(ImGuiID key, float val);
2279 IMGUI_API void* GetVoidPtr(ImGuiID key) const; // default_val is NULL
2280 IMGUI_API void SetVoidPtr(ImGuiID key, void* val);
2281
2282 // - Get***Ref() functions finds pair, insert on demand if missing, return pointer. Useful if you intend to do Get+Set.
2283 // - 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.
2284 // - 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)
2285 // float* pvar = ImGui::GetFloatRef(key); ImGui::SliderFloat("var", pvar, 0, 100.0f); some_var += *pvar;
2286 IMGUI_API int* GetIntRef(ImGuiID key, int default_val = 0);
2287 IMGUI_API bool* GetBoolRef(ImGuiID key, bool default_val = false);
2288 IMGUI_API float* GetFloatRef(ImGuiID key, float default_val = 0.0f);
2289 IMGUI_API void** GetVoidPtrRef(ImGuiID key, void* default_val = NULL);
2290
2291 // Use on your own storage if you know only integer are being stored (open/close all tree nodes)
2292 IMGUI_API void SetAllInt(int val);
2293
2294 // For quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once.
2296};
2297
2298// Helper: Manually clip large list of items.
2299// If you have lots evenly spaced items and you have a random access to the list, you can perform coarse
2300// clipping based on visibility to only submit items that are in view.
2301// The clipper calculates the range of visible items and advance the cursor to compensate for the non-visible items we have skipped.
2302// (Dear ImGui already clip items based on their bounds but: it needs to first layout the item to do so, and generally
2303// fetching/submitting your own data incurs additional cost. Coarse clipping using ImGuiListClipper allows you to easily
2304// scale using lists with tens of thousands of items without a problem)
2305// Usage:
2306// ImGuiListClipper clipper;
2307// clipper.Begin(1000); // We have 1000 elements, evenly spaced.
2308// while (clipper.Step())
2309// for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++)
2310// ImGui::Text("line number %d", i);
2311// Generally what happens is:
2312// - Clipper lets you process the first element (DisplayStart = 0, DisplayEnd = 1) regardless of it being visible or not.
2313// - User code submit that one element.
2314// - Clipper can measure the height of the first element
2315// - Clipper calculate the actual range of elements to display based on the current clipping rectangle, position the cursor before the first visible element.
2316// - User code submit visible elements.
2317// - The clipper also handles various subtleties related to keyboard/gamepad navigation, wrapping etc.
2319{
2320 int DisplayStart; // First item to display, updated by each call to Step()
2321 int DisplayEnd; // End of items to display (exclusive)
2322 int ItemsCount; // [Internal] Number of items
2323 float ItemsHeight; // [Internal] Height of item after a first step and item submission can calculate it
2324 float StartPosY; // [Internal] Cursor position at the time of Begin() or after table frozen rows are all processed
2325 void* TempData; // [Internal] Internal data
2326
2327 // 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)
2328 // items_height: Use -1.0f to be calculated automatically on first step. Otherwise pass in the distance between your items, typically GetTextLineHeightWithSpacing() or GetFrameHeightWithSpacing().
2331 IMGUI_API void Begin(int items_count, float items_height = -1.0f);
2332 IMGUI_API void End(); // Automatically called on the last call of Step() that returns false.
2333 IMGUI_API bool Step(); // Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items.
2334
2335 // Call ForceDisplayRangeByIndices() before first call to Step() if you need a range of items to be displayed regardless of visibility.
2336 IMGUI_API void ForceDisplayRangeByIndices(int item_min, int item_max); // item_max is exclusive e.g. use (42, 42+1) to make item 42 always visible BUT due to alignment/padding of certain items it is likely that an extra item may be included on either end of the display range.
2337
2338#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2339 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]
2340#endif
2341};
2342
2343// Helpers macros to generate 32-bit encoded colors
2344// User can declare their own format by #defining the 5 _SHIFT/_MASK macros in their imconfig file.
2345#ifndef IM_COL32_R_SHIFT
2346#ifdef IMGUI_USE_BGRA_PACKED_COLOR
2347#define IM_COL32_R_SHIFT 16
2348#define IM_COL32_G_SHIFT 8
2349#define IM_COL32_B_SHIFT 0
2350#define IM_COL32_A_SHIFT 24
2351#define IM_COL32_A_MASK 0xFF000000
2352#else
2353#define IM_COL32_R_SHIFT 0
2354#define IM_COL32_G_SHIFT 8
2355#define IM_COL32_B_SHIFT 16
2356#define IM_COL32_A_SHIFT 24
2357#define IM_COL32_A_MASK 0xFF000000
2358#endif
2359#endif
2360#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))
2361#define IM_COL32_WHITE IM_COL32(255,255,255,255) // Opaque white = 0xFFFFFFFF
2362#define IM_COL32_BLACK IM_COL32(0,0,0,255) // Opaque black
2363#define IM_COL32_BLACK_TRANS IM_COL32(0,0,0,0) // Transparent black = 0x00000000
2364
2365// Helper: ImColor() implicitly converts colors to either ImU32 (packed 4x1 byte) or ImVec4 (4x1 float)
2366// Prefer using IM_COL32() macros if you want a guaranteed compile-time ImU32 for usage with ImDrawList API.
2367// **Avoid storing ImColor! Store either u32 of ImVec4. This is not a full-featured color class. MAY OBSOLETE.
2368// **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.
2370{
2372
2373 constexpr ImColor() { }
2374 constexpr ImColor(float r, float g, float b, float a = 1.0f) : Value(r, g, b, a) { }
2375 constexpr ImColor(const ImVec4& col) : Value(col) {}
2376 ImColor(int r, int g, int b, int a = 255) { float sc = 1.0f / 255.0f; Value.x = (float)r * sc; Value.y = (float)g * sc; Value.z = (float)b * sc; Value.w = (float)a * sc; }
2377 ImColor(ImU32 rgba) { float sc = 1.0f / 255.0f; Value.x = (float)((rgba >> IM_COL32_R_SHIFT) & 0xFF) * sc; Value.y = (float)((rgba >> IM_COL32_G_SHIFT) & 0xFF) * sc; Value.z = (float)((rgba >> IM_COL32_B_SHIFT) & 0xFF) * sc; Value.w = (float)((rgba >> IM_COL32_A_SHIFT) & 0xFF) * sc; }
2378 inline operator ImU32() const { return ImGui::ColorConvertFloat4ToU32(Value); }
2379 inline operator ImVec4() const { return Value; }
2380
2381 // FIXME-OBSOLETE: May need to obsolete/cleanup those helpers.
2382 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; }
2383 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); }
2384};
2385
2386//-----------------------------------------------------------------------------
2387// [SECTION] Drawing API (ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawListFlags, ImDrawList, ImDrawData)
2388// Hold a series of drawing commands. The user provides a renderer for ImDrawData which essentially contains an array of ImDrawList.
2389//-----------------------------------------------------------------------------
2390
2391// The maximum line width to bake anti-aliased textures for. Build atlas with ImFontAtlasFlags_NoBakedLines to disable baking.
2392#ifndef IM_DRAWLIST_TEX_LINES_WIDTH_MAX
2393#define IM_DRAWLIST_TEX_LINES_WIDTH_MAX (63)
2394#endif
2395
2396// ImDrawCallback: Draw callbacks for advanced uses [configurable type: override in imconfig.h]
2397// NB: You most likely do NOT need to use draw callbacks just to create your own widget or customized UI rendering,
2398// you can poke into the draw list for that! Draw callback may be useful for example to:
2399// A) Change your GPU render state,
2400// B) render a complex 3D scene inside a UI element without an intermediate texture/render target, etc.
2401// The expected behavior from your rendering function is 'if (cmd.UserCallback != NULL) { cmd.UserCallback(parent_list, cmd); } else { RenderTriangles() }'
2402// 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.
2403#ifndef ImDrawCallback
2404typedef void (*ImDrawCallback)(const ImDrawList* parent_list, const ImDrawCmd* cmd);
2405#endif
2406
2407// Special Draw callback value to request renderer backend to reset the graphics/render state.
2408// The renderer backend needs to handle this special value, otherwise it will crash trying to call a function at this address.
2409// This is useful for example if you submitted callbacks which you know have altered the render state and you want it to be restored.
2410// It is not done by default because they are many perfectly useful way of altering render state for imgui contents (e.g. changing shader/blending settings before an Image call).
2411#define ImDrawCallback_ResetRenderState (ImDrawCallback)(-1)
2412
2413// Typically, 1 command = 1 GPU draw call (unless command is a callback)
2414// - VtxOffset: When 'io.BackendFlags & ImGuiBackendFlags_RendererHasVtxOffset' is enabled,
2415// this fields allow us to render meshes larger than 64K vertices while keeping 16-bit indices.
2416// Backends made for <1.71. will typically ignore the VtxOffset fields.
2417// - The ClipRect/TextureId/VtxOffset fields must be contiguous as we memcmp() them together (this is asserted for).
2419{
2420 ImVec4 ClipRect; // 4*4 // Clipping rectangle (x1, y1, x2, y2). Subtract ImDrawData->DisplayPos to get clipping rectangle in "viewport" coordinates
2421 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.
2422 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.
2423 unsigned int IdxOffset; // 4 // Start offset in index buffer.
2424 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[].
2425 ImDrawCallback UserCallback; // 4-8 // If != NULL, call the function instead of rendering the vertices. clip_rect and texture_id will be set normally.
2426 void* UserCallbackData; // 4-8 // The draw callback code can access this.
2427
2428 ImDrawCmd() { memset(this, 0, sizeof(*this)); } // Also ensure our padding fields are zeroed
2429
2430 // 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)
2431 inline ImTextureID GetTexID() const { return TextureId; }
2432};
2433
2434// Vertex layout
2435#ifndef IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT
2442#else
2443// You can override the vertex format layout by defining IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT in imconfig.h
2444// 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.
2445// 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 a the time you'd want to set your type up.
2446// 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.
2447IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT;
2448#endif
2449
2450// [Internal] For use by ImDrawList
2457
2458// [Internal] For use by ImDrawListSplitter
2464
2465
2466// Split/Merge functions are used to split the draw list into different layers which can be drawn into out of order.
2467// This is used by the Columns/Tables API, so items of each column can be batched together in a same draw call.
2469{
2470 int _Current; // Current channel number (0)
2471 int _Count; // Number of active channels (1+)
2472 ImVector<ImDrawChannel> _Channels; // Draw channels (not resized down so _Count might be < Channels.Size)
2473
2474 inline ImDrawListSplitter() { memset(this, 0, sizeof(*this)); }
2475 inline ~ImDrawListSplitter() { ClearFreeMemory(); }
2476 inline void Clear() { _Current = 0; _Count = 1; } // Do not clear Channels[] so our allocations are reused next frame
2478 IMGUI_API void Split(ImDrawList* draw_list, int count);
2479 IMGUI_API void Merge(ImDrawList* draw_list);
2480 IMGUI_API void SetCurrentChannel(ImDrawList* draw_list, int channel_idx);
2481};
2482
2483// Flags for ImDrawList functions
2484// (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)
2486{
2488 ImDrawFlags_Closed = 1 << 0, // PathStroke(), AddPolyline(): specify that shape should be closed (Important: this is always == 1 for legacy reason)
2489 ImDrawFlags_RoundCornersTopLeft = 1 << 4, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-left corner only (when rounding > 0.0f, we default to all corners). Was 0x01.
2490 ImDrawFlags_RoundCornersTopRight = 1 << 5, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-right corner only (when rounding > 0.0f, we default to all corners). Was 0x02.
2491 ImDrawFlags_RoundCornersBottomLeft = 1 << 6, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners). Was 0x04.
2492 ImDrawFlags_RoundCornersBottomRight = 1 << 7, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners). Wax 0x08.
2493 ImDrawFlags_RoundCornersNone = 1 << 8, // AddRect(), AddRectFilled(), PathRect(): disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag!
2499 ImDrawFlags_RoundCornersDefault_ = ImDrawFlags_RoundCornersAll, // Default to ALL corners if none of the _RoundCornersXX flags are specified.
2502
2503// Flags for ImDrawList instance. Those are set automatically by ImGui:: functions from ImGuiIO settings, and generally not manipulated directly.
2504// It is however possible to temporarily alter flags between calls to ImDrawList:: functions.
2506{
2508 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)
2509 ImDrawListFlags_AntiAliasedLinesUseTex = 1 << 1, // Enable anti-aliased lines/borders using textures when possible. Require backend to render with bilinear filtering (NOT point/nearest filtering).
2510 ImDrawListFlags_AntiAliasedFill = 1 << 2, // Enable anti-aliased edge around filled shapes (rounded rectangles, circles).
2511 ImDrawListFlags_AllowVtxOffset = 1 << 3 // Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
2513
2514// Draw command list
2515// This is the low-level list of polygons that ImGui:: functions are filling. At the end of the frame,
2516// all command lists are passed to your ImGuiIO::RenderDrawListFn function for rendering.
2517// Each dear imgui window contains its own ImDrawList. You can use ImGui::GetWindowDrawList() to
2518// access the current window draw list and draw custom primitives.
2519// You can interleave normal ImGui:: calls and adding primitives to the current draw list.
2520// In single viewport mode, top-left is == GetMainViewport()->Pos (generally 0,0), bottom-right is == GetMainViewport()->Pos+Size (generally io.DisplaySize).
2521// 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!)
2522// 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.
2524{
2525 // This is what you have to render
2526 ImVector<ImDrawCmd> CmdBuffer; // Draw commands. Typically 1 command = 1 GPU draw call, unless the command is a callback.
2527 ImVector<ImDrawIdx> IdxBuffer; // Index buffer. Each command consume ImDrawCmd::ElemCount of those
2529 ImDrawListFlags Flags; // Flags, you may poke into these to adjust anti-aliasing settings per-primitive.
2530
2531 // [Internal, used while building lists]
2532 unsigned int _VtxCurrentIdx; // [Internal] generally == VtxBuffer.Size unless we are past 64K vertices, in which case this gets reset to 0.
2533 const ImDrawListSharedData* _Data; // Pointer to shared draw data (you can use ImGui::GetDrawListSharedData() to get the one from current ImGui context)
2534 const char* _OwnerName; // Pointer to owner window's name for debugging
2535 ImDrawVert* _VtxWritePtr; // [Internal] point within VtxBuffer.Data after each add command (to avoid using the ImVector<> operators too much)
2536 ImDrawIdx* _IdxWritePtr; // [Internal] point within IdxBuffer.Data after each add command (to avoid using the ImVector<> operators too much)
2539 ImVector<ImVec2> _Path; // [Internal] current path building
2540 ImDrawCmdHeader _CmdHeader; // [Internal] template of active commands. Fields should match those of CmdBuffer.back().
2541 ImDrawListSplitter _Splitter; // [Internal] for channels api (note: prefer using your own persistent instance of ImDrawListSplitter!)
2542 float _FringeScale; // [Internal] anti-alias fringe is scaled by this value, this helps to keep things sharp while zooming at vertex buffer content
2543
2544 // 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)
2545 ImDrawList(const ImDrawListSharedData* shared_data) { memset(this, 0, sizeof(*this)); _Data = shared_data; }
2546
2547 ~ImDrawList() { _ClearFreeMemory(); }
2548 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)
2553 inline ImVec2 GetClipRectMin() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.x, cr.y); }
2554 inline ImVec2 GetClipRectMax() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.z, cr.w); }
2555
2556 // Primitives
2557 // - Filled shapes must always use clockwise winding order. The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
2558 // - For rectangular primitives, "p_min" and "p_max" represent the upper-left and lower-right corners.
2559 // - For circle primitives, use "num_segments == 0" to automatically calculate tessellation (preferred).
2560 // In older versions (until Dear ImGui 1.77) the AddCircle functions defaulted to num_segments == 12.
2561 // In future versions we will use textures to provide cheaper and higher-quality circles.
2562 // Use AddNgon() and AddNgonFilled() functions if you need to guaranteed a specific number of sides.
2563 IMGUI_API void AddLine(const ImVec2& p1, const ImVec2& p2, ImU32 col, float thickness = 1.0f);
2564 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)
2565 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)
2566 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);
2567 IMGUI_API void AddQuad(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness = 1.0f);
2568 IMGUI_API void AddQuadFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col);
2569 IMGUI_API void AddTriangle(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness = 1.0f);
2570 IMGUI_API void AddTriangleFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col);
2571 IMGUI_API void AddCircle(const ImVec2& center, float radius, ImU32 col, int num_segments = 0, float thickness = 1.0f);
2572 IMGUI_API void AddCircleFilled(const ImVec2& center, float radius, ImU32 col, int num_segments = 0);
2573 IMGUI_API void AddNgon(const ImVec2& center, float radius, ImU32 col, int num_segments, float thickness = 1.0f);
2574 IMGUI_API void AddNgonFilled(const ImVec2& center, float radius, ImU32 col, int num_segments);
2575 IMGUI_API void AddText(const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end = NULL);
2576 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);
2577 IMGUI_API void AddPolyline(const ImVec2* points, int num_points, ImU32 col, ImDrawFlags flags, float thickness);
2578 IMGUI_API void AddConvexPolyFilled(const ImVec2* points, int num_points, ImU32 col);
2579 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)
2580 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)
2581
2582 // Image primitives
2583 // - Read FAQ to understand what ImTextureID is.
2584 // - "p_min" and "p_max" represent the upper-left and lower-right corners of the rectangle.
2585 // - "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.
2586 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);
2587 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);
2588 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);
2589
2590 // Stateful path API, add points then finish with PathFillConvex() or PathStroke()
2591 // - Filled shapes must always use clockwise winding order. The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
2592 inline void PathClear() { _Path.Size = 0; }
2593 inline void PathLineTo(const ImVec2& pos) { _Path.push_back(pos); }
2594 inline void PathLineToMergeDuplicate(const ImVec2& pos) { if (_Path.Size == 0 || memcmp(&_Path.Data[_Path.Size - 1], &pos, 8) != 0) _Path.push_back(pos); }
2595 inline void PathFillConvex(ImU32 col) { AddConvexPolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; }
2596 inline void PathStroke(ImU32 col, ImDrawFlags flags = 0, float thickness = 1.0f) { AddPolyline(_Path.Data, _Path.Size, col, flags, thickness); _Path.Size = 0; }
2597 IMGUI_API void PathArcTo(const ImVec2& center, float radius, float a_min, float a_max, int num_segments = 0);
2598 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
2599 IMGUI_API void PathBezierCubicCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments = 0); // Cubic Bezier (4 control points)
2600 IMGUI_API void PathBezierQuadraticCurveTo(const ImVec2& p2, const ImVec2& p3, int num_segments = 0); // Quadratic Bezier (3 control points)
2601 IMGUI_API void PathRect(const ImVec2& rect_min, const ImVec2& rect_max, float rounding = 0.0f, ImDrawFlags flags = 0);
2602
2603 // Advanced
2604 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.
2605 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
2606 IMGUI_API ImDrawList* CloneOutput() const; // Create a clone of the CmdBuffer/IdxBuffer/VtxBuffer.
2607
2608 // Advanced: Channels
2609 // - Use to split render into layers. By switching channels to can render out-of-order (e.g. submit FG primitives before BG primitives)
2610 // - 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)
2611 // - FIXME-OBSOLETE: This API shouldn't have been in ImDrawList in the first place!
2612 // Prefer using your own persistent instance of ImDrawListSplitter as you can stack them.
2613 // Using the ImDrawList::ChannelsXXXX you cannot stack a split over another.
2614 inline void ChannelsSplit(int count) { _Splitter.Split(this, count); }
2615 inline void ChannelsMerge() { _Splitter.Merge(this); }
2616 inline void ChannelsSetCurrent(int n) { _Splitter.SetCurrentChannel(this, n); }
2617
2618 // Advanced: Primitives allocations
2619 // - We render triangles (three vertices)
2620 // - All primitives needs to be reserved via PrimReserve() beforehand.
2621 IMGUI_API void PrimReserve(int idx_count, int vtx_count);
2622 IMGUI_API void PrimUnreserve(int idx_count, int vtx_count);
2623 IMGUI_API void PrimRect(const ImVec2& a, const ImVec2& b, ImU32 col); // Axis aligned rectangle (composed of two triangles)
2624 IMGUI_API void PrimRectUV(const ImVec2& a, const ImVec2& b, const ImVec2& uv_a, const ImVec2& uv_b, ImU32 col);
2625 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);
2626 inline void PrimWriteVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col) { _VtxWritePtr->pos = pos; _VtxWritePtr->uv = uv; _VtxWritePtr->col = col; _VtxWritePtr++; _VtxCurrentIdx++; }
2627 inline void PrimWriteIdx(ImDrawIdx idx) { *_IdxWritePtr = idx; _IdxWritePtr++; }
2628 inline void PrimVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col) { PrimWriteIdx((ImDrawIdx)_VtxCurrentIdx); PrimWriteVtx(pos, uv, col); } // Write vertex with unique index
2629
2630#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2631 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)
2632 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)
2633#endif
2634
2635 // [Internal helpers]
2644 IMGUI_API void _PathArcToFastEx(const ImVec2& center, float radius, int a_min_sample, int a_max_sample, int a_step);
2645 IMGUI_API void _PathArcToN(const ImVec2& center, float radius, float a_min, float a_max, int num_segments);
2646};
2647
2648// All draw data to render a Dear ImGui frame
2649// (NB: the style and the naming convention here is a little inconsistent, we currently preserve them for backward compatibility purpose,
2650// as this is one of the oldest structure exposed by the library! Basically, ImDrawList == CmdList)
2652{
2653 bool Valid; // Only valid after Render() is called and before the next NewFrame() is called.
2654 int CmdListsCount; // Number of ImDrawList* to render
2655 int TotalIdxCount; // For convenience, sum of all ImDrawList's IdxBuffer.Size
2656 int TotalVtxCount; // For convenience, sum of all ImDrawList's VtxBuffer.Size
2657 ImDrawList** CmdLists; // Array of ImDrawList* to render. The ImDrawList are owned by ImGuiContext and only pointed to from here.
2658 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)
2659 ImVec2 DisplaySize; // Size of the viewport to render (== GetMainViewport()->Size for the main viewport, == io.DisplaySize in most single-viewport applications)
2660 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.
2661
2662 // Functions
2663 ImDrawData() { Clear(); }
2664 void Clear() { memset(this, 0, sizeof(*this)); } // The ImDrawList are owned by ImGuiContext!
2665 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!
2666 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.
2667};
2668
2669//-----------------------------------------------------------------------------
2670// [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontAtlasFlags, ImFontAtlas, ImFontGlyphRangesBuilder, ImFont)
2671//-----------------------------------------------------------------------------
2672
2674{
2675 void* FontData; // // TTF/OTF data
2676 int FontDataSize; // // TTF/OTF data size
2677 bool FontDataOwnedByAtlas; // true // TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
2678 int FontNo; // 0 // Index of font within TTF/OTF file
2679 float SizePixels; // // Size in pixels for rasterizer (more or less maps to the resulting font height).
2680 int OversampleH; // 3 // Rasterize at higher quality for sub-pixel positioning. Note the difference between 2 and 3 is minimal so you can reduce this to 2 to save memory. Read https://github.com/nothings/stb/blob/master/tests/oversample/README.md for details.
2681 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.
2682 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.
2683 ImVec2 GlyphExtraSpacing; // 0, 0 // Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
2684 ImVec2 GlyphOffset; // 0, 0 // Offset all glyphs from this font input.
2685 const ImWchar* GlyphRanges; // NULL // Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list). THE ARRAY DATA NEEDS TO PERSIST AS LONG AS THE FONT IS ALIVE.
2686 float GlyphMinAdvanceX; // 0 // Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
2687 float GlyphMaxAdvanceX; // FLT_MAX // Maximum AdvanceX for glyphs
2688 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.
2689 unsigned int FontBuilderFlags; // 0 // Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure.
2690 float RasterizerMultiply; // 1.0f // Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
2691 ImWchar EllipsisChar; // -1 // Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.
2692
2693 // [Internal]
2694 char Name[40]; // Name (strictly to ease debugging)
2696
2698};
2699
2700// Hold rendering data for one glyph.
2701// (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)
2703{
2704 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)
2705 unsigned int Visible : 1; // Flag to indicate glyph has no visible pixels (e.g. space). Allow early out when rendering.
2706 unsigned int Codepoint : 30; // 0x0000..0x10FFFF
2707 float AdvanceX; // Distance to next character (= data from font + ImFontConfig::GlyphExtraSpacing.x baked in)
2708 float X0, Y0, X1, Y1; // Glyph corners
2709 float U0, V0, U1, V1; // Texture coordinates
2710};
2711
2712// Helper to build glyph ranges from text/string data. Feed your application strings/characters to it then call BuildRanges().
2713// This is essentially a tightly packed of vector of 64k booleans = 8KB storage.
2715{
2716 ImVector<ImU32> UsedChars; // Store 1-bit per Unicode code point (0=unused, 1=used)
2717
2719 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); }
2720 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
2721 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
2722 inline void AddChar(ImWchar c) { SetBit(c); } // Add character
2723 IMGUI_API void AddText(const char* text, const char* text_end = NULL); // Add string (each character of the UTF-8 string are added)
2724 IMGUI_API void AddRanges(const ImWchar* ranges); // Add ranges, e.g. builder.AddRanges(ImFontAtlas::GetGlyphRangesDefault()) to force add all of ASCII/Latin+Ext
2725 IMGUI_API void BuildRanges(ImVector<ImWchar>* out_ranges); // Output new ranges
2726};
2727
2728// See ImFontAtlas::AddCustomRectXXX functions.
2730{
2731 unsigned short Width, Height; // Input // Desired rectangle dimension
2732 unsigned short X, Y; // Output // Packed position in Atlas
2733 unsigned int GlyphID; // Input // For custom font glyphs only (ID < 0x110000)
2734 float GlyphAdvanceX; // Input // For custom font glyphs only: glyph xadvance
2735 ImVec2 GlyphOffset; // Input // For custom font glyphs only: glyph display offset
2736 ImFont* Font; // Input // For custom font glyphs only: target font
2737 ImFontAtlasCustomRect() { Width = Height = 0; X = Y = 0xFFFF; GlyphID = 0; GlyphAdvanceX = 0.0f; GlyphOffset = ImVec2(0, 0); Font = NULL; }
2738 bool IsPacked() const { return X != 0xFFFF; }
2739};
2740
2741// Flags for ImFontAtlas build
2743{
2745 ImFontAtlasFlags_NoPowerOfTwoHeight = 1 << 0, // Don't round the height to next power of two
2746 ImFontAtlasFlags_NoMouseCursors = 1 << 1, // Don't build software mouse cursors into the atlas (save a little texture memory)
2747 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).
2749
2750// Load and rasterize multiple TTF/OTF fonts into a same texture. The font atlas will build a single texture holding:
2751// - One or more fonts.
2752// - Custom graphics data needed to render the shapes needed by Dear ImGui.
2753// - Mouse cursor shapes for software cursor rendering (unless setting 'Flags |= ImFontAtlasFlags_NoMouseCursors' in the font atlas).
2754// It is the user-code responsibility to setup/build the atlas, then upload the pixel data into a texture accessible by your graphics api.
2755// - 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.
2756// - Call GetTexDataAsAlpha8() or GetTexDataAsRGBA32() to build and retrieve pixels data.
2757// - Upload the pixels data into a texture within your graphics system (see imgui_impl_xxxx.cpp examples)
2758// - Call SetTexID(my_tex_id); and pass the pointer/identifier to your texture in a format natural to your graphics API.
2759// This value will be passed back to you during rendering to identify the texture. Read FAQ entry about ImTextureID for more details.
2760// Common pitfalls:
2761// - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the
2762// atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data.
2763// - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction.
2764// You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
2765// - Even though many functions are suffixed with "TTF", OTF data is supported just as well.
2766// - This is an old API and it is currently awkward for those and and various other reasons! We will address them in the future!
2768{
2773 IMGUI_API ImFont* AddFontFromFileTTF(const char* filename, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL);
2774 IMGUI_API ImFont* AddFontFromMemoryTTF(void* font_data, int font_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.
2775 IMGUI_API ImFont* AddFontFromMemoryCompressedTTF(const void* compressed_font_data, int compressed_font_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.
2776 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.
2777 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.
2778 IMGUI_API void ClearTexData(); // Clear output texture data (CPU side). Saves RAM once the texture has been copied to graphics memory.
2779 IMGUI_API void ClearFonts(); // Clear output font data (glyphs storage, UV coordinates).
2780 IMGUI_API void Clear(); // Clear all input and output.
2781
2782 // Build atlas, retrieve pixel data.
2783 // 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().
2784 // The pitch is always = Width * BytesPerPixels (1 or 4)
2785 // Building in RGBA32 format is provided for convenience and compatibility, but note that unless you manually manipulate or copy color data into
2786 // the texture (e.g. when using the AddCustomRect*** api), then the RGB pixels emitted will always be white (~75% of memory/bandwidth waste.
2787 IMGUI_API bool Build(); // Build pixels data. This is called automatically for you by the GetTexData*** functions.
2788 IMGUI_API void GetTexDataAsAlpha8(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL); // 1 byte per-pixel
2789 IMGUI_API void GetTexDataAsRGBA32(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL); // 4 bytes-per-pixel
2790 bool IsBuilt() const { return Fonts.Size > 0 && TexReady; } // Bit ambiguous: used to detect when user didn't built texture but effectively we should check TexID != 0 except that would be backend dependent...
2791 void SetTexID(ImTextureID id) { TexID = id; }
2792
2793 //-------------------------------------------
2794 // Glyph Ranges
2795 //-------------------------------------------
2796
2797 // Helpers to retrieve list of common Unicode ranges (2 value per range, values are inclusive, zero-terminated list)
2798 // NB: Make sure that your string are UTF-8 and NOT in your local code page. In C++11, you can create UTF-8 string literal using the u8"Hello world" syntax. See FAQ for details.
2799 // NB: Consider using ImFontGlyphRangesBuilder to build glyph ranges from textual data.
2800 IMGUI_API const ImWchar* GetGlyphRangesDefault(); // Basic Latin, Extended Latin
2801 IMGUI_API const ImWchar* GetGlyphRangesKorean(); // Default + Korean characters
2802 IMGUI_API const ImWchar* GetGlyphRangesJapanese(); // Default + Hiragana, Katakana, Half-Width, Selection of 2999 Ideographs
2803 IMGUI_API const ImWchar* GetGlyphRangesChineseFull(); // Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs
2804 IMGUI_API const ImWchar* GetGlyphRangesChineseSimplifiedCommon();// Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese
2805 IMGUI_API const ImWchar* GetGlyphRangesCyrillic(); // Default + about 400 Cyrillic characters
2806 IMGUI_API const ImWchar* GetGlyphRangesThai(); // Default + Thai characters
2807 IMGUI_API const ImWchar* GetGlyphRangesVietnamese(); // Default + Vietnamese characters
2808
2809 //-------------------------------------------
2810 // [BETA] Custom Rectangles/Glyphs API
2811 //-------------------------------------------
2812
2813 // You can request arbitrary rectangles to be packed into the atlas, for your own purposes.
2814 // - After calling Build(), you can query the rectangle position and render your pixels.
2815 // - If you render colored output, set 'atlas->TexPixelsUseColors = true' as this may help some backends decide of prefered texture format.
2816 // - You can also request your rectangles to be mapped as font glyph (given a font + Unicode point),
2817 // so you can render e.g. custom colorful icons and use them as regular glyphs.
2818 // - Read docs/FONTS.md for more details about using colorful icons.
2819 // - Note: this API may be redesigned later in order to support multi-monitor varying DPI settings.
2820 IMGUI_API int AddCustomRectRegular(int width, int height);
2821 IMGUI_API int AddCustomRectFontGlyph(ImFont* font, ImWchar id, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
2822 ImFontAtlasCustomRect* GetCustomRectByIndex(int index) { IM_ASSERT(index >= 0); return &CustomRects[index]; }
2823
2824 // [Internal]
2825 IMGUI_API void CalcCustomRectUV(const ImFontAtlasCustomRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const;
2826 IMGUI_API bool GetMouseCursorTexData(ImGuiMouseCursor cursor, ImVec2* out_offset, ImVec2* out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2]);
2827
2828 //-------------------------------------------
2829 // Members
2830 //-------------------------------------------
2831
2832 ImFontAtlasFlags Flags; // Build flags (see ImFontAtlasFlags_)
2833 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.
2834 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.
2835 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).
2836 bool Locked; // Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.
2837
2838 // [Internal]
2839 // NB: Access texture data via GetTexData*() calls! Which will setup a default font for you.
2840 bool TexReady; // Set when texture was built matching current font input
2841 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.
2842 unsigned char* TexPixelsAlpha8; // 1 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight
2843 unsigned int* TexPixelsRGBA32; // 4 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight * 4
2844 int TexWidth; // Texture width calculated during Build().
2845 int TexHeight; // Texture height calculated during Build().
2846 ImVec2 TexUvScale; // = (1.0f/TexWidth, 1.0f/TexHeight)
2847 ImVec2 TexUvWhitePixel; // Texture coordinates to a white pixel
2848 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.
2849 ImVector<ImFontAtlasCustomRect> CustomRects; // Rectangles for packing custom texture data into the atlas.
2850 ImVector<ImFontConfig> ConfigData; // Configuration data
2851 ImVec4 TexUvLines[IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 1]; // UVs for baked anti-aliased lines
2852
2853 // [Internal] Font builder
2854 const ImFontBuilderIO* FontBuilderIO; // Opaque interface to a font builder (default to stb_truetype, can be changed to use FreeType by defining IMGUI_ENABLE_FREETYPE).
2855 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.
2856
2857 // [Internal] Packing data
2858 int PackIdMouseCursors; // Custom texture rectangle ID for white pixel and mouse cursors
2859 int PackIdLines; // Custom texture rectangle ID for baked anti-aliased lines
2860
2861 // [Obsolete]
2862 //typedef ImFontAtlasCustomRect CustomRect; // OBSOLETED in 1.72+
2863 //typedef ImFontGlyphRangesBuilder GlyphRangesBuilder; // OBSOLETED in 1.67+
2864};
2865
2866// Font runtime data and rendering
2867// ImFontAtlas automatically loads a default embedded font for you when you call GetTexDataAsAlpha8() or GetTexDataAsRGBA32().
2869{
2870 // Members: Hot ~20/24 bytes (for CalcTextSize)
2871 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).
2872 float FallbackAdvanceX; // 4 // out // = FallbackGlyph->AdvanceX
2873 float FontSize; // 4 // in // // Height of characters/line, set during loading (don't change after loading)
2874
2875 // Members: Hot ~28/40 bytes (for CalcTextSize + render loop)
2876 ImVector<ImWchar> IndexLookup; // 12-16 // out // // Sparse. Index glyphs by Unicode code-point.
2877 ImVector<ImFontGlyph> Glyphs; // 12-16 // out // // All glyphs.
2878 const ImFontGlyph* FallbackGlyph; // 4-8 // out // = FindGlyph(FontFallbackChar)
2879
2880 // Members: Cold ~32/40 bytes
2881 ImFontAtlas* ContainerAtlas; // 4-8 // out // // What we has been loaded into
2882 const ImFontConfig* ConfigData; // 4-8 // in // // Pointer within ContainerAtlas->ConfigData
2883 short ConfigDataCount; // 2 // in // ~ 1 // Number of ImFontConfig involved in creating this font. Bigger than 1 when merging multiple font sources into one ImFont.
2884 ImWchar FallbackChar; // 2 // out // = FFFD/'?' // Character used if a glyph isn't found.
2885 ImWchar EllipsisChar; // 2 // out // = '...' // Character used for ellipsis rendering.
2886 ImWchar DotChar; // 2 // out // = '.' // Character used for ellipsis rendering (if a single '...' character isn't found)
2887 bool DirtyLookupTables; // 1 // out //
2888 float Scale; // 4 // in // = 1.f // Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()
2889 float Ascent, Descent; // 4+4 // out // // Ascent: distance from top to bottom of e.g. 'A' [0..FontSize]
2890 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)
2891 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.
2892
2893 // Methods
2898 float GetCharAdvance(ImWchar c) const { return ((int)c < IndexAdvanceX.Size) ? IndexAdvanceX[(int)c] : FallbackAdvanceX; }
2899 bool IsLoaded() const { return ContainerAtlas != NULL; }
2900 const char* GetDebugName() const { return ConfigData ? ConfigData->Name : "<unknown>"; }
2901
2902 // 'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable.
2903 // 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable.
2904 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
2905 IMGUI_API const char* CalcWordWrapPositionA(float scale, const char* text, const char* text_end, float wrap_width) const;
2906 IMGUI_API void RenderChar(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, ImWchar c) const;
2907 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;
2908
2909 // [Internal] Don't use!
2912 IMGUI_API void GrowIndex(int new_size);
2913 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);
2914 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.
2915 IMGUI_API void SetGlyphVisible(ImWchar c, bool visible);
2916 IMGUI_API bool IsGlyphRangeUnused(unsigned int c_begin, unsigned int c_last);
2917};
2918
2919//-----------------------------------------------------------------------------
2920// [SECTION] Viewports
2921//-----------------------------------------------------------------------------
2922
2923// Flags stored in ImGuiViewport::Flags, giving indications to the platform backends.
2925{
2927 ImGuiViewportFlags_IsPlatformWindow = 1 << 0, // Represent a Platform Window
2928 ImGuiViewportFlags_IsPlatformMonitor = 1 << 1, // Represent a Platform Monitor (unused yet)
2929 ImGuiViewportFlags_OwnedByApp = 1 << 2 // Platform Window: is created/managed by the application (rather than a dear imgui backend)
2931
2932// - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.
2933// - In 'docking' branch with multi-viewport enabled, we extend this concept to have multiple active viewports.
2934// - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode.
2935// - About Main Area vs Work Area:
2936// - Main Area = entire viewport.
2937// - Work Area = entire viewport minus sections used by main menu bars (for platform windows), or by task bar (for platform monitor).
2938// - Windows are generally trying to stay within the Work Area of their host viewport.
2940{
2941 ImGuiViewportFlags Flags; // See ImGuiViewportFlags_
2942 ImVec2 Pos; // Main Area: Position of the viewport (Dear ImGui coordinates are the same as OS desktop/native coordinates)
2943 ImVec2 Size; // Main Area: Size of the viewport.
2944 ImVec2 WorkPos; // Work Area: Position of the viewport minus task bars, menus bars, status bars (>= Pos)
2945 ImVec2 WorkSize; // Work Area: Size of the viewport minus task bars, menu bars, status bars (<= Size)
2946
2947 // Platform/Backend Dependent Data
2948 void* PlatformHandleRaw; // void* to hold lower-level, platform-native window handle (under Win32 this is expected to be a HWND, unused for other platforms)
2949
2950 ImGuiViewport() { memset(this, 0, sizeof(*this)); }
2951
2952 // Helpers
2953 ImVec2 GetCenter() const { return ImVec2(Pos.x + Size.x * 0.5f, Pos.y + Size.y * 0.5f); }
2954 ImVec2 GetWorkCenter() const { return ImVec2(WorkPos.x + WorkSize.x * 0.5f, WorkPos.y + WorkSize.y * 0.5f); }
2955};
2956
2957//-----------------------------------------------------------------------------
2958// [SECTION] Platform Dependent Interfaces
2959//-----------------------------------------------------------------------------
2960
2961// (Optional) Support for IME (Input Method Editor) via the io.SetPlatformImeDataFn() function.
2963{
2964 bool WantVisible; // A widget wants the IME to be visible
2965 ImVec2 InputPos; // Position of the input cursor
2966 float InputLineHeight; // Line height
2967
2968 ImGuiPlatformImeData() { memset(this, 0, sizeof(*this)); }
2969};
2970
2971//-----------------------------------------------------------------------------
2972// [SECTION] Obsolete functions and types
2973// (Will be removed! Read 'API BREAKING CHANGES' section in imgui.cpp for details)
2974// Please keep your copy of dear imgui up to date! Occasionally set '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in imconfig.h to stay ahead.
2975//-----------------------------------------------------------------------------
2976
2977namespace ImGui
2978{
2979#ifndef IMGUI_DISABLE_OBSOLETE_KEYIO
2980 IMGUI_API int GetKeyIndex(ImGuiKey key); // map ImGuiKey_* values into legacy native key index. == io.KeyMap[key]
2981#else
2982 static inline int GetKeyIndex(ImGuiKey key) { IM_ASSERT(key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END && "ImGuiKey and native_index was merged together and native_index is disabled by IMGUI_DISABLE_OBSOLETE_KEYIO. Please switch to ImGuiKey."); return key; }
2983#endif
2984}
2985
2986#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2987namespace ImGui
2988{
2989 // OBSOLETED in 1.88 (from May 2022)
2990 static inline void CaptureKeyboardFromApp(bool want_capture_keyboard = true) { SetNextFrameWantCaptureKeyboard(want_capture_keyboard); } // Renamed as name was misleading + removed default value.
2991 static inline void CaptureMouseFromApp(bool want_capture_mouse = true) { SetNextFrameWantCaptureMouse(want_capture_mouse); } // Renamed as name was misleading + removed default value.
2992 // OBSOLETED in 1.86 (from November 2021)
2993 IMGUI_API void CalcListClipping(int items_count, float items_height, int* out_items_display_start, int* out_items_display_end); // Calculate coarse clipping for large list of evenly sized items. Prefer using ImGuiListClipper.
2994 // OBSOLETED in 1.85 (from August 2021)
2995 static inline float GetWindowContentRegionWidth() { return GetWindowContentRegionMax().x - GetWindowContentRegionMin().x; }
2996 // OBSOLETED in 1.81 (from February 2021)
2997 IMGUI_API bool ListBoxHeader(const char* label, int items_count, int height_in_items = -1); // Helper to calculate size from items_count and height_in_items
2998 static inline bool ListBoxHeader(const char* label, const ImVec2& size = ImVec2(0, 0)) { return BeginListBox(label, size); }
2999 static inline void ListBoxFooter() { EndListBox(); }
3000 // OBSOLETED in 1.79 (from August 2020)
3001 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!
3002 // OBSOLETED in 1.78 (from June 2020)
3003 // Old drag/sliders functions that took a 'float power = 1.0' argument instead of flags.
3004 // For shared code, you can version check at compile-time with `#if IMGUI_VERSION_NUM >= 17704`.
3005 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);
3006 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);
3007 static inline bool DragFloat(const char* label, float* v, float v_speed, float v_min, float v_max, const char* format, float power) { return DragScalar(label, ImGuiDataType_Float, v, v_speed, &v_min, &v_max, format, power); }
3008 static inline bool DragFloat2(const char* label, float v[2], float v_speed, float v_min, float v_max, const char* format, float power) { return DragScalarN(label, ImGuiDataType_Float, v, 2, v_speed, &v_min, &v_max, format, power); }
3009 static inline bool DragFloat3(const char* label, float v[3], float v_speed, float v_min, float v_max, const char* format, float power) { return DragScalarN(label, ImGuiDataType_Float, v, 3, v_speed, &v_min, &v_max, format, power); }
3010 static inline bool DragFloat4(const char* label, float v[4], float v_speed, float v_min, float v_max, const char* format, float power) { return DragScalarN(label, ImGuiDataType_Float, v, 4, v_speed, &v_min, &v_max, format, power); }
3011 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);
3012 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);
3013 static inline bool SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format, float power) { return SliderScalar(label, ImGuiDataType_Float, v, &v_min, &v_max, format, power); }
3014 static inline bool SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format, float power) { return SliderScalarN(label, ImGuiDataType_Float, v, 2, &v_min, &v_max, format, power); }
3015 static inline bool SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format, float power) { return SliderScalarN(label, ImGuiDataType_Float, v, 3, &v_min, &v_max, format, power); }
3016 static inline bool SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format, float power) { return SliderScalarN(label, ImGuiDataType_Float, v, 4, &v_min, &v_max, format, power); }
3017 // OBSOLETED in 1.77 (from June 2020)
3018 static inline bool BeginPopupContextWindow(const char* str_id, ImGuiMouseButton mb, bool over_items) { return BeginPopupContextWindow(str_id, mb | (over_items ? 0 : ImGuiPopupFlags_NoOpenOverItems)); }
3019
3020 // Some of the older obsolete names along with their replacement (commented out so they are not reported in IDE)
3021 //static inline void TreeAdvanceToLabelPos() { SetCursorPosX(GetCursorPosX() + GetTreeNodeToLabelSpacing()); } // OBSOLETED in 1.72 (from July 2019)
3022 //static inline void SetNextTreeNodeOpen(bool open, ImGuiCond cond = 0) { SetNextItemOpen(open, cond); } // OBSOLETED in 1.71 (from June 2019)
3023 //static inline float GetContentRegionAvailWidth() { return GetContentRegionAvail().x; } // OBSOLETED in 1.70 (from May 2019)
3024 //static inline ImDrawList* GetOverlayDrawList() { return GetForegroundDrawList(); } // OBSOLETED in 1.69 (from Mar 2019)
3025 //static inline void SetScrollHere(float ratio = 0.5f) { SetScrollHereY(ratio); } // OBSOLETED in 1.66 (from Nov 2018)
3026 //static inline bool IsItemDeactivatedAfterChange() { return IsItemDeactivatedAfterEdit(); } // OBSOLETED in 1.63 (from Aug 2018)
3027 //static inline bool IsAnyWindowFocused() { return IsWindowFocused(ImGuiFocusedFlags_AnyWindow); } // OBSOLETED in 1.60 (from Apr 2018)
3028 //static inline bool IsAnyWindowHovered() { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); } // OBSOLETED in 1.60 (between Dec 2017 and Apr 2018)
3029 //static inline void ShowTestWindow() { return ShowDemoWindow(); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3030 //static inline bool IsRootWindowFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootWindow); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3031 //static inline bool IsRootWindowOrAnyChildFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3032 //static inline void SetNextWindowContentWidth(float w) { SetNextWindowContentSize(ImVec2(w, 0.0f)); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3033 //static inline float GetItemsLineHeightWithSpacing() { return GetFrameHeightWithSpacing(); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017)
3034}
3035
3036// OBSOLETED in 1.82 (from Mars 2021): flags for AddRect(), AddRectFilled(), AddImageRounded(), PathRect()
3051
3052// RENAMED ImGuiKeyModFlags -> ImGuiModFlags in 1.88 (from April 2022)
3055
3056#endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
3057
3058// RENAMED IMGUI_DISABLE_METRICS_WINDOW > IMGUI_DISABLE_DEBUG_TOOLS in 1.88 (from June 2022)
3059#if defined(IMGUI_DISABLE_METRICS_WINDOW) && !defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS) && !defined(IMGUI_DISABLE_DEBUG_TOOLS)
3060#define IMGUI_DISABLE_DEBUG_TOOLS
3061#endif
3062#if defined(IMGUI_DISABLE_METRICS_WINDOW) && defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS)
3063#error IMGUI_DISABLE_METRICS_WINDOW was renamed to IMGUI_DISABLE_DEBUG_TOOLS, please use new name.
3064#endif
3065
3066//-----------------------------------------------------------------------------
3067
3068#if defined(__clang__)
3069#pragma clang diagnostic pop
3070#elif defined(__GNUC__)
3071#pragma GCC diagnostic pop
3072#endif
3073
3074#ifdef _MSC_VER
3075#pragma warning (pop)
3076#endif
3077
3078// Include imgui_user.h at the end of imgui.h (convenient for user to only explicitly include vanilla imgui.h)
3079#ifdef IMGUI_INCLUDE_IMGUI_USER_H
3080#include "imgui_user.h"
3081#endif
3082
3083#endif // #ifndef IMGUI_DISABLE
unsigned short ImWchar16
Definition imgui.h:249
#define IM_FMTLIST(FMT)
Definition imgui.h:117
ImGuiFocusedFlags_
Definition imgui.h:1274
@ ImGuiFocusedFlags_RootWindow
Definition imgui.h:1277
@ ImGuiFocusedFlags_None
Definition imgui.h:1275
@ ImGuiFocusedFlags_AnyWindow
Definition imgui.h:1278
@ ImGuiFocusedFlags_ChildWindows
Definition imgui.h:1276
@ ImGuiFocusedFlags_NoPopupHierarchy
Definition imgui.h:1279
@ ImGuiFocusedFlags_RootAndChildWindows
Definition imgui.h:1281
int ImGuiTreeNodeFlags
Definition imgui.h:218
int ImGuiViewportFlags
Definition imgui.h:219
#define IM_COL32_WHITE
Definition imgui.h:2361
ImGuiDragDropFlags_
Definition imgui.h:1307
@ ImGuiDragDropFlags_AcceptBeforeDelivery
Definition imgui.h:1317
@ ImGuiDragDropFlags_SourceNoPreviewTooltip
Definition imgui.h:1310
@ ImGuiDragDropFlags_SourceAllowNullID
Definition imgui.h:1313
@ ImGuiDragDropFlags_AcceptPeekOnly
Definition imgui.h:1320
@ ImGuiDragDropFlags_None
Definition imgui.h:1308
@ ImGuiDragDropFlags_SourceExtern
Definition imgui.h:1314
@ ImGuiDragDropFlags_AcceptNoDrawDefaultRect
Definition imgui.h:1318
@ ImGuiDragDropFlags_SourceNoDisableHover
Definition imgui.h:1311
@ ImGuiDragDropFlags_SourceNoHoldToOpenOthers
Definition imgui.h:1312
@ ImGuiDragDropFlags_SourceAutoExpirePayload
Definition imgui.h:1315
@ ImGuiDragDropFlags_AcceptNoPreviewTooltip
Definition imgui.h:1319
int ImGuiWindowFlags
Definition imgui.h:220
ImGuiDataType_
Definition imgui.h:1329
@ ImGuiDataType_Float
Definition imgui.h:1338
@ ImGuiDataType_U32
Definition imgui.h:1335
@ ImGuiDataType_U16
Definition imgui.h:1333
@ ImGuiDataType_S8
Definition imgui.h:1330
@ ImGuiDataType_U64
Definition imgui.h:1337
@ ImGuiDataType_S32
Definition imgui.h:1334
@ ImGuiDataType_COUNT
Definition imgui.h:1340
@ ImGuiDataType_S16
Definition imgui.h:1332
@ ImGuiDataType_S64
Definition imgui.h:1336
@ ImGuiDataType_Double
Definition imgui.h:1339
@ ImGuiDataType_U8
Definition imgui.h:1331
unsigned int ImU32
Definition imgui.h:243
#define IM_FMTARGS(FMT)
Definition imgui.h:116
ImGuiHoveredFlags_
Definition imgui.h:1288
@ ImGuiHoveredFlags_None
Definition imgui.h:1289
@ ImGuiHoveredFlags_AllowWhenBlockedByActiveItem
Definition imgui.h:1297
@ ImGuiHoveredFlags_AllowWhenBlockedByPopup
Definition imgui.h:1295
@ ImGuiHoveredFlags_NoNavOverride
Definition imgui.h:1300
@ ImGuiHoveredFlags_RectOnly
Definition imgui.h:1301
@ ImGuiHoveredFlags_NoPopupHierarchy
Definition imgui.h:1293
@ ImGuiHoveredFlags_RootAndChildWindows
Definition imgui.h:1302
@ ImGuiHoveredFlags_ChildWindows
Definition imgui.h:1290
@ ImGuiHoveredFlags_RootWindow
Definition imgui.h:1291
@ ImGuiHoveredFlags_AnyWindow
Definition imgui.h:1292
@ ImGuiHoveredFlags_AllowWhenOverlapped
Definition imgui.h:1298
@ ImGuiHoveredFlags_AllowWhenDisabled
Definition imgui.h:1299
int ImGuiKey
Definition imgui.h:190
unsigned int ImGuiID
Definition imgui.h:237
#define IM_COL32_G_SHIFT
Definition imgui.h:2354
ImGuiConfigFlags_
Definition imgui.h:1521
@ ImGuiConfigFlags_NoMouse
Definition imgui.h:1527
@ ImGuiConfigFlags_NavEnableSetMousePos
Definition imgui.h:1525
@ ImGuiConfigFlags_NavEnableGamepad
Definition imgui.h:1524
@ ImGuiConfigFlags_IsTouchScreen
Definition imgui.h:1532
@ ImGuiConfigFlags_NoMouseCursorChange
Definition imgui.h:1528
@ ImGuiConfigFlags_IsSRGB
Definition imgui.h:1531
@ ImGuiConfigFlags_None
Definition imgui.h:1522
@ ImGuiConfigFlags_NavEnableKeyboard
Definition imgui.h:1523
@ ImGuiConfigFlags_NavNoCaptureKeyboard
Definition imgui.h:1526
void *(* ImGuiMemAllocFunc)(size_t sz, void *user_data)
Definition imgui.h:260
int ImDrawListFlags
Definition imgui.h:198
int ImGuiCol
Definition imgui.h:186
ImGuiNavInput_
Definition imgui.h:1491
@ ImGuiNavInput_FocusPrev
Definition imgui.h:1505
@ ImGuiNavInput_KeyUp_
Definition imgui.h:1514
@ ImGuiNavInput_LStickRight
Definition imgui.h:1502
@ ImGuiNavInput_Menu
Definition imgui.h:1496
@ ImGuiNavInput_LStickUp
Definition imgui.h:1503
@ ImGuiNavInput_TweakFast
Definition imgui.h:1508
@ ImGuiNavInput_DpadLeft
Definition imgui.h:1497
@ ImGuiNavInput_DpadRight
Definition imgui.h:1498
@ ImGuiNavInput_FocusNext
Definition imgui.h:1506
@ ImGuiNavInput_COUNT
Definition imgui.h:1516
@ ImGuiNavInput_Activate
Definition imgui.h:1493
@ ImGuiNavInput_Cancel
Definition imgui.h:1494
@ ImGuiNavInput_DpadDown
Definition imgui.h:1500
@ ImGuiNavInput_LStickLeft
Definition imgui.h:1501
@ ImGuiNavInput_KeyDown_
Definition imgui.h:1515
@ ImGuiNavInput_LStickDown
Definition imgui.h:1504
@ ImGuiNavInput_KeyLeft_
Definition imgui.h:1512
@ ImGuiNavInput_KeyRight_
Definition imgui.h:1513
@ ImGuiNavInput_TweakSlow
Definition imgui.h:1507
@ ImGuiNavInput_DpadUp
Definition imgui.h:1499
@ ImGuiNavInput_Input
Definition imgui.h:1495
void(* ImGuiSizeCallback)(ImGuiSizeCallbackData *data)
Definition imgui.h:259
ImWchar16 ImWchar
Definition imgui.h:254
#define IM_COL32_R_SHIFT
Definition imgui.h:2353
ImDrawListFlags_
Definition imgui.h:2506
@ ImDrawListFlags_None
Definition imgui.h:2507
@ ImDrawListFlags_AntiAliasedLinesUseTex
Definition imgui.h:2509
@ ImDrawListFlags_AntiAliasedFill
Definition imgui.h:2510
@ ImDrawListFlags_AntiAliasedLines
Definition imgui.h:2508
@ ImDrawListFlags_AllowVtxOffset
Definition imgui.h:2511
void(* ImDrawCallback)(const ImDrawList *parent_list, const ImDrawCmd *cmd)
Definition imgui.h:2404
ImGuiBackendFlags_
Definition imgui.h:1537
@ ImGuiBackendFlags_HasGamepad
Definition imgui.h:1539
@ ImGuiBackendFlags_HasMouseCursors
Definition imgui.h:1540
@ ImGuiBackendFlags_HasSetMousePos
Definition imgui.h:1541
@ ImGuiBackendFlags_RendererHasVtxOffset
Definition imgui.h:1542
@ ImGuiBackendFlags_None
Definition imgui.h:1538
#define IM_DRAWLIST_TEX_LINES_WIDTH_MAX
Definition imgui.h:2393
ImGuiMouseCursor_
Definition imgui.h:1729
@ ImGuiMouseCursor_None
Definition imgui.h:1730
@ ImGuiMouseCursor_ResizeNWSE
Definition imgui.h:1737
@ ImGuiMouseCursor_Hand
Definition imgui.h:1738
@ ImGuiMouseCursor_ResizeEW
Definition imgui.h:1735
@ ImGuiMouseCursor_COUNT
Definition imgui.h:1740
@ ImGuiMouseCursor_NotAllowed
Definition imgui.h:1739
@ ImGuiMouseCursor_TextInput
Definition imgui.h:1732
@ ImGuiMouseCursor_ResizeNS
Definition imgui.h:1734
@ ImGuiMouseCursor_ResizeNESW
Definition imgui.h:1736
@ ImGuiMouseCursor_ResizeAll
Definition imgui.h:1733
@ ImGuiMouseCursor_Arrow
Definition imgui.h:1731
signed char ImS8
Definition imgui.h:238
void * ImTextureID
Definition imgui.h:226
unsigned char ImU8
Definition imgui.h:239
int ImGuiHoveredFlags
Definition imgui.h:207
ImGuiButtonFlags_
Definition imgui.h:1644
@ ImGuiButtonFlags_MouseButtonRight
Definition imgui.h:1647
@ ImGuiButtonFlags_MouseButtonDefault_
Definition imgui.h:1652
@ ImGuiButtonFlags_MouseButtonMask_
Definition imgui.h:1651
@ ImGuiButtonFlags_MouseButtonLeft
Definition imgui.h:1646
@ ImGuiButtonFlags_None
Definition imgui.h:1645
@ ImGuiButtonFlags_MouseButtonMiddle
Definition imgui.h:1648
void IM_DELETE(T *p)
Definition imgui.h:1772
#define IM_ALLOC(_SIZE)
Definition imgui.h:1768
#define IMGUI_API
Definition imgui.h:93
int ImGuiFocusedFlags
Definition imgui.h:206
ImGuiTableColumnFlags_
Definition imgui.h:1208
@ ImGuiTableColumnFlags_StatusMask_
Definition imgui.h:1239
@ ImGuiTableColumnFlags_WidthFixed
Definition imgui.h:1215
@ ImGuiTableColumnFlags_IndentDisable
Definition imgui.h:1228
@ ImGuiTableColumnFlags_PreferSortDescending
Definition imgui.h:1226
@ ImGuiTableColumnFlags_IsEnabled
Definition imgui.h:1231
@ ImGuiTableColumnFlags_NoHide
Definition imgui.h:1218
@ ImGuiTableColumnFlags_NoHeaderLabel
Definition imgui.h:1223
@ ImGuiTableColumnFlags_WidthStretch
Definition imgui.h:1214
@ ImGuiTableColumnFlags_WidthMask_
Definition imgui.h:1237
@ ImGuiTableColumnFlags_NoSort
Definition imgui.h:1220
@ ImGuiTableColumnFlags_IsVisible
Definition imgui.h:1232
@ ImGuiTableColumnFlags_IndentEnable
Definition imgui.h:1227
@ ImGuiTableColumnFlags_DefaultHide
Definition imgui.h:1212
@ ImGuiTableColumnFlags_IsHovered
Definition imgui.h:1234
@ ImGuiTableColumnFlags_NoReorder
Definition imgui.h:1217
@ ImGuiTableColumnFlags_PreferSortAscending
Definition imgui.h:1225
@ ImGuiTableColumnFlags_NoSortAscending
Definition imgui.h:1221
@ ImGuiTableColumnFlags_NoResize
Definition imgui.h:1216
@ ImGuiTableColumnFlags_NoHeaderWidth
Definition imgui.h:1224
@ ImGuiTableColumnFlags_DefaultSort
Definition imgui.h:1213
@ ImGuiTableColumnFlags_NoSortDescending
Definition imgui.h:1222
@ ImGuiTableColumnFlags_Disabled
Definition imgui.h:1211
@ ImGuiTableColumnFlags_None
Definition imgui.h:1210
@ ImGuiTableColumnFlags_NoClip
Definition imgui.h:1219
@ ImGuiTableColumnFlags_IsSorted
Definition imgui.h:1233
@ ImGuiTableColumnFlags_IndentMask_
Definition imgui.h:1238
@ ImGuiTableColumnFlags_NoDirectResize_
Definition imgui.h:1240
int ImGuiDataType
Definition imgui.h:188
int ImGuiDragDropFlags
Definition imgui.h:205
int ImGuiSliderFlags
Definition imgui.h:212
ImGuiPopupFlags_
Definition imgui.h:1059
@ ImGuiPopupFlags_MouseButtonMask_
Definition imgui.h:1064
@ ImGuiPopupFlags_AnyPopup
Definition imgui.h:1070
@ ImGuiPopupFlags_AnyPopupLevel
Definition imgui.h:1069
@ ImGuiPopupFlags_NoOpenOverExistingPopup
Definition imgui.h:1066
@ ImGuiPopupFlags_MouseButtonDefault_
Definition imgui.h:1065
@ ImGuiPopupFlags_AnyPopupId
Definition imgui.h:1068
@ ImGuiPopupFlags_NoOpenOverItems
Definition imgui.h:1067
@ ImGuiPopupFlags_MouseButtonLeft
Definition imgui.h:1061
@ ImGuiPopupFlags_MouseButtonRight
Definition imgui.h:1062
@ ImGuiPopupFlags_MouseButtonMiddle
Definition imgui.h:1063
@ ImGuiPopupFlags_None
Definition imgui.h:1060
ImGuiTabBarFlags_
Definition imgui.h:1100
@ ImGuiTabBarFlags_NoCloseWithMiddleMouseButton
Definition imgui.h:1105
@ ImGuiTabBarFlags_TabListPopupButton
Definition imgui.h:1104
@ ImGuiTabBarFlags_FittingPolicyDefault_
Definition imgui.h:1111
@ ImGuiTabBarFlags_FittingPolicyMask_
Definition imgui.h:1110
@ ImGuiTabBarFlags_None
Definition imgui.h:1101
@ ImGuiTabBarFlags_NoTabListScrollingButtons
Definition imgui.h:1106
@ ImGuiTabBarFlags_NoTooltip
Definition imgui.h:1107
@ ImGuiTabBarFlags_FittingPolicyScroll
Definition imgui.h:1109
@ ImGuiTabBarFlags_AutoSelectNewTabs
Definition imgui.h:1103
@ ImGuiTabBarFlags_FittingPolicyResizeDown
Definition imgui.h:1108
@ ImGuiTabBarFlags_Reorderable
Definition imgui.h:1102
ImGuiTabItemFlags_
Definition imgui.h:1116
@ ImGuiTabItemFlags_Trailing
Definition imgui.h:1125
@ ImGuiTabItemFlags_NoReorder
Definition imgui.h:1123
@ ImGuiTabItemFlags_Leading
Definition imgui.h:1124
@ ImGuiTabItemFlags_SetSelected
Definition imgui.h:1119
@ ImGuiTabItemFlags_NoPushId
Definition imgui.h:1121
@ ImGuiTabItemFlags_NoTooltip
Definition imgui.h:1122
@ ImGuiTabItemFlags_None
Definition imgui.h:1117
@ ImGuiTabItemFlags_UnsavedDocument
Definition imgui.h:1118
@ ImGuiTabItemFlags_NoCloseWithMiddleMouseButton
Definition imgui.h:1120
int ImGuiModFlags
Definition imgui.h:209
int ImGuiTabBarFlags
Definition imgui.h:213
ImGuiStyleVar_
Definition imgui.h:1612
@ ImGuiStyleVar_GrabRounding
Definition imgui.h:1635
@ ImGuiStyleVar_ChildRounding
Definition imgui.h:1621
@ ImGuiStyleVar_DisabledAlpha
Definition imgui.h:1615
@ ImGuiStyleVar_WindowRounding
Definition imgui.h:1617
@ ImGuiStyleVar_WindowMinSize
Definition imgui.h:1619
@ ImGuiStyleVar_IndentSpacing
Definition imgui.h:1630
@ ImGuiStyleVar_FrameRounding
Definition imgui.h:1626
@ ImGuiStyleVar_ItemSpacing
Definition imgui.h:1628
@ ImGuiStyleVar_CellPadding
Definition imgui.h:1631
@ ImGuiStyleVar_GrabMinSize
Definition imgui.h:1634
@ ImGuiStyleVar_ScrollbarSize
Definition imgui.h:1632
@ ImGuiStyleVar_FrameBorderSize
Definition imgui.h:1627
@ ImGuiStyleVar_FramePadding
Definition imgui.h:1625
@ ImGuiStyleVar_ScrollbarRounding
Definition imgui.h:1633
@ ImGuiStyleVar_PopupBorderSize
Definition imgui.h:1624
@ ImGuiStyleVar_WindowPadding
Definition imgui.h:1616
@ ImGuiStyleVar_ItemInnerSpacing
Definition imgui.h:1629
@ ImGuiStyleVar_PopupRounding
Definition imgui.h:1623
@ ImGuiStyleVar_SelectableTextAlign
Definition imgui.h:1638
@ ImGuiStyleVar_ButtonTextAlign
Definition imgui.h:1637
@ ImGuiStyleVar_Alpha
Definition imgui.h:1614
@ ImGuiStyleVar_WindowTitleAlign
Definition imgui.h:1620
@ ImGuiStyleVar_ChildBorderSize
Definition imgui.h:1622
@ ImGuiStyleVar_WindowBorderSize
Definition imgui.h:1618
@ ImGuiStyleVar_TabRounding
Definition imgui.h:1636
@ ImGuiStyleVar_COUNT
Definition imgui.h:1639
int(* ImGuiInputTextCallback)(ImGuiInputTextCallbackData *data)
Definition imgui.h:258
ImGuiSliderFlags_
Definition imgui.h:1702
@ ImGuiSliderFlags_InvalidMask_
Definition imgui.h:1708
@ ImGuiSliderFlags_AlwaysClamp
Definition imgui.h:1704
@ ImGuiSliderFlags_ClampOnInput
Definition imgui.h:1712
@ ImGuiSliderFlags_Logarithmic
Definition imgui.h:1705
@ ImGuiSliderFlags_NoInput
Definition imgui.h:1707
@ ImGuiSliderFlags_None
Definition imgui.h:1703
@ ImGuiSliderFlags_NoRoundToFormat
Definition imgui.h:1706
ImGuiKey_
Definition imgui.h:1365
@ ImGuiKey_GamepadFaceRight
Definition imgui.h:1424
@ ImGuiKey_PageUp
Definition imgui.h:1373
@ ImGuiKey_F5
Definition imgui.h:1390
@ ImGuiKey_Menu
Definition imgui.h:1385
@ ImGuiKey_S
Definition imgui.h:1388
@ ImGuiKey_RightArrow
Definition imgui.h:1370
@ ImGuiKey_RightSuper
Definition imgui.h:1384
@ ImGuiKey_6
Definition imgui.h:1386
@ ImGuiKey_Delete
Definition imgui.h:1378
@ ImGuiKey_Escape
Definition imgui.h:1382
@ ImGuiKey_W
Definition imgui.h:1389
@ ImGuiKey_F1
Definition imgui.h:1390
@ ImGuiKey_LeftShift
Definition imgui.h:1383
@ ImGuiKey_KeypadMultiply
Definition imgui.h:1412
@ ImGuiKey_Keypad2
Definition imgui.h:1408
@ ImGuiKey_GamepadLStickDown
Definition imgui.h:1436
@ ImGuiKey_GamepadL2
Definition imgui.h:1431
@ ImGuiKey_Keypad9
Definition imgui.h:1409
@ ImGuiKey_DownArrow
Definition imgui.h:1372
@ ImGuiKey_GamepadFaceUp
Definition imgui.h:1421
@ ImGuiKey_RightShift
Definition imgui.h:1384
@ ImGuiKey_LeftSuper
Definition imgui.h:1383
@ ImGuiKey_0
Definition imgui.h:1386
@ ImGuiKey_Home
Definition imgui.h:1375
@ ImGuiKey_F8
Definition imgui.h:1391
@ ImGuiKey_NamedKey_BEGIN
Definition imgui.h:1459
@ ImGuiKey_Equal
Definition imgui.h:1398
@ ImGuiKey_Z
Definition imgui.h:1389
@ ImGuiKey_H
Definition imgui.h:1387
@ ImGuiKey_Keypad7
Definition imgui.h:1409
@ ImGuiKey_RightCtrl
Definition imgui.h:1384
@ ImGuiKey_J
Definition imgui.h:1387
@ ImGuiKey_2
Definition imgui.h:1386
@ ImGuiKey_5
Definition imgui.h:1386
@ ImGuiKey_GamepadDpadDown
Definition imgui.h:1426
@ ImGuiKey_GamepadRStickDown
Definition imgui.h:1440
@ ImGuiKey_Insert
Definition imgui.h:1377
@ ImGuiKey_KeypadAdd
Definition imgui.h:1414
@ ImGuiKey_None
Definition imgui.h:1367
@ ImGuiKey_Keypad3
Definition imgui.h:1408
@ ImGuiKey_GamepadStart
Definition imgui.h:1419
@ ImGuiKey_NumLock
Definition imgui.h:1405
@ ImGuiKey_Pause
Definition imgui.h:1407
@ ImGuiKey_PrintScreen
Definition imgui.h:1406
@ ImGuiKey_GamepadRStickUp
Definition imgui.h:1439
@ ImGuiKey_GraveAccent
Definition imgui.h:1402
@ ImGuiKey_Y
Definition imgui.h:1389
@ ImGuiKey_Tab
Definition imgui.h:1368
@ ImGuiKey_GamepadR1
Definition imgui.h:1430
@ ImGuiKey_N
Definition imgui.h:1388
@ ImGuiKey_GamepadBack
Definition imgui.h:1420
@ ImGuiKey_A
Definition imgui.h:1387
@ ImGuiKey_C
Definition imgui.h:1387
@ ImGuiKey_K
Definition imgui.h:1388
@ ImGuiKey_PageDown
Definition imgui.h:1374
@ ImGuiKey_KeypadDecimal
Definition imgui.h:1410
@ ImGuiKey_F
Definition imgui.h:1387
@ ImGuiKey_Backslash
Definition imgui.h:1400
@ ImGuiKey_R
Definition imgui.h:1388
@ ImGuiKey_Comma
Definition imgui.h:1393
@ ImGuiKey_GamepadR3
Definition imgui.h:1434
@ ImGuiKey_ScrollLock
Definition imgui.h:1404
@ ImGuiKey_F10
Definition imgui.h:1391
@ ImGuiKey_Slash
Definition imgui.h:1396
@ ImGuiKey_KeysData_OFFSET
Definition imgui.h:1467
@ ImGuiKey_KeypadSubtract
Definition imgui.h:1413
@ ImGuiKey_F4
Definition imgui.h:1390
@ ImGuiKey_ModCtrl
Definition imgui.h:1452
@ ImGuiKey_F7
Definition imgui.h:1391
@ ImGuiKey_Keypad4
Definition imgui.h:1408
@ ImGuiKey_Keypad0
Definition imgui.h:1408
@ ImGuiKey_M
Definition imgui.h:1388
@ ImGuiKey_X
Definition imgui.h:1389
@ ImGuiKey_NamedKey_END
Definition imgui.h:1460
@ ImGuiKey_GamepadL1
Definition imgui.h:1429
@ ImGuiKey_RightBracket
Definition imgui.h:1401
@ ImGuiKey_GamepadLStickUp
Definition imgui.h:1435
@ ImGuiKey_Minus
Definition imgui.h:1394
@ ImGuiKey_1
Definition imgui.h:1386
@ ImGuiKey_7
Definition imgui.h:1386
@ ImGuiKey_Keypad5
Definition imgui.h:1409
@ ImGuiKey_KeypadEqual
Definition imgui.h:1416
@ ImGuiKey_U
Definition imgui.h:1389
@ ImGuiKey_GamepadFaceDown
Definition imgui.h:1422
@ ImGuiKey_Semicolon
Definition imgui.h:1397
@ ImGuiKey_E
Definition imgui.h:1387
@ ImGuiKey_UpArrow
Definition imgui.h:1371
@ ImGuiKey_GamepadLStickLeft
Definition imgui.h:1437
@ ImGuiKey_KeyPadEnter
Definition imgui.h:1471
@ ImGuiKey_Period
Definition imgui.h:1395
@ ImGuiKey_F12
Definition imgui.h:1391
@ ImGuiKey_Apostrophe
Definition imgui.h:1392
@ ImGuiKey_Space
Definition imgui.h:1380
@ ImGuiKey_9
Definition imgui.h:1386
@ ImGuiKey_O
Definition imgui.h:1388
@ ImGuiKey_LeftArrow
Definition imgui.h:1369
@ ImGuiKey_RightAlt
Definition imgui.h:1384
@ ImGuiKey_4
Definition imgui.h:1386
@ ImGuiKey_Keypad8
Definition imgui.h:1409
@ ImGuiKey_F6
Definition imgui.h:1390
@ ImGuiKey_Q
Definition imgui.h:1388
@ ImGuiKey_ModAlt
Definition imgui.h:1452
@ ImGuiKey_GamepadRStickRight
Definition imgui.h:1442
@ ImGuiKey_GamepadL3
Definition imgui.h:1433
@ ImGuiKey_End
Definition imgui.h:1376
@ ImGuiKey_GamepadDpadUp
Definition imgui.h:1425
@ ImGuiKey_GamepadDpadRight
Definition imgui.h:1428
@ ImGuiKey_P
Definition imgui.h:1388
@ ImGuiKey_GamepadDpadLeft
Definition imgui.h:1427
@ ImGuiKey_F3
Definition imgui.h:1390
@ ImGuiKey_Keypad6
Definition imgui.h:1409
@ ImGuiKey_L
Definition imgui.h:1388
@ ImGuiKey_NamedKey_COUNT
Definition imgui.h:1461
@ ImGuiKey_F2
Definition imgui.h:1390
@ ImGuiKey_CapsLock
Definition imgui.h:1403
@ ImGuiKey_V
Definition imgui.h:1389
@ ImGuiKey_G
Definition imgui.h:1387
@ ImGuiKey_ModSuper
Definition imgui.h:1452
@ ImGuiKey_8
Definition imgui.h:1386
@ ImGuiKey_F9
Definition imgui.h:1391
@ ImGuiKey_Enter
Definition imgui.h:1381
@ ImGuiKey_GamepadFaceLeft
Definition imgui.h:1423
@ ImGuiKey_KeysData_SIZE
Definition imgui.h:1466
@ ImGuiKey_D
Definition imgui.h:1387
@ ImGuiKey_KeypadDivide
Definition imgui.h:1411
@ ImGuiKey_F11
Definition imgui.h:1391
@ ImGuiKey_Backspace
Definition imgui.h:1379
@ ImGuiKey_I
Definition imgui.h:1387
@ ImGuiKey_LeftCtrl
Definition imgui.h:1383
@ ImGuiKey_GamepadR2
Definition imgui.h:1432
@ ImGuiKey_3
Definition imgui.h:1386
@ ImGuiKey_T
Definition imgui.h:1388
@ ImGuiKey_COUNT
Definition imgui.h:1455
@ ImGuiKey_LeftBracket
Definition imgui.h:1399
@ ImGuiKey_LeftAlt
Definition imgui.h:1383
@ ImGuiKey_B
Definition imgui.h:1387
@ ImGuiKey_Keypad1
Definition imgui.h:1408
@ ImGuiKey_GamepadLStickRight
Definition imgui.h:1438
@ ImGuiKey_ModShift
Definition imgui.h:1452
@ ImGuiKey_KeypadEnter
Definition imgui.h:1415
@ ImGuiKey_GamepadRStickLeft
Definition imgui.h:1441
unsigned long long ImU64
Definition imgui.h:245
int ImFontAtlasFlags
Definition imgui.h:199
int ImGuiColorEditFlags
Definition imgui.h:202
ImGuiInputTextFlags_
Definition imgui.h:999
@ ImGuiInputTextFlags_None
Definition imgui.h:1000
@ ImGuiInputTextFlags_CharsNoBlank
Definition imgui.h:1004
@ ImGuiInputTextFlags_CallbackHistory
Definition imgui.h:1008
@ ImGuiInputTextFlags_NoUndoRedo
Definition imgui.h:1017
@ ImGuiInputTextFlags_NoHorizontalScroll
Definition imgui.h:1013
@ ImGuiInputTextFlags_CallbackCharFilter
Definition imgui.h:1010
@ ImGuiInputTextFlags_AllowTabInput
Definition imgui.h:1011
@ ImGuiInputTextFlags_CharsHexadecimal
Definition imgui.h:1002
@ ImGuiInputTextFlags_CharsScientific
Definition imgui.h:1018
@ ImGuiInputTextFlags_AutoSelectAll
Definition imgui.h:1005
@ ImGuiInputTextFlags_CharsDecimal
Definition imgui.h:1001
@ ImGuiInputTextFlags_CallbackCompletion
Definition imgui.h:1007
@ ImGuiInputTextFlags_Password
Definition imgui.h:1016
@ ImGuiInputTextFlags_CtrlEnterForNewLine
Definition imgui.h:1012
@ ImGuiInputTextFlags_EnterReturnsTrue
Definition imgui.h:1006
@ ImGuiInputTextFlags_ReadOnly
Definition imgui.h:1015
@ ImGuiInputTextFlags_CharsUppercase
Definition imgui.h:1003
@ ImGuiInputTextFlags_CallbackResize
Definition imgui.h:1019
@ ImGuiInputTextFlags_AlwaysOverwrite
Definition imgui.h:1014
@ ImGuiInputTextFlags_AlwaysInsertMode
Definition imgui.h:1024
@ ImGuiInputTextFlags_CallbackEdit
Definition imgui.h:1020
@ ImGuiInputTextFlags_CallbackAlways
Definition imgui.h:1009
ImGuiModFlags_
Definition imgui.h:1477
@ ImGuiModFlags_Super
Definition imgui.h:1482
@ ImGuiModFlags_Ctrl
Definition imgui.h:1479
@ ImGuiModFlags_Shift
Definition imgui.h:1480
@ ImGuiModFlags_Alt
Definition imgui.h:1481
@ ImGuiModFlags_None
Definition imgui.h:1478
int ImGuiBackendFlags
Definition imgui.h:200
#define IM_COL32_B_SHIFT
Definition imgui.h:2355
ImGuiTableBgTarget_
Definition imgui.h:1265
@ ImGuiTableBgTarget_CellBg
Definition imgui.h:1269
@ ImGuiTableBgTarget_RowBg0
Definition imgui.h:1267
@ ImGuiTableBgTarget_RowBg1
Definition imgui.h:1268
@ ImGuiTableBgTarget_None
Definition imgui.h:1266
unsigned short ImU16
Definition imgui.h:241
#define IM_MSVC_RUNTIME_CHECKS_OFF
Definition imgui.h:125
ImGuiSortDirection_
Definition imgui.h:1356
@ ImGuiSortDirection_Descending
Definition imgui.h:1359
@ ImGuiSortDirection_Ascending
Definition imgui.h:1358
@ ImGuiSortDirection_None
Definition imgui.h:1357
int ImGuiInputTextFlags
Definition imgui.h:208
int ImGuiTableBgTarget
Definition imgui.h:196
ImFontAtlasFlags_
Definition imgui.h:2743
@ ImFontAtlasFlags_NoBakedLines
Definition imgui.h:2747
@ ImFontAtlasFlags_None
Definition imgui.h:2744
@ ImFontAtlasFlags_NoPowerOfTwoHeight
Definition imgui.h:2745
@ ImFontAtlasFlags_NoMouseCursors
Definition imgui.h:2746
int ImGuiNavInput
Definition imgui.h:191
signed long long ImS64
Definition imgui.h:244
int ImGuiDir
Definition imgui.h:189
ImGuiCol_
Definition imgui.h:1547
@ ImGuiCol_BorderShadow
Definition imgui.h:1554
@ ImGuiCol_TextDisabled
Definition imgui.h:1549
@ ImGuiCol_FrameBgHovered
Definition imgui.h:1556
@ ImGuiCol_HeaderActive
Definition imgui.h:1574
@ ImGuiCol_TitleBgCollapsed
Definition imgui.h:1560
@ ImGuiCol_PlotHistogramHovered
Definition imgui.h:1589
@ ImGuiCol_ScrollbarGrab
Definition imgui.h:1563
@ ImGuiCol_TextSelectedBg
Definition imgui.h:1595
@ ImGuiCol_MenuBarBg
Definition imgui.h:1561
@ ImGuiCol_PlotHistogram
Definition imgui.h:1588
@ ImGuiCol_Header
Definition imgui.h:1572
@ ImGuiCol_TabHovered
Definition imgui.h:1582
@ ImGuiCol_HeaderHovered
Definition imgui.h:1573
@ ImGuiCol_FrameBg
Definition imgui.h:1555
@ ImGuiCol_TabUnfocused
Definition imgui.h:1584
@ ImGuiCol_ModalWindowDimBg
Definition imgui.h:1600
@ ImGuiCol_DragDropTarget
Definition imgui.h:1596
@ ImGuiCol_Button
Definition imgui.h:1569
@ ImGuiCol_TabUnfocusedActive
Definition imgui.h:1585
@ ImGuiCol_ButtonHovered
Definition imgui.h:1570
@ ImGuiCol_ButtonActive
Definition imgui.h:1571
@ ImGuiCol_SeparatorActive
Definition imgui.h:1577
@ ImGuiCol_TableRowBg
Definition imgui.h:1593
@ ImGuiCol_Border
Definition imgui.h:1553
@ ImGuiCol_FrameBgActive
Definition imgui.h:1557
@ ImGuiCol_ScrollbarGrabActive
Definition imgui.h:1565
@ ImGuiCol_WindowBg
Definition imgui.h:1550
@ ImGuiCol_TableHeaderBg
Definition imgui.h:1590
@ ImGuiCol_TitleBgActive
Definition imgui.h:1559
@ ImGuiCol_Text
Definition imgui.h:1548
@ ImGuiCol_ResizeGripActive
Definition imgui.h:1580
@ ImGuiCol_TableRowBgAlt
Definition imgui.h:1594
@ ImGuiCol_ChildBg
Definition imgui.h:1551
@ ImGuiCol_PopupBg
Definition imgui.h:1552
@ ImGuiCol_Tab
Definition imgui.h:1581
@ ImGuiCol_ScrollbarBg
Definition imgui.h:1562
@ ImGuiCol_CheckMark
Definition imgui.h:1566
@ ImGuiCol_TabActive
Definition imgui.h:1583
@ ImGuiCol_TableBorderLight
Definition imgui.h:1592
@ ImGuiCol_ScrollbarGrabHovered
Definition imgui.h:1564
@ ImGuiCol_COUNT
Definition imgui.h:1601
@ ImGuiCol_TitleBg
Definition imgui.h:1558
@ ImGuiCol_PlotLines
Definition imgui.h:1586
@ ImGuiCol_ResizeGripHovered
Definition imgui.h:1579
@ ImGuiCol_NavWindowingHighlight
Definition imgui.h:1598
@ ImGuiCol_TableBorderStrong
Definition imgui.h:1591
@ ImGuiCol_SliderGrabActive
Definition imgui.h:1568
@ ImGuiCol_SliderGrab
Definition imgui.h:1567
@ ImGuiCol_SeparatorHovered
Definition imgui.h:1576
@ ImGuiCol_ResizeGrip
Definition imgui.h:1578
@ ImGuiCol_Separator
Definition imgui.h:1575
@ ImGuiCol_NavHighlight
Definition imgui.h:1597
@ ImGuiCol_NavWindowingDimBg
Definition imgui.h:1599
@ ImGuiCol_PlotLinesHovered
Definition imgui.h:1587
ImGuiTableRowFlags_
Definition imgui.h:1250
@ ImGuiTableRowFlags_None
Definition imgui.h:1251
@ ImGuiTableRowFlags_Headers
Definition imgui.h:1252
int ImGuiConfigFlags
Definition imgui.h:203
int ImGuiMouseCursor
Definition imgui.h:193
int ImGuiButtonFlags
Definition imgui.h:201
ImGuiMouseButton_
Definition imgui.h:1719
@ ImGuiMouseButton_Middle
Definition imgui.h:1722
@ ImGuiMouseButton_Right
Definition imgui.h:1721
@ ImGuiMouseButton_COUNT
Definition imgui.h:1723
@ ImGuiMouseButton_Left
Definition imgui.h:1720
int ImGuiSelectableFlags
Definition imgui.h:211
int ImGuiComboFlags
Definition imgui.h:204
signed short ImS16
Definition imgui.h:240
ImGuiComboFlags_
Definition imgui.h:1086
@ ImGuiComboFlags_NoPreview
Definition imgui.h:1094
@ ImGuiComboFlags_PopupAlignLeft
Definition imgui.h:1088
@ ImGuiComboFlags_HeightSmall
Definition imgui.h:1089
@ ImGuiComboFlags_HeightRegular
Definition imgui.h:1090
@ ImGuiComboFlags_NoArrowButton
Definition imgui.h:1093
@ ImGuiComboFlags_None
Definition imgui.h:1087
@ ImGuiComboFlags_HeightLarge
Definition imgui.h:1091
@ ImGuiComboFlags_HeightLargest
Definition imgui.h:1092
@ ImGuiComboFlags_HeightMask_
Definition imgui.h:1095
int ImGuiKeyModFlags
Definition imgui.h:3053
ImGuiTreeNodeFlags_
Definition imgui.h:1030
@ ImGuiTreeNodeFlags_Selected
Definition imgui.h:1032
@ ImGuiTreeNodeFlags_NoAutoOpenOnLog
Definition imgui.h:1036
@ ImGuiTreeNodeFlags_OpenOnArrow
Definition imgui.h:1039
@ ImGuiTreeNodeFlags_DefaultOpen
Definition imgui.h:1037
@ ImGuiTreeNodeFlags_Leaf
Definition imgui.h:1040
@ ImGuiTreeNodeFlags_FramePadding
Definition imgui.h:1042
@ ImGuiTreeNodeFlags_NoTreePushOnOpen
Definition imgui.h:1035
@ ImGuiTreeNodeFlags_Framed
Definition imgui.h:1033
@ ImGuiTreeNodeFlags_SpanFullWidth
Definition imgui.h:1044
@ ImGuiTreeNodeFlags_NavLeftJumpsBackHere
Definition imgui.h:1045
@ ImGuiTreeNodeFlags_AllowItemOverlap
Definition imgui.h:1034
@ ImGuiTreeNodeFlags_OpenOnDoubleClick
Definition imgui.h:1038
@ ImGuiTreeNodeFlags_CollapsingHeader
Definition imgui.h:1047
@ ImGuiTreeNodeFlags_Bullet
Definition imgui.h:1041
@ ImGuiTreeNodeFlags_SpanAvailWidth
Definition imgui.h:1043
@ ImGuiTreeNodeFlags_None
Definition imgui.h:1031
unsigned int ImWchar32
Definition imgui.h:250
int ImGuiMouseButton
Definition imgui.h:192
#define IM_FREE(_PTR)
Definition imgui.h:1769
ImGuiSelectableFlags_
Definition imgui.h:1075
@ ImGuiSelectableFlags_AllowItemOverlap
Definition imgui.h:1081
@ ImGuiSelectableFlags_SpanAllColumns
Definition imgui.h:1078
@ ImGuiSelectableFlags_None
Definition imgui.h:1076
@ ImGuiSelectableFlags_DontClosePopups
Definition imgui.h:1077
@ ImGuiSelectableFlags_AllowDoubleClick
Definition imgui.h:1079
@ ImGuiSelectableFlags_Disabled
Definition imgui.h:1080
int ImGuiSortDirection
Definition imgui.h:194
int ImGuiStyleVar
Definition imgui.h:195
#define IM_ASSERT(_EXPR)
Definition imgui.h:102
ImGuiKeyModFlags_
Definition imgui.h:3054
@ ImGuiKeyModFlags_Alt
Definition imgui.h:3054
@ ImGuiKeyModFlags_Super
Definition imgui.h:3054
@ ImGuiKeyModFlags_Ctrl
Definition imgui.h:3054
@ ImGuiKeyModFlags_Shift
Definition imgui.h:3054
@ ImGuiKeyModFlags_None
Definition imgui.h:3054
#define IM_MSVC_RUNTIME_CHECKS_RESTORE
Definition imgui.h:126
ImGuiViewportFlags_
Definition imgui.h:2925
@ ImGuiViewportFlags_OwnedByApp
Definition imgui.h:2929
@ ImGuiViewportFlags_IsPlatformWindow
Definition imgui.h:2927
@ ImGuiViewportFlags_IsPlatformMonitor
Definition imgui.h:2928
@ ImGuiViewportFlags_None
Definition imgui.h:2926
int ImGuiTableRowFlags
Definition imgui.h:217
ImGuiWindowFlags_
Definition imgui.h:961
@ ImGuiWindowFlags_NoInputs
Definition imgui.h:985
@ ImGuiWindowFlags_NoBackground
Definition imgui.h:970
@ ImGuiWindowFlags_NoNavInputs
Definition imgui.h:980
@ ImGuiWindowFlags_AlwaysUseWindowPadding
Definition imgui.h:979
@ ImGuiWindowFlags_AlwaysAutoResize
Definition imgui.h:969
@ ImGuiWindowFlags_MenuBar
Definition imgui.h:973
@ ImGuiWindowFlags_HorizontalScrollbar
Definition imgui.h:974
@ ImGuiWindowFlags_Tooltip
Definition imgui.h:990
@ ImGuiWindowFlags_NoTitleBar
Definition imgui.h:963
@ ImGuiWindowFlags_NoNavFocus
Definition imgui.h:981
@ ImGuiWindowFlags_AlwaysVerticalScrollbar
Definition imgui.h:977
@ ImGuiWindowFlags_NoFocusOnAppearing
Definition imgui.h:975
@ ImGuiWindowFlags_NoCollapse
Definition imgui.h:968
@ ImGuiWindowFlags_NoScrollWithMouse
Definition imgui.h:967
@ ImGuiWindowFlags_Modal
Definition imgui.h:992
@ ImGuiWindowFlags_NoMouseInputs
Definition imgui.h:972
@ ImGuiWindowFlags_UnsavedDocument
Definition imgui.h:982
@ ImGuiWindowFlags_NoSavedSettings
Definition imgui.h:971
@ ImGuiWindowFlags_NoBringToFrontOnFocus
Definition imgui.h:976
@ ImGuiWindowFlags_Popup
Definition imgui.h:991
@ ImGuiWindowFlags_ChildMenu
Definition imgui.h:993
@ ImGuiWindowFlags_AlwaysHorizontalScrollbar
Definition imgui.h:978
@ ImGuiWindowFlags_NoDecoration
Definition imgui.h:984
@ ImGuiWindowFlags_NoNav
Definition imgui.h:983
@ ImGuiWindowFlags_NavFlattened
Definition imgui.h:988
@ ImGuiWindowFlags_NoMove
Definition imgui.h:965
@ ImGuiWindowFlags_ChildWindow
Definition imgui.h:989
@ ImGuiWindowFlags_NoResize
Definition imgui.h:964
@ ImGuiWindowFlags_NoScrollbar
Definition imgui.h:966
@ ImGuiWindowFlags_None
Definition imgui.h:962
ImGuiCond_
Definition imgui.h:1747
@ ImGuiCond_FirstUseEver
Definition imgui.h:1751
@ ImGuiCond_Always
Definition imgui.h:1749
@ ImGuiCond_Once
Definition imgui.h:1750
@ ImGuiCond_Appearing
Definition imgui.h:1752
@ ImGuiCond_None
Definition imgui.h:1748
int ImGuiTableFlags
Definition imgui.h:215
ImDrawCornerFlags_
Definition imgui.h:3039
@ ImDrawCornerFlags_TopLeft
Definition imgui.h:3041
@ ImDrawCornerFlags_Right
Definition imgui.h:3049
@ ImDrawCornerFlags_All
Definition imgui.h:3045
@ ImDrawCornerFlags_TopRight
Definition imgui.h:3042
@ ImDrawCornerFlags_Top
Definition imgui.h:3046
@ ImDrawCornerFlags_Left
Definition imgui.h:3048
@ ImDrawCornerFlags_BotLeft
Definition imgui.h:3043
@ ImDrawCornerFlags_None
Definition imgui.h:3040
@ ImDrawCornerFlags_Bot
Definition imgui.h:3047
@ ImDrawCornerFlags_BotRight
Definition imgui.h:3044
ImGuiDir_
Definition imgui.h:1345
@ ImGuiDir_Down
Definition imgui.h:1350
@ ImGuiDir_Right
Definition imgui.h:1348
@ ImGuiDir_COUNT
Definition imgui.h:1351
@ ImGuiDir_Up
Definition imgui.h:1349
@ ImGuiDir_None
Definition imgui.h:1346
@ ImGuiDir_Left
Definition imgui.h:1347
void(* ImGuiMemFreeFunc)(void *ptr, void *user_data)
Definition imgui.h:261
signed int ImS32
Definition imgui.h:242
ImGuiTableFlags_
Definition imgui.h:1151
@ ImGuiTableFlags_SortTristate
Definition imgui.h:1194
@ ImGuiTableFlags_NoSavedSettings
Definition imgui.h:1158
@ ImGuiTableFlags_Sortable
Definition imgui.h:1157
@ ImGuiTableFlags_SizingFixedSame
Definition imgui.h:1175
@ ImGuiTableFlags_NoBordersInBodyUntilResize
Definition imgui.h:1172
@ ImGuiTableFlags_SortMulti
Definition imgui.h:1193
@ ImGuiTableFlags_NoBordersInBody
Definition imgui.h:1171
@ ImGuiTableFlags_Borders
Definition imgui.h:1170
@ ImGuiTableFlags_NoClip
Definition imgui.h:1184
@ ImGuiTableFlags_RowBg
Definition imgui.h:1161
@ ImGuiTableFlags_None
Definition imgui.h:1153
@ ImGuiTableFlags_Reorderable
Definition imgui.h:1155
@ ImGuiTableFlags_BordersInnerH
Definition imgui.h:1162
@ ImGuiTableFlags_BordersInner
Definition imgui.h:1168
@ ImGuiTableFlags_BordersH
Definition imgui.h:1166
@ ImGuiTableFlags_SizingMask_
Definition imgui.h:1197
@ ImGuiTableFlags_NoPadInnerX
Definition imgui.h:1188
@ ImGuiTableFlags_ScrollY
Definition imgui.h:1191
@ ImGuiTableFlags_SizingStretchSame
Definition imgui.h:1177
@ ImGuiTableFlags_SizingStretchProp
Definition imgui.h:1176
@ ImGuiTableFlags_NoHostExtendX
Definition imgui.h:1179
@ ImGuiTableFlags_PadOuterX
Definition imgui.h:1186
@ ImGuiTableFlags_BordersOuterV
Definition imgui.h:1165
@ ImGuiTableFlags_NoKeepColumnsVisible
Definition imgui.h:1181
@ ImGuiTableFlags_ScrollX
Definition imgui.h:1190
@ ImGuiTableFlags_BordersInnerV
Definition imgui.h:1164
@ ImGuiTableFlags_ContextMenuInBody
Definition imgui.h:1159
@ ImGuiTableFlags_PreciseWidths
Definition imgui.h:1182
@ ImGuiTableFlags_BordersV
Definition imgui.h:1167
@ ImGuiTableFlags_NoPadOuterX
Definition imgui.h:1187
@ ImGuiTableFlags_SizingFixedFit
Definition imgui.h:1174
@ ImGuiTableFlags_NoHostExtendY
Definition imgui.h:1180
@ ImGuiTableFlags_Hideable
Definition imgui.h:1156
@ ImGuiTableFlags_Resizable
Definition imgui.h:1154
@ ImGuiTableFlags_BordersOuterH
Definition imgui.h:1163
@ ImGuiTableFlags_BordersOuter
Definition imgui.h:1169
int ImGuiTabItemFlags
Definition imgui.h:214
ImGuiColorEditFlags_
Definition imgui.h:1657
@ ImGuiColorEditFlags_InputRGB
Definition imgui.h:1682
@ ImGuiColorEditFlags_DisplayRGB
Definition imgui.h:1675
@ ImGuiColorEditFlags_AlphaPreview
Definition imgui.h:1672
@ ImGuiColorEditFlags_InputMask_
Definition imgui.h:1693
@ ImGuiColorEditFlags_NoSmallPreview
Definition imgui.h:1662
@ ImGuiColorEditFlags_DisplayHex
Definition imgui.h:1677
@ ImGuiColorEditFlags_Uint8
Definition imgui.h:1678
@ ImGuiColorEditFlags_NoOptions
Definition imgui.h:1661
@ ImGuiColorEditFlags_NoAlpha
Definition imgui.h:1659
@ ImGuiColorEditFlags_NoPicker
Definition imgui.h:1660
@ ImGuiColorEditFlags_NoSidePreview
Definition imgui.h:1666
@ ImGuiColorEditFlags_NoLabel
Definition imgui.h:1665
@ ImGuiColorEditFlags_InputHSV
Definition imgui.h:1683
@ ImGuiColorEditFlags_DisplayMask_
Definition imgui.h:1690
@ ImGuiColorEditFlags_NoBorder
Definition imgui.h:1668
@ ImGuiColorEditFlags_PickerMask_
Definition imgui.h:1692
@ ImGuiColorEditFlags_NoInputs
Definition imgui.h:1663
@ ImGuiColorEditFlags_PickerHueWheel
Definition imgui.h:1681
@ ImGuiColorEditFlags_AlphaPreviewHalf
Definition imgui.h:1673
@ ImGuiColorEditFlags_AlphaBar
Definition imgui.h:1671
@ ImGuiColorEditFlags_None
Definition imgui.h:1658
@ ImGuiColorEditFlags_HDR
Definition imgui.h:1674
@ ImGuiColorEditFlags_DefaultOptions_
Definition imgui.h:1687
@ ImGuiColorEditFlags_NoDragDrop
Definition imgui.h:1667
@ ImGuiColorEditFlags_PickerHueBar
Definition imgui.h:1680
@ ImGuiColorEditFlags_NoTooltip
Definition imgui.h:1664
@ ImGuiColorEditFlags_DisplayHSV
Definition imgui.h:1676
@ ImGuiColorEditFlags_Float
Definition imgui.h:1679
@ ImGuiColorEditFlags_DataTypeMask_
Definition imgui.h:1691
int ImGuiCond
Definition imgui.h:187
#define IM_UNICODE_CODEPOINT_MAX
Definition imgui.h:2188
int ImGuiPopupFlags
Definition imgui.h:210
int ImDrawFlags
Definition imgui.h:197
ImDrawFlags_
Definition imgui.h:2486
@ ImDrawFlags_RoundCornersTopLeft
Definition imgui.h:2489
@ ImDrawFlags_None
Definition imgui.h:2487
@ ImDrawFlags_RoundCornersBottomLeft
Definition imgui.h:2491
@ ImDrawFlags_RoundCornersTopRight
Definition imgui.h:2490
@ ImDrawFlags_RoundCornersNone
Definition imgui.h:2493
@ ImDrawFlags_RoundCornersBottom
Definition imgui.h:2495
@ ImDrawFlags_RoundCornersRight
Definition imgui.h:2497
@ ImDrawFlags_RoundCornersBottomRight
Definition imgui.h:2492
@ ImDrawFlags_RoundCornersMask_
Definition imgui.h:2500
@ ImDrawFlags_Closed
Definition imgui.h:2488
@ ImDrawFlags_RoundCornersLeft
Definition imgui.h:2496
@ ImDrawFlags_RoundCornersTop
Definition imgui.h:2494
@ ImDrawFlags_RoundCornersDefault_
Definition imgui.h:2499
@ ImDrawFlags_RoundCornersAll
Definition imgui.h:2498
ImDrawFlags ImDrawCornerFlags
Definition imgui.h:3037
int ImGuiTableColumnFlags
Definition imgui.h:216
#define IM_COL32_A_SHIFT
Definition imgui.h:2356
unsigned short ImDrawIdx
Definition imgui.h:233
Definition imgui.h:296
IMGUI_API bool SetDragDropPayload(const char *type, const void *data, size_t sz, ImGuiCond cond=0)
IMGUI_API void ShowStackToolWindow(bool *p_open=NULL)
IMGUI_API bool InvisibleButton(const char *str_id, const ImVec2 &size, ImGuiButtonFlags flags=0)
IMGUI_API bool TabItemButton(const char *label, ImGuiTabItemFlags flags=0)
IMGUI_API void EndChild()
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)
IMGUI_API bool BeginPopupModal(const char *name, bool *p_open=NULL, ImGuiWindowFlags flags=0)
IMGUI_API int GetMouseClickedCount(ImGuiMouseButton button)
IMGUI_API void SetNextItemWidth(float item_width)
IMGUI_API void EndDragDropSource()
IMGUI_API bool BeginMainMenuBar()
IMGUI_API bool BeginTabBar(const char *str_id, ImGuiTabBarFlags flags=0)
IMGUI_API void ShowDemoWindow(bool *p_open=NULL)
IMGUI_API void SetNextWindowContentSize(const ImVec2 &size)
IMGUI_API void TextColoredV(const ImVec4 &col, const char *fmt, va_list args) IM_FMTLIST(2)
IMGUI_API bool BeginTabItem(const char *label, bool *p_open=NULL, ImGuiTabItemFlags flags=0)
IMGUI_API bool BeginListBox(const char *label, const ImVec2 &size=ImVec2(0, 0))
IMGUI_API const ImGuiPayload * AcceptDragDropPayload(const char *type, ImGuiDragDropFlags flags=0)
IMGUI_API void LogFinish()
IMGUI_API void LabelText(const char *label, const char *fmt,...) IM_FMTARGS(2)
IMGUI_API void ShowUserGuide()
IMGUI_API void SetTooltipV(const char *fmt, va_list args) IM_FMTLIST(1)
IMGUI_API ImU32 ColorConvertFloat4ToU32(const ImVec4 &in)
IMGUI_API void DestroyContext(ImGuiContext *ctx=NULL)
IMGUI_API void TextDisabledV(const char *fmt, va_list args) IM_FMTLIST(1)
IMGUI_API void SetNextItemOpen(bool is_open, ImGuiCond cond=0)
IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val)
IMGUI_API ImDrawData * GetDrawData()
IMGUI_API void CloseCurrentPopup()
IMGUI_API void PushStyleColor(ImGuiCol idx, ImU32 col)
IMGUI_API void BeginDisabled(bool disabled=true)
IMGUI_API void End()
IMGUI_API void LogButtons()
IMGUI_API ImVec2 GetWindowContentRegionMin()
IMGUI_API bool DragFloat4(const char *label, float v[4], float v_speed=1.0f, float v_min=0.0f, float v_max=0.0f, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API void EndDragDropTarget()
IMGUI_API void OpenPopupOnItemClick(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
IMGUI_API const char * GetKeyName(ImGuiKey key)
IMGUI_API float GetWindowWidth()
IMGUI_API void TreePush(const char *str_id)
IMGUI_API bool ColorEdit3(const char *label, float col[3], ImGuiColorEditFlags flags=0)
IMGUI_API bool BeginDragDropTarget()
IMGUI_API void TableNextRow(ImGuiTableRowFlags row_flags=0, float min_row_height=0.0f)
IMGUI_API ImVec4 ColorConvertU32ToFloat4(ImU32 in)
IMGUI_API bool ArrowButton(const char *str_id, ImGuiDir dir)
IMGUI_API ImGuiContext * CreateContext(ImFontAtlas *shared_font_atlas=NULL)
IMGUI_API bool DragFloat2(const char *label, float v[2], float v_speed=1.0f, float v_min=0.0f, float v_max=0.0f, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API ImFont * GetFont()
IMGUI_API void Spacing()
IMGUI_API float GetScrollMaxX()
IMGUI_API void SetNextWindowSizeConstraints(const ImVec2 &size_min, const ImVec2 &size_max, ImGuiSizeCallback custom_callback=NULL, void *custom_callback_data=NULL)
IMGUI_API float GetTextLineHeight()
IMGUI_API int GetKeyPressedAmount(ImGuiKey key, float repeat_delay, float rate)
IMGUI_API void PushClipRect(const ImVec2 &clip_rect_min, const ImVec2 &clip_rect_max, bool intersect_with_current_clip_rect)
IMGUI_API bool DragFloat3(const char *label, float v[3], float v_speed=1.0f, float v_min=0.0f, float v_max=0.0f, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API void SetNextFrameWantCaptureKeyboard(bool want_capture_keyboard)
IMGUI_API void EndChildFrame()
IMGUI_API void PushButtonRepeat(bool repeat)
IMGUI_API bool BeginDragDropSource(ImGuiDragDropFlags flags=0)
IMGUI_API void StyleColorsClassic(ImGuiStyle *dst=NULL)
IMGUI_API bool InputInt(const char *label, int *v, int step=1, int step_fast=100, ImGuiInputTextFlags flags=0)
IMGUI_API void SetNextWindowSize(const ImVec2 &size, ImGuiCond cond=0)
IMGUI_API bool DragScalar(const char *label, ImGuiDataType data_type, void *p_data, float v_speed=1.0f, const void *p_min=NULL, const void *p_max=NULL, const char *format=NULL, ImGuiSliderFlags flags=0)
IMGUI_API void Bullet()
IMGUI_API bool BeginMenu(const char *label, bool enabled=true)
IMGUI_API bool BeginCombo(const char *label, const char *preview_value, ImGuiComboFlags flags=0)
IMGUI_API void PopAllowKeyboardFocus()
IMGUI_API bool InputDouble(const char *label, double *v, double step=0.0, double step_fast=0.0, const char *format="%.6f", ImGuiInputTextFlags flags=0)
IMGUI_API ImVec2 GetContentRegionAvail()
IMGUI_API void SetScrollY(float scroll_y)
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)
IMGUI_API float GetScrollY()
IMGUI_API void SetColumnOffset(int column_index, float offset_x)
IMGUI_API bool SliderInt2(const char *label, int v[2], int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API void Columns(int count=1, const char *id=NULL, bool border=true)
IMGUI_API void PushAllowKeyboardFocus(bool allow_keyboard_focus)
IMGUI_API ImGuiContext * GetCurrentContext()
IMGUI_API void SetCurrentContext(ImGuiContext *ctx)
IMGUI_API void TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n=-1)
IMGUI_API bool BeginChild(const char *str_id, const ImVec2 &size=ImVec2(0, 0), bool border=false, ImGuiWindowFlags flags=0)
IMGUI_API ImGuiID GetID(const char *str_id)
IMGUI_API ImU32 GetColorU32(ImGuiCol idx, float alpha_mul=1.0f)
IMGUI_API ImVec2 GetCursorScreenPos()
IMGUI_API void ShowDebugLogWindow(bool *p_open=NULL)
IMGUI_API bool ShowStyleSelector(const char *label)
IMGUI_API bool IsItemVisible()
IMGUI_API ImVec2 GetFontTexUvWhitePixel()
IMGUI_API bool IsMouseDoubleClicked(ImGuiMouseButton button)
IMGUI_API void SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void *user_data=NULL)
IMGUI_API bool ListBox(const char *label, int *current_item, const char *const items[], int items_count, int height_in_items=-1)
IMGUI_API bool SliderScalarN(const char *label, ImGuiDataType data_type, void *p_data, int components, const void *p_min, const void *p_max, const char *format=NULL, ImGuiSliderFlags flags=0)
IMGUI_API void SetCursorPosY(float local_y)
IMGUI_API ImVec2 GetContentRegionMax()
IMGUI_API void SetScrollHereX(float center_x_ratio=0.5f)
IMGUI_API float GetCursorPosY()
IMGUI_API void SetMouseCursor(ImGuiMouseCursor cursor_type)
IMGUI_API bool TreeNodeV(const char *str_id, const char *fmt, va_list args) IM_FMTLIST(2)
IMGUI_API bool SliderFloat2(const char *label, float v[2], float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API ImGuiStorage * GetStateStorage()
IMGUI_API void * MemAlloc(size_t size)
IMGUI_API bool ColorPicker3(const char *label, float col[3], ImGuiColorEditFlags flags=0)
IMGUI_API void NextColumn()
IMGUI_API bool IsItemToggledOpen()
IMGUI_API void SetWindowCollapsed(bool collapsed, ImGuiCond cond=0)
IMGUI_API void TreePop()
IMGUI_API bool SliderFloat4(const char *label, float v[4], float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API bool SliderAngle(const char *label, float *v_rad, float v_degrees_min=-360.0f, float v_degrees_max=+360.0f, const char *format="%.0f deg", ImGuiSliderFlags flags=0)
IMGUI_API void BulletTextV(const char *fmt, va_list args) IM_FMTLIST(1)
IMGUI_API const ImVec4 & GetStyleColorVec4(ImGuiCol idx)
IMGUI_API bool IsKeyPressed(ImGuiKey key, bool repeat=true)
IMGUI_API void EndDisabled()
IMGUI_API void TextColored(const ImVec4 &col, const char *fmt,...) IM_FMTARGS(2)
IMGUI_API bool TreeNodeEx(const char *label, ImGuiTreeNodeFlags flags=0)
IMGUI_API bool IsItemEdited()
IMGUI_API void SetWindowFocus()
IMGUI_API void PopButtonRepeat()
IMGUI_API void OpenPopup(const char *str_id, ImGuiPopupFlags popup_flags=0)
IMGUI_API void SetWindowFontScale(float scale)
IMGUI_API void LoadIniSettingsFromMemory(const char *ini_data, size_t ini_size=0)
IMGUI_API bool IsItemFocused()
IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, bool repeat=false)
IMGUI_API void Separator()
IMGUI_API bool InputInt3(const char *label, int v[3], ImGuiInputTextFlags flags=0)
IMGUI_API void SetWindowPos(const ImVec2 &pos, ImGuiCond cond=0)
IMGUI_API void NewFrame()
IMGUI_API void Image(ImTextureID user_texture_id, const ImVec2 &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))
IMGUI_API void PlotHistogram(const char *label, const float *values, int values_count, int values_offset=0, const char *overlay_text=NULL, float scale_min=FLT_MAX, float scale_max=FLT_MAX, ImVec2 graph_size=ImVec2(0, 0), int stride=sizeof(float))
IMGUI_API bool IsItemHovered(ImGuiHoveredFlags flags=0)
IMGUI_API bool IsMouseReleased(ImGuiMouseButton button)
IMGUI_API bool DragInt2(const char *label, int v[2], float v_speed=1.0f, int v_min=0, int v_max=0, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API void BeginTooltip()
IMGUI_API void GetAllocatorFunctions(ImGuiMemAllocFunc *p_alloc_func, ImGuiMemFreeFunc *p_free_func, void **p_user_data)
IMGUI_API void TextWrapped(const char *fmt,...) IM_FMTARGS(1)
IMGUI_API void PushTextWrapPos(float wrap_local_pos_x=0.0f)
IMGUI_API const char * GetStyleColorName(ImGuiCol idx)
IMGUI_API void ShowMetricsWindow(bool *p_open=NULL)
IMGUI_API int TableGetColumnCount()
IMGUI_API bool IsRectVisible(const ImVec2 &size)
IMGUI_API bool TreeNodeExV(const char *str_id, ImGuiTreeNodeFlags flags, const char *fmt, va_list args) IM_FMTLIST(3)
IMGUI_API bool ColorButton(const char *desc_id, const ImVec4 &col, ImGuiColorEditFlags flags=0, const ImVec2 &size=ImVec2(0, 0))
IMGUI_API ImDrawList * GetBackgroundDrawList()
IMGUI_API void CalcListClipping(int items_count, float items_height, int *out_items_display_start, int *out_items_display_end)
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)
IMGUI_API bool SliderInt3(const char *label, int v[3], int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API bool VSliderFloat(const char *label, const ImVec2 &size, float *v, float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API void EndTooltip()
IMGUI_API void DebugTextEncoding(const char *text)
IMGUI_API void EndMainMenuBar()
IMGUI_API bool TreeNode(const char *label)
IMGUI_API bool IsItemDeactivatedAfterEdit()
IMGUI_API void TableHeader(const char *label)
IMGUI_API float CalcItemWidth()
IMGUI_API bool InputInt4(const char *label, int v[4], ImGuiInputTextFlags flags=0)
IMGUI_API bool SliderScalar(const char *label, ImGuiDataType data_type, void *p_data, const void *p_min, const void *p_max, const char *format=NULL, ImGuiSliderFlags flags=0)
IMGUI_API void PopFont()
IMGUI_API bool IsMouseHoveringRect(const ImVec2 &r_min, const ImVec2 &r_max, bool clip=true)
IMGUI_API bool Combo(const char *label, int *current_item, const char *const items[], int items_count, int popup_max_height_in_items=-1)
IMGUI_API void SetNextWindowCollapsed(bool collapsed, ImGuiCond cond=0)
IMGUI_API ImGuiViewport * GetMainViewport()
IMGUI_API void PushFont(ImFont *font)
IMGUI_API void SetCursorPosX(float local_x)
IMGUI_API double GetTime()
IMGUI_API float GetFontSize()
IMGUI_API bool Button(const char *label, const ImVec2 &size=ImVec2(0, 0))
IMGUI_API void LabelTextV(const char *label, const char *fmt, va_list args) IM_FMTLIST(2)
IMGUI_API void PopStyleColor(int count=1)
IMGUI_API ImVec2 GetMousePosOnOpeningCurrentPopup()
IMGUI_API bool IsKeyDown(ImGuiKey key)
IMGUI_API const char * GetVersion()
IMGUI_API bool BeginPopupContextWindow(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
IMGUI_API void ShowStyleEditor(ImGuiStyle *ref=NULL)
IMGUI_API void AlignTextToFramePadding()
IMGUI_API void SetScrollX(float scroll_x)
IMGUI_API void SetItemDefaultFocus()
IMGUI_API float GetColumnWidth(int column_index=-1)
IMGUI_API void Indent(float indent_w=0.0f)
IMGUI_API void SetScrollFromPosX(float local_x, float center_x_ratio=0.5f)
IMGUI_API void PopID()
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)
IMGUI_API bool IsAnyItemActive()
IMGUI_API int GetColumnIndex()
IMGUI_API void ColorConvertRGBtoHSV(float r, float g, float b, float &out_h, float &out_s, float &out_v)
IMGUI_API void SetClipboardText(const char *text)
IMGUI_API ImGuiIO & GetIO()
IMGUI_API void TableSetColumnEnabled(int column_n, bool v)
IMGUI_API void ResetMouseDragDelta(ImGuiMouseButton button=0)
IMGUI_API ImDrawList * GetForegroundDrawList()
IMGUI_API void TextUnformatted(const char *text, const char *text_end=NULL)
IMGUI_API ImDrawList * GetWindowDrawList()
IMGUI_API bool IsMouseDragging(ImGuiMouseButton button, float lock_threshold=-1.0f)
IMGUI_API void PopStyleVar(int count=1)
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)
IMGUI_API const char * GetClipboardText()
IMGUI_API bool InputFloat4(const char *label, float v[4], const char *format="%.3f", ImGuiInputTextFlags flags=0)
IMGUI_API bool ColorEdit4(const char *label, float col[4], ImGuiColorEditFlags flags=0)
IMGUI_API void EndTable()
IMGUI_API void MemFree(void *ptr)
IMGUI_API void EndTabItem()
IMGUI_API bool InputFloat2(const char *label, float v[2], const char *format="%.3f", ImGuiInputTextFlags flags=0)
IMGUI_API bool InputFloat(const char *label, float *v, float step=0.0f, float step_fast=0.0f, const char *format="%.3f", ImGuiInputTextFlags flags=0)
IMGUI_API void Value(const char *prefix, bool b)
IMGUI_API ImVec2 GetWindowSize()
IMGUI_API bool InputScalar(const char *label, ImGuiDataType data_type, void *p_data, const void *p_step=NULL, const void *p_step_fast=NULL, const char *format=NULL, ImGuiInputTextFlags flags=0)
IMGUI_API void PopClipRect()
IMGUI_API void SetCursorPos(const ImVec2 &local_pos)
IMGUI_API ImGuiMouseCursor GetMouseCursor()
IMGUI_API bool IsPopupOpen(const char *str_id, ImGuiPopupFlags flags=0)
IMGUI_API void SetStateStorage(ImGuiStorage *storage)
IMGUI_API bool IsItemActive()
IMGUI_API bool CollapsingHeader(const char *label, ImGuiTreeNodeFlags flags=0)
IMGUI_API void Unindent(float indent_w=0.0f)
IMGUI_API bool IsKeyReleased(ImGuiKey key)
IMGUI_API void TextV(const char *fmt, va_list args) IM_FMTLIST(1)
IMGUI_API bool Begin(const char *name, bool *p_open=NULL, ImGuiWindowFlags flags=0)
IMGUI_API ImVec2 GetItemRectMax()
IMGUI_API void EndMenu()
IMGUI_API void EndGroup()
IMGUI_API bool InputText(const char *label, char *buf, size_t buf_size, ImGuiInputTextFlags flags=0, ImGuiInputTextCallback callback=NULL, void *user_data=NULL)
IMGUI_API void PushItemWidth(float item_width)
IMGUI_API const ImGuiPayload * GetDragDropPayload()
IMGUI_API float GetTreeNodeToLabelSpacing()
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))
IMGUI_API ImGuiStyle & GetStyle()
IMGUI_API void ShowFontSelector(const char *label)
IMGUI_API ImVec2 GetItemRectSize()
IMGUI_API void PlotLines(const char *label, const float *values, int values_count, int values_offset=0, const char *overlay_text=NULL, float scale_min=FLT_MAX, float scale_max=FLT_MAX, ImVec2 graph_size=ImVec2(0, 0), int stride=sizeof(float))
IMGUI_API bool SliderInt(const char *label, int *v, int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API int TableGetColumnIndex()
IMGUI_API bool BeginPopup(const char *str_id, ImGuiWindowFlags flags=0)
IMGUI_API bool TableSetColumnIndex(int column_n)
IMGUI_API void Render()
IMGUI_API void SetItemAllowOverlap()
IMGUI_API ImVec2 GetMousePos()
IMGUI_API bool CheckboxFlags(const char *label, int *flags, int flags_value)
IMGUI_API bool SliderFloat(const char *label, float *v, float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API bool DragIntRange2(const char *label, int *v_current_min, int *v_current_max, float v_speed=1.0f, int v_min=0, int v_max=0, const char *format="%d", const char *format_max=NULL, ImGuiSliderFlags flags=0)
IMGUI_API void SetCursorScreenPos(const ImVec2 &pos)
IMGUI_API ImVec2 GetWindowContentRegionMax()
IMGUI_API float GetFrameHeightWithSpacing()
IMGUI_API void SetColumnWidth(int column_index, float width)
IMGUI_API bool ListBoxHeader(const char *label, int items_count, int height_in_items=-1)
IMGUI_API ImVec2 GetCursorStartPos()
IMGUI_API void EndTabBar()
IMGUI_API void BulletText(const char *fmt,...) IM_FMTARGS(1)
IMGUI_API void SameLine(float offset_from_start_x=0.0f, float spacing=-1.0f)
IMGUI_API bool MenuItem(const char *label, const char *shortcut=NULL, bool selected=false, bool enabled=true)
IMGUI_API void LoadIniSettingsFromDisk(const char *ini_filename)
IMGUI_API bool SliderInt4(const char *label, int v[4], int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API ImVec2 GetCursorPos()
IMGUI_API float GetCursorPosX()
IMGUI_API void SetNextFrameWantCaptureMouse(bool want_capture_mouse)
IMGUI_API void LogToTTY(int auto_open_depth=-1)
IMGUI_API void TextDisabled(const char *fmt,...) IM_FMTARGS(1)
IMGUI_API void TableSetupColumn(const char *label, ImGuiTableColumnFlags flags=0, float init_width_or_weight=0.0f, ImGuiID user_id=0)
IMGUI_API bool SliderFloat3(const char *label, float v[3], float v_min, float v_max, const char *format="%.3f", ImGuiSliderFlags flags=0)
IMGUI_API bool RadioButton(const char *label, bool active)
IMGUI_API bool SmallButton(const char *label)
IMGUI_API int GetKeyIndex(ImGuiKey key)
IMGUI_API void LogToFile(int auto_open_depth=-1, const char *filename=NULL)
IMGUI_API bool InputFloat3(const char *label, float v[3], const char *format="%.3f", ImGuiInputTextFlags flags=0)
IMGUI_API bool IsItemClicked(ImGuiMouseButton mouse_button=0)
IMGUI_API float GetTextLineHeightWithSpacing()
IMGUI_API bool IsAnyMouseDown()
IMGUI_API bool BeginMenuBar()
IMGUI_API bool VSliderInt(const char *label, const ImVec2 &size, int *v, int v_min, int v_max, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API ImGuiTableColumnFlags TableGetColumnFlags(int column_n=-1)
IMGUI_API float GetScrollX()
IMGUI_API bool IsAnyItemHovered()
IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0)
IMGUI_API void TableSetupScrollFreeze(int cols, int rows)
IMGUI_API void NewLine()
IMGUI_API ImGuiTableSortSpecs * TableGetSortSpecs()
IMGUI_API void SetWindowSize(const ImVec2 &size, ImGuiCond cond=0)
IMGUI_API bool IsItemDeactivated()
IMGUI_API ImVec2 CalcTextSize(const char *text, const char *text_end=NULL, bool hide_text_after_double_hash=false, float wrap_width=-1.0f)
IMGUI_API bool IsMousePosValid(const ImVec2 *mouse_pos=NULL)
IMGUI_API void LogText(const char *fmt,...) IM_FMTARGS(1)
IMGUI_API const char * TableGetColumnName(int column_n=-1)
IMGUI_API void SetScrollFromPosY(float local_y, float center_y_ratio=0.5f)
IMGUI_API void TableHeadersRow()
IMGUI_API void EndMenuBar()
IMGUI_API bool IsWindowHovered(ImGuiHoveredFlags flags=0)
IMGUI_API int GetFrameCount()
IMGUI_API bool ColorPicker4(const char *label, float col[4], ImGuiColorEditFlags flags=0, const float *ref_col=NULL)
IMGUI_API bool Selectable(const char *label, bool selected=false, ImGuiSelectableFlags flags=0, const ImVec2 &size=ImVec2(0, 0))
IMGUI_API const char * SaveIniSettingsToMemory(size_t *out_ini_size=NULL)
IMGUI_API float GetFrameHeight()
IMGUI_API bool IsItemActivated()
IMGUI_API bool DragFloatRange2(const char *label, float *v_current_min, float *v_current_max, float v_speed=1.0f, float v_min=0.0f, float v_max=0.0f, const char *format="%.3f", const char *format_max=NULL, ImGuiSliderFlags flags=0)
IMGUI_API void SetTabItemClosed(const char *tab_or_docked_window_label)
IMGUI_API bool BeginChildFrame(ImGuiID id, const ImVec2 &size, ImGuiWindowFlags flags=0)
IMGUI_API int GetColumnsCount()
IMGUI_API void EndPopup()
IMGUI_API float GetWindowHeight()
IMGUI_API void StyleColorsLight(ImGuiStyle *dst=NULL)
IMGUI_API bool TableNextColumn()
IMGUI_API void TextWrappedV(const char *fmt, va_list args) IM_FMTLIST(1)
IMGUI_API bool DragInt3(const char *label, int v[3], float v_speed=1.0f, int v_min=0, int v_max=0, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_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)
IMGUI_API float GetScrollMaxY()
IMGUI_API void PopItemWidth()
IMGUI_API ImVec2 GetMouseDragDelta(ImGuiMouseButton button=0, float lock_threshold=-1.0f)
IMGUI_API bool BeginPopupContextItem(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
IMGUI_API bool IsAnyItemFocused()
IMGUI_API bool BeginPopupContextVoid(const char *str_id=NULL, ImGuiPopupFlags popup_flags=1)
IMGUI_API int TableGetRowIndex()
IMGUI_API void SetColorEditOptions(ImGuiColorEditFlags flags)
IMGUI_API bool BeginTable(const char *str_id, int column, ImGuiTableFlags flags=0, const ImVec2 &outer_size=ImVec2(0.0f, 0.0f), float inner_width=0.0f)
IMGUI_API void EndFrame()
IMGUI_API ImVec2 GetItemRectMin()
IMGUI_API bool IsWindowCollapsed()
IMGUI_API bool IsMouseDown(ImGuiMouseButton button)
IMGUI_API void LogToClipboard(int auto_open_depth=-1)
IMGUI_API bool IsWindowAppearing()
IMGUI_API void SetNextWindowPos(const ImVec2 &pos, ImGuiCond cond=0, const ImVec2 &pivot=ImVec2(0, 0))
IMGUI_API void StyleColorsDark(ImGuiStyle *dst=NULL)
IMGUI_API bool DragInt4(const char *label, int v[4], float v_speed=1.0f, int v_min=0, int v_max=0, const char *format="%d", ImGuiSliderFlags flags=0)
IMGUI_API void BeginGroup()
IMGUI_API float GetColumnOffset(int column_index=-1)
IMGUI_API void PopTextWrapPos()
IMGUI_API void SaveIniSettingsToDisk(const char *ini_filename)
IMGUI_API void SetTooltip(const char *fmt,...) IM_FMTARGS(1)
IMGUI_API void SetNextWindowBgAlpha(float alpha)
IMGUI_API void EndListBox()
IMGUI_API bool InputScalarN(const char *label, ImGuiDataType data_type, void *p_data, int components, const void *p_step=NULL, const void *p_step_fast=NULL, const char *format=NULL, ImGuiInputTextFlags flags=0)
IMGUI_API void Text(const char *fmt,...) IM_FMTARGS(1)
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)
IMGUI_API void Dummy(const ImVec2 &size)
IMGUI_API bool TextHyperLink(const char *label, bool underlineWhenHoveredOnly=false)
IMGUI_API void ShowAboutWindow(bool *p_open=NULL)
IMGUI_API void SetScrollHereY(float center_y_ratio=0.5f)
IMGUI_API void LogTextV(const char *fmt, va_list args) IM_FMTLIST(1)
IMGUI_API ImVec2 GetWindowPos()
IMGUI_API void SetKeyboardFocusHere(int offset=0)
IMGUI_API void ColorConvertHSVtoRGB(float h, float s, float v, float &out_r, float &out_g, float &out_b)
IMGUI_API void SetNextWindowFocus()
IMGUI_API bool Checkbox(const char *label, bool *v)
IMGUI_API void ProgressBar(float fraction, const ImVec2 &size_arg=ImVec2(-FLT_MIN, 0), const char *overlay=NULL)
IMGUI_API ImDrawListSharedData * GetDrawListSharedData()
IMGUI_API bool InputInt2(const char *label, int v[2], ImGuiInputTextFlags flags=0)
IMGUI_API void EndCombo()
IMGUI_API void PushID(const char *str_id)
ImVec4 Value
Definition imgui.h:2371
constexpr ImColor(const ImVec4 &col)
Definition imgui.h:2375
ImColor(int r, int g, int b, int a=255)
Definition imgui.h:2376
static ImColor HSV(float h, float s, float v, float a=1.0f)
Definition imgui.h:2383
ImColor(ImU32 rgba)
Definition imgui.h:2377
constexpr ImColor(float r, float g, float b, float a=1.0f)
Definition imgui.h:2374
constexpr ImColor()
Definition imgui.h:2373
void SetHSV(float h, float s, float v, float a=1.0f)
Definition imgui.h:2382
ImVector< ImDrawCmd > _CmdBuffer
Definition imgui.h:2461
ImVector< ImDrawIdx > _IdxBuffer
Definition imgui.h:2462
ImTextureID TextureId
Definition imgui.h:2454
ImVec4 ClipRect
Definition imgui.h:2453
unsigned int VtxOffset
Definition imgui.h:2455
ImTextureID TextureId
Definition imgui.h:2421
unsigned int VtxOffset
Definition imgui.h:2422
ImVec4 ClipRect
Definition imgui.h:2420
ImTextureID GetTexID() const
Definition imgui.h:2431
unsigned int ElemCount
Definition imgui.h:2424
ImDrawCallback UserCallback
Definition imgui.h:2425
ImDrawCmd()
Definition imgui.h:2428
unsigned int IdxOffset
Definition imgui.h:2423
void * UserCallbackData
Definition imgui.h:2426
int TotalIdxCount
Definition imgui.h:2655
ImVec2 DisplayPos
Definition imgui.h:2658
ImVec2 DisplaySize
Definition imgui.h:2659
IMGUI_API void ScaleClipRects(const ImVec2 &fb_scale)
ImDrawData()
Definition imgui.h:2663
ImDrawList ** CmdLists
Definition imgui.h:2657
void Clear()
Definition imgui.h:2664
bool Valid
Definition imgui.h:2653
ImVec2 FramebufferScale
Definition imgui.h:2660
int CmdListsCount
Definition imgui.h:2654
int TotalVtxCount
Definition imgui.h:2656
IMGUI_API void DeIndexAllBuffers()
IMGUI_API void AddNgonFilled(const ImVec2 &center, float radius, ImU32 col, int num_segments)
IMGUI_API void _PopUnusedDrawCmd()
IMGUI_API void AddCallback(ImDrawCallback callback, void *callback_data)
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)
IMGUI_API void AddConvexPolyFilled(const ImVec2 *points, int num_points, ImU32 col)
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)
IMGUI_API void _ClearFreeMemory()
IMGUI_API void _TryMergeDrawCmds()
IMGUI_API void AddQuadFilled(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, const ImVec2 &p4, ImU32 col)
IMGUI_API void PathBezierQuadraticCurveTo(const ImVec2 &p2, const ImVec2 &p3, int num_segments=0)
~ImDrawList()
Definition imgui.h:2547
IMGUI_API void AddTriangleFilled(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, ImU32 col)
unsigned int _VtxCurrentIdx
Definition imgui.h:2532
ImDrawListSplitter _Splitter
Definition imgui.h:2541
IMGUI_API void AddBezierQuadratic(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, ImU32 col, float thickness, int num_segments=0)
void ChannelsMerge()
Definition imgui.h:2615
IMGUI_API void PathArcToFast(const ImVec2 &center, float radius, int a_min_of_12, int a_max_of_12)
IMGUI_API void PrimRect(const ImVec2 &a, const ImVec2 &b, ImU32 col)
IMGUI_API void AddCircle(const ImVec2 &center, float radius, ImU32 col, int num_segments=0, float thickness=1.0f)
IMGUI_API void PushClipRect(const ImVec2 &clip_rect_min, const ImVec2 &clip_rect_max, bool intersect_with_current_clip_rect=false)
IMGUI_API void AddBezierCubic(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, const ImVec2 &p4, ImU32 col, float thickness, int num_segments=0)
void PrimVtx(const ImVec2 &pos, const ImVec2 &uv, ImU32 col)
Definition imgui.h:2628
void PrimWriteIdx(ImDrawIdx idx)
Definition imgui.h:2627
IMGUI_API void _OnChangedVtxOffset()
IMGUI_API void PushClipRectFullScreen()
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)
IMGUI_API void PrimReserve(int idx_count, int vtx_count)
IMGUI_API void PrimUnreserve(int idx_count, int vtx_count)
IMGUI_API void PathBezierCubicCurveTo(const ImVec2 &p2, const ImVec2 &p3, const ImVec2 &p4, int num_segments=0)
IMGUI_API void AddDrawCmd()
ImVector< ImVec2 > _Path
Definition imgui.h:2539
const ImDrawListSharedData * _Data
Definition imgui.h:2533
void PathStroke(ImU32 col, ImDrawFlags flags=0, float thickness=1.0f)
Definition imgui.h:2596
const char * _OwnerName
Definition imgui.h:2534
IMGUI_API ImDrawList * CloneOutput() const
ImVector< ImDrawCmd > CmdBuffer
Definition imgui.h:2526
ImDrawVert * _VtxWritePtr
Definition imgui.h:2535
IMGUI_API void _PathArcToN(const ImVec2 &center, float radius, float a_min, float a_max, int num_segments)
IMGUI_API void AddTriangle(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, ImU32 col, float thickness=1.0f)
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)
IMGUI_API void PopClipRect()
ImDrawIdx * _IdxWritePtr
Definition imgui.h:2536
IMGUI_API void AddRectFilled(const ImVec2 &p_min, const ImVec2 &p_max, ImU32 col, float rounding=0.0f, ImDrawFlags flags=0)
IMGUI_API void AddLine(const ImVec2 &p1, const ImVec2 &p2, ImU32 col, float thickness=1.0f)
IMGUI_API void _OnChangedClipRect()
ImDrawList(const ImDrawListSharedData *shared_data)
Definition imgui.h:2545
void PathLineTo(const ImVec2 &pos)
Definition imgui.h:2593
IMGUI_API void PushTextureID(ImTextureID texture_id)
ImVector< ImTextureID > _TextureIdStack
Definition imgui.h:2538
ImDrawCmdHeader _CmdHeader
Definition imgui.h:2540
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)
ImVec2 GetClipRectMax() const
Definition imgui.h:2554
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)
void PathBezierCurveTo(const ImVec2 &p2, const ImVec2 &p3, const ImVec2 &p4, int num_segments=0)
Definition imgui.h:2632
ImVec2 GetClipRectMin() const
Definition imgui.h:2553
IMGUI_API void _OnChangedTextureID()
IMGUI_API void AddPolyline(const ImVec2 *points, int num_points, ImU32 col, ImDrawFlags flags, float thickness)
void PathLineToMergeDuplicate(const ImVec2 &pos)
Definition imgui.h:2594
float _FringeScale
Definition imgui.h:2542
ImVector< ImDrawVert > VtxBuffer
Definition imgui.h:2528
IMGUI_API int _CalcCircleAutoSegmentCount(float radius) const
void AddBezierCurve(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, const ImVec2 &p4, ImU32 col, float thickness, int num_segments=0)
Definition imgui.h:2631
void ChannelsSetCurrent(int n)
Definition imgui.h:2616
IMGUI_API void AddText(const ImVec2 &pos, ImU32 col, const char *text_begin, const char *text_end=NULL)
void ChannelsSplit(int count)
Definition imgui.h:2614
IMGUI_API void AddQuad(const ImVec2 &p1, const ImVec2 &p2, const ImVec2 &p3, const ImVec2 &p4, ImU32 col, float thickness=1.0f)
IMGUI_API void AddNgon(const ImVec2 &center, float radius, ImU32 col, int num_segments, float thickness=1.0f)
IMGUI_API void _ResetForNewFrame()
ImDrawListFlags Flags
Definition imgui.h:2529
IMGUI_API void PrimRectUV(const ImVec2 &a, const ImVec2 &b, const ImVec2 &uv_a, const ImVec2 &uv_b, ImU32 col)
ImVector< ImDrawIdx > IdxBuffer
Definition imgui.h:2527
IMGUI_API void PathRect(const ImVec2 &rect_min, const ImVec2 &rect_max, float rounding=0.0f, ImDrawFlags flags=0)
ImVector< ImVec4 > _ClipRectStack
Definition imgui.h:2537
void PathClear()
Definition imgui.h:2592
void PathFillConvex(ImU32 col)
Definition imgui.h:2595
IMGUI_API void _PathArcToFastEx(const ImVec2 &center, float radius, int a_min_sample, int a_max_sample, int a_step)
IMGUI_API void AddCircleFilled(const ImVec2 &center, float radius, ImU32 col, int num_segments=0)
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)
IMGUI_API void PathArcTo(const ImVec2 &center, float radius, float a_min, float a_max, int num_segments=0)
IMGUI_API void PopTextureID()
void PrimWriteVtx(const ImVec2 &pos, const ImVec2 &uv, ImU32 col)
Definition imgui.h:2626
IMGUI_API void ClearFreeMemory()
ImVector< ImDrawChannel > _Channels
Definition imgui.h:2472
IMGUI_API void Merge(ImDrawList *draw_list)
IMGUI_API void Split(ImDrawList *draw_list, int count)
IMGUI_API void SetCurrentChannel(ImDrawList *draw_list, int channel_idx)
ImU32 col
Definition imgui.h:2440
ImVec2 uv
Definition imgui.h:2439
ImVec2 pos
Definition imgui.h:2438
unsigned short X
Definition imgui.h:2732
unsigned int GlyphID
Definition imgui.h:2733
bool IsPacked() const
Definition imgui.h:2738
unsigned short Height
Definition imgui.h:2731
ImVector< ImFont * > Fonts
Definition imgui.h:2848
int PackIdLines
Definition imgui.h:2859
IMGUI_API const ImWchar * GetGlyphRangesCyrillic()
IMGUI_API void CalcCustomRectUV(const ImFontAtlasCustomRect *rect, ImVec2 *out_uv_min, ImVec2 *out_uv_max) const
bool IsBuilt() const
Definition imgui.h:2790
IMGUI_API void Clear()
IMGUI_API const ImWchar * GetGlyphRangesDefault()
ImTextureID TexID
Definition imgui.h:2833
bool Locked
Definition imgui.h:2836
IMGUI_API ImFont * AddFont(const ImFontConfig *font_cfg)
int TexWidth
Definition imgui.h:2844
IMGUI_API bool Build()
int TexGlyphPadding
Definition imgui.h:2835
unsigned int * TexPixelsRGBA32
Definition imgui.h:2843
const ImFontBuilderIO * FontBuilderIO
Definition imgui.h:2854
unsigned char * TexPixelsAlpha8
Definition imgui.h:2842
bool TexPixelsUseColors
Definition imgui.h:2841
IMGUI_API void ClearInputData()
int TexHeight
Definition imgui.h:2845
IMGUI_API const ImWchar * GetGlyphRangesChineseSimplifiedCommon()
IMGUI_API ImFont * AddFontFromMemoryCompressedBase85TTF(const char *compressed_font_data_base85, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
ImFontAtlasCustomRect * GetCustomRectByIndex(int index)
Definition imgui.h:2822
IMGUI_API const ImWchar * GetGlyphRangesChineseFull()
IMGUI_API void ClearFonts()
IMGUI_API const ImWchar * GetGlyphRangesThai()
IMGUI_API ImFont * AddFontFromMemoryCompressedTTF(const void *compressed_font_data, int compressed_font_size, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
IMGUI_API ~ImFontAtlas()
IMGUI_API ImFont * AddFontFromMemoryTTF(void *font_data, int font_size, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
void SetTexID(ImTextureID id)
Definition imgui.h:2791
IMGUI_API void ClearTexData()
bool TexReady
Definition imgui.h:2840
int TexDesiredWidth
Definition imgui.h:2834
IMGUI_API int AddCustomRectFontGlyph(ImFont *font, ImWchar id, int width, int height, float advance_x, const ImVec2 &offset=ImVec2(0, 0))
IMGUI_API int AddCustomRectRegular(int width, int height)
IMGUI_API const ImWchar * GetGlyphRangesJapanese()
IMGUI_API ImFont * AddFontDefault(const ImFontConfig *font_cfg=NULL)
IMGUI_API void GetTexDataAsRGBA32(unsigned char **out_pixels, int *out_width, int *out_height, int *out_bytes_per_pixel=NULL)
unsigned int FontBuilderFlags
Definition imgui.h:2855
ImVec2 TexUvScale
Definition imgui.h:2846
ImFontAtlasFlags Flags
Definition imgui.h:2832
ImVector< ImFontAtlasCustomRect > CustomRects
Definition imgui.h:2849
IMGUI_API void GetTexDataAsAlpha8(unsigned char **out_pixels, int *out_width, int *out_height, int *out_bytes_per_pixel=NULL)
IMGUI_API const ImWchar * GetGlyphRangesVietnamese()
ImVec2 TexUvWhitePixel
Definition imgui.h:2847
IMGUI_API bool GetMouseCursorTexData(ImGuiMouseCursor cursor, ImVec2 *out_offset, ImVec2 *out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2])
IMGUI_API ImFont * AddFontFromFileTTF(const char *filename, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
IMGUI_API const ImWchar * GetGlyphRangesKorean()
ImVector< ImFontConfig > ConfigData
Definition imgui.h:2850
IMGUI_API ImFontAtlas()
int PackIdMouseCursors
Definition imgui.h:2858
void * FontData
Definition imgui.h:2675
char Name[40]
Definition imgui.h:2694
unsigned int FontBuilderFlags
Definition imgui.h:2689
ImVec2 GlyphOffset
Definition imgui.h:2684
float SizePixels
Definition imgui.h:2679
float GlyphMinAdvanceX
Definition imgui.h:2686
int FontDataSize
Definition imgui.h:2676
ImFont * DstFont
Definition imgui.h:2695
bool PixelSnapH
Definition imgui.h:2682
int OversampleV
Definition imgui.h:2681
ImVec2 GlyphExtraSpacing
Definition imgui.h:2683
float RasterizerMultiply
Definition imgui.h:2690
bool FontDataOwnedByAtlas
Definition imgui.h:2677
const ImWchar * GlyphRanges
Definition imgui.h:2685
int OversampleH
Definition imgui.h:2680
bool MergeMode
Definition imgui.h:2688
IMGUI_API ImFontConfig()
ImWchar EllipsisChar
Definition imgui.h:2691
float GlyphMaxAdvanceX
Definition imgui.h:2687
float AdvanceX
Definition imgui.h:2707
float X0
Definition imgui.h:2708
unsigned int Codepoint
Definition imgui.h:2706
float U0
Definition imgui.h:2709
unsigned int Visible
Definition imgui.h:2705
unsigned int Colored
Definition imgui.h:2704
void SetBit(size_t n)
Definition imgui.h:2721
IMGUI_API void AddText(const char *text, const char *text_end=NULL)
bool GetBit(size_t n) const
Definition imgui.h:2720
void AddChar(ImWchar c)
Definition imgui.h:2722
IMGUI_API void AddRanges(const ImWchar *ranges)
ImVector< ImU32 > UsedChars
Definition imgui.h:2716
IMGUI_API void BuildRanges(ImVector< ImWchar > *out_ranges)
IMGUI_API void AddRemapChar(ImWchar dst, ImWchar src, bool overwrite_dst=true)
ImVector< ImWchar > IndexLookup
Definition imgui.h:2876
const ImFontGlyph * FallbackGlyph
Definition imgui.h:2878
ImVector< ImFontGlyph > Glyphs
Definition imgui.h:2877
IMGUI_API const ImFontGlyph * FindGlyphNoFallback(ImWchar c) const
bool DirtyLookupTables
Definition imgui.h:2887
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
IMGUI_API ~ImFont()
float FontSize
Definition imgui.h:2873
short ConfigDataCount
Definition imgui.h:2883
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
ImWchar EllipsisChar
Definition imgui.h:2885
const char * GetDebugName() const
Definition imgui.h:2900
float Ascent
Definition imgui.h:2889
ImWchar DotChar
Definition imgui.h:2886
IMGUI_API const ImFontGlyph * FindGlyph(ImWchar c) const
IMGUI_API void BuildLookupTable()
int MetricsTotalSurface
Definition imgui.h:2890
ImFontAtlas * ContainerAtlas
Definition imgui.h:2881
IMGUI_API const char * CalcWordWrapPositionA(float scale, const char *text, const char *text_end, float wrap_width) const
IMGUI_API void SetGlyphVisible(ImWchar c, bool visible)
bool IsLoaded() const
Definition imgui.h:2899
IMGUI_API ImFont()
float FallbackAdvanceX
Definition imgui.h:2872
IMGUI_API void ClearOutputData()
float GetCharAdvance(ImWchar c) const
Definition imgui.h:2898
IMGUI_API void RenderChar(ImDrawList *draw_list, float size, const ImVec2 &pos, ImU32 col, ImWchar c) const
ImWchar FallbackChar
Definition imgui.h:2884
float Scale
Definition imgui.h:2888
IMGUI_API void GrowIndex(int new_size)
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)
IMGUI_API bool IsGlyphRangeUnused(unsigned int c_begin, unsigned int c_last)
ImVector< float > IndexAdvanceX
Definition imgui.h:2871
const ImFontConfig * ConfigData
Definition imgui.h:2882
ImVec2 DisplaySize
Definition imgui.h:1931
bool WantCaptureMouseUnlessPopupClose
Definition imgui.h:2054
bool WantTextInput
Definition imgui.h:2014
IMGUI_API void AddMouseButtonEvent(int button, bool down)
ImVec2 MousePosPrev
Definition imgui.h:2055
ImFont * FontDefault
Definition imgui.h:1946
float MouseDoubleClickMaxDist
Definition imgui.h:1937
void * ClipboardUserData
Definition imgui.h:1975
bool ConfigWindowsMoveFromTitleBarOnly
Definition imgui.h:1956
int MetricsRenderIndices
Definition imgui.h:2021
IMGUI_API ImGuiIO()
bool KeyAlt
Definition imgui.h:2047
int MetricsActiveAllocations
Definition imgui.h:2024
float MouseWheel
Definition imgui.h:2043
ImFontAtlas * Fonts
Definition imgui.h:1943
float MouseWheelH
Definition imgui.h:2044
IMGUI_API void ClearInputKeys()
float KeyRepeatDelay
Definition imgui.h:1939
bool KeyShift
Definition imgui.h:2046
IMGUI_API void AddMousePosEvent(float x, float y)
bool WantCaptureKeyboard
Definition imgui.h:2013
ImWchar16 InputQueueSurrogate
Definition imgui.h:2075
ImVector< ImWchar > InputQueueCharacters
Definition imgui.h:2076
float DeltaTime
Definition imgui.h:1932
bool KeyCtrl
Definition imgui.h:2045
const char * BackendPlatformName
Definition imgui.h:1965
ImVec2 MouseDelta
Definition imgui.h:2025
ImGuiConfigFlags ConfigFlags
Definition imgui.h:1929
bool WantSaveIniSettings
Definition imgui.h:2016
void * BackendPlatformUserData
Definition imgui.h:1967
IMGUI_API void SetAppAcceptingEvents(bool accepting_events)
bool AppFocusLost
Definition imgui.h:2071
IMGUI_API void AddKeyEvent(ImGuiKey key, bool down)
ImVec2 DisplayFramebufferScale
Definition imgui.h:1947
ImS8 BackendUsingLegacyKeyArrays
Definition imgui.h:2073
IMGUI_API void AddMouseWheelEvent(float wh_x, float wh_y)
float FontGlobalScale
Definition imgui.h:1944
IMGUI_API void AddInputCharacterUTF16(ImWchar16 c)
IMGUI_API void AddInputCharactersUTF8(const char *str)
bool WantSetMousePos
Definition imgui.h:2015
const char * IniFilename
Definition imgui.h:1934
void * ImeWindowHandle
Definition imgui.h:1981
void * UserData
Definition imgui.h:1941
float Framerate
Definition imgui.h:2019
int MetricsRenderVertices
Definition imgui.h:2020
bool ConfigDragClickToInputText
Definition imgui.h:1954
bool NavVisible
Definition imgui.h:2018
ImGuiBackendFlags BackendFlags
Definition imgui.h:1930
IMGUI_API void AddInputCharacter(unsigned int c)
bool MouseDrawCursor
Definition imgui.h:1950
float IniSavingRate
Definition imgui.h:1933
void * BackendRendererUserData
Definition imgui.h:1968
IMGUI_API void AddFocusEvent(bool focused)
bool NavActive
Definition imgui.h:2017
bool BackendUsingLegacyNavInputArray
Definition imgui.h:2074
bool ConfigWindowsResizeFromEdges
Definition imgui.h:1955
ImGuiModFlags KeyMods
Definition imgui.h:2052
bool AppAcceptingEvents
Definition imgui.h:2072
bool ConfigMacOSXBehaviors
Definition imgui.h:1951
IMGUI_API void ClearInputCharacters()
IMGUI_API void SetKeyEventNativeData(ImGuiKey key, int native_keycode, int native_scancode, int native_legacy_index=-1)
float KeyRepeatRate
Definition imgui.h:1940
const char * BackendRendererName
Definition imgui.h:1966
bool ConfigInputTextCursorBlink
Definition imgui.h:1953
ImVec2 MousePos
Definition imgui.h:2041
void * BackendLanguageUserData
Definition imgui.h:1969
float MouseDragThreshold
Definition imgui.h:1938
float PenPressure
Definition imgui.h:2070
IMGUI_API void AddKeyAnalogEvent(ImGuiKey key, bool down, float v)
int MetricsActiveWindows
Definition imgui.h:2023
const char * LogFilename
Definition imgui.h:1935
int MetricsRenderWindows
Definition imgui.h:2022
float ConfigMemoryCompactTimer
Definition imgui.h:1957
float MouseDoubleClickTime
Definition imgui.h:1936
bool ConfigInputTrickleEventQueue
Definition imgui.h:1952
bool WantCaptureMouse
Definition imgui.h:2012
bool FontAllowUserScaling
Definition imgui.h:1945
bool KeySuper
Definition imgui.h:2048
ImGuiInputTextFlags EventFlag
Definition imgui.h:2096
IMGUI_API void DeleteChars(int pos, int bytes_count)
ImGuiInputTextFlags Flags
Definition imgui.h:2097
bool HasSelection() const
Definition imgui.h:2120
IMGUI_API void InsertChars(int pos, const char *text, const char *text_end=NULL)
IMGUI_API ImGuiInputTextCallbackData()
bool Down
Definition imgui.h:1917
float DownDurationPrev
Definition imgui.h:1919
float DownDuration
Definition imgui.h:1918
float AnalogValue
Definition imgui.h:1920
IMGUI_API ImGuiListClipper()
float ItemsHeight
Definition imgui.h:2323
IMGUI_API void End()
void * TempData
Definition imgui.h:2325
IMGUI_API void Begin(int items_count, float items_height=-1.0f)
IMGUI_API bool Step()
ImGuiListClipper(int items_count, float items_height=-1.0f)
Definition imgui.h:2339
IMGUI_API ~ImGuiListClipper()
IMGUI_API void ForceDisplayRangeByIndices(int item_min, int item_max)
float StartPosY
Definition imgui.h:2324
ImGuiID SourceParentId
Definition imgui.h:2142
bool Preview
Definition imgui.h:2145
bool IsPreview() const
Definition imgui.h:2151
bool Delivery
Definition imgui.h:2146
int DataSize
Definition imgui.h:2138
bool IsDataType(const char *type) const
Definition imgui.h:2150
void Clear()
Definition imgui.h:2149
ImGuiID SourceId
Definition imgui.h:2141
int DataFrameCount
Definition imgui.h:2143
bool IsDelivery() const
Definition imgui.h:2152
void * Data
Definition imgui.h:2137
ImGuiStoragePair(ImGuiID _key, void *_val_p)
Definition imgui.h:2264
ImGuiStoragePair(ImGuiID _key, int _val_i)
Definition imgui.h:2262
ImGuiStoragePair(ImGuiID _key, float _val_f)
Definition imgui.h:2263
IMGUI_API void SetFloat(ImGuiID key, float val)
IMGUI_API void * GetVoidPtr(ImGuiID key) const
IMGUI_API void SetBool(ImGuiID key, bool val)
IMGUI_API float * GetFloatRef(ImGuiID key, float default_val=0.0f)
IMGUI_API void SetVoidPtr(ImGuiID key, void *val)
IMGUI_API bool GetBool(ImGuiID key, bool default_val=false) const
IMGUI_API void SetInt(ImGuiID key, int val)
ImVector< ImGuiStoragePair > Data
Definition imgui.h:2267
IMGUI_API void SetAllInt(int val)
void Clear()
Definition imgui.h:2272
IMGUI_API float GetFloat(ImGuiID key, float default_val=0.0f) const
IMGUI_API int * GetIntRef(ImGuiID key, int default_val=0)
IMGUI_API void ** GetVoidPtrRef(ImGuiID key, void *default_val=NULL)
IMGUI_API bool * GetBoolRef(ImGuiID key, bool default_val=false)
IMGUI_API void BuildSortByKey()
IMGUI_API int GetInt(ImGuiID key, int default_val=0) const
float ScrollbarRounding
Definition imgui.h:1882
bool AntiAliasedLines
Definition imgui.h:1895
float GrabMinSize
Definition imgui.h:1883
ImVec2 WindowMinSize
Definition imgui.h:1865
float FrameRounding
Definition imgui.h:1873
ImVec2 ButtonTextAlign
Definition imgui.h:1890
ImVec2 ItemInnerSpacing
Definition imgui.h:1876
bool AntiAliasedFill
Definition imgui.h:1897
float FrameBorderSize
Definition imgui.h:1874
float TabRounding
Definition imgui.h:1886
IMGUI_API ImGuiStyle()
float TabBorderSize
Definition imgui.h:1887
float IndentSpacing
Definition imgui.h:1879
ImVec2 WindowPadding
Definition imgui.h:1862
ImVec2 WindowTitleAlign
Definition imgui.h:1866
float CurveTessellationTol
Definition imgui.h:1898
float GrabRounding
Definition imgui.h:1884
float PopupRounding
Definition imgui.h:1870
float WindowBorderSize
Definition imgui.h:1864
IMGUI_API void ScaleAllSizes(float scale_factor)
float ChildBorderSize
Definition imgui.h:1869
float MouseCursorScale
Definition imgui.h:1894
ImGuiDir ColorButtonPosition
Definition imgui.h:1889
ImVec2 ItemSpacing
Definition imgui.h:1875
float LogSliderDeadzone
Definition imgui.h:1885
ImVec2 DisplaySafeAreaPadding
Definition imgui.h:1893
float ColumnsMinSpacing
Definition imgui.h:1880
float ScrollbarSize
Definition imgui.h:1881
float Alpha
Definition imgui.h:1860
ImVec2 CellPadding
Definition imgui.h:1877
ImVec2 DisplayWindowPadding
Definition imgui.h:1892
ImVec2 TouchExtraPadding
Definition imgui.h:1878
ImGuiDir WindowMenuButtonPosition
Definition imgui.h:1867
float ChildRounding
Definition imgui.h:1868
float PopupBorderSize
Definition imgui.h:1871
float DisabledAlpha
Definition imgui.h:1861
float CircleTessellationMaxError
Definition imgui.h:1899
bool AntiAliasedLinesUseTex
Definition imgui.h:1896
float WindowRounding
Definition imgui.h:1863
float TabMinWidthForCloseButton
Definition imgui.h:1888
ImVec2 SelectableTextAlign
Definition imgui.h:1891
ImVec2 FramePadding
Definition imgui.h:1872
ImGuiSortDirection SortDirection
Definition imgui.h:2161
const ImGuiTableColumnSortSpecs * Specs
Definition imgui.h:2172
IMGUI_API void append(const char *str, const char *str_end=NULL)
char operator[](int i) const
Definition imgui.h:2234
int size() const
Definition imgui.h:2237
void reserve(int capacity)
Definition imgui.h:2240
const char * end() const
Definition imgui.h:2236
void clear()
Definition imgui.h:2239
ImVector< char > Buf
Definition imgui.h:2230
const char * c_str() const
Definition imgui.h:2241
IMGUI_API void appendf(const char *fmt,...) IM_FMTARGS(2)
const char * begin() const
Definition imgui.h:2235
bool empty() const
Definition imgui.h:2238
IMGUI_API void split(char separator, ImVector< ImGuiTextRange > *out) const
ImGuiTextRange(const char *_b, const char *_e)
Definition imgui.h:2217
ImVector< ImGuiTextRange > Filters
Definition imgui.h:2222
bool IsActive() const
Definition imgui.h:2208
IMGUI_API bool Draw(const char *label="Filter (inc,-exc)", float width=0.0f)
void Clear()
Definition imgui.h:2207
IMGUI_API bool PassFilter(const char *text, const char *text_end=NULL) const
IMGUI_API void Build()
IMGUI_API ImGuiTextFilter(const char *default_filter="")
ImGuiViewportFlags Flags
Definition imgui.h:2941
ImVec2 Pos
Definition imgui.h:2942
ImVec2 GetWorkCenter() const
Definition imgui.h:2954
ImVec2 WorkPos
Definition imgui.h:2944
void * PlatformHandleRaw
Definition imgui.h:2948
ImVec2 Size
Definition imgui.h:2943
ImVec2 WorkSize
Definition imgui.h:2945
ImVec2 GetCenter() const
Definition imgui.h:2953
float y
Definition imgui.h:268
float x
Definition imgui.h:268
constexpr ImVec2()
Definition imgui.h:269
float operator[](size_t idx) const
Definition imgui.h:271
constexpr ImVec2(float _x, float _y)
Definition imgui.h:270
float x
Definition imgui.h:281
constexpr ImVec4()
Definition imgui.h:282
float y
Definition imgui.h:281
float z
Definition imgui.h:281
constexpr ImVec4(float _x, float _y, float _z, float _w)
Definition imgui.h:283
float w
Definition imgui.h:281
bool find_erase_unsorted(const T &v)
Definition imgui.h:1845
value_type * iterator
Definition imgui.h:1795
void reserve(int new_capacity)
Definition imgui.h:1830
void push_front(const T &v)
Definition imgui.h:1836
const T & operator[](int i) const
Definition imgui.h:1814
const T * begin() const
Definition imgui.h:1817
const T * find(const T &v) const
Definition imgui.h:1843
T * end()
Definition imgui.h:1818
T & back()
Definition imgui.h:1822
bool contains(const T &v) const
Definition imgui.h:1841
T * erase(const T *it)
Definition imgui.h:1837
const value_type * const_iterator
Definition imgui.h:1796
int _grow_capacity(int sz) const
Definition imgui.h:1826
void pop_back()
Definition imgui.h:1835
int index_from_ptr(const T *it) const
Definition imgui.h:1846
T * find(const T &v)
Definition imgui.h:1842
void reserve_discard(int new_capacity)
Definition imgui.h:1831
const T * end() const
Definition imgui.h:1819
bool find_erase(const T &v)
Definition imgui.h:1844
T * insert(const T *it, const T &v)
Definition imgui.h:1840
ImVector()
Definition imgui.h:1799
T & front()
Definition imgui.h:1820
int max_size() const
Definition imgui.h:1811
ImVector(const ImVector< T > &src)
Definition imgui.h:1800
const T & front() const
Definition imgui.h:1821
T value_type
Definition imgui.h:1794
T * erase_unsorted(const T *it)
Definition imgui.h:1839
int size() const
Definition imgui.h:1809
void shrink(int new_size)
Definition imgui.h:1829
T * erase(const T *it, const T *it_last)
Definition imgui.h:1838
~ImVector()
Definition imgui.h:1802
bool empty() const
Definition imgui.h:1808
ImVector< T > & operator=(const ImVector< T > &src)
Definition imgui.h:1801
void push_back(const T &v)
Definition imgui.h:1834
const T & back() const
Definition imgui.h:1823
T * begin()
Definition imgui.h:1816
int Size
Definition imgui.h:1789
int Capacity
Definition imgui.h:1790
void resize(int new_size, const T &v)
Definition imgui.h:1828
T * Data
Definition imgui.h:1791
int capacity() const
Definition imgui.h:1812
void clear_destruct()
Definition imgui.h:1806
void resize(int new_size)
Definition imgui.h:1827
int size_in_bytes() const
Definition imgui.h:1810
void clear()
Definition imgui.h:1804
T & operator[](int i)
Definition imgui.h:1813
void clear_delete()
Definition imgui.h:1805
void swap(ImVector< T > &rhs)
Definition imgui.h:1824