1// dear imgui, v1.91.6
2// (main code and documentation)
3
4// Help:
5// - See links below.
6// - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that.
7// - Read top of imgui.cpp for more details, links and comments.
8
9// Resources:
10// - FAQ ........................ https://dearimgui.com/faq (in repository as docs/FAQ.md)
11// - Homepage ................... https://github.com/ocornut/imgui
12// - Releases & changelog ....... https://github.com/ocornut/imgui/releases
13// - Gallery .................... https://github.com/ocornut/imgui/issues?q=label%3Agallery (please post your screenshots/video there!)
14// - Wiki ....................... https://github.com/ocornut/imgui/wiki (lots of good stuff there)
15// - Getting Started https://github.com/ocornut/imgui/wiki/Getting-Started (how to integrate in an existing app by adding ~25 lines of code)
16// - Third-party Extensions https://github.com/ocornut/imgui/wiki/Useful-Extensions (ImPlot & many more)
17// - Bindings/Backends https://github.com/ocornut/imgui/wiki/Bindings (language bindings, backends for various tech/engines)
18// - Glossary https://github.com/ocornut/imgui/wiki/Glossary
19// - Debug Tools https://github.com/ocornut/imgui/wiki/Debug-Tools
20// - Software using Dear ImGui https://github.com/ocornut/imgui/wiki/Software-using-dear-imgui
21// - Issues & support ........... https://github.com/ocornut/imgui/issues
22// - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps)
23
24// For first-time users having issues compiling/linking/running/loading fonts:
25// please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above.
26// Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there.
27
28// Copyright (c) 2014-2024 Omar Cornut
29// Developed by Omar Cornut and every direct or indirect contributors to the GitHub.
30// See LICENSE.txt for copyright and licensing details (standard MIT License).
31// This library is free but needs your support to sustain development and maintenance.
32// Businesses: you can support continued development via B2B invoiced technical support, maintenance and sponsoring contracts.
33// PLEASE reach out at omar AT dearimgui DOT com. See https://github.com/ocornut/imgui/wiki/Funding
34// Businesses: you can also purchase licenses for the Dear ImGui Automation/Test Engine.
35
36// It is recommended that you don't modify imgui.cpp! It will become difficult for you to update the library.
37// Note that 'ImGui::' being a namespace, you can add functions into the namespace from your own source files, without
38// modifying imgui.h or imgui.cpp. You may include imgui_internal.h to access internal data structures, but it doesn't
39// come with any guarantee of forward compatibility. Discussing your changes on the GitHub Issue Tracker may lead you
40// to a better solution or official support for them.
41
42/*
43
44Index of this file:
45
46DOCUMENTATION
47
48- MISSION STATEMENT
49- CONTROLS GUIDE
50- PROGRAMMER GUIDE
51 - READ FIRST
52 - HOW TO UPDATE TO A NEWER VERSION OF DEAR IMGUI
53 - GETTING STARTED WITH INTEGRATING DEAR IMGUI IN YOUR CODE/ENGINE
54 - HOW A SIMPLE APPLICATION MAY LOOK LIKE
55 - HOW A SIMPLE RENDERING FUNCTION MAY LOOK LIKE
56- API BREAKING CHANGES (read me when you update!)
57- FREQUENTLY ASKED QUESTIONS (FAQ)
58 - Read all answers online: https://www.dearimgui.com/faq, or in docs/FAQ.md (with a Markdown viewer)
59
60CODE
61(search for "[SECTION]" in the code to find them)
62
63// [SECTION] INCLUDES
64// [SECTION] FORWARD DECLARATIONS
65// [SECTION] CONTEXT AND MEMORY ALLOCATORS
66// [SECTION] USER FACING STRUCTURES (ImGuiStyle, ImGuiIO, ImGuiPlatformIO)
67// [SECTION] MISC HELPERS/UTILITIES (Geometry functions)
68// [SECTION] MISC HELPERS/UTILITIES (String, Format, Hash functions)
69// [SECTION] MISC HELPERS/UTILITIES (File functions)
70// [SECTION] MISC HELPERS/UTILITIES (ImText* functions)
71// [SECTION] MISC HELPERS/UTILITIES (Color functions)
72// [SECTION] ImGuiStorage
73// [SECTION] ImGuiTextFilter
74// [SECTION] ImGuiTextBuffer, ImGuiTextIndex
75// [SECTION] ImGuiListClipper
76// [SECTION] STYLING
77// [SECTION] RENDER HELPERS
78// [SECTION] INITIALIZATION, SHUTDOWN
79// [SECTION] MAIN CODE (most of the code! lots of stuff, needs tidying up!)
80// [SECTION] ID STACK
81// [SECTION] INPUTS
82// [SECTION] ERROR CHECKING, STATE RECOVERY
83// [SECTION] ITEM SUBMISSION
84// [SECTION] LAYOUT
85// [SECTION] SCROLLING
86// [SECTION] TOOLTIPS
87// [SECTION] POPUPS
88// [SECTION] KEYBOARD/GAMEPAD NAVIGATION
89// [SECTION] DRAG AND DROP
90// [SECTION] LOGGING/CAPTURING
91// [SECTION] SETTINGS
92// [SECTION] LOCALIZATION
93// [SECTION] VIEWPORTS, PLATFORM WINDOWS
94// [SECTION] DOCKING
95// [SECTION] PLATFORM DEPENDENT HELPERS
96// [SECTION] METRICS/DEBUGGER WINDOW
97// [SECTION] DEBUG LOG WINDOW
98// [SECTION] OTHER DEBUG TOOLS (ITEM PICKER, ID STACK TOOL)
99
100*/
101
102//-----------------------------------------------------------------------------
103// DOCUMENTATION
104//-----------------------------------------------------------------------------
105
106/*
107
108 MISSION STATEMENT
109 =================
110
111 - Easy to use to create code-driven and data-driven tools.
112 - Easy to use to create ad hoc short-lived tools and long-lived, more elaborate tools.
113 - Easy to hack and improve.
114 - Minimize setup and maintenance.
115 - Minimize state storage on user side.
116 - Minimize state synchronization.
117 - Portable, minimize dependencies, run on target (consoles, phones, etc.).
118 - Efficient runtime and memory consumption.
119
120 Designed primarily for developers and content-creators, not the typical end-user!
121 Some of the current weaknesses (which we aim to address in the future) includes:
122
123 - Doesn't look fancy.
124 - Limited layout features, intricate layouts are typically crafted in code.
125
126
127 CONTROLS GUIDE
128 ==============
129
130 - MOUSE CONTROLS
131 - Mouse wheel: Scroll vertically.
132 - SHIFT+Mouse wheel: Scroll horizontally.
133 - Click [X]: Close a window, available when 'bool* p_open' is passed to ImGui::Begin().
134 - Click ^, Double-Click title: Collapse window.
135 - Drag on corner/border: Resize window (double-click to auto fit window to its contents).
136 - Drag on any empty space: Move window (unless io.ConfigWindowsMoveFromTitleBarOnly = true).
137 - Left-click outside popup: Close popup stack (right-click over underlying popup: Partially close popup stack).
138
139 - TEXT EDITOR
140 - Hold SHIFT or Drag Mouse: Select text.
141 - CTRL+Left/Right: Word jump.
142 - CTRL+Shift+Left/Right: Select words.
143 - CTRL+A or Double-Click: Select All.
144 - CTRL+X, CTRL+C, CTRL+V: Use OS clipboard.
145 - CTRL+Z, CTRL+Y: Undo, Redo.
146 - ESCAPE: Revert text to its original value.
147 - On OSX, controls are automatically adjusted to match standard OSX text editing 2ts and behaviors.
148
149 - KEYBOARD CONTROLS
150 - Basic:
151 - Tab, SHIFT+Tab Cycle through text editable fields.
152 - CTRL+Tab, CTRL+Shift+Tab Cycle through windows.
153 - CTRL+Click Input text into a Slider or Drag widget.
154 - Extended features with `io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard`:
155 - Tab, SHIFT+Tab: Cycle through every items.
156 - Arrow keys Move through items using directional navigation. Tweak value.
157 - Arrow keys + Alt, Shift Tweak slower, tweak faster (when using arrow keys).
158 - Enter Activate item (prefer text input when possible).
159 - Space Activate item (prefer tweaking with arrows when possible).
160 - Escape Deactivate item, leave child window, close popup.
161 - Page Up, Page Down Previous page, next page.
162 - Home, End Scroll to top, scroll to bottom.
163 - Alt Toggle between scrolling layer and menu layer.
164 - CTRL+Tab then Ctrl+Arrows Move window. Hold SHIFT to resize instead of moving.
165 - Output when ImGuiConfigFlags_NavEnableKeyboard set,
166 - io.WantCaptureKeyboard flag is set when keyboard is claimed.
167 - io.NavActive: true when a window is focused and it doesn't have the ImGuiWindowFlags_NoNavInputs flag set.
168 - io.NavVisible: true when the navigation cursor is visible (usually goes to back false when mouse is used).
169
170 - GAMEPAD CONTROLS
171 - Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
172 - Particularly useful to use Dear ImGui on a console system (e.g. PlayStation, Switch, Xbox) without a mouse!
173 - Download controller mapping PNG/PSD at http://dearimgui.com/controls_sheets
174 - Backend support: backend needs to:
175 - Set 'io.BackendFlags |= ImGuiBackendFlags_HasGamepad' + call io.AddKeyEvent/AddKeyAnalogEvent() with ImGuiKey_Gamepad_XXX keys.
176 - For analog values (0.0f to 1.0f), backend is responsible to handling a dead-zone and rescaling inputs accordingly.
177 Backend code will probably need to transform your raw inputs (such as e.g. remapping your 0.2..0.9 raw input range to 0.0..1.0 imgui range, etc.).
178 - If you need to share inputs between your game and the Dear ImGui interface, the easiest approach is to go all-or-nothing,
179 with a buttons combo to toggle the target. Please reach out if you think the game vs navigation input sharing could be improved.
180
181 - REMOTE INPUTS SHARING & MOUSE EMULATION
182 - PS4/PS5 users: Consider emulating a mouse cursor with DualShock touch pad or a spare analog stick as a mouse-emulation fallback.
183 - Consoles/Tablet/Phone users: Consider using a Synergy 1.x server (on your PC) + run examples/libs/synergy/uSynergy.c (on your console/tablet/phone app)
184 in order to share your PC mouse/keyboard.
185 - See https://github.com/ocornut/imgui/wiki/Useful-Extensions#remoting for other remoting solutions.
186 - On a TV/console system where readability may be lower or mouse inputs may be awkward, you may want to set the io.ConfigNavMoveSetMousePos flag.
187 Enabling io.ConfigNavMoveSetMousePos + ImGuiBackendFlags_HasSetMousePos instructs Dear ImGui to move your mouse cursor along with navigation movements.
188 When enabled, the NewFrame() function may alter 'io.MousePos' and set 'io.WantSetMousePos' to notify you that it wants the mouse cursor to be moved.
189 When that happens your backend NEEDS to move the OS or underlying mouse cursor on the next frame. Some of the backends in examples/ do that.
190 (If you set the NavEnableSetMousePos flag but don't honor 'io.WantSetMousePos' properly, Dear ImGui will misbehave as it will see your mouse moving back & forth!)
191 (In a setup when you may not have easy control over the mouse cursor, e.g. uSynergy.c doesn't expose moving remote mouse cursor, you may want
192 to set a boolean to ignore your other external mouse positions until the external source is moved again.)
193
194
195 PROGRAMMER GUIDE
196 ================
197
198 READ FIRST
199 ----------
200 - Remember to check the wonderful Wiki (https://github.com/ocornut/imgui/wiki)
201 - Your code creates the UI every frame of your application loop, if your code doesn't run the UI is gone!
202 The UI can be highly dynamic, there are no construction or destruction steps, less superfluous
203 data retention on your side, less state duplication, less state synchronization, fewer bugs.
204 - Call and read ImGui::ShowDemoWindow() for demo code demonstrating most features.
205 Or browse https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html for interactive web version.
206 - The library is designed to be built from sources. Avoid pre-compiled binaries and packaged versions. See imconfig.h to configure your build.
207 - Dear ImGui is an implementation of the IMGUI paradigm (immediate-mode graphical user interface, a term coined by Casey Muratori).
208 You can learn about IMGUI principles at http://www.johno.se/book/imgui.html, http://mollyrocket.com/861 & more links in Wiki.
209 - Dear ImGui is a "single pass" rasterizing implementation of the IMGUI paradigm, aimed at ease of use and high-performances.
210 For every application frame, your UI code will be called only once. This is in contrast to e.g. Unity's implementation of an IMGUI,
211 where the UI code is called multiple times ("multiple passes") from a single entry point. There are pros and cons to both approaches.
212 - Our origin is on the top-left. In axis aligned bounding boxes, Min = top-left, Max = bottom-right.
213 - Please make sure you have asserts enabled (IM_ASSERT redirects to assert() by default, but can be redirected).
214 If you get an assert, read the messages and comments around the assert.
215 - This codebase aims to be highly optimized:
216 - A typical idle frame should never call malloc/free.
217 - We rely on a maximum of constant-time or O(N) algorithms. Limiting searches/scans as much as possible.
218 - We put particular energy in making sure performances are decent with typical "Debug" build settings as well.
219 Which mean we tend to avoid over-relying on "zero-cost abstraction" as they aren't zero-cost at all.
220 - This codebase aims to be both highly opinionated and highly flexible:
221 - This code works because of the things it choose to solve or not solve.
222 - C++: this is a pragmatic C-ish codebase: we don't use fancy C++ features, we don't include C++ headers,
223 and ImGui:: is a namespace. We rarely use member functions (and when we did, I am mostly regretting it now).
224 This is to increase compatibility, increase maintainability and facilitate use from other languages.
225 - C++: ImVec2/ImVec4 do not expose math operators by default, because it is expected that you use your own math types.
226 See FAQ "How can I use my own math types instead of ImVec2/ImVec4?" for details about setting up imconfig.h for that.
227 We can can optionally export math operators for ImVec2/ImVec4 using IMGUI_DEFINE_MATH_OPERATORS, which we use internally.
228 - C++: pay attention that ImVector<> manipulates plain-old-data and does not honor construction/destruction
229 (so don't use ImVector in your code or at our own risk!).
230 - Building: We don't use nor mandate a build system for the main library.
231 This is in an effort to ensure that it works in the real world aka with any esoteric build setup.
232 This is also because providing a build system for the main library would be of little-value.
233 The build problems are almost never coming from the main library but from specific backends.
234
235
236 HOW TO UPDATE TO A NEWER VERSION OF DEAR IMGUI
237 ----------------------------------------------
238 - Update submodule or copy/overwrite every file.
239 - About imconfig.h:
240 - You may modify your copy of imconfig.h, in this case don't overwrite it.
241 - or you may locally branch to modify imconfig.h and merge/rebase latest.
242 - or you may '#define IMGUI_USER_CONFIG "my_config_file.h"' globally from your build system to
243 specify a custom path for your imconfig.h file and instead not have to modify the default one.
244
245 - Overwrite all the sources files except for imconfig.h (if you have modified your copy of imconfig.h)
246 - Or maintain your own branch where you have imconfig.h modified as a top-most commit which you can regularly rebase over "master".
247 - You can also use '#define IMGUI_USER_CONFIG "my_config_file.h" to redirect configuration to your own file.
248 - Read the "API BREAKING CHANGES" section (below). This is where we list occasional API breaking changes.
249 If a function/type has been renamed / or marked obsolete, try to fix the name in your code before it is permanently removed
250 from the public API. If you have a problem with a missing function/symbols, search for its name in the code, there will
251 likely be a comment about it. Please report any issue to the GitHub page!
252 - To find out usage of old API, you can add '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in your configuration file.
253 - Try to keep your copy of Dear ImGui reasonably up to date!
254
255
256 GETTING STARTED WITH INTEGRATING DEAR IMGUI IN YOUR CODE/ENGINE
257 ---------------------------------------------------------------
258 - See https://github.com/ocornut/imgui/wiki/Getting-Started.
259 - Run and study the examples and demo in imgui_demo.cpp to get acquainted with the library.
260 - In the majority of cases you should be able to use unmodified backends files available in the backends/ folder.
261 - Add the Dear ImGui source files + selected backend source files to your projects or using your preferred build system.
262 It is recommended you build and statically link the .cpp files as part of your project and NOT as a shared library (DLL).
263 - You can later customize the imconfig.h file to tweak some compile-time behavior, such as integrating Dear ImGui types with your own maths types.
264 - When using Dear ImGui, your programming IDE is your friend: follow the declaration of variables, functions and types to find comments about them.
265 - Dear ImGui never touches or knows about your GPU state. The only function that knows about GPU is the draw function that you provide.
266 Effectively it means you can create widgets at any time in your code, regardless of considerations of being in "update" vs "render"
267 phases of your own application. All rendering information is stored into command-lists that you will retrieve after calling ImGui::Render().
268 - Refer to the backends and demo applications in the examples/ folder for instruction on how to setup your code.
269 - If you are running over a standard OS with a common graphics API, you should be able to use unmodified imgui_impl_*** files from the examples/ folder.
270
271
272 HOW A SIMPLE APPLICATION MAY LOOK LIKE
273 --------------------------------------
274 EXHIBIT 1: USING THE EXAMPLE BACKENDS (= imgui_impl_XXX.cpp files from the backends/ folder).
275 The sub-folders in examples/ contain examples applications following this structure.
276
277 // Application init: create a dear imgui context, setup some options, load fonts
278 ImGui::CreateContext();
279 ImGuiIO& io = ImGui::GetIO();
280 // TODO: Set optional io.ConfigFlags values, e.g. 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard' to enable keyboard controls.
281 // TODO: Fill optional fields of the io structure later.
282 // TODO: Load TTF/OTF fonts if you don't want to use the default font.
283
284 // Initialize helper Platform and Renderer backends (here we are using imgui_impl_win32.cpp and imgui_impl_dx11.cpp)
285 ImGui_ImplWin32_Init(hwnd);
286 ImGui_ImplDX11_Init(g_pd3dDevice, g_pd3dDeviceContext);
287
288 // Application main loop
289 while (true)
290 {
291 // Feed inputs to dear imgui, start new frame
292 ImGui_ImplDX11_NewFrame();
293 ImGui_ImplWin32_NewFrame();
294 ImGui::NewFrame();
295
296 // Any application code here
297 ImGui::Text("Hello, world!");
298
299 // Render dear imgui into screen
300 ImGui::Render();
301 ImGui_ImplDX11_RenderDrawData(ImGui::GetDrawData());
302 g_pSwapChain->Present(1, 0);
303 }
304
305 // Shutdown
306 ImGui_ImplDX11_Shutdown();
307 ImGui_ImplWin32_Shutdown();
308 ImGui::DestroyContext();
309
310 EXHIBIT 2: IMPLEMENTING CUSTOM BACKEND / CUSTOM ENGINE
311
312 // Application init: create a dear imgui context, setup some options, load fonts
313 ImGui::CreateContext();
314 ImGuiIO& io = ImGui::GetIO();
315 // TODO: Set optional io.ConfigFlags values, e.g. 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard' to enable keyboard controls.
316 // TODO: Fill optional fields of the io structure later.
317 // TODO: Load TTF/OTF fonts if you don't want to use the default font.
318
319 // Build and load the texture atlas into a texture
320 // (In the examples/ app this is usually done within the ImGui_ImplXXX_Init() function from one of the demo Renderer)
321 int width, height;
322 unsigned char* pixels = nullptr;
323 io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
324
325 // At this point you've got the texture data and you need to upload that to your graphic system:
326 // After we have created the texture, store its pointer/identifier (_in whichever format your engine uses_) in 'io.Fonts->TexID'.
327 // This will be passed back to your via the renderer. Basically ImTextureID == void*. Read FAQ for details about ImTextureID.
328 MyTexture* texture = MyEngine::CreateTextureFromMemoryPixels(pixels, width, height, TEXTURE_TYPE_RGBA32)
329 io.Fonts->SetTexID((void*)texture);
330
331 // Application main loop
332 while (true)
333 {
334 // Setup low-level inputs, e.g. on Win32: calling GetKeyboardState(), or write to those fields from your Windows message handlers, etc.
335 // (In the examples/ app this is usually done within the ImGui_ImplXXX_NewFrame() function from one of the demo Platform Backends)
336 io.DeltaTime = 1.0f/60.0f; // set the time elapsed since the previous frame (in seconds)
337 io.DisplaySize.x = 1920.0f; // set the current display width
338 io.DisplaySize.y = 1280.0f; // set the current display height here
339 io.AddMousePosEvent(mouse_x, mouse_y); // update mouse position
340 io.AddMouseButtonEvent(0, mouse_b[0]); // update mouse button states
341 io.AddMouseButtonEvent(1, mouse_b[1]); // update mouse button states
342
343 // Call NewFrame(), after this point you can use ImGui::* functions anytime
344 // (So you want to try calling NewFrame() as early as you can in your main loop to be able to use Dear ImGui everywhere)
345 ImGui::NewFrame();
346
347 // Most of your application code here
348 ImGui::Text("Hello, world!");
349 MyGameUpdate(); // may use any Dear ImGui functions, e.g. ImGui::Begin("My window"); ImGui::Text("Hello, world!"); ImGui::End();
350 MyGameRender(); // may use any Dear ImGui functions as well!
351
352 // Render dear imgui, swap buffers
353 // (You want to try calling EndFrame/Render as late as you can, to be able to use Dear ImGui in your own game rendering code)
354 ImGui::EndFrame();
355 ImGui::Render();
356 ImDrawData* draw_data = ImGui::GetDrawData();
357 MyImGuiRenderFunction(draw_data);
358 SwapBuffers();
359 }
360
361 // Shutdown
362 ImGui::DestroyContext();
363
364 To decide whether to dispatch mouse/keyboard inputs to Dear ImGui to the rest of your application,
365 you should read the 'io.WantCaptureMouse', 'io.WantCaptureKeyboard' and 'io.WantTextInput' flags!
366 Please read the FAQ entry "How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?" about this.
367
368
369 HOW A SIMPLE RENDERING FUNCTION MAY LOOK LIKE
370 ---------------------------------------------
371 The backends in impl_impl_XXX.cpp files contain many working implementations of a rendering function.
372
373 void MyImGuiRenderFunction(ImDrawData* draw_data)
374 {
375 // TODO: Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled
376 // TODO: Setup texture sampling state: sample with bilinear filtering (NOT point/nearest filtering). Use 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines;' to allow point/nearest filtering.
377 // TODO: Setup viewport covering draw_data->DisplayPos to draw_data->DisplayPos + draw_data->DisplaySize
378 // TODO: Setup orthographic projection matrix cover draw_data->DisplayPos to draw_data->DisplayPos + draw_data->DisplaySize
379 // TODO: Setup shader: vertex { float2 pos, float2 uv, u32 color }, fragment shader sample color from 1 texture, multiply by vertex color.
380 ImVec2 clip_off = draw_data->DisplayPos;
381 for (int n = 0; n < draw_data->CmdListsCount; n++)
382 {
383 const ImDrawList* cmd_list = draw_data->CmdLists[n];
384 const ImDrawVert* vtx_buffer = cmd_list->VtxBuffer.Data; // vertex buffer generated by Dear ImGui
385 const ImDrawIdx* idx_buffer = cmd_list->IdxBuffer.Data; // index buffer generated by Dear ImGui
386 for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
387 {
388 const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
389 if (pcmd->UserCallback)
390 {
391 pcmd->UserCallback(cmd_list, pcmd);
392 }
393 else
394 {
395 // Project scissor/clipping rectangles into framebuffer space
396 ImVec2 clip_min(pcmd->ClipRect.x - clip_off.x, pcmd->ClipRect.y - clip_off.y);
397 ImVec2 clip_max(pcmd->ClipRect.z - clip_off.x, pcmd->ClipRect.w - clip_off.y);
398 if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
399 continue;
400
401 // We are using scissoring to clip some objects. All low-level graphics API should support it.
402 // - If your engine doesn't support scissoring yet, you may ignore this at first. You will get some small glitches
403 // (some elements visible outside their bounds) but you can fix that once everything else works!
404 // - Clipping coordinates are provided in imgui coordinates space:
405 // - For a given viewport, draw_data->DisplayPos == viewport->Pos and draw_data->DisplaySize == viewport->Size
406 // - In a single viewport application, draw_data->DisplayPos == (0,0) and draw_data->DisplaySize == io.DisplaySize, but always use GetMainViewport()->Pos/Size instead of hardcoding those values.
407 // - In the interest of supporting multi-viewport applications (see 'docking' branch on github),
408 // always subtract draw_data->DisplayPos from clipping bounds to convert them to your viewport space.
409 // - Note that pcmd->ClipRect contains Min+Max bounds. Some graphics API may use Min+Max, other may use Min+Size (size being Max-Min)
410 MyEngineSetScissor(clip_min.x, clip_min.y, clip_max.x, clip_max.y);
411
412 // The texture for the draw call is specified by pcmd->GetTexID().
413 // The vast majority of draw calls will use the Dear ImGui texture atlas, which value you have set yourself during initialization.
414 MyEngineBindTexture((MyTexture*)pcmd->GetTexID());
415
416 // Render 'pcmd->ElemCount/3' indexed triangles.
417 // By default the indices ImDrawIdx are 16-bit, you can change them to 32-bit in imconfig.h if your engine doesn't support 16-bit indices.
418 MyEngineDrawIndexedTriangles(pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer + pcmd->IdxOffset, vtx_buffer, pcmd->VtxOffset);
419 }
420 }
421 }
422 }
423
424
425 API BREAKING CHANGES
426 ====================
427
428 Occasionally introducing changes that are breaking the API. We try to make the breakage minor and easy to fix.
429 Below is a change-log of API breaking changes only. If you are using one of the functions listed, expect to have to fix some code.
430 When you are not sure about an old symbol or function name, try using the Search/Find function of your IDE to look for comments or references in all imgui files.
431 You can read releases logs https://github.com/ocornut/imgui/releases for more details.
432
433(Docking/Viewport Branch)
434 - 2024/XX/XX (1.XXXX) - when multi-viewports are enabled, all positions will be in your natural OS coordinates space. It means that:
435 - reference to hard-coded positions such as in SetNextWindowPos(ImVec2(0,0)) are probably not what you want anymore.
436 you may use GetMainViewport()->Pos to offset hard-coded positions, e.g. SetNextWindowPos(GetMainViewport()->Pos)
437 - likewise io.MousePos and GetMousePos() will use OS coordinates.
438 If you query mouse positions to interact with non-imgui coordinates you will need to offset them, e.g. subtract GetWindowViewport()->Pos.
439
440 - 2024/11/27 (1.91.6) - changed CRC32 table from CRC32-adler to CRC32c polynomial in order to be compatible with the result of SSE 4.2 instructions.
441 As a result, old .ini data may be partially lost (docking and tables information particularly).
442 Because some users have crafted and storing .ini data as a way to workaround limitations of the docking API, we are providing a '#define IMGUI_USE_LEGACY_CRC32_ADLER' compile-time option to keep using old CRC32 tables if you cannot afford invalidating old .ini data.
443 - 2024/11/06 (1.91.5) - commented/obsoleted out pre-1.87 IO system (equivalent to using IMGUI_DISABLE_OBSOLETE_KEYIO or IMGUI_DISABLE_OBSOLETE_FUNCTIONS before)
444 - io.KeyMap[] and io.KeysDown[] are removed (obsoleted February 2022).
445 - io.NavInputs[] and ImGuiNavInput are removed (obsoleted July 2022).
446 - pre-1.87 backends are not supported:
447 - backends need to call io.AddKeyEvent(), io.AddMouseEvent() instead of writing to io.KeysDown[], io.MouseDown[] fields.
448 - backends need to call io.AddKeyAnalogEvent() for gamepad values instead of writing to io.NavInputs[] fields.
449 - for more reference:
450 - read 1.87 and 1.88 part of this section or read Changelog for 1.87 and 1.88.
451 - read https://github.com/ocornut/imgui/issues/4921
452 - if you have trouble updating a very old codebase using legacy backend-specific key codes: consider updating to 1.91.4 first, then #define IMGUI_DISABLE_OBSOLETE_KEYIO, then update to latest.
453 - obsoleted ImGuiKey_COUNT (it is unusually error-prone/misleading since valid keys don't start at 0). probably use ImGuiKey_NamedKey_BEGIN/ImGuiKey_NamedKey_END?
454 - fonts: removed const qualifiers from most font functions in prevision for upcoming font improvements.
455 - 2024/10/18 (1.91.4) - renamed ImGuiCol_NavHighlight to ImGuiCol_NavCursor (for consistency with newly exposed and reworked features). Kept inline redirection enum (will obsolete).
456 - 2024/10/14 (1.91.4) - moved ImGuiConfigFlags_NavEnableSetMousePos to standalone io.ConfigNavMoveSetMousePos bool.
457 moved ImGuiConfigFlags_NavNoCaptureKeyboard to standalone io.ConfigNavCaptureKeyboard bool (note the inverted value!).
458 kept legacy names (will obsolete) + code that copies settings once the first time. Dynamically changing the old value won't work. Switch to using the new value!
459 - 2024/10/10 (1.91.4) - the typedef for ImTextureID now defaults to ImU64 instead of void*. (#1641)
460 this removes the requirement to redefine it for backends which are e.g. storing descriptor sets or other 64-bits structures when building on 32-bits archs. It therefore simplify various building scripts/helpers.
461 you may have compile-time issues if you were casting to 'void*' instead of 'ImTextureID' when passing your types to functions taking ImTextureID values, e.g. ImGui::Image().
462 in doubt it is almost always better to do an intermediate intptr_t cast, since it allows casting any pointer/integer type without warning:
463 - May warn: ImGui::Image((void*)MyTextureData, ...);
464 - May warn: ImGui::Image((void*)(intptr_t)MyTextureData, ...);
465 - Won't warn: ImGui::Image((ImTextureID)(intptr_t)MyTextureData), ...);
466 - note that you can always define ImTextureID to be your own high-level structures (with dedicated constructors) if you like.
467 - 2024/10/03 (1.91.3) - drags: treat v_min==v_max as a valid clamping range when != 0.0f. Zero is a still special value due to legacy reasons, unless using ImGuiSliderFlags_ClampZeroRange. (#7968, #3361, #76)
468 - drags: extended behavior of ImGuiSliderFlags_AlwaysClamp to include _ClampZeroRange. It considers v_min==v_max==0.0f as a valid clamping range (aka edits not allowed).
469 although unlikely, it you wish to only clamp on text input but want v_min==v_max==0.0f to mean unclamped drags, you can use _ClampOnInput instead of _AlwaysClamp. (#7968, #3361, #76)
470 - 2024/09/10 (1.91.2) - internals: using multiple overlayed ButtonBehavior() with same ID will now have io.ConfigDebugHighlightIdConflicts=true feature emit a warning. (#8030)
471 it was one of the rare case where using same ID is legal. workarounds: (1) use single ButtonBehavior() call with multiple _MouseButton flags, or (2) surround the calls with PushItemFlag(ImGuiItemFlags_AllowDuplicateId, true); ... PopItemFlag()
472 - 2024/08/23 (1.91.1) - renamed ImGuiChildFlags_Border to ImGuiChildFlags_Borders for consistency. kept inline redirection flag.
473 - 2024/08/22 (1.91.1) - moved some functions from ImGuiIO to ImGuiPlatformIO structure:
474 - io.GetClipboardTextFn -> platform_io.Platform_GetClipboardTextFn + changed 'void* user_data' to 'ImGuiContext* ctx'. Pull your user data from platform_io.ClipboardUserData.
475 - io.SetClipboardTextFn -> platform_io.Platform_SetClipboardTextFn + same as above line.
476 - io.PlatformOpenInShellFn -> platform_io.Platform_OpenInShellFn (#7660)
477 - io.PlatformSetImeDataFn -> platform_io.Platform_SetImeDataFn
478 - io.PlatformLocaleDecimalPoint -> platform_io.Platform_LocaleDecimalPoint (#7389, #6719, #2278)
479 - access those via GetPlatformIO() instead of GetIO().
480 some were introduced very recently and often automatically setup by core library and backends, so for those we are exceptionally not maintaining a legacy redirection symbol.
481 - commented the old ImageButton() signature obsoleted in 1.89 (~August 2022). As a reminder:
482 - old ImageButton() before 1.89 used ImTextureId as item id (created issue with e.g. multiple buttons in same scope, transient texture id values, opaque computation of ID)
483 - new ImageButton() since 1.89 requires an explicit 'const char* str_id'
484 - old ImageButton() before 1.89 had frame_padding' override argument.
485 - new ImageButton() since 1.89 always use style.FramePadding, which you can freely override with PushStyleVar()/PopStyleVar().
486 - 2024/07/25 (1.91.0) - obsoleted GetContentRegionMax(), GetWindowContentRegionMin() and GetWindowContentRegionMax(). (see #7838 on GitHub for more info)
487 you should never need those functions. you can do everything with GetCursorScreenPos() and GetContentRegionAvail() in a more simple way.
488 - instead of: GetWindowContentRegionMax().x - GetCursorPos().x
489 - you can use: GetContentRegionAvail().x
490 - instead of: GetWindowContentRegionMax().x + GetWindowPos().x
491 - you can use: GetCursorScreenPos().x + GetContentRegionAvail().x // when called from left edge of window
492 - instead of: GetContentRegionMax()
493 - you can use: GetContentRegionAvail() + GetCursorScreenPos() - GetWindowPos() // right edge in local coordinates
494 - instead of: GetWindowContentRegionMax().x - GetWindowContentRegionMin().x
495 - you can use: GetContentRegionAvail() // when called from left edge of window
496 - 2024/07/15 (1.91.0) - renamed ImGuiSelectableFlags_DontClosePopups to ImGuiSelectableFlags_NoAutoClosePopups. (#1379, #1468, #2200, #4936, #5216, #7302, #7573)
497 (internals: also renamed ImGuiItemFlags_SelectableDontClosePopup into ImGuiItemFlags_AutoClosePopups with inverted behaviors)
498 - 2024/07/15 (1.91.0) - obsoleted PushButtonRepeat()/PopButtonRepeat() in favor of using new PushItemFlag(ImGuiItemFlags_ButtonRepeat, ...)/PopItemFlag().
499 - 2024/07/02 (1.91.0) - commented out obsolete ImGuiModFlags (renamed to ImGuiKeyChord in 1.89). (#4921, #456)
500 - commented out obsolete ImGuiModFlags_XXX values (renamed to ImGuiMod_XXX in 1.89). (#4921, #456)
501 - ImGuiModFlags_Ctrl -> ImGuiMod_Ctrl, ImGuiModFlags_Shift -> ImGuiMod_Shift etc.
502 - 2024/07/02 (1.91.0) - IO, IME: renamed platform IME hook and added explicit context for consistency and future-proofness.
503 - old: io.SetPlatformImeDataFn(ImGuiViewport* viewport, ImGuiPlatformImeData* data);
504 - new: io.PlatformSetImeDataFn(ImGuiContext* ctx, ImGuiViewport* viewport, ImGuiPlatformImeData* data);
505 - 2024/06/21 (1.90.9) - BeginChild: added ImGuiChildFlags_NavFlattened as a replacement for the window flag ImGuiWindowFlags_NavFlattened: the feature only ever made sense for BeginChild() anyhow.
506 - old: BeginChild("Name", size, 0, ImGuiWindowFlags_NavFlattened);
507 - new: BeginChild("Name", size, ImGuiChildFlags_NavFlattened, 0);
508 - 2024/06/21 (1.90.9) - io: ClearInputKeys() (first exposed in 1.89.8) doesn't clear mouse data, newly added ClearInputMouse() does.
509 - 2024/06/20 (1.90.9) - renamed ImGuiDragDropFlags_SourceAutoExpirePayload to ImGuiDragDropFlags_PayloadAutoExpire.
510 - 2024/06/18 (1.90.9) - style: renamed ImGuiCol_TabActive -> ImGuiCol_TabSelected, ImGuiCol_TabUnfocused -> ImGuiCol_TabDimmed, ImGuiCol_TabUnfocusedActive -> ImGuiCol_TabDimmedSelected.
511 - 2024/06/10 (1.90.9) - removed old nested structure: renaming ImGuiStorage::ImGuiStoragePair type to ImGuiStoragePair (simpler for many languages).
512 - 2024/06/06 (1.90.8) - reordered ImGuiInputTextFlags values. This should not be breaking unless you are using generated headers that have values not matching the main library.
513 - 2024/06/06 (1.90.8) - removed 'ImGuiButtonFlags_MouseButtonDefault_ = ImGuiButtonFlags_MouseButtonLeft', was mostly unused and misleading.
514 - 2024/05/27 (1.90.7) - commented out obsolete symbols marked obsolete in 1.88 (May 2022):
515 - old: CaptureKeyboardFromApp(bool)
516 - new: SetNextFrameWantCaptureKeyboard(bool)
517 - old: CaptureMouseFromApp(bool)
518 - new: SetNextFrameWantCaptureMouse(bool)
519 - 2024/05/22 (1.90.7) - inputs (internals): renamed ImGuiKeyOwner_None to ImGuiKeyOwner_NoOwner, to make use more explicit and reduce confusion with the default it is a non-zero value and cannot be the default value (never made public, but disclosing as I expect a few users caught on owner-aware inputs).
520 - inputs (internals): renamed ImGuiInputFlags_RouteGlobalLow -> ImGuiInputFlags_RouteGlobal, ImGuiInputFlags_RouteGlobal -> ImGuiInputFlags_RouteGlobalOverFocused, ImGuiInputFlags_RouteGlobalHigh -> ImGuiInputFlags_RouteGlobalHighest.
521 - inputs (internals): Shortcut(), SetShortcutRouting(): swapped last two parameters order in function signatures:
522 - old: Shortcut(ImGuiKeyChord key_chord, ImGuiID owner_id = 0, ImGuiInputFlags flags = 0);
523 - new: Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0, ImGuiID owner_id = 0);
524 - inputs (internals): owner-aware versions of IsKeyPressed(), IsKeyChordPressed(), IsMouseClicked(): swapped last two parameters order in function signatures.
525 - old: IsKeyPressed(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags = 0);
526 - new: IsKeyPressed(ImGuiKey key, ImGuiInputFlags flags, ImGuiID owner_id = 0);
527 - old: IsMouseClicked(ImGuiMouseButton button, ImGuiID owner_id, ImGuiInputFlags flags = 0);
528 - new: IsMouseClicked(ImGuiMouseButton button, ImGuiInputFlags flags, ImGuiID owner_id = 0);
529 for various reasons those changes makes sense. They are being made because making some of those API public.
530 only past users of imgui_internal.h with the extra parameters will be affected. Added asserts for valid flags in various functions to detect _some_ misuses, BUT NOT ALL.
531 - 2024/05/21 (1.90.7) - docking: changed signature of DockSpaceOverViewport() to add explicit dockspace id if desired. pass 0 to use old behavior. (#7611)
532 - old: DockSpaceOverViewport(const ImGuiViewport* viewport = NULL, ImGuiDockNodeFlags flags = 0, ...);
533 - new: DockSpaceOverViewport(ImGuiID dockspace_id = 0, const ImGuiViewport* viewport = NULL, ImGuiDockNodeFlags flags = 0, ...);
534 - 2024/05/16 (1.90.7) - inputs: on macOS X, Cmd and Ctrl keys are now automatically swapped by io.AddKeyEvent() as this naturally align with how macOS X uses those keys.
535 - it shouldn't really affect you unless you had custom shortcut swapping in place for macOS X apps.
536 - removed ImGuiMod_Shortcut which was previously dynamically remapping to Ctrl or Cmd/Super. It is now unnecessary to specific cross-platform idiomatic shortcuts. (#2343, #4084, #5923, #456)
537 - 2024/05/14 (1.90.7) - backends: SDL_Renderer2 and SDL_Renderer3 backend now take a SDL_Renderer* in their RenderDrawData() functions.
538 - 2024/04/18 (1.90.6) - TreeNode: Fixed a layout inconsistency when using an empty/hidden label followed by a SameLine() call. (#7505, #282)
539 - old: TreeNode("##Hidden"); SameLine(); Text("Hello"); // <-- This was actually incorrect! BUT appeared to look ok with the default style where ItemSpacing.x == FramePadding.x * 2 (it didn't look aligned otherwise).
540 - new: TreeNode("##Hidden"); SameLine(0, 0); Text("Hello"); // <-- This is correct for all styles values.
541 with the fix, IF you were successfully using TreeNode("")+SameLine(); you will now have extra spacing between your TreeNode and the following item.
542 You'll need to change the SameLine() call to SameLine(0,0) to remove this extraneous spacing. This seemed like the more sensible fix that's not making things less consistent.
543 (Note: when using this idiom you are likely to also use ImGuiTreeNodeFlags_SpanAvailWidth).
544 - 2024/03/18 (1.90.5) - merged the radius_x/radius_y parameters in ImDrawList::AddEllipse(), AddEllipseFilled() and PathEllipticalArcTo() into a single ImVec2 parameter. Exceptionally, because those functions were added in 1.90, we are not adding inline redirection functions. The transition is easy and should affect few users. (#2743, #7417)
545 - 2024/03/08 (1.90.5) - inputs: more formally obsoleted GetKeyIndex() when IMGUI_DISABLE_OBSOLETE_FUNCTIONS is set. It has been unnecessary and a no-op since 1.87 (it returns the same value as passed when used with a 1.87+ backend using io.AddKeyEvent() function). (#4921)
546 - IsKeyPressed(GetKeyIndex(ImGuiKey_XXX)) -> use IsKeyPressed(ImGuiKey_XXX)
547 - 2024/01/15 (1.90.2) - commented out obsolete ImGuiIO::ImeWindowHandle marked obsolete in 1.87, favor of writing to 'void* ImGuiViewport::PlatformHandleRaw'.
548 - 2023/12/19 (1.90.1) - commented out obsolete ImGuiKey_KeyPadEnter redirection to ImGuiKey_KeypadEnter.
549 - 2023/11/06 (1.90.1) - removed CalcListClipping() marked obsolete in 1.86. Prefer using ImGuiListClipper which can return non-contiguous ranges.
550 - 2023/11/05 (1.90.1) - imgui_freetype: commented out ImGuiFreeType::BuildFontAtlas() obsoleted in 1.81. prefer using #define IMGUI_ENABLE_FREETYPE or see commented code for manual calls.
551 - 2023/11/05 (1.90.1) - internals,columns: commented out legacy ImGuiColumnsFlags_XXX symbols redirecting to ImGuiOldColumnsFlags_XXX, obsoleted from imgui_internal.h in 1.80.
552 - 2023/11/09 (1.90.0) - removed IM_OFFSETOF() macro in favor of using offsetof() available in C++11. Kept redirection define (will obsolete).
553 - 2023/11/07 (1.90.0) - removed BeginChildFrame()/EndChildFrame() in favor of using BeginChild() with the ImGuiChildFlags_FrameStyle flag. kept inline redirection function (will obsolete).
554 those functions were merely PushStyle/PopStyle helpers, the removal isn't so much motivated by needing to add the feature in BeginChild(), but by the necessity to avoid BeginChildFrame() signature mismatching BeginChild() signature and features.
555 - 2023/11/02 (1.90.0) - BeginChild: upgraded 'bool border = true' parameter to 'ImGuiChildFlags flags' type, added ImGuiChildFlags_Border equivalent. As with our prior "bool-to-flags" API updates, the ImGuiChildFlags_Border value is guaranteed to be == true forever to ensure a smoother transition, meaning all existing calls will still work.
556 - old: BeginChild("Name", size, true)
557 - new: BeginChild("Name", size, ImGuiChildFlags_Border)
558 - old: BeginChild("Name", size, false)
559 - new: BeginChild("Name", size) or BeginChild("Name", 0) or BeginChild("Name", size, ImGuiChildFlags_None)
560 **AMEND FROM THE FUTURE: from 1.91.1, 'ImGuiChildFlags_Border' is called 'ImGuiChildFlags_Borders'**
561 - 2023/11/02 (1.90.0) - BeginChild: added child-flag ImGuiChildFlags_AlwaysUseWindowPadding as a replacement for the window-flag ImGuiWindowFlags_AlwaysUseWindowPadding: the feature only ever made sense for BeginChild() anyhow.
562 - old: BeginChild("Name", size, 0, ImGuiWindowFlags_AlwaysUseWindowPadding);
563 - new: BeginChild("Name", size, ImGuiChildFlags_AlwaysUseWindowPadding, 0);
564 - 2023/09/27 (1.90.0) - io: removed io.MetricsActiveAllocations introduced in 1.63. Same as 'g.DebugMemAllocCount - g.DebugMemFreeCount' (still displayed in Metrics, unlikely to be accessed by end-user).
565 - 2023/09/26 (1.90.0) - debug tools: Renamed ShowStackToolWindow() ("Stack Tool") to ShowIDStackToolWindow() ("ID Stack Tool"), as earlier name was misleading. Kept inline redirection function. (#4631)
566 - 2023/09/15 (1.90.0) - ListBox, Combo: changed signature of "name getter" callback in old one-liner ListBox()/Combo() apis. kept inline redirection function (will obsolete).
567 - old: bool Combo(const char* label, int* current_item, bool (*getter)(void* user_data, int idx, const char** out_text), ...)
568 - new: bool Combo(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), ...);
569 - old: bool ListBox(const char* label, int* current_item, bool (*getting)(void* user_data, int idx, const char** out_text), ...);
570 - new: bool ListBox(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), ...);
571 - 2023/09/08 (1.90.0) - commented out obsolete redirecting functions:
572 - GetWindowContentRegionWidth() -> use GetWindowContentRegionMax().x - GetWindowContentRegionMin().x. Consider that generally 'GetContentRegionAvail().x' is more useful.
573 - ImDrawCornerFlags_XXX -> use ImDrawFlags_RoundCornersXXX flags. Read 1.82 Changelog for details + grep commented names in sources.
574 - commented out runtime support for hardcoded ~0 or 0x01..0x0F rounding flags values for AddRect()/AddRectFilled()/PathRect()/AddImageRounded() -> use ImDrawFlags_RoundCornersXXX flags. Read 1.82 Changelog for details
575 - 2023/08/25 (1.89.9) - clipper: Renamed IncludeRangeByIndices() (also called ForceDisplayRangeByIndices() before 1.89.6) to IncludeItemsByIndex(). Kept inline redirection function. Sorry!
576 - 2023/07/12 (1.89.8) - ImDrawData: CmdLists now owned, changed from ImDrawList** to ImVector<ImDrawList*>. Majority of users shouldn't be affected, but you cannot compare to NULL nor reassign manually anymore. Instead use AddDrawList(). (#6406, #4879, #1878)
577 - 2023/06/28 (1.89.7) - overlapping items: obsoleted 'SetItemAllowOverlap()' (called after item) in favor of calling 'SetNextItemAllowOverlap()' (called before item). 'SetItemAllowOverlap()' didn't and couldn't work reliably since 1.89 (2022-11-15).
578 - 2023/06/28 (1.89.7) - overlapping items: renamed 'ImGuiTreeNodeFlags_AllowItemOverlap' to 'ImGuiTreeNodeFlags_AllowOverlap', 'ImGuiSelectableFlags_AllowItemOverlap' to 'ImGuiSelectableFlags_AllowOverlap'. Kept redirecting enums (will obsolete).
579 - 2023/06/28 (1.89.7) - overlapping items: IsItemHovered() now by default return false when querying an item using AllowOverlap mode which is being overlapped. Use ImGuiHoveredFlags_AllowWhenOverlappedByItem to revert to old behavior.
580 - 2023/06/28 (1.89.7) - overlapping items: Selectable and TreeNode don't allow overlap when active so overlapping widgets won't appear as hovered. While this fixes a common small visual issue, it also means that calling IsItemHovered() after a non-reactive elements - e.g. Text() - overlapping an active one may fail if you don't use IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem). (#6610)
581 - 2023/06/20 (1.89.7) - moved io.HoverDelayShort/io.HoverDelayNormal to style.HoverDelayShort/style.HoverDelayNormal. As the fields were added in 1.89 and expected to be left unchanged by most users, or only tweaked once during app initialization, we are exceptionally accepting the breakage.
582 - 2023/05/30 (1.89.6) - backends: renamed "imgui_impl_sdlrenderer.cpp" to "imgui_impl_sdlrenderer2.cpp" and "imgui_impl_sdlrenderer.h" to "imgui_impl_sdlrenderer2.h". This is in prevision for the future release of SDL3.
583 - 2023/05/22 (1.89.6) - listbox: commented out obsolete/redirecting functions that were marked obsolete more than two years ago:
584 - ListBoxHeader() -> use BeginListBox() (note how two variants of ListBoxHeader() existed. Check commented versions in imgui.h for reference)
585 - ListBoxFooter() -> use EndListBox()
586 - 2023/05/15 (1.89.6) - clipper: commented out obsolete redirection constructor 'ImGuiListClipper(int items_count, float items_height = -1.0f)' that was marked obsolete in 1.79. Use default constructor + clipper.Begin().
587 - 2023/05/15 (1.89.6) - clipper: renamed ImGuiListClipper::ForceDisplayRangeByIndices() to ImGuiListClipper::IncludeRangeByIndices().
588 - 2023/03/14 (1.89.4) - commented out redirecting enums/functions names that were marked obsolete two years ago:
589 - ImGuiSliderFlags_ClampOnInput -> use ImGuiSliderFlags_AlwaysClamp
590 - ImGuiInputTextFlags_AlwaysInsertMode -> use ImGuiInputTextFlags_AlwaysOverwrite
591 - ImDrawList::AddBezierCurve() -> use ImDrawList::AddBezierCubic()
592 - ImDrawList::PathBezierCurveTo() -> use ImDrawList::PathBezierCubicCurveTo()
593 - 2023/03/09 (1.89.4) - renamed PushAllowKeyboardFocus()/PopAllowKeyboardFocus() to PushTabStop()/PopTabStop(). Kept inline redirection functions (will obsolete).
594 - 2023/03/09 (1.89.4) - tooltips: Added 'bool' return value to BeginTooltip() for API consistency. Please only submit contents and call EndTooltip() if BeginTooltip() returns true. In reality the function will _currently_ always return true, but further changes down the line may change this, best to clarify API sooner.
595 - 2023/02/15 (1.89.4) - moved the optional "courtesy maths operators" implementation from imgui_internal.h in imgui.h.
596 Even though we encourage using your own maths types and operators by setting up IM_VEC2_CLASS_EXTRA,
597 it has been frequently requested by people to use our own. We had an opt-in define which was
598 previously fulfilled in imgui_internal.h. It is now fulfilled in imgui.h. (#6164)
599 - OK: #define IMGUI_DEFINE_MATH_OPERATORS / #include "imgui.h" / #include "imgui_internal.h"
600 - Error: #include "imgui.h" / #define IMGUI_DEFINE_MATH_OPERATORS / #include "imgui_internal.h"
601 - 2023/02/07 (1.89.3) - backends: renamed "imgui_impl_sdl.cpp" to "imgui_impl_sdl2.cpp" and "imgui_impl_sdl.h" to "imgui_impl_sdl2.h". (#6146) This is in prevision for the future release of SDL3.
602 - 2022/10/26 (1.89) - commented out redirecting OpenPopupContextItem() which was briefly the name of OpenPopupOnItemClick() from 1.77 to 1.79.
603 - 2022/10/12 (1.89) - removed runtime patching of invalid "%f"/"%0.f" format strings for DragInt()/SliderInt(). This was obsoleted in 1.61 (May 2018). See 1.61 changelog for details.
604 - 2022/09/26 (1.89) - renamed and merged keyboard modifiers key enums and flags into a same set. Kept inline redirection enums (will obsolete).
605 - ImGuiKey_ModCtrl and ImGuiModFlags_Ctrl -> ImGuiMod_Ctrl
606 - ImGuiKey_ModShift and ImGuiModFlags_Shift -> ImGuiMod_Shift
607 - ImGuiKey_ModAlt and ImGuiModFlags_Alt -> ImGuiMod_Alt
608 - ImGuiKey_ModSuper and ImGuiModFlags_Super -> ImGuiMod_Super
609 the ImGuiKey_ModXXX were introduced in 1.87 and mostly used by backends.
610 the ImGuiModFlags_XXX have been exposed in imgui.h but not really used by any public api only by third-party extensions.
611 exceptionally commenting out the older ImGuiKeyModFlags_XXX names ahead of obsolescence schedule to reduce confusion and because they were not meant to be used anyway.
612 - 2022/09/20 (1.89) - ImGuiKey is now a typed enum, allowing ImGuiKey_XXX symbols to be named in debuggers.
613 this will require uses of legacy backend-dependent indices to be casted, e.g.
614 - with imgui_impl_glfw: IsKeyPressed(GLFW_KEY_A) -> IsKeyPressed((ImGuiKey)GLFW_KEY_A);
615 - with imgui_impl_win32: IsKeyPressed('A') -> IsKeyPressed((ImGuiKey)'A')
616 - etc. However if you are upgrading code you might well use the better, backend-agnostic IsKeyPressed(ImGuiKey_A) now!
617 - 2022/09/12 (1.89) - removed the bizarre legacy default argument for 'TreePush(const void* ptr = NULL)', always pass a pointer value explicitly. NULL/nullptr is ok but require cast, e.g. TreePush((void*)nullptr);
618 - 2022/09/05 (1.89) - commented out redirecting functions/enums names that were marked obsolete in 1.77 and 1.78 (June 2020):
619 - DragScalar(), DragScalarN(), DragFloat(), DragFloat2(), DragFloat3(), DragFloat4(): For old signatures ending with (..., const char* format, float power = 1.0f) -> use (..., format ImGuiSliderFlags_Logarithmic) if power != 1.0f.
620 - SliderScalar(), SliderScalarN(), SliderFloat(), SliderFloat2(), SliderFloat3(), SliderFloat4(): For old signatures ending with (..., const char* format, float power = 1.0f) -> use (..., format ImGuiSliderFlags_Logarithmic) if power != 1.0f.
621 - BeginPopupContextWindow(const char*, ImGuiMouseButton, bool) -> use BeginPopupContextWindow(const char*, ImGuiPopupFlags)
622 - 2022/09/02 (1.89) - obsoleted using SetCursorPos()/SetCursorScreenPos() to extend parent window/cell boundaries.
623 this relates to when moving the cursor position beyond current boundaries WITHOUT submitting an item.
624 - previously this would make the window content size ~200x200:
625 Begin(...) + SetCursorScreenPos(GetCursorScreenPos() + ImVec2(200,200)) + End();
626 - instead, please submit an item:
627 Begin(...) + SetCursorScreenPos(GetCursorScreenPos() + ImVec2(200,200)) + Dummy(ImVec2(0,0)) + End();
628 - alternative:
629 Begin(...) + Dummy(ImVec2(200,200)) + End();
630 - content size is now only extended when submitting an item!
631 - with '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' this will now be detected and assert.
632 - without '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' this will silently be fixed until we obsolete it.
633 - 2022/08/03 (1.89) - changed signature of ImageButton() function. Kept redirection function (will obsolete).
634 - added 'const char* str_id' parameter + removed 'int frame_padding = -1' parameter.
635 - old signature: bool ImageButton(ImTextureID tex_id, ImVec2 size, ImVec2 uv0 = ImVec2(0,0), ImVec2 uv1 = ImVec2(1,1), int frame_padding = -1, ImVec4 bg_col = ImVec4(0,0,0,0), ImVec4 tint_col = ImVec4(1,1,1,1));
636 - used the ImTextureID value to create an ID. This was inconsistent with other functions, led to ID conflicts, and caused problems with engines using transient ImTextureID values.
637 - had a FramePadding override which was inconsistent with other functions and made the already-long signature even longer.
638 - new signature: bool ImageButton(const char* str_id, ImTextureID tex_id, ImVec2 size, ImVec2 uv0 = ImVec2(0,0), ImVec2 uv1 = ImVec2(1,1), ImVec4 bg_col = ImVec4(0,0,0,0), ImVec4 tint_col = ImVec4(1,1,1,1));
639 - requires an explicit identifier. You may still use e.g. PushID() calls and then pass an empty identifier.
640 - always uses style.FramePadding for padding, to be consistent with other buttons. You may use PushStyleVar() to alter this.
641 - 2022/07/08 (1.89) - inputs: removed io.NavInputs[] and ImGuiNavInput enum (following 1.87 changes).
642 - Official backends from 1.87+ -> no issue.
643 - Official backends from 1.60 to 1.86 -> will build and convert gamepad inputs, unless IMGUI_DISABLE_OBSOLETE_KEYIO is defined. Need updating!
644 - Custom backends not writing to io.NavInputs[] -> no issue.
645 - Custom backends writing to io.NavInputs[] -> will build and convert gamepad inputs, unless IMGUI_DISABLE_OBSOLETE_KEYIO is defined. Need fixing!
646 - TL;DR: Backends should call io.AddKeyEvent()/io.AddKeyAnalogEvent() with ImGuiKey_GamepadXXX values instead of filling io.NavInput[].
647 - 2022/06/15 (1.88) - renamed IMGUI_DISABLE_METRICS_WINDOW to IMGUI_DISABLE_DEBUG_TOOLS for correctness. kept support for old define (will obsolete).
648 - 2022/05/03 (1.88) - backends: osx: removed ImGui_ImplOSX_HandleEvent() from backend API in favor of backend automatically handling event capture. All ImGui_ImplOSX_HandleEvent() calls should be removed as they are now unnecessary.
649 - 2022/04/05 (1.88) - inputs: renamed ImGuiKeyModFlags to ImGuiModFlags. Kept inline redirection enums (will obsolete). This was never used in public API functions but technically present in imgui.h and ImGuiIO.
650 - 2022/01/20 (1.87) - inputs: reworded gamepad IO.
651 - Backend writing to io.NavInputs[] -> backend should call io.AddKeyEvent()/io.AddKeyAnalogEvent() with ImGuiKey_GamepadXXX values.
652 - 2022/01/19 (1.87) - sliders, drags: removed support for legacy arithmetic operators (+,+-,*,/) when inputing text. This doesn't break any api/code but a feature that used to be accessible by end-users (which seemingly no one used).
653 - 2022/01/17 (1.87) - inputs: reworked mouse IO.
654 - Backend writing to io.MousePos -> backend should call io.AddMousePosEvent()
655 - Backend writing to io.MouseDown[] -> backend should call io.AddMouseButtonEvent()
656 - Backend writing to io.MouseWheel -> backend should call io.AddMouseWheelEvent()
657 - Backend writing to io.MouseHoveredViewport -> backend should call io.AddMouseViewportEvent() [Docking branch w/ multi-viewports only]
658 note: for all calls to IO new functions, the Dear ImGui context should be bound/current.
659 read https://github.com/ocornut/imgui/issues/4921 for details.
660 - 2022/01/10 (1.87) - inputs: reworked keyboard IO. Removed io.KeyMap[], io.KeysDown[] in favor of calling io.AddKeyEvent(). Removed GetKeyIndex(), now unnecessary. All IsKeyXXX() functions now take ImGuiKey values. All features are still functional until IMGUI_DISABLE_OBSOLETE_KEYIO is defined. Read Changelog and Release Notes for details.
661 - IsKeyPressed(MY_NATIVE_KEY_XXX) -> use IsKeyPressed(ImGuiKey_XXX)
662 - IsKeyPressed(GetKeyIndex(ImGuiKey_XXX)) -> use IsKeyPressed(ImGuiKey_XXX)
663 - Backend writing to io.KeyMap[],io.KeysDown[] -> backend should call io.AddKeyEvent() (+ call io.SetKeyEventNativeData() if you want legacy user code to stil function with legacy key codes).
664 - Backend writing to io.KeyCtrl, io.KeyShift.. -> backend should call io.AddKeyEvent() with ImGuiMod_XXX values. *IF YOU PULLED CODE BETWEEN 2021/01/10 and 2021/01/27: We used to have a io.AddKeyModsEvent() function which was now replaced by io.AddKeyEvent() with ImGuiMod_XXX values.*
665 - one case won't work with backward compatibility: if your custom backend used ImGuiKey as mock native indices (e.g. "io.KeyMap[ImGuiKey_A] = ImGuiKey_A") because those values are now larger than the legacy KeyDown[] array. Will assert.
666 - inputs: added ImGuiKey_ModCtrl/ImGuiKey_ModShift/ImGuiKey_ModAlt/ImGuiKey_ModSuper values to submit keyboard modifiers using io.AddKeyEvent(), instead of writing directly to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper.
667 - 2022/01/05 (1.87) - inputs: renamed ImGuiKey_KeyPadEnter to ImGuiKey_KeypadEnter to align with new symbols. Kept redirection enum.
668 - 2022/01/05 (1.87) - removed io.ImeSetInputScreenPosFn() in favor of more flexible io.SetPlatformImeDataFn(). Removed 'void* io.ImeWindowHandle' in favor of writing to 'void* ImGuiViewport::PlatformHandleRaw'.
669 - 2022/01/01 (1.87) - commented out redirecting functions/enums names that were marked obsolete in 1.69, 1.70, 1.71, 1.72 (March-July 2019)
670 - ImGui::SetNextTreeNodeOpen() -> use ImGui::SetNextItemOpen()
671 - ImGui::GetContentRegionAvailWidth() -> use ImGui::GetContentRegionAvail().x
672 - ImGui::TreeAdvanceToLabelPos() -> use ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetTreeNodeToLabelSpacing());
673 - ImFontAtlas::CustomRect -> use ImFontAtlasCustomRect
674 - ImGuiColorEditFlags_RGB/HSV/HEX -> use ImGuiColorEditFlags_DisplayRGB/HSV/Hex
675 - 2021/12/20 (1.86) - backends: removed obsolete Marmalade backend (imgui_impl_marmalade.cpp) + example. Find last supported version at https://github.com/ocornut/imgui/wiki/Bindings
676 - 2021/11/04 (1.86) - removed CalcListClipping() function. Prefer using ImGuiListClipper which can return non-contiguous ranges. Please open an issue if you think you really need this function.
677 - 2021/08/23 (1.85) - removed GetWindowContentRegionWidth() function. keep inline redirection helper. can use 'GetWindowContentRegionMax().x - GetWindowContentRegionMin().x' instead for generally 'GetContentRegionAvail().x' is more useful.
678 - 2021/07/26 (1.84) - commented out redirecting functions/enums names that were marked obsolete in 1.67 and 1.69 (March 2019):
679 - ImGui::GetOverlayDrawList() -> use ImGui::GetForegroundDrawList()
680 - ImFont::GlyphRangesBuilder -> use ImFontGlyphRangesBuilder
681 - 2021/05/19 (1.83) - backends: obsoleted direct access to ImDrawCmd::TextureId in favor of calling ImDrawCmd::GetTexID().
682 - if you are using official backends from the source tree: you have nothing to do.
683 - if you have copied old backend code or using your own: change access to draw_cmd->TextureId to draw_cmd->GetTexID().
684 - 2021/03/12 (1.82) - upgraded ImDrawList::AddRect(), AddRectFilled(), PathRect() to use ImDrawFlags instead of ImDrawCornersFlags.
685 - ImDrawCornerFlags_TopLeft -> use ImDrawFlags_RoundCornersTopLeft
686 - ImDrawCornerFlags_BotRight -> use ImDrawFlags_RoundCornersBottomRight
687 - ImDrawCornerFlags_None -> use ImDrawFlags_RoundCornersNone etc.
688 flags now sanely defaults to 0 instead of 0x0F, consistent with all other flags in the API.
689 breaking: the default with rounding > 0.0f is now "round all corners" vs old implicit "round no corners":
690 - rounding == 0.0f + flags == 0 --> meant no rounding --> unchanged (common use)
691 - rounding > 0.0f + flags != 0 --> meant rounding --> unchanged (common use)
692 - rounding == 0.0f + flags != 0 --> meant no rounding --> unchanged (unlikely use)
693 - rounding > 0.0f + flags == 0 --> meant no rounding --> BREAKING (unlikely use): will now round all corners --> use ImDrawFlags_RoundCornersNone or rounding == 0.0f.
694 this ONLY matters for hard coded use of 0 + rounding > 0.0f. Use of named ImDrawFlags_RoundCornersNone (new) or ImDrawCornerFlags_None (old) are ok.
695 the old ImDrawCornersFlags used awkward default values of ~0 or 0xF (4 lower bits set) to signify "round all corners" and we sometimes encouraged using them as shortcuts.
696 legacy path still support use of hard coded ~0 or any value from 0x1 or 0xF. They will behave the same with legacy paths enabled (will assert otherwise).
697 - 2021/03/11 (1.82) - removed redirecting functions/enums names that were marked obsolete in 1.66 (September 2018):
698 - ImGui::SetScrollHere() -> use ImGui::SetScrollHereY()
699 - 2021/03/11 (1.82) - clarified that ImDrawList::PathArcTo(), ImDrawList::PathArcToFast() won't render with radius < 0.0f. Previously it sorts of accidentally worked but would generally lead to counter-clockwise paths and have an effect on anti-aliasing.
700 - 2021/03/10 (1.82) - upgraded ImDrawList::AddPolyline() and PathStroke() "bool closed" parameter to "ImDrawFlags flags". The matching ImDrawFlags_Closed value is guaranteed to always stay == 1 in the future.
701 - 2021/02/22 (1.82) - (*undone in 1.84*) win32+mingw: Re-enabled IME functions by default even under MinGW. In July 2016, issue #738 had me incorrectly disable those default functions for MinGW. MinGW users should: either link with -limm32, either set their imconfig file with '#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS'.
702 - 2021/02/17 (1.82) - renamed rarely used style.CircleSegmentMaxError (old default = 1.60f) to style.CircleTessellationMaxError (new default = 0.30f) as the meaning of the value changed.
703 - 2021/02/03 (1.81) - renamed ListBoxHeader(const char* label, ImVec2 size) to BeginListBox(). Kept inline redirection function (will obsolete).
704 - removed ListBoxHeader(const char* label, int items_count, int height_in_items = -1) in favor of specifying size. Kept inline redirection function (will obsolete).
705 - renamed ListBoxFooter() to EndListBox(). Kept inline redirection function (will obsolete).
706 - 2021/01/26 (1.81) - removed ImGuiFreeType::BuildFontAtlas(). Kept inline redirection function. Prefer using '#define IMGUI_ENABLE_FREETYPE', but there's a runtime selection path available too. The shared extra flags parameters (very rarely used) are now stored in ImFontAtlas::FontBuilderFlags.
707 - renamed ImFontConfig::RasterizerFlags (used by FreeType) to ImFontConfig::FontBuilderFlags.
708 - renamed ImGuiFreeType::XXX flags to ImGuiFreeTypeBuilderFlags_XXX for consistency with other API.
709 - 2020/10/12 (1.80) - removed redirecting functions/enums that were marked obsolete in 1.63 (August 2018):
710 - ImGui::IsItemDeactivatedAfterChange() -> use ImGui::IsItemDeactivatedAfterEdit().
711 - ImGuiCol_ModalWindowDarkening -> use ImGuiCol_ModalWindowDimBg
712 - ImGuiInputTextCallback -> use ImGuiTextEditCallback
713 - ImGuiInputTextCallbackData -> use ImGuiTextEditCallbackData
714 - 2020/12/21 (1.80) - renamed ImDrawList::AddBezierCurve() to AddBezierCubic(), and PathBezierCurveTo() to PathBezierCubicCurveTo(). Kept inline redirection function (will obsolete).
715 - 2020/12/04 (1.80) - added imgui_tables.cpp file! Manually constructed project files will need the new file added!
716 - 2020/11/18 (1.80) - renamed undocumented/internals ImGuiColumnsFlags_* to ImGuiOldColumnFlags_* in prevision of incoming Tables API.
717 - 2020/11/03 (1.80) - renamed io.ConfigWindowsMemoryCompactTimer to io.ConfigMemoryCompactTimer as the feature will apply to other data structures
718 - 2020/10/14 (1.80) - backends: moved all backends files (imgui_impl_XXXX.cpp, imgui_impl_XXXX.h) from examples/ to backends/.
719 - 2020/10/12 (1.80) - removed redirecting functions/enums that were marked obsolete in 1.60 (April 2018):
720 - io.RenderDrawListsFn pointer -> use ImGui::GetDrawData() value and call the render function of your backend
721 - ImGui::IsAnyWindowFocused() -> use ImGui::IsWindowFocused(ImGuiFocusedFlags_AnyWindow)
722 - ImGui::IsAnyWindowHovered() -> use ImGui::IsWindowHovered(ImGuiHoveredFlags_AnyWindow)
723 - ImGuiStyleVar_Count_ -> use ImGuiStyleVar_COUNT
724 - ImGuiMouseCursor_Count_ -> use ImGuiMouseCursor_COUNT
725 - removed redirecting functions names that were marked obsolete in 1.61 (May 2018):
726 - InputFloat (... int decimal_precision ...) -> use InputFloat (... const char* format ...) with format = "%.Xf" where X is your value for decimal_precision.
727 - same for InputFloat2()/InputFloat3()/InputFloat4() variants taking a `int decimal_precision` parameter.
728 - 2020/10/05 (1.79) - removed ImGuiListClipper: Renamed constructor parameters which created an ambiguous alternative to using the ImGuiListClipper::Begin() function, with misleading edge cases (note: imgui_memory_editor <0.40 from imgui_club/ used this old clipper API. Update your copy if needed).
729 - 2020/09/25 (1.79) - renamed ImGuiSliderFlags_ClampOnInput to ImGuiSliderFlags_AlwaysClamp. Kept redirection enum (will obsolete sooner because previous name was added recently).
730 - 2020/09/25 (1.79) - renamed style.TabMinWidthForUnselectedCloseButton to style.TabMinWidthForCloseButton.
731 - 2020/09/21 (1.79) - renamed OpenPopupContextItem() back to OpenPopupOnItemClick(), reverting the change from 1.77. For varieties of reason this is more self-explanatory.
732 - 2020/09/21 (1.79) - removed return value from OpenPopupOnItemClick() - returned true on mouse release on an item - because it is inconsistent with other popup APIs and makes others misleading. It's also and unnecessary: you can use IsWindowAppearing() after BeginPopup() for a similar result.
733 - 2020/09/17 (1.79) - removed ImFont::DisplayOffset in favor of ImFontConfig::GlyphOffset. DisplayOffset was applied after scaling and not very meaningful/useful outside of being needed by the default ProggyClean font. If you scaled this value after calling AddFontDefault(), this is now done automatically. It was also getting in the way of better font scaling, so let's get rid of it now!
734 - 2020/08/17 (1.78) - obsoleted use of the trailing 'float power=1.0f' parameter for DragFloat(), DragFloat2(), DragFloat3(), DragFloat4(), DragFloatRange2(), DragScalar(), DragScalarN(), SliderFloat(), SliderFloat2(), SliderFloat3(), SliderFloat4(), SliderScalar(), SliderScalarN(), VSliderFloat() and VSliderScalar().
735 replaced the 'float power=1.0f' argument with integer-based flags defaulting to 0 (as with all our flags).
736 worked out a backward-compatibility scheme so hopefully most C++ codebase should not be affected. in short, when calling those functions:
737 - if you omitted the 'power' parameter (likely!), you are not affected.
738 - if you set the 'power' parameter to 1.0f (same as previous default value): 1/ your compiler may warn on float>int conversion, 2/ everything else will work. 3/ you can replace the 1.0f value with 0 to fix the warning, and be technically correct.
739 - if you set the 'power' parameter to >1.0f (to enable non-linear editing): 1/ your compiler may warn on float>int conversion, 2/ code will assert at runtime, 3/ in case asserts are disabled, the code will not crash and enable the _Logarithmic flag. 4/ you can replace the >1.0f value with ImGuiSliderFlags_Logarithmic to fix the warning/assert and get a _similar_ effect as previous uses of power >1.0f.
740 see https://github.com/ocornut/imgui/issues/3361 for all details.
741 kept inline redirection functions (will obsolete) apart for: DragFloatRange2(), VSliderFloat(), VSliderScalar(). For those three the 'float power=1.0f' version was removed directly as they were most unlikely ever used.
742 for shared code, you can version check at compile-time with `#if IMGUI_VERSION_NUM >= 17704`.
743 - obsoleted use of v_min > v_max in DragInt, DragFloat, DragScalar to lock edits (introduced in 1.73, was not demoed nor documented very), will be replaced by a more generic ReadOnly feature. You may use the ImGuiSliderFlags_ReadOnly internal flag in the meantime.
744 - 2020/06/23 (1.77) - removed BeginPopupContextWindow(const char*, int mouse_button, bool also_over_items) in favor of BeginPopupContextWindow(const char*, ImGuiPopupFlags flags) with ImGuiPopupFlags_NoOverItems.
745 - 2020/06/15 (1.77) - renamed OpenPopupOnItemClick() to OpenPopupContextItem(). Kept inline redirection function (will obsolete). [NOTE: THIS WAS REVERTED IN 1.79]
746 - 2020/06/15 (1.77) - removed CalcItemRectClosestPoint() entry point which was made obsolete and asserting in December 2017.
747 - 2020/04/23 (1.77) - removed unnecessary ID (first arg) of ImFontAtlas::AddCustomRectRegular().
748 - 2020/01/22 (1.75) - ImDrawList::AddCircle()/AddCircleFilled() functions don't accept negative radius any more.
749 - 2019/12/17 (1.75) - [undid this change in 1.76] made Columns() limited to 64 columns by asserting above that limit. While the current code technically supports it, future code may not so we're putting the restriction ahead.
750 - 2019/12/13 (1.75) - [imgui_internal.h] changed ImRect() default constructor initializes all fields to 0.0f instead of (FLT_MAX,FLT_MAX,-FLT_MAX,-FLT_MAX). If you used ImRect::Add() to create bounding boxes by adding multiple points into it, you may need to fix your initial value.
751 - 2019/12/08 (1.75) - removed redirecting functions/enums that were marked obsolete in 1.53 (December 2017):
752 - ShowTestWindow() -> use ShowDemoWindow()
753 - IsRootWindowFocused() -> use IsWindowFocused(ImGuiFocusedFlags_RootWindow)
754 - IsRootWindowOrAnyChildFocused() -> use IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows)
755 - SetNextWindowContentWidth(w) -> use SetNextWindowContentSize(ImVec2(w, 0.0f)
756 - GetItemsLineHeightWithSpacing() -> use GetFrameHeightWithSpacing()
757 - ImGuiCol_ChildWindowBg -> use ImGuiCol_ChildBg
758 - ImGuiStyleVar_ChildWindowRounding -> use ImGuiStyleVar_ChildRounding
759 - ImGuiTreeNodeFlags_AllowOverlapMode -> use ImGuiTreeNodeFlags_AllowItemOverlap
760 - IMGUI_DISABLE_TEST_WINDOWS -> use IMGUI_DISABLE_DEMO_WINDOWS
761 - 2019/12/08 (1.75) - obsoleted calling ImDrawList::PrimReserve() with a negative count (which was vaguely documented and rarely if ever used). Instead, we added an explicit PrimUnreserve() API.
762 - 2019/12/06 (1.75) - removed implicit default parameter to IsMouseDragging(int button = 0) to be consistent with other mouse functions (none of the other functions have it).
763 - 2019/11/21 (1.74) - ImFontAtlas::AddCustomRectRegular() now requires an ID larger than 0x110000 (instead of 0x10000) to conform with supporting Unicode planes 1-16 in a future update. ID below 0x110000 will now assert.
764 - 2019/11/19 (1.74) - renamed IMGUI_DISABLE_FORMAT_STRING_FUNCTIONS to IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS for consistency.
765 - 2019/11/19 (1.74) - renamed IMGUI_DISABLE_MATH_FUNCTIONS to IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS for consistency.
766 - 2019/10/22 (1.74) - removed redirecting functions/enums that were marked obsolete in 1.52 (October 2017):
767 - Begin() [old 5 args version] -> use Begin() [3 args], use SetNextWindowSize() SetNextWindowBgAlpha() if needed
768 - IsRootWindowOrAnyChildHovered() -> use IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows)
769 - AlignFirstTextHeightToWidgets() -> use AlignTextToFramePadding()
770 - SetNextWindowPosCenter() -> use SetNextWindowPos() with a pivot of (0.5f, 0.5f)
771 - ImFont::Glyph -> use ImFontGlyph
772 - 2019/10/14 (1.74) - inputs: Fixed a miscalculation in the keyboard/mouse "typematic" repeat delay/rate calculation, used by keys and e.g. repeating mouse buttons as well as the GetKeyPressedAmount() function.
773 if you were using a non-default value for io.KeyRepeatRate (previous default was 0.250), you can add +io.KeyRepeatDelay to it to compensate for the fix.
774 The function was triggering on: 0.0 and (delay+rate*N) where (N>=1). Fixed formula responds to (N>=0). Effectively it made io.KeyRepeatRate behave like it was set to (io.KeyRepeatRate + io.KeyRepeatDelay).
775 If you never altered io.KeyRepeatRate nor used GetKeyPressedAmount() this won't affect you.
776 - 2019/07/15 (1.72) - removed TreeAdvanceToLabelPos() which is rarely used and only does SetCursorPosX(GetCursorPosX() + GetTreeNodeToLabelSpacing()). Kept redirection function (will obsolete).
777 - 2019/07/12 (1.72) - renamed ImFontAtlas::CustomRect to ImFontAtlasCustomRect. Kept redirection typedef (will obsolete).
778 - 2019/06/14 (1.72) - removed redirecting functions/enums names that were marked obsolete in 1.51 (June 2017): ImGuiCol_Column*, ImGuiSetCond_*, IsItemHoveredRect(), IsPosHoveringAnyWindow(), IsMouseHoveringAnyWindow(), IsMouseHoveringWindow(), IMGUI_ONCE_UPON_A_FRAME. Grep this log for details and new names, or see how they were implemented until 1.71.
779 - 2019/06/07 (1.71) - rendering of child window outer decorations (bg color, border, scrollbars) is now performed as part of the parent window. If you have
780 overlapping child windows in a same parent, and relied on their relative z-order to be mapped to their submission order, this will affect your rendering.
781 This optimization is disabled if the parent window has no visual output, because it appears to be the most common situation leading to the creation of overlapping child windows.
782 Please reach out if you are affected.
783 - 2019/05/13 (1.71) - renamed SetNextTreeNodeOpen() to SetNextItemOpen(). Kept inline redirection function (will obsolete).
784 - 2019/05/11 (1.71) - changed io.AddInputCharacter(unsigned short c) signature to io.AddInputCharacter(unsigned int c).
785 - 2019/04/29 (1.70) - improved ImDrawList thick strokes (>1.0f) preserving correct thickness up to 90 degrees angles (e.g. rectangles). If you have custom rendering using thick lines, they will appear thicker now.
786 - 2019/04/29 (1.70) - removed GetContentRegionAvailWidth(), use GetContentRegionAvail().x instead. Kept inline redirection function (will obsolete).
787 - 2019/03/04 (1.69) - renamed GetOverlayDrawList() to GetForegroundDrawList(). Kept redirection function (will obsolete).
788 - 2019/02/26 (1.69) - renamed ImGuiColorEditFlags_RGB/ImGuiColorEditFlags_HSV/ImGuiColorEditFlags_HEX to ImGuiColorEditFlags_DisplayRGB/ImGuiColorEditFlags_DisplayHSV/ImGuiColorEditFlags_DisplayHex. Kept redirection enums (will obsolete).
789 - 2019/02/14 (1.68) - made it illegal/assert when io.DisplayTime == 0.0f (with an exception for the first frame). If for some reason your time step calculation gives you a zero value, replace it with an arbitrarily small value!
790 - 2019/02/01 (1.68) - removed io.DisplayVisibleMin/DisplayVisibleMax (which were marked obsolete and removed from viewport/docking branch already).
791 - 2019/01/06 (1.67) - renamed io.InputCharacters[], marked internal as was always intended. Please don't access directly, and use AddInputCharacter() instead!
792 - 2019/01/06 (1.67) - renamed ImFontAtlas::GlyphRangesBuilder to ImFontGlyphRangesBuilder. Kept redirection typedef (will obsolete).
793 - 2018/12/20 (1.67) - made it illegal to call Begin("") with an empty string. This somehow half-worked before but had various undesirable side-effects.
794 - 2018/12/10 (1.67) - renamed io.ConfigResizeWindowsFromEdges to io.ConfigWindowsResizeFromEdges as we are doing a large pass on configuration flags.
795 - 2018/10/12 (1.66) - renamed misc/stl/imgui_stl.* to misc/cpp/imgui_stdlib.* in prevision for other C++ helper files.
796 - 2018/09/28 (1.66) - renamed SetScrollHere() to SetScrollHereY(). Kept redirection function (will obsolete).
797 - 2018/09/06 (1.65) - renamed stb_truetype.h to imstb_truetype.h, stb_textedit.h to imstb_textedit.h, and stb_rect_pack.h to imstb_rectpack.h.
798 If you were conveniently using the imgui copy of those STB headers in your project you will have to update your include paths.
799 - 2018/09/05 (1.65) - renamed io.OptCursorBlink/io.ConfigCursorBlink to io.ConfigInputTextCursorBlink. (#1427)
800 - 2018/08/31 (1.64) - added imgui_widgets.cpp file, extracted and moved widgets code out of imgui.cpp into imgui_widgets.cpp. Re-ordered some of the code remaining in imgui.cpp.
801 NONE OF THE FUNCTIONS HAVE CHANGED. THE CODE IS SEMANTICALLY 100% IDENTICAL, BUT _EVERY_ FUNCTION HAS BEEN MOVED.
802 Because of this, any local modifications to imgui.cpp will likely conflict when you update. Read docs/CHANGELOG.txt for suggestions.
803 - 2018/08/22 (1.63) - renamed IsItemDeactivatedAfterChange() to IsItemDeactivatedAfterEdit() for consistency with new IsItemEdited() API. Kept redirection function (will obsolete soonish as IsItemDeactivatedAfterChange() is very recent).
804 - 2018/08/21 (1.63) - renamed ImGuiTextEditCallback to ImGuiInputTextCallback, ImGuiTextEditCallbackData to ImGuiInputTextCallbackData for consistency. Kept redirection types (will obsolete).
805 - 2018/08/21 (1.63) - removed ImGuiInputTextCallbackData::ReadOnly since it is a duplication of (ImGuiInputTextCallbackData::Flags & ImGuiInputTextFlags_ReadOnly).
806 - 2018/08/01 (1.63) - removed per-window ImGuiWindowFlags_ResizeFromAnySide beta flag in favor of a global io.ConfigResizeWindowsFromEdges [update 1.67 renamed to ConfigWindowsResizeFromEdges] to enable the feature.
807 - 2018/08/01 (1.63) - renamed io.OptCursorBlink to io.ConfigCursorBlink [-> io.ConfigInputTextCursorBlink in 1.65], io.OptMacOSXBehaviors to ConfigMacOSXBehaviors for consistency.
808 - 2018/07/22 (1.63) - changed ImGui::GetTime() return value from float to double to avoid accumulating floating point imprecisions over time.
809 - 2018/07/08 (1.63) - style: renamed ImGuiCol_ModalWindowDarkening to ImGuiCol_ModalWindowDimBg for consistency with other features. Kept redirection enum (will obsolete).
810 - 2018/06/08 (1.62) - examples: the imgui_impl_XXX files have been split to separate platform (Win32, GLFW, SDL2, etc.) from renderer (DX11, OpenGL, Vulkan, etc.).
811 old backends will still work as is, however prefer using the separated backends as they will be updated to support multi-viewports.
812 when adopting new backends follow the main.cpp code of your preferred examples/ folder to know which functions to call.
813 in particular, note that old backends called ImGui::NewFrame() at the end of their ImGui_ImplXXXX_NewFrame() function.
814 - 2018/06/06 (1.62) - renamed GetGlyphRangesChinese() to GetGlyphRangesChineseFull() to distinguish other variants and discourage using the full set.
815 - 2018/06/06 (1.62) - TreeNodeEx()/TreeNodeBehavior(): the ImGuiTreeNodeFlags_CollapsingHeader helper now include the ImGuiTreeNodeFlags_NoTreePushOnOpen flag. See Changelog for details.
816 - 2018/05/03 (1.61) - DragInt(): the default compile-time format string has been changed from "%.0f" to "%d", as we are not using integers internally any more.
817 If you used DragInt() with custom format strings, make sure you change them to use %d or an integer-compatible format.
818 To honor backward-compatibility, the DragInt() code will currently parse and modify format strings to replace %*f with %d, giving time to users to upgrade their code.
819 If you have IMGUI_DISABLE_OBSOLETE_FUNCTIONS enabled, the code will instead assert! You may run a reg-exp search on your codebase for e.g. "DragInt.*%f" to help you find them.
820 - 2018/04/28 (1.61) - obsoleted InputFloat() functions taking an optional "int decimal_precision" in favor of an equivalent and more flexible "const char* format",
821 consistent with other functions. Kept redirection functions (will obsolete).
822 - 2018/04/09 (1.61) - IM_DELETE() helper function added in 1.60 doesn't clear the input _pointer_ reference, more consistent with expectation and allows passing r-value.
823 - 2018/03/20 (1.60) - renamed io.WantMoveMouse to io.WantSetMousePos for consistency and ease of understanding (was added in 1.52, _not_ used by core and only honored by some backend ahead of merging the Nav branch).
824 - 2018/03/12 (1.60) - removed ImGuiCol_CloseButton, ImGuiCol_CloseButtonActive, ImGuiCol_CloseButtonHovered as the closing cross uses regular button colors now.
825 - 2018/03/08 (1.60) - changed ImFont::DisplayOffset.y to default to 0 instead of +1. Fixed rounding of Ascent/Descent to match TrueType renderer. If you were adding or subtracting to ImFont::DisplayOffset check if your fonts are correctly aligned vertically.
826 - 2018/03/03 (1.60) - renamed ImGuiStyleVar_Count_ to ImGuiStyleVar_COUNT and ImGuiMouseCursor_Count_ to ImGuiMouseCursor_COUNT for consistency with other public enums.
827 - 2018/02/18 (1.60) - BeginDragDropSource(): temporarily removed the optional mouse_button=0 parameter because it is not really usable in many situations at the moment.
828 - 2018/02/16 (1.60) - obsoleted the io.RenderDrawListsFn callback, you can call your graphics engine render function after ImGui::Render(). Use ImGui::GetDrawData() to retrieve the ImDrawData* to display.
829 - 2018/02/07 (1.60) - reorganized context handling to be more explicit,
830 - YOU NOW NEED TO CALL ImGui::CreateContext() AT THE BEGINNING OF YOUR APP, AND CALL ImGui::DestroyContext() AT THE END.
831 - removed Shutdown() function, as DestroyContext() serve this purpose.
832 - you may pass a ImFontAtlas* pointer to CreateContext() to share a font atlas between contexts. Otherwise CreateContext() will create its own font atlas instance.
833 - removed allocator parameters from CreateContext(), they are now setup with SetAllocatorFunctions(), and shared by all contexts.
834 - removed the default global context and font atlas instance, which were confusing for users of DLL reloading and users of multiple contexts.
835 - 2018/01/31 (1.60) - moved sample TTF files from extra_fonts/ to misc/fonts/. If you loaded files directly from the imgui repo you may need to update your paths.
836 - 2018/01/11 (1.60) - obsoleted IsAnyWindowHovered() in favor of IsWindowHovered(ImGuiHoveredFlags_AnyWindow). Kept redirection function (will obsolete).
837 - 2018/01/11 (1.60) - obsoleted IsAnyWindowFocused() in favor of IsWindowFocused(ImGuiFocusedFlags_AnyWindow). Kept redirection function (will obsolete).
838 - 2018/01/03 (1.60) - renamed ImGuiSizeConstraintCallback to ImGuiSizeCallback, ImGuiSizeConstraintCallbackData to ImGuiSizeCallbackData.
839 - 2017/12/29 (1.60) - removed CalcItemRectClosestPoint() which was weird and not really used by anyone except demo code. If you need it it's easy to replicate on your side.
840 - 2017/12/24 (1.53) - renamed the emblematic ShowTestWindow() function to ShowDemoWindow(). Kept redirection function (will obsolete).
841 - 2017/12/21 (1.53) - ImDrawList: renamed style.AntiAliasedShapes to style.AntiAliasedFill for consistency and as a way to explicitly break code that manipulate those flag at runtime. You can now manipulate ImDrawList::Flags
842 - 2017/12/21 (1.53) - ImDrawList: removed 'bool anti_aliased = true' final parameter of ImDrawList::AddPolyline() and ImDrawList::AddConvexPolyFilled(). Prefer manipulating ImDrawList::Flags if you need to toggle them during the frame.
843 - 2017/12/14 (1.53) - using the ImGuiWindowFlags_NoScrollWithMouse flag on a child window forwards the mouse wheel event to the parent window, unless either ImGuiWindowFlags_NoInputs or ImGuiWindowFlags_NoScrollbar are also set.
844 - 2017/12/13 (1.53) - renamed GetItemsLineHeightWithSpacing() to GetFrameHeightWithSpacing(). Kept redirection function (will obsolete).
845 - 2017/12/13 (1.53) - obsoleted IsRootWindowFocused() in favor of using IsWindowFocused(ImGuiFocusedFlags_RootWindow). Kept redirection function (will obsolete).
846 - obsoleted IsRootWindowOrAnyChildFocused() in favor of using IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows). Kept redirection function (will obsolete).
847 - 2017/12/12 (1.53) - renamed ImGuiTreeNodeFlags_AllowOverlapMode to ImGuiTreeNodeFlags_AllowItemOverlap. Kept redirection enum (will obsolete).
848 - 2017/12/10 (1.53) - removed SetNextWindowContentWidth(), prefer using SetNextWindowContentSize(). Kept redirection function (will obsolete).
849 - 2017/11/27 (1.53) - renamed ImGuiTextBuffer::append() helper to appendf(), appendv() to appendfv(). If you copied the 'Log' demo in your code, it uses appendv() so that needs to be renamed.
850 - 2017/11/18 (1.53) - Style, Begin: removed ImGuiWindowFlags_ShowBorders window flag. Borders are now fully set up in the ImGuiStyle structure (see e.g. style.FrameBorderSize, style.WindowBorderSize). Use ImGui::ShowStyleEditor() to look them up.
851 Please note that the style system will keep evolving (hopefully stabilizing in Q1 2018), and so custom styles will probably subtly break over time. It is recommended you use the StyleColorsClassic(), StyleColorsDark(), StyleColorsLight() functions.
852 - 2017/11/18 (1.53) - Style: removed ImGuiCol_ComboBg in favor of combo boxes using ImGuiCol_PopupBg for consistency.
853 - 2017/11/18 (1.53) - Style: renamed ImGuiCol_ChildWindowBg to ImGuiCol_ChildBg.
854 - 2017/11/18 (1.53) - Style: renamed style.ChildWindowRounding to style.ChildRounding, ImGuiStyleVar_ChildWindowRounding to ImGuiStyleVar_ChildRounding.
855 - 2017/11/02 (1.53) - obsoleted IsRootWindowOrAnyChildHovered() in favor of using IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows);
856 - 2017/10/24 (1.52) - renamed IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCS/IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCS to IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS/IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS for consistency.
857 - 2017/10/20 (1.52) - changed IsWindowHovered() default parameters behavior to return false if an item is active in another window (e.g. click-dragging item from another window to this window). You can use the newly introduced IsWindowHovered() flags to requests this specific behavior if you need it.
858 - 2017/10/20 (1.52) - marked IsItemHoveredRect()/IsMouseHoveringWindow() as obsolete, in favor of using the newly introduced flags for IsItemHovered() and IsWindowHovered(). See https://github.com/ocornut/imgui/issues/1382 for details.
859 removed the IsItemRectHovered()/IsWindowRectHovered() names introduced in 1.51 since they were merely more consistent names for the two functions we are now obsoleting.
860 IsItemHoveredRect() --> IsItemHovered(ImGuiHoveredFlags_RectOnly)
861 IsMouseHoveringAnyWindow() --> IsWindowHovered(ImGuiHoveredFlags_AnyWindow)
862 IsMouseHoveringWindow() --> IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem) [weird, old behavior]
863 - 2017/10/17 (1.52) - marked the old 5-parameters version of Begin() as obsolete (still available). Use SetNextWindowSize()+Begin() instead!
864 - 2017/10/11 (1.52) - renamed AlignFirstTextHeightToWidgets() to AlignTextToFramePadding(). Kept inline redirection function (will obsolete).
865 - 2017/09/26 (1.52) - renamed ImFont::Glyph to ImFontGlyph. Kept redirection typedef (will obsolete).
866 - 2017/09/25 (1.52) - removed SetNextWindowPosCenter() because SetNextWindowPos() now has the optional pivot information to do the same and more. Kept redirection function (will obsolete).
867 - 2017/08/25 (1.52) - io.MousePos needs to be set to ImVec2(-FLT_MAX,-FLT_MAX) when mouse is unavailable/missing. Previously ImVec2(-1,-1) was enough but we now accept negative mouse coordinates. In your backend if you need to support unavailable mouse, make sure to replace "io.MousePos = ImVec2(-1,-1)" with "io.MousePos = ImVec2(-FLT_MAX,-FLT_MAX)".
868 - 2017/08/22 (1.51) - renamed IsItemHoveredRect() to IsItemRectHovered(). Kept inline redirection function (will obsolete). -> (1.52) use IsItemHovered(ImGuiHoveredFlags_RectOnly)!
869 - renamed IsMouseHoveringAnyWindow() to IsAnyWindowHovered() for consistency. Kept inline redirection function (will obsolete).
870 - renamed IsMouseHoveringWindow() to IsWindowRectHovered() for consistency. Kept inline redirection function (will obsolete).
871 - 2017/08/20 (1.51) - renamed GetStyleColName() to GetStyleColorName() for consistency.
872 - 2017/08/20 (1.51) - added PushStyleColor(ImGuiCol idx, ImU32 col) overload, which _might_ cause an "ambiguous call" compilation error if you are using ImColor() with implicit cast. Cast to ImU32 or ImVec4 explicily to fix.
873 - 2017/08/15 (1.51) - marked the weird IMGUI_ONCE_UPON_A_FRAME helper macro as obsolete. prefer using the more explicit ImGuiOnceUponAFrame type.
874 - 2017/08/15 (1.51) - changed parameter order for BeginPopupContextWindow() from (const char*,int buttons,bool also_over_items) to (const char*,int buttons,bool also_over_items). Note that most calls relied on default parameters completely.
875 - 2017/08/13 (1.51) - renamed ImGuiCol_Column to ImGuiCol_Separator, ImGuiCol_ColumnHovered to ImGuiCol_SeparatorHovered, ImGuiCol_ColumnActive to ImGuiCol_SeparatorActive. Kept redirection enums (will obsolete).
876 - 2017/08/11 (1.51) - renamed ImGuiSetCond_Always to ImGuiCond_Always, ImGuiSetCond_Once to ImGuiCond_Once, ImGuiSetCond_FirstUseEver to ImGuiCond_FirstUseEver, ImGuiSetCond_Appearing to ImGuiCond_Appearing. Kept redirection enums (will obsolete).
877 - 2017/08/09 (1.51) - removed ValueColor() helpers, they are equivalent to calling Text(label) + SameLine() + ColorButton().
878 - 2017/08/08 (1.51) - removed ColorEditMode() and ImGuiColorEditMode in favor of ImGuiColorEditFlags and parameters to the various Color*() functions. The SetColorEditOptions() allows to initialize default but the user can still change them with right-click context menu.
879 - changed prototype of 'ColorEdit4(const char* label, float col[4], bool show_alpha = true)' to 'ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags = 0)', where passing flags = 0x01 is a safe no-op (hello dodgy backward compatibility!). - check and run the demo window, under "Color/Picker Widgets", to understand the various new options.
880 - changed prototype of rarely used 'ColorButton(ImVec4 col, bool small_height = false, bool outline_border = true)' to 'ColorButton(const char* desc_id, ImVec4 col, ImGuiColorEditFlags flags = 0, ImVec2 size = ImVec2(0, 0))'
881 - 2017/07/20 (1.51) - removed IsPosHoveringAnyWindow(ImVec2), which was partly broken and misleading. ASSERT + redirect user to io.WantCaptureMouse
882 - 2017/05/26 (1.50) - removed ImFontConfig::MergeGlyphCenterV in favor of a more multipurpose ImFontConfig::GlyphOffset.
883 - 2017/05/01 (1.50) - renamed ImDrawList::PathFill() (rarely used directly) to ImDrawList::PathFillConvex() for clarity.
884 - 2016/11/06 (1.50) - BeginChild(const char*) now applies the stack id to the provided label, consistently with other functions as it should always have been. It shouldn't affect you unless (extremely unlikely) you were appending multiple times to a same child from different locations of the stack id. If that's the case, generate an id with GetID() and use it instead of passing string to BeginChild().
885 - 2016/10/15 (1.50) - avoid 'void* user_data' parameter to io.SetClipboardTextFn/io.GetClipboardTextFn pointers. We pass io.ClipboardUserData to it.
886 - 2016/09/25 (1.50) - style.WindowTitleAlign is now a ImVec2 (ImGuiAlign enum was removed). set to (0.5f,0.5f) for horizontal+vertical centering, (0.0f,0.0f) for upper-left, etc.
887 - 2016/07/30 (1.50) - SameLine(x) with x>0.0f is now relative to left of column/group if any, and not always to left of window. This was sort of always the intent and hopefully, breakage should be minimal.
888 - 2016/05/12 (1.49) - title bar (using ImGuiCol_TitleBg/ImGuiCol_TitleBgActive colors) isn't rendered over a window background (ImGuiCol_WindowBg color) anymore.
889 If your TitleBg/TitleBgActive alpha was 1.0f or you are using the default theme it will not affect you, otherwise if <1.0f you need to tweak your custom theme to readjust for the fact that we don't draw a WindowBg background behind the title bar.
890 This helper function will convert an old TitleBg/TitleBgActive color into a new one with the same visual output, given the OLD color and the OLD WindowBg color:
891 ImVec4 ConvertTitleBgCol(const ImVec4& win_bg_col, const ImVec4& title_bg_col) { float new_a = 1.0f - ((1.0f - win_bg_col.w) * (1.0f - title_bg_col.w)), k = title_bg_col.w / new_a; return ImVec4((win_bg_col.x * win_bg_col.w + title_bg_col.x) * k, (win_bg_col.y * win_bg_col.w + title_bg_col.y) * k, (win_bg_col.z * win_bg_col.w + title_bg_col.z) * k, new_a); }
892 If this is confusing, pick the RGB value from title bar from an old screenshot and apply this as TitleBg/TitleBgActive. Or you may just create TitleBgActive from a tweaked TitleBg color.
893 - 2016/05/07 (1.49) - removed confusing set of GetInternalState(), GetInternalStateSize(), SetInternalState() functions. Now using CreateContext(), DestroyContext(), GetCurrentContext(), SetCurrentContext().
894 - 2016/05/02 (1.49) - renamed SetNextTreeNodeOpened() to SetNextTreeNodeOpen(), no redirection.
895 - 2016/05/01 (1.49) - obsoleted old signature of CollapsingHeader(const char* label, const char* str_id = NULL, bool display_frame = true, bool default_open = false) as extra parameters were badly designed and rarely used. You can replace the "default_open = true" flag in new API with CollapsingHeader(label, ImGuiTreeNodeFlags_DefaultOpen).
896 - 2016/04/26 (1.49) - changed ImDrawList::PushClipRect(ImVec4 rect) to ImDrawList::PushClipRect(Imvec2 min,ImVec2 max,bool intersect_with_current_clip_rect=false). Note that higher-level ImGui::PushClipRect() is preferable because it will clip at logic/widget level, whereas ImDrawList::PushClipRect() only affect your renderer.
897 - 2016/04/03 (1.48) - removed style.WindowFillAlphaDefault setting which was redundant. Bake default BG alpha inside style.Colors[ImGuiCol_WindowBg] and all other Bg color values. (ref GitHub issue #337).
898 - 2016/04/03 (1.48) - renamed ImGuiCol_TooltipBg to ImGuiCol_PopupBg, used by popups/menus and tooltips. popups/menus were previously using ImGuiCol_WindowBg. (ref github issue #337)
899 - 2016/03/21 (1.48) - renamed GetWindowFont() to GetFont(), GetWindowFontSize() to GetFontSize(). Kept inline redirection function (will obsolete).
900 - 2016/03/02 (1.48) - InputText() completion/history/always callbacks: if you modify the text buffer manually (without using DeleteChars()/InsertChars() helper) you need to maintain the BufTextLen field. added an assert.
901 - 2016/01/23 (1.48) - fixed not honoring exact width passed to PushItemWidth(), previously it would add extra FramePadding.x*2 over that width. if you had manual pixel-perfect alignment in place it might affect you.
902 - 2015/12/27 (1.48) - fixed ImDrawList::AddRect() which used to render a rectangle 1 px too large on each axis.
903 - 2015/12/04 (1.47) - renamed Color() helpers to ValueColor() - dangerously named, rarely used and probably to be made obsolete.
904 - 2015/08/29 (1.45) - with the addition of horizontal scrollbar we made various fixes to inconsistencies with dealing with cursor position.
905 GetCursorPos()/SetCursorPos() functions now include the scrolled amount. It shouldn't affect the majority of users, but take note that SetCursorPosX(100.0f) puts you at +100 from the starting x position which may include scrolling, not at +100 from the window left side.
906 GetContentRegionMax()/GetWindowContentRegionMin()/GetWindowContentRegionMax() functions allow include the scrolled amount. Typically those were used in cases where no scrolling would happen so it may not be a problem, but watch out!
907 - 2015/08/29 (1.45) - renamed style.ScrollbarWidth to style.ScrollbarSize
908 - 2015/08/05 (1.44) - split imgui.cpp into extra files: imgui_demo.cpp imgui_draw.cpp imgui_internal.h that you need to add to your project.
909 - 2015/07/18 (1.44) - fixed angles in ImDrawList::PathArcTo(), PathArcToFast() (introduced in 1.43) being off by an extra PI for no justifiable reason
910 - 2015/07/14 (1.43) - add new ImFontAtlas::AddFont() API. For the old AddFont***, moved the 'font_no' parameter of ImFontAtlas::AddFont** functions to the ImFontConfig structure.
911 you need to render your textured triangles with bilinear filtering to benefit from sub-pixel positioning of text.
912 - 2015/07/08 (1.43) - switched rendering data to use indexed rendering. this is saving a fair amount of CPU/GPU and enables us to get anti-aliasing for a marginal cost.
913 this necessary change will break your rendering function! the fix should be very easy. sorry for that :(
914 - if you are using a vanilla copy of one of the imgui_impl_XXX.cpp provided in the example, you just need to update your copy and you can ignore the rest.
915 - the signature of the io.RenderDrawListsFn handler has changed!
916 old: ImGui_XXXX_RenderDrawLists(ImDrawList** const cmd_lists, int cmd_lists_count)
917 new: ImGui_XXXX_RenderDrawLists(ImDrawData* draw_data).
918 parameters: 'cmd_lists' becomes 'draw_data->CmdLists', 'cmd_lists_count' becomes 'draw_data->CmdListsCount'
919 ImDrawList: 'commands' becomes 'CmdBuffer', 'vtx_buffer' becomes 'VtxBuffer', 'IdxBuffer' is new.
920 ImDrawCmd: 'vtx_count' becomes 'ElemCount', 'clip_rect' becomes 'ClipRect', 'user_callback' becomes 'UserCallback', 'texture_id' becomes 'TextureId'.
921 - each ImDrawList now contains both a vertex buffer and an index buffer. For each command, render ElemCount/3 triangles using indices from the index buffer.
922 - if you REALLY cannot render indexed primitives, you can call the draw_data->DeIndexAllBuffers() method to de-index the buffers. This is slow and a waste of CPU/GPU. Prefer using indexed rendering!
923 - refer to code in the examples/ folder or ask on the GitHub if you are unsure of how to upgrade. please upgrade!
924 - 2015/07/10 (1.43) - changed SameLine() parameters from int to float.
925 - 2015/07/02 (1.42) - renamed SetScrollPosHere() to SetScrollFromCursorPos(). Kept inline redirection function (will obsolete).
926 - 2015/07/02 (1.42) - renamed GetScrollPosY() to GetScrollY(). Necessary to reduce confusion along with other scrolling functions, because positions (e.g. cursor position) are not equivalent to scrolling amount.
927 - 2015/06/14 (1.41) - changed ImageButton() default bg_col parameter from (0,0,0,1) (black) to (0,0,0,0) (transparent) - makes a difference when texture have transparence
928 - 2015/06/14 (1.41) - changed Selectable() API from (label, selected, size) to (label, selected, flags, size). Size override should have been rarely used. Sorry!
929 - 2015/05/31 (1.40) - renamed GetWindowCollapsed() to IsWindowCollapsed() for consistency. Kept inline redirection function (will obsolete).
930 - 2015/05/31 (1.40) - renamed IsRectClipped() to IsRectVisible() for consistency. Note that return value is opposite! Kept inline redirection function (will obsolete).
931 - 2015/05/27 (1.40) - removed the third 'repeat_if_held' parameter from Button() - sorry! it was rarely used and inconsistent. Use PushButtonRepeat(true) / PopButtonRepeat() to enable repeat on desired buttons.
932 - 2015/05/11 (1.40) - changed BeginPopup() API, takes a string identifier instead of a bool. ImGui needs to manage the open/closed state of popups. Call OpenPopup() to actually set the "open" state of a popup. BeginPopup() returns true if the popup is opened.
933 - 2015/05/03 (1.40) - removed style.AutoFitPadding, using style.WindowPadding makes more sense (the default values were already the same).
934 - 2015/04/13 (1.38) - renamed IsClipped() to IsRectClipped(). Kept inline redirection function until 1.50.
935 - 2015/04/09 (1.38) - renamed ImDrawList::AddArc() to ImDrawList::AddArcFast() for compatibility with future API
936 - 2015/04/03 (1.38) - removed ImGuiCol_CheckHovered, ImGuiCol_CheckActive, replaced with the more general ImGuiCol_FrameBgHovered, ImGuiCol_FrameBgActive.
937 - 2014/04/03 (1.38) - removed support for passing -FLT_MAX..+FLT_MAX as the range for a SliderFloat(). Use DragFloat() or Inputfloat() instead.
938 - 2015/03/17 (1.36) - renamed GetItemBoxMin()/GetItemBoxMax()/IsMouseHoveringBox() to GetItemRectMin()/GetItemRectMax()/IsMouseHoveringRect(). Kept inline redirection function until 1.50.
939 - 2015/03/15 (1.36) - renamed style.TreeNodeSpacing to style.IndentSpacing, ImGuiStyleVar_TreeNodeSpacing to ImGuiStyleVar_IndentSpacing
940 - 2015/03/13 (1.36) - renamed GetWindowIsFocused() to IsWindowFocused(). Kept inline redirection function until 1.50.
941 - 2015/03/08 (1.35) - renamed style.ScrollBarWidth to style.ScrollbarWidth (casing)
942 - 2015/02/27 (1.34) - renamed OpenNextNode(bool) to SetNextTreeNodeOpened(bool, ImGuiSetCond). Kept inline redirection function until 1.50.
943 - 2015/02/27 (1.34) - renamed ImGuiSetCondition_*** to ImGuiSetCond_***, and _FirstUseThisSession becomes _Once.
944 - 2015/02/11 (1.32) - changed text input callback ImGuiTextEditCallback return type from void-->int. reserved for future use, return 0 for now.
945 - 2015/02/10 (1.32) - renamed GetItemWidth() to CalcItemWidth() to clarify its evolving behavior
946 - 2015/02/08 (1.31) - renamed GetTextLineSpacing() to GetTextLineHeightWithSpacing()
947 - 2015/02/01 (1.31) - removed IO.MemReallocFn (unused)
948 - 2015/01/19 (1.30) - renamed ImGuiStorage::GetIntPtr()/GetFloatPtr() to GetIntRef()/GetIntRef() because Ptr was conflicting with actual pointer storage functions.
949 - 2015/01/11 (1.30) - big font/image API change! now loads TTF file. allow for multiple fonts. no need for a PNG loader.
950 - 2015/01/11 (1.30) - removed GetDefaultFontData(). uses io.Fonts->GetTextureData*() API to retrieve uncompressed pixels.
951 - old: const void* png_data; unsigned int png_size; ImGui::GetDefaultFontData(NULL, NULL, &png_data, &png_size); [..Upload texture to GPU..];
952 - new: unsigned char* pixels; int width, height; io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height); [..Upload texture to GPU..]; io.Fonts->SetTexID(YourTexIdentifier);
953 you now have more flexibility to load multiple TTF fonts and manage the texture buffer for internal needs. It is now recommended that you sample the font texture with bilinear interpolation.
954 - 2015/01/11 (1.30) - added texture identifier in ImDrawCmd passed to your render function (we can now render images). make sure to call io.Fonts->SetTexID()
955 - 2015/01/11 (1.30) - removed IO.PixelCenterOffset (unnecessary, can be handled in user projection matrix)
956 - 2015/01/11 (1.30) - removed ImGui::IsItemFocused() in favor of ImGui::IsItemActive() which handles all widgets
957 - 2014/12/10 (1.18) - removed SetNewWindowDefaultPos() in favor of new generic API SetNextWindowPos(pos, ImGuiSetCondition_FirstUseEver)
958 - 2014/11/28 (1.17) - moved IO.Font*** options to inside the IO.Font-> structure (FontYOffset, FontTexUvForWhite, FontBaseScale, FontFallbackGlyph)
959 - 2014/11/26 (1.17) - reworked syntax of IMGUI_ONCE_UPON_A_FRAME helper macro to increase compiler compatibility
960 - 2014/11/07 (1.15) - renamed IsHovered() to IsItemHovered()
961 - 2014/10/02 (1.14) - renamed IMGUI_INCLUDE_IMGUI_USER_CPP to IMGUI_INCLUDE_IMGUI_USER_INL and imgui_user.cpp to imgui_user.inl (more IDE friendly)
962 - 2014/09/25 (1.13) - removed 'text_end' parameter from IO.SetClipboardTextFn (the string is now always zero-terminated for simplicity)
963 - 2014/09/24 (1.12) - renamed SetFontScale() to SetWindowFontScale()
964 - 2014/09/24 (1.12) - moved IM_MALLOC/IM_REALLOC/IM_FREE preprocessor defines to IO.MemAllocFn/IO.MemReallocFn/IO.MemFreeFn
965 - 2014/08/30 (1.09) - removed IO.FontHeight (now computed automatically)
966 - 2014/08/30 (1.09) - moved IMGUI_FONT_TEX_UV_FOR_WHITE preprocessor define to IO.FontTexUvForWhite
967 - 2014/08/28 (1.09) - changed the behavior of IO.PixelCenterOffset following various rendering fixes
968
969
970 FREQUENTLY ASKED QUESTIONS (FAQ)
971 ================================
972
973 Read all answers online:
974 https://www.dearimgui.com/faq or https://github.com/ocornut/imgui/blob/master/docs/FAQ.md (same url)
975 Read all answers locally (with a text editor or ideally a Markdown viewer):
976 docs/FAQ.md
977 Some answers are copied down here to facilitate searching in code.
978
979 Q&A: Basics
980 ===========
981
982 Q: Where is the documentation?
983 A: This library is poorly documented at the moment and expects the user to be acquainted with C/C++.
984 - Run the examples/ applications and explore them.
985 - Read Getting Started (https://github.com/ocornut/imgui/wiki/Getting-Started) guide.
986 - See demo code in imgui_demo.cpp and particularly the ImGui::ShowDemoWindow() function.
987 - The demo covers most features of Dear ImGui, so you can read the code and see its output.
988 - See documentation and comments at the top of imgui.cpp + effectively imgui.h.
989 - 20+ standalone example applications using e.g. OpenGL/DirectX are provided in the
990 examples/ folder to explain how to integrate Dear ImGui with your own engine/application.
991 - The Wiki (https://github.com/ocornut/imgui/wiki) has many resources and links.
992 - The Glossary (https://github.com/ocornut/imgui/wiki/Glossary) page also may be useful.
993 - Your programming IDE is your friend, find the type or function declaration to find comments
994 associated with it.
995
996 Q: What is this library called?
997 Q: Which version should I get?
998 >> This library is called "Dear ImGui", please don't call it "ImGui" :)
999 >> See https://www.dearimgui.com/faq for details.
1000
1001 Q&A: Integration
1002 ================
1003
1004 Q: How to get started?
1005 A: Read https://github.com/ocornut/imgui/wiki/Getting-Started. Read 'PROGRAMMER GUIDE' above. Read examples/README.txt.
1006
1007 Q: How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?
1008 A: You should read the 'io.WantCaptureMouse', 'io.WantCaptureKeyboard' and 'io.WantTextInput' flags!
1009 >> See https://www.dearimgui.com/faq for a fully detailed answer. You really want to read this.
1010
1011 Q. How can I enable keyboard or gamepad controls?
1012 Q: How can I use this on a machine without mouse, keyboard or screen? (input share, remote display)
1013 Q: I integrated Dear ImGui in my engine and little squares are showing instead of text...
1014 Q: I integrated Dear ImGui in my engine and some elements are clipping or disappearing when I move windows around...
1015 Q: I integrated Dear ImGui in my engine and some elements are displaying outside their expected windows boundaries...
1016 >> See https://www.dearimgui.com/faq
1017
1018 Q&A: Usage
1019 ----------
1020
1021 Q: About the ID Stack system..
1022 - Why is my widget not reacting when I click on it?
1023 - How can I have widgets with an empty label?
1024 - How can I have multiple widgets with the same label?
1025 - How can I have multiple windows with the same label?
1026 Q: How can I display an image? What is ImTextureID, how does it work?
1027 Q: How can I use my own math types instead of ImVec2?
1028 Q: How can I interact with standard C++ types (such as std::string and std::vector)?
1029 Q: How can I display custom shapes? (using low-level ImDrawList API)
1030 >> See https://www.dearimgui.com/faq
1031
1032 Q&A: Fonts, Text
1033 ================
1034
1035 Q: How should I handle DPI in my application?
1036 Q: How can I load a different font than the default?
1037 Q: How can I easily use icons in my application?
1038 Q: How can I load multiple fonts?
1039 Q: How can I display and input non-Latin characters such as Chinese, Japanese, Korean, Cyrillic?
1040 >> See https://www.dearimgui.com/faq and https://github.com/ocornut/imgui/blob/master/docs/FONTS.md
1041
1042 Q&A: Concerns
1043 =============
1044
1045 Q: Who uses Dear ImGui?
1046 Q: Can you create elaborate/serious tools with Dear ImGui?
1047 Q: Can you reskin the look of Dear ImGui?
1048 Q: Why using C++ (as opposed to C)?
1049 >> See https://www.dearimgui.com/faq
1050
1051 Q&A: Community
1052 ==============
1053
1054 Q: How can I help?
1055 A: - Businesses: please reach out to "omar AT dearimgui DOT com" if you work in a place using Dear ImGui!
1056 We can discuss ways for your company to fund development via invoiced technical support, maintenance or sponsoring contacts.
1057 This is among the most useful thing you can do for Dear ImGui. With increased funding, we sustain and grow work on this project.
1058 >>> See https://github.com/ocornut/imgui/wiki/Funding
1059 - Businesses: you can also purchase licenses for the Dear ImGui Automation/Test Engine.
1060 - If you are experienced with Dear ImGui and C++, look at the GitHub issues, look at the Wiki, and see how you want to help and can help!
1061 - Disclose your usage of Dear ImGui via a dev blog post, a tweet, a screenshot, a mention somewhere etc.
1062 You may post screenshot or links in the gallery threads. Visuals are ideal as they inspire other programmers.
1063 But even without visuals, disclosing your use of dear imgui helps the library grow credibility, and help other teams and programmers with taking decisions.
1064 - If you have issues or if you need to hack into the library, even if you don't expect any support it is useful that you share your issues (on GitHub or privately).
1065
1066*/
1067
1068//-------------------------------------------------------------------------
1069// [SECTION] INCLUDES
1070//-------------------------------------------------------------------------
1071
1072#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
1073#define _CRT_SECURE_NO_WARNINGS
1074#endif
1075
1076#ifndef IMGUI_DEFINE_MATH_OPERATORS
1077#define IMGUI_DEFINE_MATH_OPERATORS
1078#endif
1079
1080#include "imgui.h"
1081#ifndef IMGUI_DISABLE
1082#include "imgui_internal.h"
1083
1084// System includes
1085#include <stdio.h> // vsnprintf, sscanf, printf
1086#include <stdint.h> // intptr_t
1087
1088// [Windows] On non-Visual Studio compilers, we default to IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS unless explicitly enabled
1089#if defined(_WIN32) && !defined(_MSC_VER) && !defined(IMGUI_ENABLE_WIN32_DEFAULT_IME_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS)
1090#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS
1091#endif
1092
1093// [Windows] OS specific includes (optional)
1094#if defined(_WIN32) && defined(IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS) && defined(IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS) && defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS) && defined(IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS)
1095#define IMGUI_DISABLE_WIN32_FUNCTIONS
1096#endif
1097#if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS)
1098#ifndef WIN32_LEAN_AND_MEAN
1099#define WIN32_LEAN_AND_MEAN
1100#endif
1101#ifndef NOMINMAX
1102#define NOMINMAX
1103#endif
1104#ifndef __MINGW32__
1105#include <Windows.h> // _wfopen, OpenClipboard
1106#else
1107#include <windows.h>
1108#endif
1109#if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP || WINAPI_FAMILY == WINAPI_FAMILY_GAMES)
1110// The UWP and GDK Win32 API subsets don't support clipboard nor IME functions
1111#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS
1112#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS
1113#define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS
1114#endif
1115#endif
1116
1117// [Apple] OS specific includes
1118#if defined(__APPLE__)
1119#include <TargetConditionals.h>
1120#endif
1121
1122// Visual Studio warnings
1123#ifdef _MSC_VER
1124#pragma warning (disable: 4127) // condition expression is constant
1125#pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen
1126#if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later
1127#pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types
1128#endif
1129#pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to an 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2).
1130#pragma warning (disable: 26495) // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6).
1131#pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3).
1132#endif
1133
1134// Clang/GCC warnings with -Weverything
1135#if defined(__clang__)
1136#if __has_warning("-Wunknown-warning-option")
1137#pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great!
1138#endif
1139#pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx'
1140#pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse.
1141#pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok.
1142#pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code.
1143#pragma clang diagnostic ignored "-Wexit-time-destructors" // warning: declaration requires an exit-time destructor // exit-time destruction order is undefined. if MemFree() leads to users code that has been disabled before exit it might cause problems. ImGui coding style welcomes static/globals.
1144#pragma clang diagnostic ignored "-Wglobal-constructors" // warning: declaration requires a global destructor // similar to above, not sure what the exact difference is.
1145#pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness
1146#pragma clang diagnostic ignored "-Wformat-pedantic" // warning: format specifies type 'void *' but the argument has type 'xxxx *' // unreasonable, would lead to casting every %p arg to void*. probably enabled by -pedantic.
1147#pragma clang diagnostic ignored "-Wint-to-void-pointer-cast" // warning: cast to 'void *' from smaller integer type 'int'
1148#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0
1149#pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double.
1150#pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision
1151#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access
1152#pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type
1153#elif defined(__GNUC__)
1154// We disable -Wpragmas because GCC doesn't provide a has_warning equivalent and some forks/patches may not follow the warning/version association.
1155#pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind
1156#pragma GCC diagnostic ignored "-Wunused-function" // warning: 'xxxx' defined but not used
1157#pragma GCC diagnostic ignored "-Wint-to-pointer-cast" // warning: cast to pointer from integer of different size
1158#pragma GCC diagnostic ignored "-Wformat" // warning: format '%p' expects argument of type 'void*', but argument 6 has type 'ImGuiWindow*'
1159#pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function
1160#pragma GCC diagnostic ignored "-Wconversion" // warning: conversion to 'xxxx' from 'xxxx' may alter its value
1161#pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked
1162#pragma GCC diagnostic ignored "-Wstrict-overflow" // warning: assuming signed overflow does not occur when assuming that (X - c) > X is always false
1163#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
1164#endif
1165
1166// Debug options
1167#define IMGUI_DEBUG_NAV_SCORING 0 // Display navigation scoring preview when hovering items. Hold CTRL to display for all candidates. CTRL+Arrow to change last direction.
1168#define IMGUI_DEBUG_NAV_RECTS 0 // Display the reference navigation rectangle for each window
1169
1170// When using CTRL+TAB (or Gamepad Square+L/R) we delay the visual a little in order to reduce visual noise doing a fast switch.
1171static const float NAV_WINDOWING_HIGHLIGHT_DELAY = 0.20f; // Time before the highlight and screen dimming starts fading in
1172static const float NAV_WINDOWING_LIST_APPEAR_DELAY = 0.15f; // Time before the window list starts to appear
1173
1174static const float NAV_ACTIVATE_HIGHLIGHT_TIMER = 0.10f; // Time to highlight an item activated by a shortcut.
1175
1176// Window resizing from edges (when io.ConfigWindowsResizeFromEdges = true and ImGuiBackendFlags_HasMouseCursors is set in io.BackendFlags by backend)
1177static const float WINDOWS_HOVER_PADDING = 4.0f; // Extend outside window for hovering/resizing (maxxed with TouchPadding) and inside windows for borders. Affect FindHoveredWindow().
1178static const float WINDOWS_RESIZE_FROM_EDGES_FEEDBACK_TIMER = 0.04f; // Reduce visual noise by only highlighting the border after a certain time.
1179static const float WINDOWS_MOUSE_WHEEL_SCROLL_LOCK_TIMER = 0.70f; // Lock scrolled window (so it doesn't pick child windows that are scrolling through) for a certain time, unless mouse moved.
1180
1181// Tooltip offset
1182static const ImVec2 TOOLTIP_DEFAULT_OFFSET_MOUSE = ImVec2(16, 10); // Multiplied by g.Style.MouseCursorScale
1183static const ImVec2 TOOLTIP_DEFAULT_OFFSET_TOUCH = ImVec2(0, -20); // Multiplied by g.Style.MouseCursorScale
1184static const ImVec2 TOOLTIP_DEFAULT_PIVOT_TOUCH = ImVec2(0.5f, 1.0f); // Multiplied by g.Style.MouseCursorScale
1185
1186// Docking
1187static const float DOCKING_TRANSPARENT_PAYLOAD_ALPHA = 0.50f; // For use with io.ConfigDockingTransparentPayload. Apply to Viewport _or_ WindowBg in host viewport.
1188
1189//-------------------------------------------------------------------------
1190// [SECTION] FORWARD DECLARATIONS
1191//-------------------------------------------------------------------------
1192
1193static void SetCurrentWindow(ImGuiWindow* window);
1194static ImGuiWindow* CreateNewWindow(const char* name, ImGuiWindowFlags flags);
1195static ImVec2 CalcNextScrollFromScrollTargetAndClamp(ImGuiWindow* window);
1196
1197static void AddWindowToSortBuffer(ImVector<ImGuiWindow*>* out_sorted_windows, ImGuiWindow* window);
1198
1199// Settings
1200static void WindowSettingsHandler_ClearAll(ImGuiContext*, ImGuiSettingsHandler*);
1201static void* WindowSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name);
1202static void WindowSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line);
1203static void WindowSettingsHandler_ApplyAll(ImGuiContext*, ImGuiSettingsHandler*);
1204static void WindowSettingsHandler_WriteAll(ImGuiContext*, ImGuiSettingsHandler*, ImGuiTextBuffer* buf);
1205
1206// Platform Dependents default implementation for ImGuiPlatformIO functions
1207static const char* Platform_GetClipboardTextFn_DefaultImpl(ImGuiContext* ctx);
1208static void Platform_SetClipboardTextFn_DefaultImpl(ImGuiContext* ctx, const char* text);
1209static void Platform_SetImeDataFn_DefaultImpl(ImGuiContext* ctx, ImGuiViewport* viewport, ImGuiPlatformImeData* data);
1210static bool Platform_OpenInShellFn_DefaultImpl(ImGuiContext* ctx, const char* path);
1211
1212namespace ImGui
1213{
1214// Item
1215static void ItemHandleShortcut(ImGuiID id);
1216
1217// Navigation
1218static void NavUpdate();
1219static void NavUpdateWindowing();
1220static void NavUpdateWindowingOverlay();
1221static void NavUpdateCancelRequest();
1222static void NavUpdateCreateMoveRequest();
1223static void NavUpdateCreateTabbingRequest();
1224static float NavUpdatePageUpPageDown();
1225static inline void NavUpdateAnyRequestFlag();
1226static void NavUpdateCreateWrappingRequest();
1227static void NavEndFrame();
1228static bool NavScoreItem(ImGuiNavItemData* result);
1229static void NavApplyItemToResult(ImGuiNavItemData* result);
1230static void NavProcessItem();
1231static void NavProcessItemForTabbingRequest(ImGuiID id, ImGuiItemFlags item_flags, ImGuiNavMoveFlags move_flags);
1232static ImGuiInputSource NavCalcPreferredRefPosSource();
1233static ImVec2 NavCalcPreferredRefPos();
1234static void NavSaveLastChildNavWindowIntoParent(ImGuiWindow* nav_window);
1235static ImGuiWindow* NavRestoreLastChildNavWindow(ImGuiWindow* window);
1236static void NavRestoreLayer(ImGuiNavLayer layer);
1237static int FindWindowFocusIndex(ImGuiWindow* window);
1238
1239// Error Checking and Debug Tools
1240static void ErrorCheckNewFrameSanityChecks();
1241static void ErrorCheckEndFrameSanityChecks();
1242#ifndef IMGUI_DISABLE_DEBUG_TOOLS
1243static void UpdateDebugToolItemPicker();
1244static void UpdateDebugToolStackQueries();
1245static void UpdateDebugToolFlashStyleColor();
1246#endif
1247
1248// Inputs
1249static void UpdateKeyboardInputs();
1250static void UpdateMouseInputs();
1251static void UpdateMouseWheel();
1252static void UpdateKeyRoutingTable(ImGuiKeyRoutingTable* rt);
1253
1254// Misc
1255static void UpdateSettings();
1256static int UpdateWindowManualResize(ImGuiWindow* window, const ImVec2& size_auto_fit, int* border_hovered, int* border_held, int resize_grip_count, ImU32 resize_grip_col[4], const ImRect& visibility_rect);
1257static void RenderWindowOuterBorders(ImGuiWindow* window);
1258static void RenderWindowDecorations(ImGuiWindow* window, const ImRect& title_bar_rect, bool title_bar_is_highlight, bool handle_borders_and_resize_grips, int resize_grip_count, const ImU32 resize_grip_col[4], float resize_grip_draw_size);
1259static void RenderWindowTitleBarContents(ImGuiWindow* window, const ImRect& title_bar_rect, const char* name, bool* p_open);
1260static void RenderDimmedBackgroundBehindWindow(ImGuiWindow* window, ImU32 col);
1261static void RenderDimmedBackgrounds();
1262static void SetLastItemDataForWindow(ImGuiWindow* window, const ImRect& rect);
1263
1264// Viewports
1265const ImGuiID IMGUI_VIEWPORT_DEFAULT_ID = 0x11111111; // Using an arbitrary constant instead of e.g. ImHashStr("ViewportDefault", 0); so it's easier to spot in the debugger. The exact value doesn't matter.
1266static ImGuiViewportP* AddUpdateViewport(ImGuiWindow* window, ImGuiID id, const ImVec2& platform_pos, const ImVec2& size, ImGuiViewportFlags flags);
1267static void DestroyViewport(ImGuiViewportP* viewport);
1268static void UpdateViewportsNewFrame();
1269static void UpdateViewportsEndFrame();
1270static void WindowSelectViewport(ImGuiWindow* window);
1271static void WindowSyncOwnedViewport(ImGuiWindow* window, ImGuiWindow* parent_window_in_stack);
1272static bool UpdateTryMergeWindowIntoHostViewport(ImGuiWindow* window, ImGuiViewportP* host_viewport);
1273static bool UpdateTryMergeWindowIntoHostViewports(ImGuiWindow* window);
1274static bool GetWindowAlwaysWantOwnViewport(ImGuiWindow* window);
1275static int FindPlatformMonitorForPos(const ImVec2& pos);
1276static int FindPlatformMonitorForRect(const ImRect& r);
1277static void UpdateViewportPlatformMonitor(ImGuiViewportP* viewport);
1278
1279}
1280
1281//-----------------------------------------------------------------------------
1282// [SECTION] CONTEXT AND MEMORY ALLOCATORS
1283//-----------------------------------------------------------------------------
1284
1285// DLL users:
1286// - Heaps and globals are not shared across DLL boundaries!
1287// - You will need to call SetCurrentContext() + SetAllocatorFunctions() for each static/DLL boundary you are calling from.
1288// - Same applies for hot-reloading mechanisms that are reliant on reloading DLL (note that many hot-reloading mechanisms work without DLL).
1289// - Using Dear ImGui via a shared library is not recommended, because of function call overhead and because we don't guarantee backward nor forward ABI compatibility.
1290// - Confused? In a debugger: add GImGui to your watch window and notice how its value changes depending on your current location (which DLL boundary you are in).
1291
1292// Current context pointer. Implicitly used by all Dear ImGui functions. Always assumed to be != NULL.
1293// - ImGui::CreateContext() will automatically set this pointer if it is NULL.
1294// Change to a different context by calling ImGui::SetCurrentContext().
1295// - Important: Dear ImGui functions are not thread-safe because of this pointer.
1296// If you want thread-safety to allow N threads to access N different contexts:
1297// - Change this variable to use thread local storage so each thread can refer to a different context, in your imconfig.h:
1298// struct ImGuiContext;
1299// extern thread_local ImGuiContext* MyImGuiTLS;
1300// #define GImGui MyImGuiTLS
1301// And then define MyImGuiTLS in one of your cpp files. Note that thread_local is a C++11 keyword, earlier C++ uses compiler-specific keyword.
1302// - Future development aims to make this context pointer explicit to all calls. Also read https://github.com/ocornut/imgui/issues/586
1303// - If you need a finite number of contexts, you may compile and use multiple instances of the ImGui code from a different namespace.
1304// - DLL users: read comments above.
1305#ifndef GImGui
1306ImGuiContext* GImGui = NULL;
1307#endif
1308
1309// Memory Allocator functions. Use SetAllocatorFunctions() to change them.
1310// - You probably don't want to modify that mid-program, and if you use global/static e.g. ImVector<> instances you may need to keep them accessible during program destruction.
1311// - DLL users: read comments above.
1312#ifndef IMGUI_DISABLE_DEFAULT_ALLOCATORS
1313static void* MallocWrapper(size_t size, void* user_data) { IM_UNUSED(user_data); return malloc(size: size); }
1314static void FreeWrapper(void* ptr, void* user_data) { IM_UNUSED(user_data); free(ptr: ptr); }
1315#else
1316static void* MallocWrapper(size_t size, void* user_data) { IM_UNUSED(user_data); IM_UNUSED(size); IM_ASSERT(0); return NULL; }
1317static void FreeWrapper(void* ptr, void* user_data) { IM_UNUSED(user_data); IM_UNUSED(ptr); IM_ASSERT(0); }
1318#endif
1319static ImGuiMemAllocFunc GImAllocatorAllocFunc = MallocWrapper;
1320static ImGuiMemFreeFunc GImAllocatorFreeFunc = FreeWrapper;
1321static void* GImAllocatorUserData = NULL;
1322
1323//-----------------------------------------------------------------------------
1324// [SECTION] USER FACING STRUCTURES (ImGuiStyle, ImGuiIO, ImGuiPlatformIO)
1325//-----------------------------------------------------------------------------
1326
1327ImGuiStyle::ImGuiStyle()
1328{
1329 Alpha = 1.0f; // Global alpha applies to everything in Dear ImGui.
1330 DisabledAlpha = 0.60f; // Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha.
1331 WindowPadding = ImVec2(8,8); // Padding within a window
1332 WindowRounding = 0.0f; // 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.
1333 WindowBorderSize = 1.0f; // Thickness of border around windows. Generally set to 0.0f or 1.0f. Other values not well tested.
1334 WindowMinSize = ImVec2(32,32); // Minimum window size
1335 WindowTitleAlign = ImVec2(0.0f,0.5f);// Alignment for title bar text
1336 WindowMenuButtonPosition = ImGuiDir_Left; // Position of the collapsing/docking button in the title bar (left/right). Defaults to ImGuiDir_Left.
1337 ChildRounding = 0.0f; // Radius of child window corners rounding. Set to 0.0f to have rectangular child windows
1338 ChildBorderSize = 1.0f; // Thickness of border around child windows. Generally set to 0.0f or 1.0f. Other values not well tested.
1339 PopupRounding = 0.0f; // Radius of popup window corners rounding. Set to 0.0f to have rectangular child windows
1340 PopupBorderSize = 1.0f; // Thickness of border around popup or tooltip windows. Generally set to 0.0f or 1.0f. Other values not well tested.
1341 FramePadding = ImVec2(4,3); // Padding within a framed rectangle (used by most widgets)
1342 FrameRounding = 0.0f; // Radius of frame corners rounding. Set to 0.0f to have rectangular frames (used by most widgets).
1343 FrameBorderSize = 0.0f; // Thickness of border around frames. Generally set to 0.0f or 1.0f. Other values not well tested.
1344 ItemSpacing = ImVec2(8,4); // Horizontal and vertical spacing between widgets/lines
1345 ItemInnerSpacing = ImVec2(4,4); // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label)
1346 CellPadding = ImVec2(4,2); // Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows.
1347 TouchExtraPadding = ImVec2(0,0); // 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!
1348 IndentSpacing = 21.0f; // Horizontal spacing when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).
1349 ColumnsMinSpacing = 6.0f; // Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
1350 ScrollbarSize = 14.0f; // Width of the vertical scrollbar, Height of the horizontal scrollbar
1351 ScrollbarRounding = 9.0f; // Radius of grab corners rounding for scrollbar
1352 GrabMinSize = 12.0f; // Minimum width/height of a grab box for slider/scrollbar
1353 GrabRounding = 0.0f; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
1354 LogSliderDeadzone = 4.0f; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
1355 TabRounding = 4.0f; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
1356 TabBorderSize = 0.0f; // Thickness of border around tabs.
1357 TabMinWidthForCloseButton = 0.0f; // Minimum width for close button to appear on an unselected tab when hovered. Set to 0.0f to always show when hovering, set to FLT_MAX to never show close button unless selected.
1358 TabBarBorderSize = 1.0f; // Thickness of tab-bar separator, which takes on the tab active color to denote focus.
1359 TabBarOverlineSize = 2.0f; // Thickness of tab-bar overline, which highlights the selected tab-bar.
1360 TableAngledHeadersAngle = 35.0f * (IM_PI / 180.0f); // Angle of angled headers (supported values range from -50 degrees to +50 degrees).
1361 TableAngledHeadersTextAlign = ImVec2(0.5f,0.0f);// Alignment of angled headers within the cell
1362 ColorButtonPosition = ImGuiDir_Right; // Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right.
1363 ButtonTextAlign = ImVec2(0.5f,0.5f);// Alignment of button text when button is larger than text.
1364 SelectableTextAlign = ImVec2(0.0f,0.0f);// 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.
1365 SeparatorTextBorderSize = 3.0f; // Thickness of border in SeparatorText()
1366 SeparatorTextAlign = ImVec2(0.0f,0.5f);// Alignment of text within the separator. Defaults to (0.0f, 0.5f) (left aligned, center).
1367 SeparatorTextPadding = ImVec2(20.0f,3.f);// Horizontal offset of text from each edge of the separator + spacing on other axis. Generally small values. .y is recommended to be == FramePadding.y.
1368 DisplayWindowPadding = ImVec2(19,19); // Window position are clamped to be visible within the display area or monitors by at least this amount. Only applies to regular windows.
1369 DisplaySafeAreaPadding = ImVec2(3,3); // If you cannot see the edge of your screen (e.g. on a TV) increase the safe area padding. Covers popups/tooltips as well regular windows.
1370 DockingSeparatorSize = 2.0f; // Thickness of resizing border between docked windows
1371 MouseCursorScale = 1.0f; // Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). May be removed later.
1372 AntiAliasedLines = true; // Enable anti-aliased lines/borders. Disable if you are really tight on CPU/GPU.
1373 AntiAliasedLinesUseTex = true; // Enable anti-aliased lines/borders using textures where possible. Require backend to render with bilinear filtering (NOT point/nearest filtering).
1374 AntiAliasedFill = true; // Enable anti-aliased filled shapes (rounded rectangles, circles, etc.).
1375 CurveTessellationTol = 1.25f; // Tessellation tolerance when using PathBezierCurveTo() without a specific number of segments. Decrease for highly tessellated curves (higher quality, more polygons), increase to reduce quality.
1376 CircleTessellationMaxError = 0.30f; // 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.
1377
1378 // Behaviors
1379 HoverStationaryDelay = 0.15f; // Delay for IsItemHovered(ImGuiHoveredFlags_Stationary). Time required to consider mouse stationary.
1380 HoverDelayShort = 0.15f; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayShort). Usually used along with HoverStationaryDelay.
1381 HoverDelayNormal = 0.40f; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayNormal). "
1382 HoverFlagsForTooltipMouse = ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_AllowWhenDisabled; // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using mouse.
1383 HoverFlagsForTooltipNav = ImGuiHoveredFlags_NoSharedDelay | ImGuiHoveredFlags_DelayNormal | ImGuiHoveredFlags_AllowWhenDisabled; // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using keyboard/gamepad.
1384
1385 // Default theme
1386 ImGui::StyleColorsDark(dst: this);
1387}
1388
1389// To scale your entire UI (e.g. if you want your app to use High DPI or generally be DPI aware) you may use this helper function. Scaling the fonts is done separately and is up to you.
1390// Important: This operation is lossy because we round all sizes to integer. If you need to change your scale multiples, call this over a freshly initialized ImGuiStyle structure rather than scaling multiple times.
1391void ImGuiStyle::ScaleAllSizes(float scale_factor)
1392{
1393 WindowPadding = ImTrunc(v: WindowPadding * scale_factor);
1394 WindowRounding = ImTrunc(f: WindowRounding * scale_factor);
1395 WindowMinSize = ImTrunc(v: WindowMinSize * scale_factor);
1396 ChildRounding = ImTrunc(f: ChildRounding * scale_factor);
1397 PopupRounding = ImTrunc(f: PopupRounding * scale_factor);
1398 FramePadding = ImTrunc(v: FramePadding * scale_factor);
1399 FrameRounding = ImTrunc(f: FrameRounding * scale_factor);
1400 ItemSpacing = ImTrunc(v: ItemSpacing * scale_factor);
1401 ItemInnerSpacing = ImTrunc(v: ItemInnerSpacing * scale_factor);
1402 CellPadding = ImTrunc(v: CellPadding * scale_factor);
1403 TouchExtraPadding = ImTrunc(v: TouchExtraPadding * scale_factor);
1404 IndentSpacing = ImTrunc(f: IndentSpacing * scale_factor);
1405 ColumnsMinSpacing = ImTrunc(f: ColumnsMinSpacing * scale_factor);
1406 ScrollbarSize = ImTrunc(f: ScrollbarSize * scale_factor);
1407 ScrollbarRounding = ImTrunc(f: ScrollbarRounding * scale_factor);
1408 GrabMinSize = ImTrunc(f: GrabMinSize * scale_factor);
1409 GrabRounding = ImTrunc(f: GrabRounding * scale_factor);
1410 LogSliderDeadzone = ImTrunc(f: LogSliderDeadzone * scale_factor);
1411 TabRounding = ImTrunc(f: TabRounding * scale_factor);
1412 TabMinWidthForCloseButton = (TabMinWidthForCloseButton != FLT_MAX) ? ImTrunc(f: TabMinWidthForCloseButton * scale_factor) : FLT_MAX;
1413 TabBarOverlineSize = ImTrunc(f: TabBarOverlineSize * scale_factor);
1414 SeparatorTextPadding = ImTrunc(v: SeparatorTextPadding * scale_factor);
1415 DockingSeparatorSize = ImTrunc(f: DockingSeparatorSize * scale_factor);
1416 DisplayWindowPadding = ImTrunc(v: DisplayWindowPadding * scale_factor);
1417 DisplaySafeAreaPadding = ImTrunc(v: DisplaySafeAreaPadding * scale_factor);
1418 MouseCursorScale = ImTrunc(f: MouseCursorScale * scale_factor);
1419}
1420
1421ImGuiIO::ImGuiIO()
1422{
1423 // Most fields are initialized with zero
1424 memset(s: this, c: 0, n: sizeof(*this));
1425 IM_STATIC_ASSERT(IM_ARRAYSIZE(ImGuiIO::MouseDown) == ImGuiMouseButton_COUNT && IM_ARRAYSIZE(ImGuiIO::MouseClicked) == ImGuiMouseButton_COUNT);
1426
1427 // Settings
1428 ConfigFlags = ImGuiConfigFlags_None;
1429 BackendFlags = ImGuiBackendFlags_None;
1430 DisplaySize = ImVec2(-1.0f, -1.0f);
1431 DeltaTime = 1.0f / 60.0f;
1432 IniSavingRate = 5.0f;
1433 IniFilename = "imgui.ini"; // Important: "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).
1434 LogFilename = "imgui_log.txt";
1435 UserData = NULL;
1436
1437 Fonts = NULL;
1438 FontGlobalScale = 1.0f;
1439 FontDefault = NULL;
1440 FontAllowUserScaling = false;
1441 DisplayFramebufferScale = ImVec2(1.0f, 1.0f);
1442
1443 // Keyboard/Gamepad Navigation options
1444 ConfigNavSwapGamepadButtons = false;
1445 ConfigNavMoveSetMousePos = false;
1446 ConfigNavCaptureKeyboard = true;
1447 ConfigNavEscapeClearFocusItem = true;
1448 ConfigNavEscapeClearFocusWindow = false;
1449 ConfigNavCursorVisibleAuto = true;
1450 ConfigNavCursorVisibleAlways = false;
1451
1452 // Docking options (when ImGuiConfigFlags_DockingEnable is set)
1453 ConfigDockingNoSplit = false;
1454 ConfigDockingWithShift = false;
1455 ConfigDockingAlwaysTabBar = false;
1456 ConfigDockingTransparentPayload = false;
1457
1458 // Viewport options (when ImGuiConfigFlags_ViewportsEnable is set)
1459 ConfigViewportsNoAutoMerge = false;
1460 ConfigViewportsNoTaskBarIcon = false;
1461 ConfigViewportsNoDecoration = true;
1462 ConfigViewportsNoDefaultParent = false;
1463
1464 // Miscellaneous options
1465 MouseDrawCursor = false;
1466#ifdef __APPLE__
1467 ConfigMacOSXBehaviors = true; // Set Mac OS X style defaults based on __APPLE__ compile time flag
1468#else
1469 ConfigMacOSXBehaviors = false;
1470#endif
1471 ConfigInputTrickleEventQueue = true;
1472 ConfigInputTextCursorBlink = true;
1473 ConfigInputTextEnterKeepActive = false;
1474 ConfigDragClickToInputText = false;
1475 ConfigWindowsResizeFromEdges = true;
1476 ConfigWindowsMoveFromTitleBarOnly = false;
1477 ConfigWindowsCopyContentsWithCtrlC = false;
1478 ConfigScrollbarScrollByPage = true;
1479 ConfigMemoryCompactTimer = 60.0f;
1480 ConfigDebugIsDebuggerPresent = false;
1481 ConfigDebugHighlightIdConflicts = true;
1482 ConfigDebugBeginReturnValueOnce = false;
1483 ConfigDebugBeginReturnValueLoop = false;
1484
1485 ConfigErrorRecovery = true;
1486 ConfigErrorRecoveryEnableAssert = true;
1487 ConfigErrorRecoveryEnableDebugLog = true;
1488 ConfigErrorRecoveryEnableTooltip = true;
1489
1490 // Inputs Behaviors
1491 MouseDoubleClickTime = 0.30f;
1492 MouseDoubleClickMaxDist = 6.0f;
1493 MouseDragThreshold = 6.0f;
1494 KeyRepeatDelay = 0.275f;
1495 KeyRepeatRate = 0.050f;
1496
1497 // Platform Functions
1498 // Note: Initialize() will setup default clipboard/ime handlers.
1499 BackendPlatformName = BackendRendererName = NULL;
1500 BackendPlatformUserData = BackendRendererUserData = BackendLanguageUserData = NULL;
1501
1502 // Input (NB: we already have memset zero the entire structure!)
1503 MousePos = ImVec2(-FLT_MAX, -FLT_MAX);
1504 MousePosPrev = ImVec2(-FLT_MAX, -FLT_MAX);
1505 MouseSource = ImGuiMouseSource_Mouse;
1506 for (int i = 0; i < IM_ARRAYSIZE(MouseDownDuration); i++) MouseDownDuration[i] = MouseDownDurationPrev[i] = -1.0f;
1507 for (int i = 0; i < IM_ARRAYSIZE(KeysData); i++) { KeysData[i].DownDuration = KeysData[i].DownDurationPrev = -1.0f; }
1508 AppAcceptingEvents = true;
1509}
1510
1511// Pass in translated ASCII characters for text input.
1512// - with glfw you can get those from the callback set in glfwSetCharCallback()
1513// - on Windows you can get those using ToAscii+keyboard state, or via the WM_CHAR message
1514// FIXME: Should in theory be called "AddCharacterEvent()" to be consistent with new API
1515void ImGuiIO::AddInputCharacter(unsigned int c)
1516{
1517 IM_ASSERT(Ctx != NULL);
1518 ImGuiContext& g = *Ctx;
1519 if (c == 0 || !AppAcceptingEvents)
1520 return;
1521
1522 ImGuiInputEvent e;
1523 e.Type = ImGuiInputEventType_Text;
1524 e.Source = ImGuiInputSource_Keyboard;
1525 e.EventId = g.InputEventsNextEventId++;
1526 e.Text.Char = c;
1527 g.InputEventsQueue.push_back(v: e);
1528}
1529
1530// UTF16 strings use surrogate pairs to encode codepoints >= 0x10000, so
1531// we should save the high surrogate.
1532void ImGuiIO::AddInputCharacterUTF16(ImWchar16 c)
1533{
1534 if ((c == 0 && InputQueueSurrogate == 0) || !AppAcceptingEvents)
1535 return;
1536
1537 if ((c & 0xFC00) == 0xD800) // High surrogate, must save
1538 {
1539 if (InputQueueSurrogate != 0)
1540 AddInputCharacter(IM_UNICODE_CODEPOINT_INVALID);
1541 InputQueueSurrogate = c;
1542 return;
1543 }
1544
1545 ImWchar cp = c;
1546 if (InputQueueSurrogate != 0)
1547 {
1548 if ((c & 0xFC00) != 0xDC00) // Invalid low surrogate
1549 {
1550 AddInputCharacter(IM_UNICODE_CODEPOINT_INVALID);
1551 }
1552 else
1553 {
1554#if IM_UNICODE_CODEPOINT_MAX == 0xFFFF
1555 cp = IM_UNICODE_CODEPOINT_INVALID; // Codepoint will not fit in ImWchar
1556#else
1557 cp = (ImWchar)(((InputQueueSurrogate - 0xD800) << 10) + (c - 0xDC00) + 0x10000);
1558#endif
1559 }
1560
1561 InputQueueSurrogate = 0;
1562 }
1563 AddInputCharacter(c: (unsigned)cp);
1564}
1565
1566void ImGuiIO::AddInputCharactersUTF8(const char* utf8_chars)
1567{
1568 if (!AppAcceptingEvents)
1569 return;
1570 while (*utf8_chars != 0)
1571 {
1572 unsigned int c = 0;
1573 utf8_chars += ImTextCharFromUtf8(out_char: &c, in_text: utf8_chars, NULL);
1574 AddInputCharacter(c);
1575 }
1576}
1577
1578// Clear all incoming events.
1579void ImGuiIO::ClearEventsQueue()
1580{
1581 IM_ASSERT(Ctx != NULL);
1582 ImGuiContext& g = *Ctx;
1583 g.InputEventsQueue.clear();
1584}
1585
1586// Clear current keyboard/gamepad state + current frame text input buffer. Equivalent to releasing all keys/buttons.
1587void ImGuiIO::ClearInputKeys()
1588{
1589 ImGuiContext& g = *Ctx;
1590 for (int key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key++)
1591 {
1592 if (ImGui::IsMouseKey(key: (ImGuiKey)key))
1593 continue;
1594 ImGuiKeyData* key_data = &g.IO.KeysData[key - ImGuiKey_NamedKey_BEGIN];
1595 key_data->Down = false;
1596 key_data->DownDuration = -1.0f;
1597 key_data->DownDurationPrev = -1.0f;
1598 }
1599 KeyCtrl = KeyShift = KeyAlt = KeySuper = false;
1600 KeyMods = ImGuiMod_None;
1601 InputQueueCharacters.resize(new_size: 0); // Behavior of old ClearInputCharacters().
1602}
1603
1604void ImGuiIO::ClearInputMouse()
1605{
1606 for (ImGuiKey key = ImGuiKey_Mouse_BEGIN; key < ImGuiKey_Mouse_END; key = (ImGuiKey)(key + 1))
1607 {
1608 ImGuiKeyData* key_data = &KeysData[key - ImGuiKey_NamedKey_BEGIN];
1609 key_data->Down = false;
1610 key_data->DownDuration = -1.0f;
1611 key_data->DownDurationPrev = -1.0f;
1612 }
1613 MousePos = ImVec2(-FLT_MAX, -FLT_MAX);
1614 for (int n = 0; n < IM_ARRAYSIZE(MouseDown); n++)
1615 {
1616 MouseDown[n] = false;
1617 MouseDownDuration[n] = MouseDownDurationPrev[n] = -1.0f;
1618 }
1619 MouseWheel = MouseWheelH = 0.0f;
1620}
1621
1622// Removed this as it is ambiguous/misleading and generally incorrect to use with the existence of a higher-level input queue.
1623// Current frame character buffer is now also cleared by ClearInputKeys().
1624#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
1625void ImGuiIO::ClearInputCharacters()
1626{
1627 InputQueueCharacters.resize(new_size: 0);
1628}
1629#endif
1630
1631static ImGuiInputEvent* FindLatestInputEvent(ImGuiContext* ctx, ImGuiInputEventType type, int arg = -1)
1632{
1633 ImGuiContext& g = *ctx;
1634 for (int n = g.InputEventsQueue.Size - 1; n >= 0; n--)
1635 {
1636 ImGuiInputEvent* e = &g.InputEventsQueue[n];
1637 if (e->Type != type)
1638 continue;
1639 if (type == ImGuiInputEventType_Key && e->Key.Key != arg)
1640 continue;
1641 if (type == ImGuiInputEventType_MouseButton && e->MouseButton.Button != arg)
1642 continue;
1643 return e;
1644 }
1645 return NULL;
1646}
1647
1648// Queue a new key down/up event.
1649// - ImGuiKey key: Translated key (as in, generally ImGuiKey_A matches the key end-user would use to emit an 'A' character)
1650// - bool down: Is the key down? use false to signify a key release.
1651// - float analog_value: 0.0f..1.0f
1652// IMPORTANT: THIS FUNCTION AND OTHER "ADD" GRABS THE CONTEXT FROM OUR INSTANCE.
1653// WE NEED TO ENSURE THAT ALL FUNCTION CALLS ARE FULFILLING THIS, WHICH IS WHY GetKeyData() HAS AN EXPLICIT CONTEXT.
1654void ImGuiIO::AddKeyAnalogEvent(ImGuiKey key, bool down, float analog_value)
1655{
1656 //if (e->Down) { IMGUI_DEBUG_LOG_IO("AddKeyEvent() Key='%s' %d, NativeKeycode = %d, NativeScancode = %d\n", ImGui::GetKeyName(e->Key), e->Down, e->NativeKeycode, e->NativeScancode); }
1657 IM_ASSERT(Ctx != NULL);
1658 if (key == ImGuiKey_None || !AppAcceptingEvents)
1659 return;
1660 ImGuiContext& g = *Ctx;
1661 IM_ASSERT(ImGui::IsNamedKeyOrMod(key)); // Backend needs to pass a valid ImGuiKey_ constant. 0..511 values are legacy native key codes which are not accepted by this API.
1662 IM_ASSERT(ImGui::IsAliasKey(key) == false); // Backend cannot submit ImGuiKey_MouseXXX values they are automatically inferred from AddMouseXXX() events.
1663
1664 // MacOS: swap Cmd(Super) and Ctrl
1665 if (g.IO.ConfigMacOSXBehaviors)
1666 {
1667 if (key == ImGuiMod_Super) { key = ImGuiMod_Ctrl; }
1668 else if (key == ImGuiMod_Ctrl) { key = ImGuiMod_Super; }
1669 else if (key == ImGuiKey_LeftSuper) { key = ImGuiKey_LeftCtrl; }
1670 else if (key == ImGuiKey_RightSuper){ key = ImGuiKey_RightCtrl; }
1671 else if (key == ImGuiKey_LeftCtrl) { key = ImGuiKey_LeftSuper; }
1672 else if (key == ImGuiKey_RightCtrl) { key = ImGuiKey_RightSuper; }
1673 }
1674
1675 // Filter duplicate (in particular: key mods and gamepad analog values are commonly spammed)
1676 const ImGuiInputEvent* latest_event = FindLatestInputEvent(ctx: &g, type: ImGuiInputEventType_Key, arg: (int)key);
1677 const ImGuiKeyData* key_data = ImGui::GetKeyData(ctx: &g, key);
1678 const bool latest_key_down = latest_event ? latest_event->Key.Down : key_data->Down;
1679 const float latest_key_analog = latest_event ? latest_event->Key.AnalogValue : key_data->AnalogValue;
1680 if (latest_key_down == down && latest_key_analog == analog_value)
1681 return;
1682
1683 // Add event
1684 ImGuiInputEvent e;
1685 e.Type = ImGuiInputEventType_Key;
1686 e.Source = ImGui::IsGamepadKey(key) ? ImGuiInputSource_Gamepad : ImGuiInputSource_Keyboard;
1687 e.EventId = g.InputEventsNextEventId++;
1688 e.Key.Key = key;
1689 e.Key.Down = down;
1690 e.Key.AnalogValue = analog_value;
1691 g.InputEventsQueue.push_back(v: e);
1692}
1693
1694void ImGuiIO::AddKeyEvent(ImGuiKey key, bool down)
1695{
1696 if (!AppAcceptingEvents)
1697 return;
1698 AddKeyAnalogEvent(key, down, analog_value: down ? 1.0f : 0.0f);
1699}
1700
1701// [Optional] Call after AddKeyEvent().
1702// Specify native keycode, scancode + Specify index for legacy <1.87 IsKeyXXX() functions with native indices.
1703// If you are writing a backend in 2022 or don't use IsKeyXXX() with native values that are not ImGuiKey values, you can avoid calling this.
1704void ImGuiIO::SetKeyEventNativeData(ImGuiKey key, int native_keycode, int native_scancode, int native_legacy_index)
1705{
1706 if (key == ImGuiKey_None)
1707 return;
1708 IM_ASSERT(ImGui::IsNamedKey(key)); // >= 512
1709 IM_ASSERT(native_legacy_index == -1 || ImGui::IsLegacyKey((ImGuiKey)native_legacy_index)); // >= 0 && <= 511
1710 IM_UNUSED(key); // Yet unused
1711 IM_UNUSED(native_keycode); // Yet unused
1712 IM_UNUSED(native_scancode); // Yet unused
1713 IM_UNUSED(native_legacy_index); // Yet unused
1714}
1715
1716// 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.
1717void ImGuiIO::SetAppAcceptingEvents(bool accepting_events)
1718{
1719 AppAcceptingEvents = accepting_events;
1720}
1721
1722// Queue a mouse move event
1723void ImGuiIO::AddMousePosEvent(float x, float y)
1724{
1725 IM_ASSERT(Ctx != NULL);
1726 ImGuiContext& g = *Ctx;
1727 if (!AppAcceptingEvents)
1728 return;
1729
1730 // Apply same flooring as UpdateMouseInputs()
1731 ImVec2 pos((x > -FLT_MAX) ? ImFloor(f: x) : x, (y > -FLT_MAX) ? ImFloor(f: y) : y);
1732
1733 // Filter duplicate
1734 const ImGuiInputEvent* latest_event = FindLatestInputEvent(ctx: &g, type: ImGuiInputEventType_MousePos);
1735 const ImVec2 latest_pos = latest_event ? ImVec2(latest_event->MousePos.PosX, latest_event->MousePos.PosY) : g.IO.MousePos;
1736 if (latest_pos.x == pos.x && latest_pos.y == pos.y)
1737 return;
1738
1739 ImGuiInputEvent e;
1740 e.Type = ImGuiInputEventType_MousePos;
1741 e.Source = ImGuiInputSource_Mouse;
1742 e.EventId = g.InputEventsNextEventId++;
1743 e.MousePos.PosX = pos.x;
1744 e.MousePos.PosY = pos.y;
1745 e.MousePos.MouseSource = g.InputEventsNextMouseSource;
1746 g.InputEventsQueue.push_back(v: e);
1747}
1748
1749void ImGuiIO::AddMouseButtonEvent(int mouse_button, bool down)
1750{
1751 IM_ASSERT(Ctx != NULL);
1752 ImGuiContext& g = *Ctx;
1753 IM_ASSERT(mouse_button >= 0 && mouse_button < ImGuiMouseButton_COUNT);
1754 if (!AppAcceptingEvents)
1755 return;
1756
1757 // On MacOS X: Convert Ctrl(Super)+Left click into Right-click: handle held button.
1758 if (ConfigMacOSXBehaviors && mouse_button == 0 && MouseCtrlLeftAsRightClick)
1759 {
1760 // Order of both statements matterns: this event will still release mouse button 1
1761 mouse_button = 1;
1762 if (!down)
1763 MouseCtrlLeftAsRightClick = false;
1764 }
1765
1766 // Filter duplicate
1767 const ImGuiInputEvent* latest_event = FindLatestInputEvent(ctx: &g, type: ImGuiInputEventType_MouseButton, arg: (int)mouse_button);
1768 const bool latest_button_down = latest_event ? latest_event->MouseButton.Down : g.IO.MouseDown[mouse_button];
1769 if (latest_button_down == down)
1770 return;
1771
1772 // On MacOS X: Convert Ctrl(Super)+Left click into Right-click.
1773 // - Note that this is actual physical Ctrl which is ImGuiMod_Super for us.
1774 // - At this point we want from !down to down, so this is handling the initial press.
1775 if (ConfigMacOSXBehaviors && mouse_button == 0 && down)
1776 {
1777 const ImGuiInputEvent* latest_super_event = FindLatestInputEvent(ctx: &g, type: ImGuiInputEventType_Key, arg: (int)ImGuiMod_Super);
1778 if (latest_super_event ? latest_super_event->Key.Down : g.IO.KeySuper)
1779 {
1780 IMGUI_DEBUG_LOG_IO("[io] Super+Left Click aliased into Right Click\n");
1781 MouseCtrlLeftAsRightClick = true;
1782 AddMouseButtonEvent(mouse_button: 1, down: true); // This is just quicker to write that passing through, as we need to filter duplicate again.
1783 return;
1784 }
1785 }
1786
1787 ImGuiInputEvent e;
1788 e.Type = ImGuiInputEventType_MouseButton;
1789 e.Source = ImGuiInputSource_Mouse;
1790 e.EventId = g.InputEventsNextEventId++;
1791 e.MouseButton.Button = mouse_button;
1792 e.MouseButton.Down = down;
1793 e.MouseButton.MouseSource = g.InputEventsNextMouseSource;
1794 g.InputEventsQueue.push_back(v: e);
1795}
1796
1797// Queue a mouse wheel event (some mouse/API may only have a Y component)
1798void ImGuiIO::AddMouseWheelEvent(float wheel_x, float wheel_y)
1799{
1800 IM_ASSERT(Ctx != NULL);
1801 ImGuiContext& g = *Ctx;
1802
1803 // Filter duplicate (unlike most events, wheel values are relative and easy to filter)
1804 if (!AppAcceptingEvents || (wheel_x == 0.0f && wheel_y == 0.0f))
1805 return;
1806
1807 ImGuiInputEvent e;
1808 e.Type = ImGuiInputEventType_MouseWheel;
1809 e.Source = ImGuiInputSource_Mouse;
1810 e.EventId = g.InputEventsNextEventId++;
1811 e.MouseWheel.WheelX = wheel_x;
1812 e.MouseWheel.WheelY = wheel_y;
1813 e.MouseWheel.MouseSource = g.InputEventsNextMouseSource;
1814 g.InputEventsQueue.push_back(v: e);
1815}
1816
1817// This is not a real event, the data is latched in order to be stored in actual Mouse events.
1818// This is so that duplicate events (e.g. Windows sending extraneous WM_MOUSEMOVE) gets filtered and are not leading to actual source changes.
1819void ImGuiIO::AddMouseSourceEvent(ImGuiMouseSource source)
1820{
1821 IM_ASSERT(Ctx != NULL);
1822 ImGuiContext& g = *Ctx;
1823 g.InputEventsNextMouseSource = source;
1824}
1825
1826void ImGuiIO::AddMouseViewportEvent(ImGuiID viewport_id)
1827{
1828 IM_ASSERT(Ctx != NULL);
1829 ImGuiContext& g = *Ctx;
1830 //IM_ASSERT(g.IO.BackendFlags & ImGuiBackendFlags_HasMouseHoveredViewport);
1831 if (!AppAcceptingEvents)
1832 return;
1833
1834 // Filter duplicate
1835 const ImGuiInputEvent* latest_event = FindLatestInputEvent(ctx: &g, type: ImGuiInputEventType_MouseViewport);
1836 const ImGuiID latest_viewport_id = latest_event ? latest_event->MouseViewport.HoveredViewportID : g.IO.MouseHoveredViewport;
1837 if (latest_viewport_id == viewport_id)
1838 return;
1839
1840 ImGuiInputEvent e;
1841 e.Type = ImGuiInputEventType_MouseViewport;
1842 e.Source = ImGuiInputSource_Mouse;
1843 e.MouseViewport.HoveredViewportID = viewport_id;
1844 g.InputEventsQueue.push_back(v: e);
1845}
1846
1847void ImGuiIO::AddFocusEvent(bool focused)
1848{
1849 IM_ASSERT(Ctx != NULL);
1850 ImGuiContext& g = *Ctx;
1851
1852 // Filter duplicate
1853 const ImGuiInputEvent* latest_event = FindLatestInputEvent(ctx: &g, type: ImGuiInputEventType_Focus);
1854 const bool latest_focused = latest_event ? latest_event->AppFocused.Focused : !g.IO.AppFocusLost;
1855 if (latest_focused == focused || (ConfigDebugIgnoreFocusLoss && !focused))
1856 return;
1857
1858 ImGuiInputEvent e;
1859 e.Type = ImGuiInputEventType_Focus;
1860 e.EventId = g.InputEventsNextEventId++;
1861 e.AppFocused.Focused = focused;
1862 g.InputEventsQueue.push_back(v: e);
1863}
1864
1865ImGuiPlatformIO::ImGuiPlatformIO()
1866{
1867 // Most fields are initialized with zero
1868 memset(s: this, c: 0, n: sizeof(*this));
1869 Platform_LocaleDecimalPoint = '.';
1870}
1871
1872//-----------------------------------------------------------------------------
1873// [SECTION] MISC HELPERS/UTILITIES (Geometry functions)
1874//-----------------------------------------------------------------------------
1875
1876ImVec2 ImBezierCubicClosestPoint(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& p, int num_segments)
1877{
1878 IM_ASSERT(num_segments > 0); // Use ImBezierCubicClosestPointCasteljau()
1879 ImVec2 p_last = p1;
1880 ImVec2 p_closest;
1881 float p_closest_dist2 = FLT_MAX;
1882 float t_step = 1.0f / (float)num_segments;
1883 for (int i_step = 1; i_step <= num_segments; i_step++)
1884 {
1885 ImVec2 p_current = ImBezierCubicCalc(p1, p2, p3, p4, t: t_step * i_step);
1886 ImVec2 p_line = ImLineClosestPoint(a: p_last, b: p_current, p);
1887 float dist2 = ImLengthSqr(lhs: p - p_line);
1888 if (dist2 < p_closest_dist2)
1889 {
1890 p_closest = p_line;
1891 p_closest_dist2 = dist2;
1892 }
1893 p_last = p_current;
1894 }
1895 return p_closest;
1896}
1897
1898// Closely mimics PathBezierToCasteljau() in imgui_draw.cpp
1899static void ImBezierCubicClosestPointCasteljauStep(const ImVec2& p, ImVec2& p_closest, ImVec2& p_last, float& p_closest_dist2, float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4, float tess_tol, int level)
1900{
1901 float dx = x4 - x1;
1902 float dy = y4 - y1;
1903 float d2 = ((x2 - x4) * dy - (y2 - y4) * dx);
1904 float d3 = ((x3 - x4) * dy - (y3 - y4) * dx);
1905 d2 = (d2 >= 0) ? d2 : -d2;
1906 d3 = (d3 >= 0) ? d3 : -d3;
1907 if ((d2 + d3) * (d2 + d3) < tess_tol * (dx * dx + dy * dy))
1908 {
1909 ImVec2 p_current(x4, y4);
1910 ImVec2 p_line = ImLineClosestPoint(a: p_last, b: p_current, p);
1911 float dist2 = ImLengthSqr(lhs: p - p_line);
1912 if (dist2 < p_closest_dist2)
1913 {
1914 p_closest = p_line;
1915 p_closest_dist2 = dist2;
1916 }
1917 p_last = p_current;
1918 }
1919 else if (level < 10)
1920 {
1921 float x12 = (x1 + x2)*0.5f, y12 = (y1 + y2)*0.5f;
1922 float x23 = (x2 + x3)*0.5f, y23 = (y2 + y3)*0.5f;
1923 float x34 = (x3 + x4)*0.5f, y34 = (y3 + y4)*0.5f;
1924 float x123 = (x12 + x23)*0.5f, y123 = (y12 + y23)*0.5f;
1925 float x234 = (x23 + x34)*0.5f, y234 = (y23 + y34)*0.5f;
1926 float x1234 = (x123 + x234)*0.5f, y1234 = (y123 + y234)*0.5f;
1927 ImBezierCubicClosestPointCasteljauStep(p, p_closest, p_last, p_closest_dist2, x1, y1, x2: x12, y2: y12, x3: x123, y3: y123, x4: x1234, y4: y1234, tess_tol, level: level + 1);
1928 ImBezierCubicClosestPointCasteljauStep(p, p_closest, p_last, p_closest_dist2, x1: x1234, y1: y1234, x2: x234, y2: y234, x3: x34, y3: y34, x4, y4, tess_tol, level: level + 1);
1929 }
1930}
1931
1932// tess_tol is generally the same value you would find in ImGui::GetStyle().CurveTessellationTol
1933// Because those ImXXX functions are lower-level than ImGui:: we cannot access this value automatically.
1934ImVec2 ImBezierCubicClosestPointCasteljau(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& p, float tess_tol)
1935{
1936 IM_ASSERT(tess_tol > 0.0f);
1937 ImVec2 p_last = p1;
1938 ImVec2 p_closest;
1939 float p_closest_dist2 = FLT_MAX;
1940 ImBezierCubicClosestPointCasteljauStep(p, p_closest, p_last, p_closest_dist2, x1: p1.x, y1: p1.y, x2: p2.x, y2: p2.y, x3: p3.x, y3: p3.y, x4: p4.x, y4: p4.y, tess_tol, level: 0);
1941 return p_closest;
1942}
1943
1944ImVec2 ImLineClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& p)
1945{
1946 ImVec2 ap = p - a;
1947 ImVec2 ab_dir = b - a;
1948 float dot = ap.x * ab_dir.x + ap.y * ab_dir.y;
1949 if (dot < 0.0f)
1950 return a;
1951 float ab_len_sqr = ab_dir.x * ab_dir.x + ab_dir.y * ab_dir.y;
1952 if (dot > ab_len_sqr)
1953 return b;
1954 return a + ab_dir * dot / ab_len_sqr;
1955}
1956
1957bool ImTriangleContainsPoint(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p)
1958{
1959 bool b1 = ((p.x - b.x) * (a.y - b.y) - (p.y - b.y) * (a.x - b.x)) < 0.0f;
1960 bool b2 = ((p.x - c.x) * (b.y - c.y) - (p.y - c.y) * (b.x - c.x)) < 0.0f;
1961 bool b3 = ((p.x - a.x) * (c.y - a.y) - (p.y - a.y) * (c.x - a.x)) < 0.0f;
1962 return ((b1 == b2) && (b2 == b3));
1963}
1964
1965void ImTriangleBarycentricCoords(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p, float& out_u, float& out_v, float& out_w)
1966{
1967 ImVec2 v0 = b - a;
1968 ImVec2 v1 = c - a;
1969 ImVec2 v2 = p - a;
1970 const float denom = v0.x * v1.y - v1.x * v0.y;
1971 out_v = (v2.x * v1.y - v1.x * v2.y) / denom;
1972 out_w = (v0.x * v2.y - v2.x * v0.y) / denom;
1973 out_u = 1.0f - out_v - out_w;
1974}
1975
1976ImVec2 ImTriangleClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p)
1977{
1978 ImVec2 proj_ab = ImLineClosestPoint(a, b, p);
1979 ImVec2 proj_bc = ImLineClosestPoint(a: b, b: c, p);
1980 ImVec2 proj_ca = ImLineClosestPoint(a: c, b: a, p);
1981 float dist2_ab = ImLengthSqr(lhs: p - proj_ab);
1982 float dist2_bc = ImLengthSqr(lhs: p - proj_bc);
1983 float dist2_ca = ImLengthSqr(lhs: p - proj_ca);
1984 float m = ImMin(lhs: dist2_ab, rhs: ImMin(lhs: dist2_bc, rhs: dist2_ca));
1985 if (m == dist2_ab)
1986 return proj_ab;
1987 if (m == dist2_bc)
1988 return proj_bc;
1989 return proj_ca;
1990}
1991
1992//-----------------------------------------------------------------------------
1993// [SECTION] MISC HELPERS/UTILITIES (String, Format, Hash functions)
1994//-----------------------------------------------------------------------------
1995
1996// Consider using _stricmp/_strnicmp under Windows or strcasecmp/strncasecmp. We don't actually use either ImStricmp/ImStrnicmp in the codebase any more.
1997int ImStricmp(const char* str1, const char* str2)
1998{
1999 int d;
2000 while ((d = ImToUpper(c: *str2) - ImToUpper(c: *str1)) == 0 && *str1) { str1++; str2++; }
2001 return d;
2002}
2003
2004int ImStrnicmp(const char* str1, const char* str2, size_t count)
2005{
2006 int d = 0;
2007 while (count > 0 && (d = ImToUpper(c: *str2) - ImToUpper(c: *str1)) == 0 && *str1) { str1++; str2++; count--; }
2008 return d;
2009}
2010
2011void ImStrncpy(char* dst, const char* src, size_t count)
2012{
2013 if (count < 1)
2014 return;
2015 if (count > 1)
2016 strncpy(dest: dst, src: src, n: count - 1);
2017 dst[count - 1] = 0;
2018}
2019
2020char* ImStrdup(const char* str)
2021{
2022 size_t len = strlen(s: str);
2023 void* buf = IM_ALLOC(len + 1);
2024 return (char*)memcpy(dest: buf, src: (const void*)str, n: len + 1);
2025}
2026
2027char* ImStrdupcpy(char* dst, size_t* p_dst_size, const char* src)
2028{
2029 size_t dst_buf_size = p_dst_size ? *p_dst_size : strlen(s: dst) + 1;
2030 size_t src_size = strlen(s: src) + 1;
2031 if (dst_buf_size < src_size)
2032 {
2033 IM_FREE(dst);
2034 dst = (char*)IM_ALLOC(src_size);
2035 if (p_dst_size)
2036 *p_dst_size = src_size;
2037 }
2038 return (char*)memcpy(dest: dst, src: (const void*)src, n: src_size);
2039}
2040
2041const char* ImStrchrRange(const char* str, const char* str_end, char c)
2042{
2043 const char* p = (const char*)memchr(s: str, c: (int)c, n: str_end - str);
2044 return p;
2045}
2046
2047int ImStrlenW(const ImWchar* str)
2048{
2049 //return (int)wcslen((const wchar_t*)str); // FIXME-OPT: Could use this when wchar_t are 16-bit
2050 int n = 0;
2051 while (*str++) n++;
2052 return n;
2053}
2054
2055// Find end-of-line. Return pointer will point to either first \n, either str_end.
2056const char* ImStreolRange(const char* str, const char* str_end)
2057{
2058 const char* p = (const char*)memchr(s: str, c: '\n', n: str_end - str);
2059 return p ? p : str_end;
2060}
2061
2062const char* ImStrbol(const char* buf_mid_line, const char* buf_begin) // find beginning-of-line
2063{
2064 while (buf_mid_line > buf_begin && buf_mid_line[-1] != '\n')
2065 buf_mid_line--;
2066 return buf_mid_line;
2067}
2068
2069const char* ImStristr(const char* haystack, const char* haystack_end, const char* needle, const char* needle_end)
2070{
2071 if (!needle_end)
2072 needle_end = needle + strlen(s: needle);
2073
2074 const char un0 = (char)ImToUpper(c: *needle);
2075 while ((!haystack_end && *haystack) || (haystack_end && haystack < haystack_end))
2076 {
2077 if (ImToUpper(c: *haystack) == un0)
2078 {
2079 const char* b = needle + 1;
2080 for (const char* a = haystack + 1; b < needle_end; a++, b++)
2081 if (ImToUpper(c: *a) != ImToUpper(c: *b))
2082 break;
2083 if (b == needle_end)
2084 return haystack;
2085 }
2086 haystack++;
2087 }
2088 return NULL;
2089}
2090
2091// Trim str by offsetting contents when there's leading data + writing a \0 at the trailing position. We use this in situation where the cost is negligible.
2092void ImStrTrimBlanks(char* buf)
2093{
2094 char* p = buf;
2095 while (p[0] == ' ' || p[0] == '\t') // Leading blanks
2096 p++;
2097 char* p_start = p;
2098 while (*p != 0) // Find end of string
2099 p++;
2100 while (p > p_start && (p[-1] == ' ' || p[-1] == '\t')) // Trailing blanks
2101 p--;
2102 if (p_start != buf) // Copy memory if we had leading blanks
2103 memmove(dest: buf, src: p_start, n: p - p_start);
2104 buf[p - p_start] = 0; // Zero terminate
2105}
2106
2107const char* ImStrSkipBlank(const char* str)
2108{
2109 while (str[0] == ' ' || str[0] == '\t')
2110 str++;
2111 return str;
2112}
2113
2114// A) MSVC version appears to return -1 on overflow, whereas glibc appears to return total count (which may be >= buf_size).
2115// Ideally we would test for only one of those limits at runtime depending on the behavior the vsnprintf(), but trying to deduct it at compile time sounds like a pandora can of worm.
2116// B) When buf==NULL vsnprintf() will return the output size.
2117#ifndef IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS
2118
2119// We support stb_sprintf which is much faster (see: https://github.com/nothings/stb/blob/master/stb_sprintf.h)
2120// You may set IMGUI_USE_STB_SPRINTF to use our default wrapper, or set IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS
2121// and setup the wrapper yourself. (FIXME-OPT: Some of our high-level operations such as ImGuiTextBuffer::appendfv() are
2122// designed using two-passes worst case, which probably could be improved using the stbsp_vsprintfcb() function.)
2123#ifdef IMGUI_USE_STB_SPRINTF
2124#ifndef IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION
2125#define STB_SPRINTF_IMPLEMENTATION
2126#endif
2127#ifdef IMGUI_STB_SPRINTF_FILENAME
2128#include IMGUI_STB_SPRINTF_FILENAME
2129#else
2130#include "stb_sprintf.h"
2131#endif
2132#endif // #ifdef IMGUI_USE_STB_SPRINTF
2133
2134#if defined(_MSC_VER) && !defined(vsnprintf)
2135#define vsnprintf _vsnprintf
2136#endif
2137
2138int ImFormatString(char* buf, size_t buf_size, const char* fmt, ...)
2139{
2140 va_list args;
2141 va_start(args, fmt);
2142#ifdef IMGUI_USE_STB_SPRINTF
2143 int w = stbsp_vsnprintf(buf, (int)buf_size, fmt, args);
2144#else
2145 int w = vsnprintf(s: buf, maxlen: buf_size, format: fmt, arg: args);
2146#endif
2147 va_end(args);
2148 if (buf == NULL)
2149 return w;
2150 if (w == -1 || w >= (int)buf_size)
2151 w = (int)buf_size - 1;
2152 buf[w] = 0;
2153 return w;
2154}
2155
2156int ImFormatStringV(char* buf, size_t buf_size, const char* fmt, va_list args)
2157{
2158#ifdef IMGUI_USE_STB_SPRINTF
2159 int w = stbsp_vsnprintf(buf, (int)buf_size, fmt, args);
2160#else
2161 int w = vsnprintf(s: buf, maxlen: buf_size, format: fmt, arg: args);
2162#endif
2163 if (buf == NULL)
2164 return w;
2165 if (w == -1 || w >= (int)buf_size)
2166 w = (int)buf_size - 1;
2167 buf[w] = 0;
2168 return w;
2169}
2170#endif // #ifdef IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS
2171
2172void ImFormatStringToTempBuffer(const char** out_buf, const char** out_buf_end, const char* fmt, ...)
2173{
2174 va_list args;
2175 va_start(args, fmt);
2176 ImFormatStringToTempBufferV(out_buf, out_buf_end, fmt, args);
2177 va_end(args);
2178}
2179
2180// FIXME: Should rework API toward allowing multiple in-flight temp buffers (easier and safer for caller)
2181// by making the caller acquire a temp buffer token, with either explicit or destructor release, e.g.
2182// ImGuiTempBufferToken token;
2183// ImFormatStringToTempBuffer(token, ...);
2184void ImFormatStringToTempBufferV(const char** out_buf, const char** out_buf_end, const char* fmt, va_list args)
2185{
2186 ImGuiContext& g = *GImGui;
2187 if (fmt[0] == '%' && fmt[1] == 's' && fmt[2] == 0)
2188 {
2189 const char* buf = va_arg(args, const char*); // Skip formatting when using "%s"
2190 if (buf == NULL)
2191 buf = "(null)";
2192 *out_buf = buf;
2193 if (out_buf_end) { *out_buf_end = buf + strlen(s: buf); }
2194 }
2195 else if (fmt[0] == '%' && fmt[1] == '.' && fmt[2] == '*' && fmt[3] == 's' && fmt[4] == 0)
2196 {
2197 int buf_len = va_arg(args, int); // Skip formatting when using "%.*s"
2198 const char* buf = va_arg(args, const char*);
2199 if (buf == NULL)
2200 {
2201 buf = "(null)";
2202 buf_len = ImMin(lhs: buf_len, rhs: 6);
2203 }
2204 *out_buf = buf;
2205 *out_buf_end = buf + buf_len; // Disallow not passing 'out_buf_end' here. User is expected to use it.
2206 }
2207 else
2208 {
2209 int buf_len = ImFormatStringV(buf: g.TempBuffer.Data, buf_size: g.TempBuffer.Size, fmt, args);
2210 *out_buf = g.TempBuffer.Data;
2211 if (out_buf_end) { *out_buf_end = g.TempBuffer.Data + buf_len; }
2212 }
2213}
2214
2215#ifndef IMGUI_ENABLE_SSE4_2_CRC
2216// CRC32 needs a 1KB lookup table (not cache friendly)
2217// Although the code to generate the table is simple and shorter than the table itself, using a const table allows us to easily:
2218// - avoid an unnecessary branch/memory tap, - keep the ImHashXXX functions usable by static constructors, - make it thread-safe.
2219static const ImU32 GCrc32LookupTable[256] =
2220{
2221#ifdef IMGUI_USE_LEGACY_CRC32_ADLER
2222 // Legacy CRC32-adler table used pre 1.91.6 (before 2024/11/27). Only use if you cannot afford invalidating old .ini data.
2223 0x00000000,0x77073096,0xEE0E612C,0x990951BA,0x076DC419,0x706AF48F,0xE963A535,0x9E6495A3,0x0EDB8832,0x79DCB8A4,0xE0D5E91E,0x97D2D988,0x09B64C2B,0x7EB17CBD,0xE7B82D07,0x90BF1D91,
2224 0x1DB71064,0x6AB020F2,0xF3B97148,0x84BE41DE,0x1ADAD47D,0x6DDDE4EB,0xF4D4B551,0x83D385C7,0x136C9856,0x646BA8C0,0xFD62F97A,0x8A65C9EC,0x14015C4F,0x63066CD9,0xFA0F3D63,0x8D080DF5,
2225 0x3B6E20C8,0x4C69105E,0xD56041E4,0xA2677172,0x3C03E4D1,0x4B04D447,0xD20D85FD,0xA50AB56B,0x35B5A8FA,0x42B2986C,0xDBBBC9D6,0xACBCF940,0x32D86CE3,0x45DF5C75,0xDCD60DCF,0xABD13D59,
2226 0x26D930AC,0x51DE003A,0xC8D75180,0xBFD06116,0x21B4F4B5,0x56B3C423,0xCFBA9599,0xB8BDA50F,0x2802B89E,0x5F058808,0xC60CD9B2,0xB10BE924,0x2F6F7C87,0x58684C11,0xC1611DAB,0xB6662D3D,
2227 0x76DC4190,0x01DB7106,0x98D220BC,0xEFD5102A,0x71B18589,0x06B6B51F,0x9FBFE4A5,0xE8B8D433,0x7807C9A2,0x0F00F934,0x9609A88E,0xE10E9818,0x7F6A0DBB,0x086D3D2D,0x91646C97,0xE6635C01,
2228 0x6B6B51F4,0x1C6C6162,0x856530D8,0xF262004E,0x6C0695ED,0x1B01A57B,0x8208F4C1,0xF50FC457,0x65B0D9C6,0x12B7E950,0x8BBEB8EA,0xFCB9887C,0x62DD1DDF,0x15DA2D49,0x8CD37CF3,0xFBD44C65,
2229 0x4DB26158,0x3AB551CE,0xA3BC0074,0xD4BB30E2,0x4ADFA541,0x3DD895D7,0xA4D1C46D,0xD3D6F4FB,0x4369E96A,0x346ED9FC,0xAD678846,0xDA60B8D0,0x44042D73,0x33031DE5,0xAA0A4C5F,0xDD0D7CC9,
2230 0x5005713C,0x270241AA,0xBE0B1010,0xC90C2086,0x5768B525,0x206F85B3,0xB966D409,0xCE61E49F,0x5EDEF90E,0x29D9C998,0xB0D09822,0xC7D7A8B4,0x59B33D17,0x2EB40D81,0xB7BD5C3B,0xC0BA6CAD,
2231 0xEDB88320,0x9ABFB3B6,0x03B6E20C,0x74B1D29A,0xEAD54739,0x9DD277AF,0x04DB2615,0x73DC1683,0xE3630B12,0x94643B84,0x0D6D6A3E,0x7A6A5AA8,0xE40ECF0B,0x9309FF9D,0x0A00AE27,0x7D079EB1,
2232 0xF00F9344,0x8708A3D2,0x1E01F268,0x6906C2FE,0xF762575D,0x806567CB,0x196C3671,0x6E6B06E7,0xFED41B76,0x89D32BE0,0x10DA7A5A,0x67DD4ACC,0xF9B9DF6F,0x8EBEEFF9,0x17B7BE43,0x60B08ED5,
2233 0xD6D6A3E8,0xA1D1937E,0x38D8C2C4,0x4FDFF252,0xD1BB67F1,0xA6BC5767,0x3FB506DD,0x48B2364B,0xD80D2BDA,0xAF0A1B4C,0x36034AF6,0x41047A60,0xDF60EFC3,0xA867DF55,0x316E8EEF,0x4669BE79,
2234 0xCB61B38C,0xBC66831A,0x256FD2A0,0x5268E236,0xCC0C7795,0xBB0B4703,0x220216B9,0x5505262F,0xC5BA3BBE,0xB2BD0B28,0x2BB45A92,0x5CB36A04,0xC2D7FFA7,0xB5D0CF31,0x2CD99E8B,0x5BDEAE1D,
2235 0x9B64C2B0,0xEC63F226,0x756AA39C,0x026D930A,0x9C0906A9,0xEB0E363F,0x72076785,0x05005713,0x95BF4A82,0xE2B87A14,0x7BB12BAE,0x0CB61B38,0x92D28E9B,0xE5D5BE0D,0x7CDCEFB7,0x0BDBDF21,
2236 0x86D3D2D4,0xF1D4E242,0x68DDB3F8,0x1FDA836E,0x81BE16CD,0xF6B9265B,0x6FB077E1,0x18B74777,0x88085AE6,0xFF0F6A70,0x66063BCA,0x11010B5C,0x8F659EFF,0xF862AE69,0x616BFFD3,0x166CCF45,
2237 0xA00AE278,0xD70DD2EE,0x4E048354,0x3903B3C2,0xA7672661,0xD06016F7,0x4969474D,0x3E6E77DB,0xAED16A4A,0xD9D65ADC,0x40DF0B66,0x37D83BF0,0xA9BCAE53,0xDEBB9EC5,0x47B2CF7F,0x30B5FFE9,
2238 0xBDBDF21C,0xCABAC28A,0x53B39330,0x24B4A3A6,0xBAD03605,0xCDD70693,0x54DE5729,0x23D967BF,0xB3667A2E,0xC4614AB8,0x5D681B02,0x2A6F2B94,0xB40BBE37,0xC30C8EA1,0x5A05DF1B,0x2D02EF8D,
2239#else
2240 // CRC32c table compatible with SSE 4.2 instructions
2241 0x00000000,0xF26B8303,0xE13B70F7,0x1350F3F4,0xC79A971F,0x35F1141C,0x26A1E7E8,0xD4CA64EB,0x8AD958CF,0x78B2DBCC,0x6BE22838,0x9989AB3B,0x4D43CFD0,0xBF284CD3,0xAC78BF27,0x5E133C24,
2242 0x105EC76F,0xE235446C,0xF165B798,0x030E349B,0xD7C45070,0x25AFD373,0x36FF2087,0xC494A384,0x9A879FA0,0x68EC1CA3,0x7BBCEF57,0x89D76C54,0x5D1D08BF,0xAF768BBC,0xBC267848,0x4E4DFB4B,
2243 0x20BD8EDE,0xD2D60DDD,0xC186FE29,0x33ED7D2A,0xE72719C1,0x154C9AC2,0x061C6936,0xF477EA35,0xAA64D611,0x580F5512,0x4B5FA6E6,0xB93425E5,0x6DFE410E,0x9F95C20D,0x8CC531F9,0x7EAEB2FA,
2244 0x30E349B1,0xC288CAB2,0xD1D83946,0x23B3BA45,0xF779DEAE,0x05125DAD,0x1642AE59,0xE4292D5A,0xBA3A117E,0x4851927D,0x5B016189,0xA96AE28A,0x7DA08661,0x8FCB0562,0x9C9BF696,0x6EF07595,
2245 0x417B1DBC,0xB3109EBF,0xA0406D4B,0x522BEE48,0x86E18AA3,0x748A09A0,0x67DAFA54,0x95B17957,0xCBA24573,0x39C9C670,0x2A993584,0xD8F2B687,0x0C38D26C,0xFE53516F,0xED03A29B,0x1F682198,
2246 0x5125DAD3,0xA34E59D0,0xB01EAA24,0x42752927,0x96BF4DCC,0x64D4CECF,0x77843D3B,0x85EFBE38,0xDBFC821C,0x2997011F,0x3AC7F2EB,0xC8AC71E8,0x1C661503,0xEE0D9600,0xFD5D65F4,0x0F36E6F7,
2247 0x61C69362,0x93AD1061,0x80FDE395,0x72966096,0xA65C047D,0x5437877E,0x4767748A,0xB50CF789,0xEB1FCBAD,0x197448AE,0x0A24BB5A,0xF84F3859,0x2C855CB2,0xDEEEDFB1,0xCDBE2C45,0x3FD5AF46,
2248 0x7198540D,0x83F3D70E,0x90A324FA,0x62C8A7F9,0xB602C312,0x44694011,0x5739B3E5,0xA55230E6,0xFB410CC2,0x092A8FC1,0x1A7A7C35,0xE811FF36,0x3CDB9BDD,0xCEB018DE,0xDDE0EB2A,0x2F8B6829,
2249 0x82F63B78,0x709DB87B,0x63CD4B8F,0x91A6C88C,0x456CAC67,0xB7072F64,0xA457DC90,0x563C5F93,0x082F63B7,0xFA44E0B4,0xE9141340,0x1B7F9043,0xCFB5F4A8,0x3DDE77AB,0x2E8E845F,0xDCE5075C,
2250 0x92A8FC17,0x60C37F14,0x73938CE0,0x81F80FE3,0x55326B08,0xA759E80B,0xB4091BFF,0x466298FC,0x1871A4D8,0xEA1A27DB,0xF94AD42F,0x0B21572C,0xDFEB33C7,0x2D80B0C4,0x3ED04330,0xCCBBC033,
2251 0xA24BB5A6,0x502036A5,0x4370C551,0xB11B4652,0x65D122B9,0x97BAA1BA,0x84EA524E,0x7681D14D,0x2892ED69,0xDAF96E6A,0xC9A99D9E,0x3BC21E9D,0xEF087A76,0x1D63F975,0x0E330A81,0xFC588982,
2252 0xB21572C9,0x407EF1CA,0x532E023E,0xA145813D,0x758FE5D6,0x87E466D5,0x94B49521,0x66DF1622,0x38CC2A06,0xCAA7A905,0xD9F75AF1,0x2B9CD9F2,0xFF56BD19,0x0D3D3E1A,0x1E6DCDEE,0xEC064EED,
2253 0xC38D26C4,0x31E6A5C7,0x22B65633,0xD0DDD530,0x0417B1DB,0xF67C32D8,0xE52CC12C,0x1747422F,0x49547E0B,0xBB3FFD08,0xA86F0EFC,0x5A048DFF,0x8ECEE914,0x7CA56A17,0x6FF599E3,0x9D9E1AE0,
2254 0xD3D3E1AB,0x21B862A8,0x32E8915C,0xC083125F,0x144976B4,0xE622F5B7,0xF5720643,0x07198540,0x590AB964,0xAB613A67,0xB831C993,0x4A5A4A90,0x9E902E7B,0x6CFBAD78,0x7FAB5E8C,0x8DC0DD8F,
2255 0xE330A81A,0x115B2B19,0x020BD8ED,0xF0605BEE,0x24AA3F05,0xD6C1BC06,0xC5914FF2,0x37FACCF1,0x69E9F0D5,0x9B8273D6,0x88D28022,0x7AB90321,0xAE7367CA,0x5C18E4C9,0x4F48173D,0xBD23943E,
2256 0xF36E6F75,0x0105EC76,0x12551F82,0xE03E9C81,0x34F4F86A,0xC69F7B69,0xD5CF889D,0x27A40B9E,0x79B737BA,0x8BDCB4B9,0x988C474D,0x6AE7C44E,0xBE2DA0A5,0x4C4623A6,0x5F16D052,0xAD7D5351
2257#endif
2258};
2259#endif
2260
2261// Known size hash
2262// It is ok to call ImHashData on a string with known length but the ### operator won't be supported.
2263// FIXME-OPT: Replace with e.g. FNV1a hash? CRC32 pretty much randomly access 1KB. Need to do proper measurements.
2264ImGuiID ImHashData(const void* data_p, size_t data_size, ImGuiID seed)
2265{
2266 ImU32 crc = ~seed;
2267 const unsigned char* data = (const unsigned char*)data_p;
2268 const unsigned char *data_end = (const unsigned char*)data_p + data_size;
2269#ifndef IMGUI_ENABLE_SSE4_2_CRC
2270 const ImU32* crc32_lut = GCrc32LookupTable;
2271 while (data < data_end)
2272 crc = (crc >> 8) ^ crc32_lut[(crc & 0xFF) ^ *data++];
2273 return ~crc;
2274#else
2275 while (data + 4 <= data_end)
2276 {
2277 crc = _mm_crc32_u32(crc, *(ImU32*)data);
2278 data += 4;
2279 }
2280 while (data < data_end)
2281 crc = _mm_crc32_u8(crc, *data++);
2282 return ~crc;
2283#endif
2284}
2285
2286// Zero-terminated string hash, with support for ### to reset back to seed value
2287// We support a syntax of "label###id" where only "###id" is included in the hash, and only "label" gets displayed.
2288// Because this syntax is rarely used we are optimizing for the common case.
2289// - If we reach ### in the string we discard the hash so far and reset to the seed.
2290// - We don't do 'current += 2; continue;' after handling ### to keep the code smaller/faster (measured ~10% diff in Debug build)
2291// FIXME-OPT: Replace with e.g. FNV1a hash? CRC32 pretty much randomly access 1KB. Need to do proper measurements.
2292ImGuiID ImHashStr(const char* data_p, size_t data_size, ImGuiID seed)
2293{
2294 seed = ~seed;
2295 ImU32 crc = seed;
2296 const unsigned char* data = (const unsigned char*)data_p;
2297#ifndef IMGUI_ENABLE_SSE4_2_CRC
2298 const ImU32* crc32_lut = GCrc32LookupTable;
2299#endif
2300 if (data_size != 0)
2301 {
2302 while (data_size-- != 0)
2303 {
2304 unsigned char c = *data++;
2305 if (c == '#' && data_size >= 2 && data[0] == '#' && data[1] == '#')
2306 crc = seed;
2307#ifndef IMGUI_ENABLE_SSE4_2_CRC
2308 crc = (crc >> 8) ^ crc32_lut[(crc & 0xFF) ^ c];
2309#else
2310 crc = _mm_crc32_u8(crc, c);
2311#endif
2312 }
2313 }
2314 else
2315 {
2316 while (unsigned char c = *data++)
2317 {
2318 if (c == '#' && data[0] == '#' && data[1] == '#')
2319 crc = seed;
2320#ifndef IMGUI_ENABLE_SSE4_2_CRC
2321 crc = (crc >> 8) ^ crc32_lut[(crc & 0xFF) ^ c];
2322#else
2323 crc = _mm_crc32_u8(crc, c);
2324#endif
2325 }
2326 }
2327 return ~crc;
2328}
2329
2330//-----------------------------------------------------------------------------
2331// [SECTION] MISC HELPERS/UTILITIES (File functions)
2332//-----------------------------------------------------------------------------
2333
2334// Default file functions
2335#ifndef IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS
2336
2337ImFileHandle ImFileOpen(const char* filename, const char* mode)
2338{
2339#if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) && !defined(__CYGWIN__) && !defined(__GNUC__)
2340 // We need a fopen() wrapper because MSVC/Windows fopen doesn't handle UTF-8 filenames.
2341 // Previously we used ImTextCountCharsFromUtf8/ImTextStrFromUtf8 here but we now need to support ImWchar16 and ImWchar32!
2342 const int filename_wsize = ::MultiByteToWideChar(CP_UTF8, 0, filename, -1, NULL, 0);
2343 const int mode_wsize = ::MultiByteToWideChar(CP_UTF8, 0, mode, -1, NULL, 0);
2344
2345 // Use stack buffer if possible, otherwise heap buffer. Sizes include zero terminator.
2346 // We don't rely on current ImGuiContext as this is implied to be a helper function which doesn't depend on it (see #7314).
2347 wchar_t local_temp_stack[FILENAME_MAX];
2348 ImVector<wchar_t> local_temp_heap;
2349 if (filename_wsize + mode_wsize > IM_ARRAYSIZE(local_temp_stack))
2350 local_temp_heap.resize(filename_wsize + mode_wsize);
2351 wchar_t* filename_wbuf = local_temp_heap.Data ? local_temp_heap.Data : local_temp_stack;
2352 wchar_t* mode_wbuf = filename_wbuf + filename_wsize;
2353 ::MultiByteToWideChar(CP_UTF8, 0, filename, -1, filename_wbuf, filename_wsize);
2354 ::MultiByteToWideChar(CP_UTF8, 0, mode, -1, mode_wbuf, mode_wsize);
2355 return ::_wfopen(filename_wbuf, mode_wbuf);
2356#else
2357 return fopen(filename: filename, modes: mode);
2358#endif
2359}
2360
2361// We should in theory be using fseeko()/ftello() with off_t and _fseeki64()/_ftelli64() with __int64, waiting for the PR that does that in a very portable pre-C++11 zero-warnings way.
2362bool ImFileClose(ImFileHandle f) { return fclose(stream: f) == 0; }
2363ImU64 ImFileGetSize(ImFileHandle f) { long off = 0, sz = 0; return ((off = ftell(stream: f)) != -1 && !fseek(stream: f, off: 0, SEEK_END) && (sz = ftell(stream: f)) != -1 && !fseek(stream: f, off: off, SEEK_SET)) ? (ImU64)sz : (ImU64)-1; }
2364ImU64 ImFileRead(void* data, ImU64 sz, ImU64 count, ImFileHandle f) { return fread(ptr: data, size: (size_t)sz, n: (size_t)count, stream: f); }
2365ImU64 ImFileWrite(const void* data, ImU64 sz, ImU64 count, ImFileHandle f) { return fwrite(ptr: data, size: (size_t)sz, n: (size_t)count, s: f); }
2366#endif // #ifndef IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS
2367
2368// Helper: Load file content into memory
2369// Memory allocated with IM_ALLOC(), must be freed by user using IM_FREE() == ImGui::MemFree()
2370// This can't really be used with "rt" because fseek size won't match read size.
2371void* ImFileLoadToMemory(const char* filename, const char* mode, size_t* out_file_size, int padding_bytes)
2372{
2373 IM_ASSERT(filename && mode);
2374 if (out_file_size)
2375 *out_file_size = 0;
2376
2377 ImFileHandle f;
2378 if ((f = ImFileOpen(filename, mode)) == NULL)
2379 return NULL;
2380
2381 size_t file_size = (size_t)ImFileGetSize(f);
2382 if (file_size == (size_t)-1)
2383 {
2384 ImFileClose(f);
2385 return NULL;
2386 }
2387
2388 void* file_data = IM_ALLOC(file_size + padding_bytes);
2389 if (file_data == NULL)
2390 {
2391 ImFileClose(f);
2392 return NULL;
2393 }
2394 if (ImFileRead(data: file_data, sz: 1, count: file_size, f) != file_size)
2395 {
2396 ImFileClose(f);
2397 IM_FREE(file_data);
2398 return NULL;
2399 }
2400 if (padding_bytes > 0)
2401 memset(s: (void*)(((char*)file_data) + file_size), c: 0, n: (size_t)padding_bytes);
2402
2403 ImFileClose(f);
2404 if (out_file_size)
2405 *out_file_size = file_size;
2406
2407 return file_data;
2408}
2409
2410//-----------------------------------------------------------------------------
2411// [SECTION] MISC HELPERS/UTILITIES (ImText* functions)
2412//-----------------------------------------------------------------------------
2413
2414IM_MSVC_RUNTIME_CHECKS_OFF
2415
2416// Convert UTF-8 to 32-bit character, process single character input.
2417// A nearly-branchless UTF-8 decoder, based on work of Christopher Wellons (https://github.com/skeeto/branchless-utf8).
2418// We handle UTF-8 decoding error by skipping forward.
2419int ImTextCharFromUtf8(unsigned int* out_char, const char* in_text, const char* in_text_end)
2420{
2421 static const char lengths[32] = { 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 3, 3, 4, 0 };
2422 static const int masks[] = { 0x00, 0x7f, 0x1f, 0x0f, 0x07 };
2423 static const uint32_t mins[] = { 0x400000, 0, 0x80, 0x800, 0x10000 };
2424 static const int shiftc[] = { 0, 18, 12, 6, 0 };
2425 static const int shifte[] = { 0, 6, 4, 2, 0 };
2426 int len = lengths[*(const unsigned char*)in_text >> 3];
2427 int wanted = len + (len ? 0 : 1);
2428
2429 if (in_text_end == NULL)
2430 in_text_end = in_text + wanted; // Max length, nulls will be taken into account.
2431
2432 // Copy at most 'len' bytes, stop copying at 0 or past in_text_end. Branch predictor does a good job here,
2433 // so it is fast even with excessive branching.
2434 unsigned char s[4];
2435 s[0] = in_text + 0 < in_text_end ? in_text[0] : 0;
2436 s[1] = in_text + 1 < in_text_end ? in_text[1] : 0;
2437 s[2] = in_text + 2 < in_text_end ? in_text[2] : 0;
2438 s[3] = in_text + 3 < in_text_end ? in_text[3] : 0;
2439
2440 // Assume a four-byte character and load four bytes. Unused bits are shifted out.
2441 *out_char = (uint32_t)(s[0] & masks[len]) << 18;
2442 *out_char |= (uint32_t)(s[1] & 0x3f) << 12;
2443 *out_char |= (uint32_t)(s[2] & 0x3f) << 6;
2444 *out_char |= (uint32_t)(s[3] & 0x3f) << 0;
2445 *out_char >>= shiftc[len];
2446
2447 // Accumulate the various error conditions.
2448 int e = 0;
2449 e = (*out_char < mins[len]) << 6; // non-canonical encoding
2450 e |= ((*out_char >> 11) == 0x1b) << 7; // surrogate half?
2451 e |= (*out_char > IM_UNICODE_CODEPOINT_MAX) << 8; // out of range?
2452 e |= (s[1] & 0xc0) >> 2;
2453 e |= (s[2] & 0xc0) >> 4;
2454 e |= (s[3] ) >> 6;
2455 e ^= 0x2a; // top two bits of each tail byte correct?
2456 e >>= shifte[len];
2457
2458 if (e)
2459 {
2460 // No bytes are consumed when *in_text == 0 || in_text == in_text_end.
2461 // One byte is consumed in case of invalid first byte of in_text.
2462 // All available bytes (at most `len` bytes) are consumed on incomplete/invalid second to last bytes.
2463 // Invalid or incomplete input may consume less bytes than wanted, therefore every byte has to be inspected in s.
2464 wanted = ImMin(lhs: wanted, rhs: !!s[0] + !!s[1] + !!s[2] + !!s[3]);
2465 *out_char = IM_UNICODE_CODEPOINT_INVALID;
2466 }
2467
2468 return wanted;
2469}
2470
2471int ImTextStrFromUtf8(ImWchar* buf, int buf_size, const char* in_text, const char* in_text_end, const char** in_text_remaining)
2472{
2473 ImWchar* buf_out = buf;
2474 ImWchar* buf_end = buf + buf_size;
2475 while (buf_out < buf_end - 1 && (!in_text_end || in_text < in_text_end) && *in_text)
2476 {
2477 unsigned int c;
2478 in_text += ImTextCharFromUtf8(out_char: &c, in_text, in_text_end);
2479 *buf_out++ = (ImWchar)c;
2480 }
2481 *buf_out = 0;
2482 if (in_text_remaining)
2483 *in_text_remaining = in_text;
2484 return (int)(buf_out - buf);
2485}
2486
2487int ImTextCountCharsFromUtf8(const char* in_text, const char* in_text_end)
2488{
2489 int char_count = 0;
2490 while ((!in_text_end || in_text < in_text_end) && *in_text)
2491 {
2492 unsigned int c;
2493 in_text += ImTextCharFromUtf8(out_char: &c, in_text, in_text_end);
2494 char_count++;
2495 }
2496 return char_count;
2497}
2498
2499// Based on stb_to_utf8() from github.com/nothings/stb/
2500static inline int ImTextCharToUtf8_inline(char* buf, int buf_size, unsigned int c)
2501{
2502 if (c < 0x80)
2503 {
2504 buf[0] = (char)c;
2505 return 1;
2506 }
2507 if (c < 0x800)
2508 {
2509 if (buf_size < 2) return 0;
2510 buf[0] = (char)(0xc0 + (c >> 6));
2511 buf[1] = (char)(0x80 + (c & 0x3f));
2512 return 2;
2513 }
2514 if (c < 0x10000)
2515 {
2516 if (buf_size < 3) return 0;
2517 buf[0] = (char)(0xe0 + (c >> 12));
2518 buf[1] = (char)(0x80 + ((c >> 6) & 0x3f));
2519 buf[2] = (char)(0x80 + ((c ) & 0x3f));
2520 return 3;
2521 }
2522 if (c <= 0x10FFFF)
2523 {
2524 if (buf_size < 4) return 0;
2525 buf[0] = (char)(0xf0 + (c >> 18));
2526 buf[1] = (char)(0x80 + ((c >> 12) & 0x3f));
2527 buf[2] = (char)(0x80 + ((c >> 6) & 0x3f));
2528 buf[3] = (char)(0x80 + ((c ) & 0x3f));
2529 return 4;
2530 }
2531 // Invalid code point, the max unicode is 0x10FFFF
2532 return 0;
2533}
2534
2535const char* ImTextCharToUtf8(char out_buf[5], unsigned int c)
2536{
2537 int count = ImTextCharToUtf8_inline(buf: out_buf, buf_size: 5, c);
2538 out_buf[count] = 0;
2539 return out_buf;
2540}
2541
2542// Not optimal but we very rarely use this function.
2543int ImTextCountUtf8BytesFromChar(const char* in_text, const char* in_text_end)
2544{
2545 unsigned int unused = 0;
2546 return ImTextCharFromUtf8(out_char: &unused, in_text, in_text_end);
2547}
2548
2549static inline int ImTextCountUtf8BytesFromChar(unsigned int c)
2550{
2551 if (c < 0x80) return 1;
2552 if (c < 0x800) return 2;
2553 if (c < 0x10000) return 3;
2554 if (c <= 0x10FFFF) return 4;
2555 return 3;
2556}
2557
2558int ImTextStrToUtf8(char* out_buf, int out_buf_size, const ImWchar* in_text, const ImWchar* in_text_end)
2559{
2560 char* buf_p = out_buf;
2561 const char* buf_end = out_buf + out_buf_size;
2562 while (buf_p < buf_end - 1 && (!in_text_end || in_text < in_text_end) && *in_text)
2563 {
2564 unsigned int c = (unsigned int)(*in_text++);
2565 if (c < 0x80)
2566 *buf_p++ = (char)c;
2567 else
2568 buf_p += ImTextCharToUtf8_inline(buf: buf_p, buf_size: (int)(buf_end - buf_p - 1), c);
2569 }
2570 *buf_p = 0;
2571 return (int)(buf_p - out_buf);
2572}
2573
2574int ImTextCountUtf8BytesFromStr(const ImWchar* in_text, const ImWchar* in_text_end)
2575{
2576 int bytes_count = 0;
2577 while ((!in_text_end || in_text < in_text_end) && *in_text)
2578 {
2579 unsigned int c = (unsigned int)(*in_text++);
2580 if (c < 0x80)
2581 bytes_count++;
2582 else
2583 bytes_count += ImTextCountUtf8BytesFromChar(c);
2584 }
2585 return bytes_count;
2586}
2587
2588const char* ImTextFindPreviousUtf8Codepoint(const char* in_text_start, const char* in_text_curr)
2589{
2590 while (in_text_curr > in_text_start)
2591 {
2592 in_text_curr--;
2593 if ((*in_text_curr & 0xC0) != 0x80)
2594 return in_text_curr;
2595 }
2596 return in_text_start;
2597}
2598
2599int ImTextCountLines(const char* in_text, const char* in_text_end)
2600{
2601 if (in_text_end == NULL)
2602 in_text_end = in_text + strlen(s: in_text); // FIXME-OPT: Not optimal approach, discourage use for now.
2603 int count = 0;
2604 while (in_text < in_text_end)
2605 {
2606 const char* line_end = (const char*)memchr(s: in_text, c: '\n', n: in_text_end - in_text);
2607 in_text = line_end ? line_end + 1 : in_text_end;
2608 count++;
2609 }
2610 return count;
2611}
2612
2613IM_MSVC_RUNTIME_CHECKS_RESTORE
2614
2615//-----------------------------------------------------------------------------
2616// [SECTION] MISC HELPERS/UTILITIES (Color functions)
2617// Note: The Convert functions are early design which are not consistent with other API.
2618//-----------------------------------------------------------------------------
2619
2620IMGUI_API ImU32 ImAlphaBlendColors(ImU32 col_a, ImU32 col_b)
2621{
2622 float t = ((col_b >> IM_COL32_A_SHIFT) & 0xFF) / 255.f;
2623 int r = ImLerp(a: (int)(col_a >> IM_COL32_R_SHIFT) & 0xFF, b: (int)(col_b >> IM_COL32_R_SHIFT) & 0xFF, t);
2624 int g = ImLerp(a: (int)(col_a >> IM_COL32_G_SHIFT) & 0xFF, b: (int)(col_b >> IM_COL32_G_SHIFT) & 0xFF, t);
2625 int b = ImLerp(a: (int)(col_a >> IM_COL32_B_SHIFT) & 0xFF, b: (int)(col_b >> IM_COL32_B_SHIFT) & 0xFF, t);
2626 return IM_COL32(r, g, b, 0xFF);
2627}
2628
2629ImVec4 ImGui::ColorConvertU32ToFloat4(ImU32 in)
2630{
2631 float s = 1.0f / 255.0f;
2632 return ImVec4(
2633 ((in >> IM_COL32_R_SHIFT) & 0xFF) * s,
2634 ((in >> IM_COL32_G_SHIFT) & 0xFF) * s,
2635 ((in >> IM_COL32_B_SHIFT) & 0xFF) * s,
2636 ((in >> IM_COL32_A_SHIFT) & 0xFF) * s);
2637}
2638
2639ImU32 ImGui::ColorConvertFloat4ToU32(const ImVec4& in)
2640{
2641 ImU32 out;
2642 out = ((ImU32)IM_F32_TO_INT8_SAT(in.x)) << IM_COL32_R_SHIFT;
2643 out |= ((ImU32)IM_F32_TO_INT8_SAT(in.y)) << IM_COL32_G_SHIFT;
2644 out |= ((ImU32)IM_F32_TO_INT8_SAT(in.z)) << IM_COL32_B_SHIFT;
2645 out |= ((ImU32)IM_F32_TO_INT8_SAT(in.w)) << IM_COL32_A_SHIFT;
2646 return out;
2647}
2648
2649// Convert rgb floats ([0-1],[0-1],[0-1]) to hsv floats ([0-1],[0-1],[0-1]), from Foley & van Dam p592
2650// Optimized http://lolengine.net/blog/2013/01/13/fast-rgb-to-hsv
2651void ImGui::ColorConvertRGBtoHSV(float r, float g, float b, float& out_h, float& out_s, float& out_v)
2652{
2653 float K = 0.f;
2654 if (g < b)
2655 {
2656 ImSwap(a&: g, b);
2657 K = -1.f;
2658 }
2659 if (r < g)
2660 {
2661 ImSwap(a&: r, b&: g);
2662 K = -2.f / 6.f - K;
2663 }
2664
2665 const float chroma = r - (g < b ? g : b);
2666 out_h = ImFabs(K + (g - b) / (6.f * chroma + 1e-20f));
2667 out_s = chroma / (r + 1e-20f);
2668 out_v = r;
2669}
2670
2671// Convert hsv floats ([0-1],[0-1],[0-1]) to rgb floats ([0-1],[0-1],[0-1]), from Foley & van Dam p593
2672// also http://en.wikipedia.org/wiki/HSL_and_HSV
2673void ImGui::ColorConvertHSVtoRGB(float h, float s, float v, float& out_r, float& out_g, float& out_b)
2674{
2675 if (s == 0.0f)
2676 {
2677 // gray
2678 out_r = out_g = out_b = v;
2679 return;
2680 }
2681
2682 h = ImFmod(h, 1.0f) / (60.0f / 360.0f);
2683 int i = (int)h;
2684 float f = h - (float)i;
2685 float p = v * (1.0f - s);
2686 float q = v * (1.0f - s * f);
2687 float t = v * (1.0f - s * (1.0f - f));
2688
2689 switch (i)
2690 {
2691 case 0: out_r = v; out_g = t; out_b = p; break;
2692 case 1: out_r = q; out_g = v; out_b = p; break;
2693 case 2: out_r = p; out_g = v; out_b = t; break;
2694 case 3: out_r = p; out_g = q; out_b = v; break;
2695 case 4: out_r = t; out_g = p; out_b = v; break;
2696 case 5: default: out_r = v; out_g = p; out_b = q; break;
2697 }
2698}
2699
2700//-----------------------------------------------------------------------------
2701// [SECTION] ImGuiStorage
2702// Helper: Key->value storage
2703//-----------------------------------------------------------------------------
2704
2705// std::lower_bound but without the bullshit
2706ImGuiStoragePair* ImLowerBound(ImGuiStoragePair* in_begin, ImGuiStoragePair* in_end, ImGuiID key)
2707{
2708 ImGuiStoragePair* in_p = in_begin;
2709 for (size_t count = (size_t)(in_end - in_p); count > 0; )
2710 {
2711 size_t count2 = count >> 1;
2712 ImGuiStoragePair* mid = in_p + count2;
2713 if (mid->key < key)
2714 {
2715 in_p = ++mid;
2716 count -= count2 + 1;
2717 }
2718 else
2719 {
2720 count = count2;
2721 }
2722 }
2723 return in_p;
2724}
2725
2726IM_MSVC_RUNTIME_CHECKS_OFF
2727static int IMGUI_CDECL PairComparerByID(const void* lhs, const void* rhs)
2728{
2729 // We can't just do a subtraction because qsort uses signed integers and subtracting our ID doesn't play well with that.
2730 ImGuiID lhs_v = ((const ImGuiStoragePair*)lhs)->key;
2731 ImGuiID rhs_v = ((const ImGuiStoragePair*)rhs)->key;
2732 return (lhs_v > rhs_v ? +1 : lhs_v < rhs_v ? -1 : 0);
2733}
2734
2735// For quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once.
2736void ImGuiStorage::BuildSortByKey()
2737{
2738 ImQsort(base: Data.Data, count: (size_t)Data.Size, size_of_element: sizeof(ImGuiStoragePair), compare_func: PairComparerByID);
2739}
2740
2741int ImGuiStorage::GetInt(ImGuiID key, int default_val) const
2742{
2743 ImGuiStoragePair* it = ImLowerBound(in_begin: const_cast<ImGuiStoragePair*>(Data.Data), in_end: const_cast<ImGuiStoragePair*>(Data.Data + Data.Size), key);
2744 if (it == Data.Data + Data.Size || it->key != key)
2745 return default_val;
2746 return it->val_i;
2747}
2748
2749bool ImGuiStorage::GetBool(ImGuiID key, bool default_val) const
2750{
2751 return GetInt(key, default_val: default_val ? 1 : 0) != 0;
2752}
2753
2754float ImGuiStorage::GetFloat(ImGuiID key, float default_val) const
2755{
2756 ImGuiStoragePair* it = ImLowerBound(in_begin: const_cast<ImGuiStoragePair*>(Data.Data), in_end: const_cast<ImGuiStoragePair*>(Data.Data + Data.Size), key);
2757 if (it == Data.Data + Data.Size || it->key != key)
2758 return default_val;
2759 return it->val_f;
2760}
2761
2762void* ImGuiStorage::GetVoidPtr(ImGuiID key) const
2763{
2764 ImGuiStoragePair* it = ImLowerBound(in_begin: const_cast<ImGuiStoragePair*>(Data.Data), in_end: const_cast<ImGuiStoragePair*>(Data.Data + Data.Size), key);
2765 if (it == Data.Data + Data.Size || it->key != key)
2766 return NULL;
2767 return it->val_p;
2768}
2769
2770// 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.
2771int* ImGuiStorage::GetIntRef(ImGuiID key, int default_val)
2772{
2773 ImGuiStoragePair* it = ImLowerBound(in_begin: Data.Data, in_end: Data.Data + Data.Size, key);
2774 if (it == Data.Data + Data.Size || it->key != key)
2775 it = Data.insert(it, v: ImGuiStoragePair(key, default_val));
2776 return &it->val_i;
2777}
2778
2779bool* ImGuiStorage::GetBoolRef(ImGuiID key, bool default_val)
2780{
2781 return (bool*)GetIntRef(key, default_val: default_val ? 1 : 0);
2782}
2783
2784float* ImGuiStorage::GetFloatRef(ImGuiID key, float default_val)
2785{
2786 ImGuiStoragePair* it = ImLowerBound(in_begin: Data.Data, in_end: Data.Data + Data.Size, key);
2787 if (it == Data.Data + Data.Size || it->key != key)
2788 it = Data.insert(it, v: ImGuiStoragePair(key, default_val));
2789 return &it->val_f;
2790}
2791
2792void** ImGuiStorage::GetVoidPtrRef(ImGuiID key, void* default_val)
2793{
2794 ImGuiStoragePair* it = ImLowerBound(in_begin: Data.Data, in_end: Data.Data + Data.Size, key);
2795 if (it == Data.Data + Data.Size || it->key != key)
2796 it = Data.insert(it, v: ImGuiStoragePair(key, default_val));
2797 return &it->val_p;
2798}
2799
2800// FIXME-OPT: Need a way to reuse the result of lower_bound when doing GetInt()/SetInt() - not too bad because it only happens on explicit interaction (maximum one a frame)
2801void ImGuiStorage::SetInt(ImGuiID key, int val)
2802{
2803 ImGuiStoragePair* it = ImLowerBound(in_begin: Data.Data, in_end: Data.Data + Data.Size, key);
2804 if (it == Data.Data + Data.Size || it->key != key)
2805 Data.insert(it, v: ImGuiStoragePair(key, val));
2806 else
2807 it->val_i = val;
2808}
2809
2810void ImGuiStorage::SetBool(ImGuiID key, bool val)
2811{
2812 SetInt(key, val: val ? 1 : 0);
2813}
2814
2815void ImGuiStorage::SetFloat(ImGuiID key, float val)
2816{
2817 ImGuiStoragePair* it = ImLowerBound(in_begin: Data.Data, in_end: Data.Data + Data.Size, key);
2818 if (it == Data.Data + Data.Size || it->key != key)
2819 Data.insert(it, v: ImGuiStoragePair(key, val));
2820 else
2821 it->val_f = val;
2822}
2823
2824void ImGuiStorage::SetVoidPtr(ImGuiID key, void* val)
2825{
2826 ImGuiStoragePair* it = ImLowerBound(in_begin: Data.Data, in_end: Data.Data + Data.Size, key);
2827 if (it == Data.Data + Data.Size || it->key != key)
2828 Data.insert(it, v: ImGuiStoragePair(key, val));
2829 else
2830 it->val_p = val;
2831}
2832
2833void ImGuiStorage::SetAllInt(int v)
2834{
2835 for (int i = 0; i < Data.Size; i++)
2836 Data[i].val_i = v;
2837}
2838IM_MSVC_RUNTIME_CHECKS_RESTORE
2839
2840//-----------------------------------------------------------------------------
2841// [SECTION] ImGuiTextFilter
2842//-----------------------------------------------------------------------------
2843
2844// Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]"
2845ImGuiTextFilter::ImGuiTextFilter(const char* default_filter) //-V1077
2846{
2847 InputBuf[0] = 0;
2848 CountGrep = 0;
2849 if (default_filter)
2850 {
2851 ImStrncpy(dst: InputBuf, src: default_filter, IM_ARRAYSIZE(InputBuf));
2852 Build();
2853 }
2854}
2855
2856bool ImGuiTextFilter::Draw(const char* label, float width)
2857{
2858 if (width != 0.0f)
2859 ImGui::SetNextItemWidth(width);
2860 bool value_changed = ImGui::InputText(label, buf: InputBuf, IM_ARRAYSIZE(InputBuf));
2861 if (value_changed)
2862 Build();
2863 return value_changed;
2864}
2865
2866void ImGuiTextFilter::ImGuiTextRange::split(char separator, ImVector<ImGuiTextRange>* out) const
2867{
2868 out->resize(new_size: 0);
2869 const char* wb = b;
2870 const char* we = wb;
2871 while (we < e)
2872 {
2873 if (*we == separator)
2874 {
2875 out->push_back(v: ImGuiTextRange(wb, we));
2876 wb = we + 1;
2877 }
2878 we++;
2879 }
2880 if (wb != we)
2881 out->push_back(v: ImGuiTextRange(wb, we));
2882}
2883
2884void ImGuiTextFilter::Build()
2885{
2886 Filters.resize(new_size: 0);
2887 ImGuiTextRange input_range(InputBuf, InputBuf + strlen(s: InputBuf));
2888 input_range.split(separator: ',', out: &Filters);
2889
2890 CountGrep = 0;
2891 for (ImGuiTextRange& f : Filters)
2892 {
2893 while (f.b < f.e && ImCharIsBlankA(c: f.b[0]))
2894 f.b++;
2895 while (f.e > f.b && ImCharIsBlankA(c: f.e[-1]))
2896 f.e--;
2897 if (f.empty())
2898 continue;
2899 if (f.b[0] != '-')
2900 CountGrep += 1;
2901 }
2902}
2903
2904bool ImGuiTextFilter::PassFilter(const char* text, const char* text_end) const
2905{
2906 if (Filters.Size == 0)
2907 return true;
2908
2909 if (text == NULL)
2910 text = text_end = "";
2911
2912 for (const ImGuiTextRange& f : Filters)
2913 {
2914 if (f.b == f.e)
2915 continue;
2916 if (f.b[0] == '-')
2917 {
2918 // Subtract
2919 if (ImStristr(haystack: text, haystack_end: text_end, needle: f.b + 1, needle_end: f.e) != NULL)
2920 return false;
2921 }
2922 else
2923 {
2924 // Grep
2925 if (ImStristr(haystack: text, haystack_end: text_end, needle: f.b, needle_end: f.e) != NULL)
2926 return true;
2927 }
2928 }
2929
2930 // Implicit * grep
2931 if (CountGrep == 0)
2932 return true;
2933
2934 return false;
2935}
2936
2937//-----------------------------------------------------------------------------
2938// [SECTION] ImGuiTextBuffer, ImGuiTextIndex
2939//-----------------------------------------------------------------------------
2940
2941// On some platform vsnprintf() takes va_list by reference and modifies it.
2942// va_copy is the 'correct' way to copy a va_list but Visual Studio prior to 2013 doesn't have it.
2943#ifndef va_copy
2944#if defined(__GNUC__) || defined(__clang__)
2945#define va_copy(dest, src) __builtin_va_copy(dest, src)
2946#else
2947#define va_copy(dest, src) (dest = src)
2948#endif
2949#endif
2950
2951char ImGuiTextBuffer::EmptyString[1] = { 0 };
2952
2953void ImGuiTextBuffer::append(const char* str, const char* str_end)
2954{
2955 int len = str_end ? (int)(str_end - str) : (int)strlen(s: str);
2956
2957 // Add zero-terminator the first time
2958 const int write_off = (Buf.Size != 0) ? Buf.Size : 1;
2959 const int needed_sz = write_off + len;
2960 if (write_off + len >= Buf.Capacity)
2961 {
2962 int new_capacity = Buf.Capacity * 2;
2963 Buf.reserve(new_capacity: needed_sz > new_capacity ? needed_sz : new_capacity);
2964 }
2965
2966 Buf.resize(new_size: needed_sz);
2967 memcpy(dest: &Buf[write_off - 1], src: str, n: (size_t)len);
2968 Buf[write_off - 1 + len] = 0;
2969}
2970
2971void ImGuiTextBuffer::appendf(const char* fmt, ...)
2972{
2973 va_list args;
2974 va_start(args, fmt);
2975 appendfv(fmt, args);
2976 va_end(args);
2977}
2978
2979// Helper: Text buffer for logging/accumulating text
2980void ImGuiTextBuffer::appendfv(const char* fmt, va_list args)
2981{
2982 va_list args_copy;
2983 va_copy(args_copy, args);
2984
2985 int len = ImFormatStringV(NULL, buf_size: 0, fmt, args); // FIXME-OPT: could do a first pass write attempt, likely successful on first pass.
2986 if (len <= 0)
2987 {
2988 va_end(args_copy);
2989 return;
2990 }
2991
2992 // Add zero-terminator the first time
2993 const int write_off = (Buf.Size != 0) ? Buf.Size : 1;
2994 const int needed_sz = write_off + len;
2995 if (write_off + len >= Buf.Capacity)
2996 {
2997 int new_capacity = Buf.Capacity * 2;
2998 Buf.reserve(new_capacity: needed_sz > new_capacity ? needed_sz : new_capacity);
2999 }
3000
3001 Buf.resize(new_size: needed_sz);
3002 ImFormatStringV(buf: &Buf[write_off - 1], buf_size: (size_t)len + 1, fmt, args: args_copy);
3003 va_end(args_copy);
3004}
3005
3006void ImGuiTextIndex::append(const char* base, int old_size, int new_size)
3007{
3008 IM_ASSERT(old_size >= 0 && new_size >= old_size && new_size >= EndOffset);
3009 if (old_size == new_size)
3010 return;
3011 if (EndOffset == 0 || base[EndOffset - 1] == '\n')
3012 LineOffsets.push_back(v: EndOffset);
3013 const char* base_end = base + new_size;
3014 for (const char* p = base + old_size; (p = (const char*)memchr(s: p, c: '\n', n: base_end - p)) != 0; )
3015 if (++p < base_end) // Don't push a trailing offset on last \n
3016 LineOffsets.push_back(v: (int)(intptr_t)(p - base));
3017 EndOffset = ImMax(lhs: EndOffset, rhs: new_size);
3018}
3019
3020//-----------------------------------------------------------------------------
3021// [SECTION] ImGuiListClipper
3022//-----------------------------------------------------------------------------
3023
3024// FIXME-TABLE: This prevents us from using ImGuiListClipper _inside_ a table cell.
3025// The problem we have is that without a Begin/End scheme for rows using the clipper is ambiguous.
3026static bool GetSkipItemForListClipping()
3027{
3028 ImGuiContext& g = *GImGui;
3029 return (g.CurrentTable ? g.CurrentTable->HostSkipItems : g.CurrentWindow->SkipItems);
3030}
3031
3032static void ImGuiListClipper_SortAndFuseRanges(ImVector<ImGuiListClipperRange>& ranges, int offset = 0)
3033{
3034 if (ranges.Size - offset <= 1)
3035 return;
3036
3037 // Helper to order ranges and fuse them together if possible (bubble sort is fine as we are only sorting 2-3 entries)
3038 for (int sort_end = ranges.Size - offset - 1; sort_end > 0; --sort_end)
3039 for (int i = offset; i < sort_end + offset; ++i)
3040 if (ranges[i].Min > ranges[i + 1].Min)
3041 ImSwap(a&: ranges[i], b&: ranges[i + 1]);
3042
3043 // Now fuse ranges together as much as possible.
3044 for (int i = 1 + offset; i < ranges.Size; i++)
3045 {
3046 IM_ASSERT(!ranges[i].PosToIndexConvert && !ranges[i - 1].PosToIndexConvert);
3047 if (ranges[i - 1].Max < ranges[i].Min)
3048 continue;
3049 ranges[i - 1].Min = ImMin(lhs: ranges[i - 1].Min, rhs: ranges[i].Min);
3050 ranges[i - 1].Max = ImMax(lhs: ranges[i - 1].Max, rhs: ranges[i].Max);
3051 ranges.erase(it: ranges.Data + i);
3052 i--;
3053 }
3054}
3055
3056static void ImGuiListClipper_SeekCursorAndSetupPrevLine(float pos_y, float line_height)
3057{
3058 // Set cursor position and a few other things so that SetScrollHereY() and Columns() can work when seeking cursor.
3059 // FIXME: It is problematic that we have to do that here, because custom/equivalent end-user code would stumble on the same issue.
3060 // The clipper should probably have a final step to display the last item in a regular manner, maybe with an opt-out flag for data sets which may have costly seek?
3061 ImGuiContext& g = *GImGui;
3062 ImGuiWindow* window = g.CurrentWindow;
3063 float off_y = pos_y - window->DC.CursorPos.y;
3064 window->DC.CursorPos.y = pos_y;
3065 window->DC.CursorMaxPos.y = ImMax(lhs: window->DC.CursorMaxPos.y, rhs: pos_y - g.Style.ItemSpacing.y);
3066 window->DC.CursorPosPrevLine.y = window->DC.CursorPos.y - line_height; // Setting those fields so that SetScrollHereY() can properly function after the end of our clipper usage.
3067 window->DC.PrevLineSize.y = (line_height - g.Style.ItemSpacing.y); // If we end up needing more accurate data (to e.g. use SameLine) we may as well make the clipper have a fourth step to let user process and display the last item in their list.
3068 if (ImGuiOldColumns* columns = window->DC.CurrentColumns)
3069 columns->LineMinY = window->DC.CursorPos.y; // Setting this so that cell Y position are set properly
3070 if (ImGuiTable* table = g.CurrentTable)
3071 {
3072 if (table->IsInsideRow)
3073 ImGui::TableEndRow(table);
3074 table->RowPosY2 = window->DC.CursorPos.y;
3075 const int row_increase = (int)((off_y / line_height) + 0.5f);
3076 //table->CurrentRow += row_increase; // Can't do without fixing TableEndRow()
3077 table->RowBgColorCounter += row_increase;
3078 }
3079}
3080
3081ImGuiListClipper::ImGuiListClipper()
3082{
3083 memset(s: this, c: 0, n: sizeof(*this));
3084}
3085
3086ImGuiListClipper::~ImGuiListClipper()
3087{
3088 End();
3089}
3090
3091void ImGuiListClipper::Begin(int items_count, float items_height)
3092{
3093 if (Ctx == NULL)
3094 Ctx = ImGui::GetCurrentContext();
3095
3096 ImGuiContext& g = *Ctx;
3097 ImGuiWindow* window = g.CurrentWindow;
3098 IMGUI_DEBUG_LOG_CLIPPER("Clipper: Begin(%d,%.2f) in '%s'\n", items_count, items_height, window->Name);
3099
3100 if (ImGuiTable* table = g.CurrentTable)
3101 if (table->IsInsideRow)
3102 ImGui::TableEndRow(table);
3103
3104 StartPosY = window->DC.CursorPos.y;
3105 ItemsHeight = items_height;
3106 ItemsCount = items_count;
3107 DisplayStart = -1;
3108 DisplayEnd = 0;
3109
3110 // Acquire temporary buffer
3111 if (++g.ClipperTempDataStacked > g.ClipperTempData.Size)
3112 g.ClipperTempData.resize(new_size: g.ClipperTempDataStacked, v: ImGuiListClipperData());
3113 ImGuiListClipperData* data = &g.ClipperTempData[g.ClipperTempDataStacked - 1];
3114 data->Reset(clipper: this);
3115 data->LossynessOffset = window->DC.CursorStartPosLossyness.y;
3116 TempData = data;
3117 StartSeekOffsetY = data->LossynessOffset;
3118}
3119
3120void ImGuiListClipper::End()
3121{
3122 if (ImGuiListClipperData* data = (ImGuiListClipperData*)TempData)
3123 {
3124 // In theory here we should assert that we are already at the right position, but it seems saner to just seek at the end and not assert/crash the user.
3125 ImGuiContext& g = *Ctx;
3126 IMGUI_DEBUG_LOG_CLIPPER("Clipper: End() in '%s'\n", g.CurrentWindow->Name);
3127 if (ItemsCount >= 0 && ItemsCount < INT_MAX && DisplayStart >= 0)
3128 SeekCursorForItem(item_index: ItemsCount);
3129
3130 // Restore temporary buffer and fix back pointers which may be invalidated when nesting
3131 IM_ASSERT(data->ListClipper == this);
3132 data->StepNo = data->Ranges.Size;
3133 if (--g.ClipperTempDataStacked > 0)
3134 {
3135 data = &g.ClipperTempData[g.ClipperTempDataStacked - 1];
3136 data->ListClipper->TempData = data;
3137 }
3138 TempData = NULL;
3139 }
3140 ItemsCount = -1;
3141}
3142
3143void ImGuiListClipper::IncludeItemsByIndex(int item_begin, int item_end)
3144{
3145 ImGuiListClipperData* data = (ImGuiListClipperData*)TempData;
3146 IM_ASSERT(DisplayStart < 0); // Only allowed after Begin() and if there has not been a specified range yet.
3147 IM_ASSERT(item_begin <= item_end);
3148 if (item_begin < item_end)
3149 data->Ranges.push_back(v: ImGuiListClipperRange::FromIndices(min: item_begin, max: item_end));
3150}
3151
3152// This is already called while stepping.
3153// The ONLY reason you may want to call this is if you passed INT_MAX to ImGuiListClipper::Begin() because you couldn't step item count beforehand.
3154void ImGuiListClipper::SeekCursorForItem(int item_n)
3155{
3156 // - Perform the add and multiply with double to allow seeking through larger ranges.
3157 // - StartPosY starts from ItemsFrozen, by adding SeekOffsetY we generally cancel that out (SeekOffsetY == LossynessOffset - ItemsFrozen * ItemsHeight).
3158 // - The reason we store SeekOffsetY instead of inferring it, is because we want to allow user to perform Seek after the last step, where ImGuiListClipperData is already done.
3159 float pos_y = (float)((double)StartPosY + StartSeekOffsetY + (double)item_n * ItemsHeight);
3160 ImGuiListClipper_SeekCursorAndSetupPrevLine(pos_y, line_height: ItemsHeight);
3161}
3162
3163static bool ImGuiListClipper_StepInternal(ImGuiListClipper* clipper)
3164{
3165 ImGuiContext& g = *clipper->Ctx;
3166 ImGuiWindow* window = g.CurrentWindow;
3167 ImGuiListClipperData* data = (ImGuiListClipperData*)clipper->TempData;
3168 IM_ASSERT(data != NULL && "Called ImGuiListClipper::Step() too many times, or before ImGuiListClipper::Begin() ?");
3169
3170 ImGuiTable* table = g.CurrentTable;
3171 if (table && table->IsInsideRow)
3172 ImGui::TableEndRow(table);
3173
3174 // No items
3175 if (clipper->ItemsCount == 0 || GetSkipItemForListClipping())
3176 return false;
3177
3178 // While we are in frozen row state, keep displaying items one by one, unclipped
3179 // FIXME: Could be stored as a table-agnostic state.
3180 if (data->StepNo == 0 && table != NULL && !table->IsUnfrozenRows)
3181 {
3182 clipper->DisplayStart = data->ItemsFrozen;
3183 clipper->DisplayEnd = ImMin(lhs: data->ItemsFrozen + 1, rhs: clipper->ItemsCount);
3184 if (clipper->DisplayStart < clipper->DisplayEnd)
3185 data->ItemsFrozen++;
3186 return true;
3187 }
3188
3189 // Step 0: Let you process the first element (regardless of it being visible or not, so we can measure the element height)
3190 bool calc_clipping = false;
3191 if (data->StepNo == 0)
3192 {
3193 clipper->StartPosY = window->DC.CursorPos.y;
3194 if (clipper->ItemsHeight <= 0.0f)
3195 {
3196 // Submit the first item (or range) so we can measure its height (generally the first range is 0..1)
3197 data->Ranges.push_front(v: ImGuiListClipperRange::FromIndices(min: data->ItemsFrozen, max: data->ItemsFrozen + 1));
3198 clipper->DisplayStart = ImMax(lhs: data->Ranges[0].Min, rhs: data->ItemsFrozen);
3199 clipper->DisplayEnd = ImMin(lhs: data->Ranges[0].Max, rhs: clipper->ItemsCount);
3200 data->StepNo = 1;
3201 return true;
3202 }
3203 calc_clipping = true; // If on the first step with known item height, calculate clipping.
3204 }
3205
3206 // Step 1: Let the clipper infer height from first range
3207 if (clipper->ItemsHeight <= 0.0f)
3208 {
3209 IM_ASSERT(data->StepNo == 1);
3210 if (table)
3211 IM_ASSERT(table->RowPosY1 == clipper->StartPosY && table->RowPosY2 == window->DC.CursorPos.y);
3212
3213 clipper->ItemsHeight = (window->DC.CursorPos.y - clipper->StartPosY) / (float)(clipper->DisplayEnd - clipper->DisplayStart);
3214 bool affected_by_floating_point_precision = ImIsFloatAboveGuaranteedIntegerPrecision(f: clipper->StartPosY) || ImIsFloatAboveGuaranteedIntegerPrecision(f: window->DC.CursorPos.y);
3215 if (affected_by_floating_point_precision)
3216 clipper->ItemsHeight = window->DC.PrevLineSize.y + g.Style.ItemSpacing.y; // FIXME: Technically wouldn't allow multi-line entries.
3217 if (clipper->ItemsHeight == 0.0f && clipper->ItemsCount == INT_MAX) // Accept that no item have been submitted if in indeterminate mode.
3218 return false;
3219 IM_ASSERT(clipper->ItemsHeight > 0.0f && "Unable to calculate item height! First item hasn't moved the cursor vertically!");
3220 calc_clipping = true; // If item height had to be calculated, calculate clipping afterwards.
3221 }
3222
3223 // Step 0 or 1: Calculate the actual ranges of visible elements.
3224 const int already_submitted = clipper->DisplayEnd;
3225 if (calc_clipping)
3226 {
3227 // Record seek offset, this is so ImGuiListClipper::Seek() can be called after ImGuiListClipperData is done
3228 clipper->StartSeekOffsetY = (double)data->LossynessOffset - data->ItemsFrozen * (double)clipper->ItemsHeight;
3229
3230 if (g.LogEnabled)
3231 {
3232 // If logging is active, do not perform any clipping
3233 data->Ranges.push_back(v: ImGuiListClipperRange::FromIndices(min: 0, max: clipper->ItemsCount));
3234 }
3235 else
3236 {
3237 // Add range selected to be included for navigation
3238 const bool is_nav_request = (g.NavMoveScoringItems && g.NavWindow && g.NavWindow->RootWindowForNav == window->RootWindowForNav);
3239 if (is_nav_request)
3240 data->Ranges.push_back(v: ImGuiListClipperRange::FromPositions(y1: g.NavScoringNoClipRect.Min.y, y2: g.NavScoringNoClipRect.Max.y, off_min: 0, off_max: 0));
3241 if (is_nav_request && (g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) && g.NavTabbingDir == -1)
3242 data->Ranges.push_back(v: ImGuiListClipperRange::FromIndices(min: clipper->ItemsCount - 1, max: clipper->ItemsCount));
3243
3244 // Add focused/active item
3245 ImRect nav_rect_abs = ImGui::WindowRectRelToAbs(window, r: window->NavRectRel[0]);
3246 if (g.NavId != 0 && window->NavLastIds[0] == g.NavId)
3247 data->Ranges.push_back(v: ImGuiListClipperRange::FromPositions(y1: nav_rect_abs.Min.y, y2: nav_rect_abs.Max.y, off_min: 0, off_max: 0));
3248
3249 // Add visible range
3250 float min_y = window->ClipRect.Min.y;
3251 float max_y = window->ClipRect.Max.y;
3252
3253 // Add box selection range
3254 ImGuiBoxSelectState* bs = &g.BoxSelectState;
3255 if (bs->IsActive && bs->Window == window)
3256 {
3257 // FIXME: Selectable() use of half-ItemSpacing isn't consistent in matter of layout, as ItemAdd(bb) stray above ItemSize()'s CursorPos.
3258 // RangeSelect's BoxSelect relies on comparing overlap of previous and current rectangle and is sensitive to that.
3259 // As a workaround we currently half ItemSpacing worth on each side.
3260 min_y -= g.Style.ItemSpacing.y;
3261 max_y += g.Style.ItemSpacing.y;
3262
3263 // Box-select on 2D area requires different clipping.
3264 if (bs->UnclipMode)
3265 data->Ranges.push_back(v: ImGuiListClipperRange::FromPositions(y1: bs->UnclipRect.Min.y, y2: bs->UnclipRect.Max.y, off_min: 0, off_max: 0));
3266 }
3267
3268 const int off_min = (is_nav_request && g.NavMoveClipDir == ImGuiDir_Up) ? -1 : 0;
3269 const int off_max = (is_nav_request && g.NavMoveClipDir == ImGuiDir_Down) ? 1 : 0;
3270 data->Ranges.push_back(v: ImGuiListClipperRange::FromPositions(y1: min_y, y2: max_y, off_min, off_max));
3271 }
3272
3273 // Convert position ranges to item index ranges
3274 // - Very important: when a starting position is after our maximum item, we set Min to (ItemsCount - 1). This allows us to handle most forms of wrapping.
3275 // - Due to how Selectable extra padding they tend to be "unaligned" with exact unit in the item list,
3276 // which with the flooring/ceiling tend to lead to 2 items instead of one being submitted.
3277 for (ImGuiListClipperRange& range : data->Ranges)
3278 if (range.PosToIndexConvert)
3279 {
3280 int m1 = (int)(((double)range.Min - window->DC.CursorPos.y - data->LossynessOffset) / clipper->ItemsHeight);
3281 int m2 = (int)((((double)range.Max - window->DC.CursorPos.y - data->LossynessOffset) / clipper->ItemsHeight) + 0.999999f);
3282 range.Min = ImClamp(v: already_submitted + m1 + range.PosToIndexOffsetMin, mn: already_submitted, mx: clipper->ItemsCount - 1);
3283 range.Max = ImClamp(v: already_submitted + m2 + range.PosToIndexOffsetMax, mn: range.Min + 1, mx: clipper->ItemsCount);
3284 range.PosToIndexConvert = false;
3285 }
3286 ImGuiListClipper_SortAndFuseRanges(ranges&: data->Ranges, offset: data->StepNo);
3287 }
3288
3289 // Step 0+ (if item height is given in advance) or 1+: Display the next range in line.
3290 while (data->StepNo < data->Ranges.Size)
3291 {
3292 clipper->DisplayStart = ImMax(lhs: data->Ranges[data->StepNo].Min, rhs: already_submitted);
3293 clipper->DisplayEnd = ImMin(lhs: data->Ranges[data->StepNo].Max, rhs: clipper->ItemsCount);
3294 if (clipper->DisplayStart > already_submitted) //-V1051
3295 clipper->SeekCursorForItem(item_n: clipper->DisplayStart);
3296 data->StepNo++;
3297 if (clipper->DisplayStart == clipper->DisplayEnd && data->StepNo < data->Ranges.Size)
3298 continue;
3299 return true;
3300 }
3301
3302 // After the last step: Let the clipper validate that we have reached the expected Y position (corresponding to element DisplayEnd),
3303 // Advance the cursor to the end of the list and then returns 'false' to end the loop.
3304 if (clipper->ItemsCount < INT_MAX)
3305 clipper->SeekCursorForItem(item_n: clipper->ItemsCount);
3306
3307 return false;
3308}
3309
3310bool ImGuiListClipper::Step()
3311{
3312 ImGuiContext& g = *Ctx;
3313 bool need_items_height = (ItemsHeight <= 0.0f);
3314 bool ret = ImGuiListClipper_StepInternal(clipper: this);
3315 if (ret && (DisplayStart == DisplayEnd))
3316 ret = false;
3317 if (g.CurrentTable && g.CurrentTable->IsUnfrozenRows == false)
3318 IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): inside frozen table row.\n");
3319 if (need_items_height && ItemsHeight > 0.0f)
3320 IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): computed ItemsHeight: %.2f.\n", ItemsHeight);
3321 if (ret)
3322 {
3323 IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): display %d to %d.\n", DisplayStart, DisplayEnd);
3324 }
3325 else
3326 {
3327 IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): End.\n");
3328 End();
3329 }
3330 return ret;
3331}
3332
3333//-----------------------------------------------------------------------------
3334// [SECTION] STYLING
3335//-----------------------------------------------------------------------------
3336
3337ImGuiStyle& ImGui::GetStyle()
3338{
3339 IM_ASSERT(GImGui != NULL && "No current context. Did you call ImGui::CreateContext() and ImGui::SetCurrentContext() ?");
3340 return GImGui->Style;
3341}
3342
3343ImU32 ImGui::GetColorU32(ImGuiCol idx, float alpha_mul)
3344{
3345 ImGuiStyle& style = GImGui->Style;
3346 ImVec4 c = style.Colors[idx];
3347 c.w *= style.Alpha * alpha_mul;
3348 return ColorConvertFloat4ToU32(in: c);
3349}
3350
3351ImU32 ImGui::GetColorU32(const ImVec4& col)
3352{
3353 ImGuiStyle& style = GImGui->Style;
3354 ImVec4 c = col;
3355 c.w *= style.Alpha;
3356 return ColorConvertFloat4ToU32(in: c);
3357}
3358
3359const ImVec4& ImGui::GetStyleColorVec4(ImGuiCol idx)
3360{
3361 ImGuiStyle& style = GImGui->Style;
3362 return style.Colors[idx];
3363}
3364
3365ImU32 ImGui::GetColorU32(ImU32 col, float alpha_mul)
3366{
3367 ImGuiStyle& style = GImGui->Style;
3368 alpha_mul *= style.Alpha;
3369 if (alpha_mul >= 1.0f)
3370 return col;
3371 ImU32 a = (col & IM_COL32_A_MASK) >> IM_COL32_A_SHIFT;
3372 a = (ImU32)(a * alpha_mul); // We don't need to clamp 0..255 because alpha is in 0..1 range.
3373 return (col & ~IM_COL32_A_MASK) | (a << IM_COL32_A_SHIFT);
3374}
3375
3376// FIXME: This may incur a round-trip (if the end user got their data from a float4) but eventually we aim to store the in-flight colors as ImU32
3377void ImGui::PushStyleColor(ImGuiCol idx, ImU32 col)
3378{
3379 ImGuiContext& g = *GImGui;
3380 ImGuiColorMod backup;
3381 backup.Col = idx;
3382 backup.BackupValue = g.Style.Colors[idx];
3383 g.ColorStack.push_back(v: backup);
3384 if (g.DebugFlashStyleColorIdx != idx)
3385 g.Style.Colors[idx] = ColorConvertU32ToFloat4(in: col);
3386}
3387
3388void ImGui::PushStyleColor(ImGuiCol idx, const ImVec4& col)
3389{
3390 ImGuiContext& g = *GImGui;
3391 ImGuiColorMod backup;
3392 backup.Col = idx;
3393 backup.BackupValue = g.Style.Colors[idx];
3394 g.ColorStack.push_back(v: backup);
3395 if (g.DebugFlashStyleColorIdx != idx)
3396 g.Style.Colors[idx] = col;
3397}
3398
3399void ImGui::PopStyleColor(int count)
3400{
3401 ImGuiContext& g = *GImGui;
3402 if (g.ColorStack.Size < count)
3403 {
3404 IM_ASSERT_USER_ERROR(0, "Calling PopStyleColor() too many times!");
3405 count = g.ColorStack.Size;
3406 }
3407 while (count > 0)
3408 {
3409 ImGuiColorMod& backup = g.ColorStack.back();
3410 g.Style.Colors[backup.Col] = backup.BackupValue;
3411 g.ColorStack.pop_back();
3412 count--;
3413 }
3414}
3415
3416static const ImGuiCol GWindowDockStyleColors[ImGuiWindowDockStyleCol_COUNT] =
3417{
3418 ImGuiCol_Text, ImGuiCol_TabHovered, ImGuiCol_Tab, ImGuiCol_TabSelected, ImGuiCol_TabSelectedOverline, ImGuiCol_TabDimmed, ImGuiCol_TabDimmedSelected, ImGuiCol_TabDimmedSelectedOverline,
3419};
3420
3421static const ImGuiDataVarInfo GStyleVarInfo[] =
3422{
3423 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, Alpha) }, // ImGuiStyleVar_Alpha
3424 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, DisabledAlpha) }, // ImGuiStyleVar_DisabledAlpha
3425 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, WindowPadding) }, // ImGuiStyleVar_WindowPadding
3426 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, WindowRounding) }, // ImGuiStyleVar_WindowRounding
3427 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, WindowBorderSize) }, // ImGuiStyleVar_WindowBorderSize
3428 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, WindowMinSize) }, // ImGuiStyleVar_WindowMinSize
3429 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, WindowTitleAlign) }, // ImGuiStyleVar_WindowTitleAlign
3430 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, ChildRounding) }, // ImGuiStyleVar_ChildRounding
3431 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, ChildBorderSize) }, // ImGuiStyleVar_ChildBorderSize
3432 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, PopupRounding) }, // ImGuiStyleVar_PopupRounding
3433 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, PopupBorderSize) }, // ImGuiStyleVar_PopupBorderSize
3434 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, FramePadding) }, // ImGuiStyleVar_FramePadding
3435 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, FrameRounding) }, // ImGuiStyleVar_FrameRounding
3436 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, FrameBorderSize) }, // ImGuiStyleVar_FrameBorderSize
3437 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, ItemSpacing) }, // ImGuiStyleVar_ItemSpacing
3438 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, ItemInnerSpacing) }, // ImGuiStyleVar_ItemInnerSpacing
3439 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, IndentSpacing) }, // ImGuiStyleVar_IndentSpacing
3440 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, CellPadding) }, // ImGuiStyleVar_CellPadding
3441 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, ScrollbarSize) }, // ImGuiStyleVar_ScrollbarSize
3442 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, ScrollbarRounding) }, // ImGuiStyleVar_ScrollbarRounding
3443 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, GrabMinSize) }, // ImGuiStyleVar_GrabMinSize
3444 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, GrabRounding) }, // ImGuiStyleVar_GrabRounding
3445 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, TabRounding) }, // ImGuiStyleVar_TabRounding
3446 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, TabBorderSize) }, // ImGuiStyleVar_TabBorderSize
3447 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, TabBarBorderSize) }, // ImGuiStyleVar_TabBarBorderSize
3448 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, TabBarOverlineSize) }, // ImGuiStyleVar_TabBarOverlineSize
3449 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, TableAngledHeadersAngle)}, // ImGuiStyleVar_TableAngledHeadersAngle
3450 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, TableAngledHeadersTextAlign)},// ImGuiStyleVar_TableAngledHeadersTextAlign
3451 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, ButtonTextAlign) }, // ImGuiStyleVar_ButtonTextAlign
3452 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, SelectableTextAlign) }, // ImGuiStyleVar_SelectableTextAlign
3453 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, SeparatorTextBorderSize)}, // ImGuiStyleVar_SeparatorTextBorderSize
3454 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, SeparatorTextAlign) }, // ImGuiStyleVar_SeparatorTextAlign
3455 { .Type: ImGuiDataType_Float, .Count: 2, .Offset: (ImU32)offsetof(ImGuiStyle, SeparatorTextPadding) }, // ImGuiStyleVar_SeparatorTextPadding
3456 { .Type: ImGuiDataType_Float, .Count: 1, .Offset: (ImU32)offsetof(ImGuiStyle, DockingSeparatorSize) }, // ImGuiStyleVar_DockingSeparatorSize
3457};
3458
3459const ImGuiDataVarInfo* ImGui::GetStyleVarInfo(ImGuiStyleVar idx)
3460{
3461 IM_ASSERT(idx >= 0 && idx < ImGuiStyleVar_COUNT);
3462 IM_STATIC_ASSERT(IM_ARRAYSIZE(GStyleVarInfo) == ImGuiStyleVar_COUNT);
3463 return &GStyleVarInfo[idx];
3464}
3465
3466void ImGui::PushStyleVar(ImGuiStyleVar idx, float val)
3467{
3468 ImGuiContext& g = *GImGui;
3469 const ImGuiDataVarInfo* var_info = GetStyleVarInfo(idx);
3470 if (var_info->Type != ImGuiDataType_Float || var_info->Count != 1)
3471 {
3472 IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!");
3473 return;
3474 }
3475 float* pvar = (float*)var_info->GetVarPtr(parent: &g.Style);
3476 g.StyleVarStack.push_back(v: ImGuiStyleMod(idx, *pvar));
3477 *pvar = val;
3478}
3479
3480void ImGui::PushStyleVarX(ImGuiStyleVar idx, float val_x)
3481{
3482 ImGuiContext& g = *GImGui;
3483 const ImGuiDataVarInfo* var_info = GetStyleVarInfo(idx);
3484 if (var_info->Type != ImGuiDataType_Float || var_info->Count != 2)
3485 {
3486 IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!");
3487 return;
3488 }
3489 ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(parent: &g.Style);
3490 g.StyleVarStack.push_back(v: ImGuiStyleMod(idx, *pvar));
3491 pvar->x = val_x;
3492}
3493
3494void ImGui::PushStyleVarY(ImGuiStyleVar idx, float val_y)
3495{
3496 ImGuiContext& g = *GImGui;
3497 const ImGuiDataVarInfo* var_info = GetStyleVarInfo(idx);
3498 if (var_info->Type != ImGuiDataType_Float || var_info->Count != 2)
3499 {
3500 IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!");
3501 return;
3502 }
3503 ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(parent: &g.Style);
3504 g.StyleVarStack.push_back(v: ImGuiStyleMod(idx, *pvar));
3505 pvar->y = val_y;
3506}
3507
3508void ImGui::PushStyleVar(ImGuiStyleVar idx, const ImVec2& val)
3509{
3510 ImGuiContext& g = *GImGui;
3511 const ImGuiDataVarInfo* var_info = GetStyleVarInfo(idx);
3512 if (var_info->Type != ImGuiDataType_Float || var_info->Count != 2)
3513 {
3514 IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!");
3515 return;
3516 }
3517 ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(parent: &g.Style);
3518 g.StyleVarStack.push_back(v: ImGuiStyleMod(idx, *pvar));
3519 *pvar = val;
3520}
3521
3522void ImGui::PopStyleVar(int count)
3523{
3524 ImGuiContext& g = *GImGui;
3525 if (g.StyleVarStack.Size < count)
3526 {
3527 IM_ASSERT_USER_ERROR(0, "Calling PopStyleVar() too many times!");
3528 count = g.StyleVarStack.Size;
3529 }
3530 while (count > 0)
3531 {
3532 // We avoid a generic memcpy(data, &backup.Backup.., GDataTypeSize[info->Type] * info->Count), the overhead in Debug is not worth it.
3533 ImGuiStyleMod& backup = g.StyleVarStack.back();
3534 const ImGuiDataVarInfo* info = GetStyleVarInfo(idx: backup.VarIdx);
3535 void* data = info->GetVarPtr(parent: &g.Style);
3536 if (info->Type == ImGuiDataType_Float && info->Count == 1) { ((float*)data)[0] = backup.BackupFloat[0]; }
3537 else if (info->Type == ImGuiDataType_Float && info->Count == 2) { ((float*)data)[0] = backup.BackupFloat[0]; ((float*)data)[1] = backup.BackupFloat[1]; }
3538 g.StyleVarStack.pop_back();
3539 count--;
3540 }
3541}
3542
3543const char* ImGui::GetStyleColorName(ImGuiCol idx)
3544{
3545 // Create switch-case from enum with regexp: ImGuiCol_{.*}, --> case ImGuiCol_\1: return "\1";
3546 switch (idx)
3547 {
3548 case ImGuiCol_Text: return "Text";
3549 case ImGuiCol_TextDisabled: return "TextDisabled";
3550 case ImGuiCol_WindowBg: return "WindowBg";
3551 case ImGuiCol_ChildBg: return "ChildBg";
3552 case ImGuiCol_PopupBg: return "PopupBg";
3553 case ImGuiCol_Border: return "Border";
3554 case ImGuiCol_BorderShadow: return "BorderShadow";
3555 case ImGuiCol_FrameBg: return "FrameBg";
3556 case ImGuiCol_FrameBgHovered: return "FrameBgHovered";
3557 case ImGuiCol_FrameBgActive: return "FrameBgActive";
3558 case ImGuiCol_TitleBg: return "TitleBg";
3559 case ImGuiCol_TitleBgActive: return "TitleBgActive";
3560 case ImGuiCol_TitleBgCollapsed: return "TitleBgCollapsed";
3561 case ImGuiCol_MenuBarBg: return "MenuBarBg";
3562 case ImGuiCol_ScrollbarBg: return "ScrollbarBg";
3563 case ImGuiCol_ScrollbarGrab: return "ScrollbarGrab";
3564 case ImGuiCol_ScrollbarGrabHovered: return "ScrollbarGrabHovered";
3565 case ImGuiCol_ScrollbarGrabActive: return "ScrollbarGrabActive";
3566 case ImGuiCol_CheckMark: return "CheckMark";
3567 case ImGuiCol_SliderGrab: return "SliderGrab";
3568 case ImGuiCol_SliderGrabActive: return "SliderGrabActive";
3569 case ImGuiCol_Button: return "Button";
3570 case ImGuiCol_ButtonHovered: return "ButtonHovered";
3571 case ImGuiCol_ButtonActive: return "ButtonActive";
3572 case ImGuiCol_Header: return "Header";
3573 case ImGuiCol_HeaderHovered: return "HeaderHovered";
3574 case ImGuiCol_HeaderActive: return "HeaderActive";
3575 case ImGuiCol_Separator: return "Separator";
3576 case ImGuiCol_SeparatorHovered: return "SeparatorHovered";
3577 case ImGuiCol_SeparatorActive: return "SeparatorActive";
3578 case ImGuiCol_ResizeGrip: return "ResizeGrip";
3579 case ImGuiCol_ResizeGripHovered: return "ResizeGripHovered";
3580 case ImGuiCol_ResizeGripActive: return "ResizeGripActive";
3581 case ImGuiCol_TabHovered: return "TabHovered";
3582 case ImGuiCol_Tab: return "Tab";
3583 case ImGuiCol_TabSelected: return "TabSelected";
3584 case ImGuiCol_TabSelectedOverline: return "TabSelectedOverline";
3585 case ImGuiCol_TabDimmed: return "TabDimmed";
3586 case ImGuiCol_TabDimmedSelected: return "TabDimmedSelected";
3587 case ImGuiCol_TabDimmedSelectedOverline: return "TabDimmedSelectedOverline";
3588 case ImGuiCol_DockingPreview: return "DockingPreview";
3589 case ImGuiCol_DockingEmptyBg: return "DockingEmptyBg";
3590 case ImGuiCol_PlotLines: return "PlotLines";
3591 case ImGuiCol_PlotLinesHovered: return "PlotLinesHovered";
3592 case ImGuiCol_PlotHistogram: return "PlotHistogram";
3593 case ImGuiCol_PlotHistogramHovered: return "PlotHistogramHovered";
3594 case ImGuiCol_TableHeaderBg: return "TableHeaderBg";
3595 case ImGuiCol_TableBorderStrong: return "TableBorderStrong";
3596 case ImGuiCol_TableBorderLight: return "TableBorderLight";
3597 case ImGuiCol_TableRowBg: return "TableRowBg";
3598 case ImGuiCol_TableRowBgAlt: return "TableRowBgAlt";
3599 case ImGuiCol_TextLink: return "TextLink";
3600 case ImGuiCol_TextSelectedBg: return "TextSelectedBg";
3601 case ImGuiCol_DragDropTarget: return "DragDropTarget";
3602 case ImGuiCol_NavCursor: return "NavCursor";
3603 case ImGuiCol_NavWindowingHighlight: return "NavWindowingHighlight";
3604 case ImGuiCol_NavWindowingDimBg: return "NavWindowingDimBg";
3605 case ImGuiCol_ModalWindowDimBg: return "ModalWindowDimBg";
3606 }
3607 IM_ASSERT(0);
3608 return "Unknown";
3609}
3610
3611
3612//-----------------------------------------------------------------------------
3613// [SECTION] RENDER HELPERS
3614// Some of those (internal) functions are currently quite a legacy mess - their signature and behavior will change,
3615// we need a nicer separation between low-level functions and high-level functions relying on the ImGui context.
3616// Also see imgui_draw.cpp for some more which have been reworked to not rely on ImGui:: context.
3617//-----------------------------------------------------------------------------
3618
3619const char* ImGui::FindRenderedTextEnd(const char* text, const char* text_end)
3620{
3621 const char* text_display_end = text;
3622 if (!text_end)
3623 text_end = (const char*)-1;
3624
3625 while (text_display_end < text_end && *text_display_end != '\0' && (text_display_end[0] != '#' || text_display_end[1] != '#'))
3626 text_display_end++;
3627 return text_display_end;
3628}
3629
3630// Internal ImGui functions to render text
3631// RenderText***() functions calls ImDrawList::AddText() calls ImBitmapFont::RenderText()
3632void ImGui::RenderText(ImVec2 pos, const char* text, const char* text_end, bool hide_text_after_hash)
3633{
3634 ImGuiContext& g = *GImGui;
3635 ImGuiWindow* window = g.CurrentWindow;
3636
3637 // Hide anything after a '##' string
3638 const char* text_display_end;
3639 if (hide_text_after_hash)
3640 {
3641 text_display_end = FindRenderedTextEnd(text, text_end);
3642 }
3643 else
3644 {
3645 if (!text_end)
3646 text_end = text + strlen(s: text); // FIXME-OPT
3647 text_display_end = text_end;
3648 }
3649
3650 if (text != text_display_end)
3651 {
3652 window->DrawList->AddText(font: g.Font, font_size: g.FontSize, pos, col: GetColorU32(idx: ImGuiCol_Text), text_begin: text, text_end: text_display_end);
3653 if (g.LogEnabled)
3654 LogRenderedText(ref_pos: &pos, text, text_end: text_display_end);
3655 }
3656}
3657
3658void ImGui::RenderTextWrapped(ImVec2 pos, const char* text, const char* text_end, float wrap_width)
3659{
3660 ImGuiContext& g = *GImGui;
3661 ImGuiWindow* window = g.CurrentWindow;
3662
3663 if (!text_end)
3664 text_end = text + strlen(s: text); // FIXME-OPT
3665
3666 if (text != text_end)
3667 {
3668 window->DrawList->AddText(font: g.Font, font_size: g.FontSize, pos, col: GetColorU32(idx: ImGuiCol_Text), text_begin: text, text_end, wrap_width);
3669 if (g.LogEnabled)
3670 LogRenderedText(ref_pos: &pos, text, text_end);
3671 }
3672}
3673
3674// Default clip_rect uses (pos_min,pos_max)
3675// Handle clipping on CPU immediately (vs typically let the GPU clip the triangles that are overlapping the clipping rectangle edges)
3676// FIXME-OPT: Since we have or calculate text_size we could coarse clip whole block immediately, especally for text above draw_list->DrawList.
3677// Effectively as this is called from widget doing their own coarse clipping it's not very valuable presently. Next time function will take
3678// better advantage of the render function taking size into account for coarse clipping.
3679void ImGui::RenderTextClippedEx(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_display_end, const ImVec2* text_size_if_known, const ImVec2& align, const ImRect* clip_rect)
3680{
3681 // Perform CPU side clipping for single clipped element to avoid using scissor state
3682 ImVec2 pos = pos_min;
3683 const ImVec2 text_size = text_size_if_known ? *text_size_if_known : CalcTextSize(text, text_end: text_display_end, hide_text_after_double_hash: false, wrap_width: 0.0f);
3684
3685 const ImVec2* clip_min = clip_rect ? &clip_rect->Min : &pos_min;
3686 const ImVec2* clip_max = clip_rect ? &clip_rect->Max : &pos_max;
3687 bool need_clipping = (pos.x + text_size.x >= clip_max->x) || (pos.y + text_size.y >= clip_max->y);
3688 if (clip_rect) // If we had no explicit clipping rectangle then pos==clip_min
3689 need_clipping |= (pos.x < clip_min->x) || (pos.y < clip_min->y);
3690
3691 // Align whole block. We should defer that to the better rendering function when we'll have support for individual line alignment.
3692 if (align.x > 0.0f) pos.x = ImMax(lhs: pos.x, rhs: pos.x + (pos_max.x - pos.x - text_size.x) * align.x);
3693 if (align.y > 0.0f) pos.y = ImMax(lhs: pos.y, rhs: pos.y + (pos_max.y - pos.y - text_size.y) * align.y);
3694
3695 // Render
3696 if (need_clipping)
3697 {
3698 ImVec4 fine_clip_rect(clip_min->x, clip_min->y, clip_max->x, clip_max->y);
3699 draw_list->AddText(NULL, font_size: 0.0f, pos, col: GetColorU32(idx: ImGuiCol_Text), text_begin: text, text_end: text_display_end, wrap_width: 0.0f, cpu_fine_clip_rect: &fine_clip_rect);
3700 }
3701 else
3702 {
3703 draw_list->AddText(NULL, font_size: 0.0f, pos, col: GetColorU32(idx: ImGuiCol_Text), text_begin: text, text_end: text_display_end, wrap_width: 0.0f, NULL);
3704 }
3705}
3706
3707void ImGui::RenderTextClipped(const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align, const ImRect* clip_rect)
3708{
3709 // Hide anything after a '##' string
3710 const char* text_display_end = FindRenderedTextEnd(text, text_end);
3711 const int text_len = (int)(text_display_end - text);
3712 if (text_len == 0)
3713 return;
3714
3715 ImGuiContext& g = *GImGui;
3716 ImGuiWindow* window = g.CurrentWindow;
3717 RenderTextClippedEx(draw_list: window->DrawList, pos_min, pos_max, text, text_display_end, text_size_if_known, align, clip_rect);
3718 if (g.LogEnabled)
3719 LogRenderedText(ref_pos: &pos_min, text, text_end: text_display_end);
3720}
3721
3722// Another overly complex function until we reorganize everything into a nice all-in-one helper.
3723// This is made more complex because we have dissociated the layout rectangle (pos_min..pos_max) which define _where_ the ellipsis is, from actual clipping of text and limit of the ellipsis display.
3724// This is because in the context of tabs we selectively hide part of the text when the Close Button appears, but we don't want the ellipsis to move.
3725void ImGui::RenderTextEllipsis(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, float clip_max_x, float ellipsis_max_x, const char* text, const char* text_end_full, const ImVec2* text_size_if_known)
3726{
3727 ImGuiContext& g = *GImGui;
3728 if (text_end_full == NULL)
3729 text_end_full = FindRenderedTextEnd(text);
3730 const ImVec2 text_size = text_size_if_known ? *text_size_if_known : CalcTextSize(text, text_end: text_end_full, hide_text_after_double_hash: false, wrap_width: 0.0f);
3731
3732 //draw_list->AddLine(ImVec2(pos_max.x, pos_min.y - 4), ImVec2(pos_max.x, pos_max.y + 4), IM_COL32(0, 0, 255, 255));
3733 //draw_list->AddLine(ImVec2(ellipsis_max_x, pos_min.y-2), ImVec2(ellipsis_max_x, pos_max.y+2), IM_COL32(0, 255, 0, 255));
3734 //draw_list->AddLine(ImVec2(clip_max_x, pos_min.y), ImVec2(clip_max_x, pos_max.y), IM_COL32(255, 0, 0, 255));
3735 // FIXME: We could technically remove (last_glyph->AdvanceX - last_glyph->X1) from text_size.x here and save a few pixels.
3736 if (text_size.x > pos_max.x - pos_min.x)
3737 {
3738 // Hello wo...
3739 // | | |
3740 // min max ellipsis_max
3741 // <-> this is generally some padding value
3742
3743 ImFont* font = draw_list->_Data->Font;
3744 const float font_size = draw_list->_Data->FontSize;
3745 const float font_scale = draw_list->_Data->FontScale;
3746 const char* text_end_ellipsis = NULL;
3747 const float ellipsis_width = font->EllipsisWidth * font_scale;
3748
3749 // We can now claim the space between pos_max.x and ellipsis_max.x
3750 const float text_avail_width = ImMax(lhs: (ImMax(lhs: pos_max.x, rhs: ellipsis_max_x) - ellipsis_width) - pos_min.x, rhs: 1.0f);
3751 float text_size_clipped_x = font->CalcTextSizeA(size: font_size, max_width: text_avail_width, wrap_width: 0.0f, text_begin: text, text_end: