Merge branch 'ocornut:master' into cpu

2026-03-30 12:28:11 +02:00
parent f46085238e bd3c925680
commit 8fb4746c91
25 changed files with 573 additions and 229 deletions
@@ -41,16 +41,6 @@ HOW TO UPDATE?

 Breaking Changes:

- - Changed default ImTextureID_Invalid value to -1 instead of 0 if not #define-d.
-    (#9293, #8745, #8465, #7090)
-   - It seems like a better default since it will work with backends storing
-     indices or memory offsets inside ImTextureID, where 0 might be a valid value.
-   - If this is causing problem with e.g your custom ImTextureID definition, you can
-     add '#define ImTextureID_Invalid 0' to your imconfig.h + PLEASE report this to GitHub.
-   - If you have hardcoded e.g. 'if (tex_id == 0)' checks they should be updated.
-     e.g. OpenGL2, OpenGL3 and SDLRenderer3 backends incorrectly had 'IM_ASSERT(tex->TexID == 0)'
-     lines which were replaced with 'IM_ASSERT(tex->TexID == ImTextureID_Invalid)'.
-     If you have copied or forked backends consider fixing locally. (#9295)
 - Separator(): fixed a legacy quirk where Separator() was submitting a zero-height
   item for layout purpose, even though it draws a 1-pixel separator.
   The fix could affect code e.g. computing height from multiple widgets in order to
@@ -63,6 +53,8 @@ Breaking Changes:
      BeginChild("ScrollingRegion", { 0, -footer_height });
   When such idiom was used and assuming zero-height Separator, it is likely that
   in 1.92.7 the resulting window will have unexpected 1 pixel scrolling range.
+ - Multi-Select: renamed ImGuiMultiSelectFlags_SelectOnClick to ImGuiMultiSelectFlags_SelectOnAuto.
+   Kept inline redirection enum (will obsolete).
 - Combo(), ListBox(): commented out legacy signatures which were obsoleted in 1.90
   (Nov 2023), when the getter callback type was changed from:
      getter type:   bool (*getter)(void* user_data, int idx, const char** out_text)
@@ -87,6 +79,19 @@ Other Changes:
    signals to be emitted the same way regardless of that setting. (#9001, #9115)
  - Fixed a glitch when using ImGuiInputTextFlags_ElideLeft where the local x offset
    would be incorrect during the deactivation frame. (#9298)
+  - Fixed a crash introduced in 1.92.6 when handling ImGuiInputTextFlags_CallbackResize
+    in certain situations. (#9174)
+  - Fixed selection highlight Y1 offset being very slightly off (since 1.92.3). (#9311) [@v-ein]
+  - InputTextMultiline: fixed an issue introduced in 1.92.3 where line count calculated
+    for vertical scrollbar range would be +1 when the widget is inactive, word-wrap is
+    disabled and the text buffer ends with '\n'. Fixed a similar issue related to clipping
+    large amount of text.
+  - InputTextMultiline: avoid going through reactivation code and fixed losing revert value
+    when activating scrollbar.
+  - InputTextMultiline: fixed an issue where edit buffer wouldn't be reapplied to back
+    buffer on the IsItemDeactivatedAfterEdit() frame. This could create issues when
+    using the idiom of not applying edits before IsItemDeactivatedAfterEdit().
+    (#9308, #8915, #8273)
 - Style:
  - Border sizes are now scaled (and rounded) by ScaleAllSizes().
  - When using large values with ScallAllSizes(), the following items thickness
@@ -107,6 +112,10 @@ Other Changes:
    BeginPopupContextItem(), BeginPopupContextWindow() or OpenPopupOnItemClick().
    (#8803, #9270) [@exelix11, @ocornut]
  - Popups: pressing North button (PS4/PS5 triangle, SwitchX, Xbox Y) also open popups menus.
+- Multi-Select:
+  - Added ImGuiMultiSelectFlags_SelectOnClickAlways mode (rarely used).
+    This prevents Drag and Drop of multiple items, but it allows to start a new Box-Selection
+    from inside an existing selection (Excel style). (#9307, #1861)
 - Clipper:
  - Clear `DisplayStart`/`DisplayEnd` fields when `Step()` returns false.
  - Added `UserIndex` helper storage. This is solely a convenience for cases where
@@ -115,17 +124,41 @@ Other Changes:
  - Implemented a custom tweak to extend hit-testing bounding box when window is sitting
    at the edge of a viewport (e.g. fullscreen or docked window), so that e.g. mouse the
    mouse at the extreme of the screen will reach the scrollbar. (#9276)
+  - Fixed an issue which could lead initial click to move the current scroll by a pixel.
 - Button:
  - Moved ImGuiButtonFlags_AllowOverlap from imgui_internal.h to imgui.h,
    as a convenience for when using e.g. InvisibleButton().
 - Focus: fixed fallback "Debug" window temporarily taking focus and setting io.WantCaptureKeyboard
  for one frame on e.g. application boot if no other windows are submitted. (#9243)
+- DrawList:
+  - PathArcTo(): fixed erroneous segment count for pathologically small arcs on large 
+    circles. (#9331, #9313) [@thedmd, @epajarre]
+- Memory:
+  - Discard/GC of ImDrawList buffers for unused windows favor restoring them to
+    ~Size*1.05 instead of Capacity when awakening again. Facilitate releasing ImDrawList
+    buffers after unusual usage spike. (#9303)
+  - Fixed GetForegroundDrawList()/GetBackgroundDrawList() per-viewport buffers not being
+    collected when unused for io.ConfigMemoryCompactTimer amount of time. (#9303)
 - Demo: fixed IMGUI_DEMO_MARKER locations for examples applets. (#9261, #3689) [@pthom]
+- Internals:
+  - ButtonBehavior: fixed internal/low-level ImGuiButtonFlags_PressedOnRelease
+    (as well as equivalent ImGuiSelectableFlags_SelectOnRelease for Selectable) from
+    not taking current active id. ImGuiButtonFlags_NoHoldingActiveID allows that.
+    This was pretty sure only used internally by MenuItem().
 - Backends:
+  - DirectX9, OpenGL2, OpenGL3, Metal, SDLGPU3, SDLRenderer2, SDLRenderer3: fixed easy-to-fix
+    issues in code assuming ImTextureID_Invalid is always defined to 0. (#9295, #9310)
+  - GLFW: mouse cursor is properly restored if changed by user app/code while using
+    glfwSetInputMode(..., GLFW_CURSOR_DISABLED) or ImGuiConfigFlags_NoMouseCursorChange.
+    Amend optimization done in 1.92.6.
  - SDLGPU3: removed unnecessary call to SDL_WaitForGPUIdle when releasing
    vertex/index buffers. (#9262) [@jaenis]
  - WebGPU: fixed version check for Emscripten 5.0.0+.
  - WebGPU: removed support for Emscripten <4.0.10. (#9281) [@ypujante]
+  - WebGPU: added support for WGVK native backend via IMGUI_IMPL_WEBGPU_BACKEND_WGVK,
+    using SPIRV shaders if WGSL is not available. (#9316, #9246, #9257) [@r-lyeh]
+    (WGVK is a lightweight alternative to Dawn or WGPU for native applications,
+    which is easier to build/setup, see: https://github.com/manuel5975p/WGVK)
 - Examples:
  - Emscripten: added `tabindex=-1` to canvas in our shell_minimal.htm. Without it,
    the canvas was not focusable in the DOM, which in turn make some backends
@@ -140,7 +173,8 @@ Other Changes:
  - WebGPU: fixed undefined behaviors in example code for requesting adapter
    and device. (#9246, #9256) [@r-lyeh]
  - SDL2+WebGPU: fixed hi-dpi handling. (#9300) [@ypujante]
-  - GLFW/SDL2/SDL3+WebGPU: removed suport for Emscripten <4.0.10. (#9281) [@ypujante]
+  - GLFW/SDL2/SDL3+WebGPU: added support for WGVK. (#9316, #9246, #9257) [@r-lyeh, @ocornut]
+  - GLFW/SDL2/SDL3+WebGPU: removed support for Emscripten <4.0.10. (#9281) [@ypujante]


 -----------------------------------------------------------------------
@@ -25,7 +25,7 @@ or view this file with any Markdown viewer.
 | [I integrated Dear ImGui in my engine and some elements are clipping or disappearing when I move windows around...](#q-i-integrated-dear-imgui-in-my-engine-and-some-elements-are-clipping-or-disappearing-when-i-move-windows-around) |
 | [I integrated Dear ImGui in my engine and some elements are displaying outside their expected windows boundaries...](#q-i-integrated-dear-imgui-in-my-engine-and-some-elements-are-displaying-outside-their-expected-windows-boundaries) |
 | **Q&A: Usage** |
-| **[About the ID Stack system..<br>Why is my widget not reacting when I click on it?<br>Why is the wrong widget reacting when I click on one?<br>How can I have widgets with an empty label?<br>How can I have multiple widgets with the same label?<br>How can I have multiple windows with the same label?](#q-about-the-id-stack-system)** |
+| **[About the ID Stack system...](#q-about-the-id-stack-system)**<br>**[How can I have multiple widgets with the same label?](#q-how-can-i-have-multiple-widgets-with-the-same-label) (using `##` or `PushID()`)**<br>**[How can I have widgets with an empty label?](#q-how-can-i-have-widgets-with-an-empty-label) (using `##`)**<br>**[How can I animate the label of an existing widget?](#q-how-can-i-change-the-label-of-an-existing-widget) (using `###`)**<br>**[General description of the label and ID Stack system.](#general-description-of-the-label-and-id-stack-system)** |
 | [How can I display an image?](#q-how-can-i-display-an-image)<br>[What are ImTextureID/ImTextureRef?](#q-what-are-imtextureidimtextureref)|
 | [How can I use maths operators with ImVec2?](#q-how-can-i-use-maths-operators-with-imvec2) |
 | [How can I use my own maths types instead of ImVec2/ImVec4?](#q-how-can-i-use-my-own-maths-types-instead-of-imvec2imvec4) |
@@ -263,15 +263,19 @@ ctx->RSSetScissorRects(1, &r);

 # Q&A: Usage

-### Q: About the ID Stack system...
-### Q: Why is my widget not reacting when I click on it?
-### Q: Why is the wrong widget reacting when I click on one?
-### Q: How can I have widgets with an empty label?
-### Q: How can I have multiple widgets with the same label?
-### Q: How can I have multiple windows with the same label?
+## Q: About the ID Stack system...

 **USING THE SAME LABEL+ID IS THE MOST COMMON USER MISTAKE!**
 <br>**USING AN EMPTY LABEL IS THE SAME AS USING THE SAME LABEL AS YOUR PARENT WIDGET!**
+<br>Read the questions in this section for a more general understand of how labels and ID works in Dear ImGui.
+
+TL;DR;
+- Widgets labels are also used to compute Widgets unique identifiers.
+- Unique identifiers are hashes of the label + of the parent scope (e.g. parent window or parent tree node labels).
+- You can use `PushID()` to append to the identifier without making it visible.
+- You can use `"##something"` in a label to append to the identifier without making it visible.
+- You can use `"###something"` in a label to make the identifier ignore the visible part.
+
 <table>
 <tr>
 <td><img src="https://github.com/user-attachments/assets/776a8315-1164-4178-9a8c-df52e0ff28aa"></td>
@@ -302,16 +306,99 @@ ImGui::End();
 </tr>
 </table>

-A primer on labels and the ID Stack...
+### Q: How can I have multiple widgets with the same label?
+
+A. When widgets are in a same scope and finite, you can use a `"##something"` suffix which will be part of the identifier but not visible as a label.
+
+```cpp
+Button("Play");        // Label = "Play",   ID = hash of ("MyWindow", "Play")
+Button("Play##foo1");  // Label = "Play",   ID = hash of ("MyWindow", "Play##foo1")  // Different from other buttons
+Button("Play##foo2");  // Label = "Play",   ID = hash of ("MyWindow", "Play##foo2")  // Different from other buttons
+```
+
+B. More generally, e.g. in loops, you can use `PushID()/PopID()` to push a prefix which will be part of the identifier.
+
+```cpp
+// Using PushID() with a string
+for (int i = 0; i < 100; i++)
+{
+  MyObject* obj = Objects[i];
+  PushID(obj->Name);
+  Button("Click");     // Label = "Click",  ID = hash of ("Window", obj->Name, "Click")
+  PopID();
+}
+```
+
+```cpp
+// Using PushID() with an index
+for (int i = 0; i < 100; i++)
+{
+  PushID(i);
+  Button("Click");     // Label = "Click",  ID = hash of ("Window", i, "Click")
+  PopID();
+}
+```
+
+### Q: How can I have widgets with an empty label?
+
+If you want to completely hide the label, but still need an ID:
+
+```cpp
+Checkbox("##On", &b);  // Label = "",       ID = hash of (..., "##On")   // No visible label, just a checkbox!
+```
+##### [Return to Index](#index)
+
+### Q: How can I make a label dynamic?
+
+Dear ImGui is very dynamic so you can submit different widgets every frame.
+However, in order to preserve widget state (eg. which tree node is open; which button is focused) the library internaly refers to their unique ID.
+
+Occasionally you might want to change a label while preserving a constant ID. This allows you to change/animate labels while persisting associated state.
+For example, you may want to include varying information in a window title bar or button label.
+
+Using "###" exclude the preceeding part from ID computation:
+```cpp
+Button("Hello###ID");   // Label = "Enable",   ID = hash of (..., "ID")
+Button("World###ID");   // Label = "Disable",  ID = hash of (..., "ID")  // Same ID, different label
+```
+Using a same ID ensure that associated related e.g. weither the widget is focused, won't be lost when the label changes.
+
+<table>
+<tr>
+<td><img src="https://github.com/user-attachments/assets/2bf18756-e122-498d-bbd4-5c44bb1018d5"></td>
+<td>
+<pre lang="cpp">
+// Window label has animating FPS counter
+// Window ID stays the same = hash of "MyGame"
+char buf[128];
+sprintf(buf, "My game (%.1f FPS)###MyGame", io.Framerate);
+ImGui::Begin(buf);
+&nbsp;
+// Label changes between "Enable" and "Disable"
+// ID stays the same = hash of ("MyGame", "MyButton")
+if (ImGui::Button(enabled ? "Disable###MyButton" : "Enable###MyButton", { -FLT_MIN, 0.0f }))
+    enabled = !enabled;
+&nbsp;
+ImGui::End();
+</pre>
+</td>
+</tr>
+</table>
+
+(Hint: I'd suggest wrapping sprintf in something more compact to use, e.g. [ocornut/Str](https://github.com/ocornut/Str) for what I personally use).
+
+##### [Return to Index](#index)
+
+### General description of the label and ID Stack system

 Dear ImGui internally needs to uniquely identify UI elements.
-Elements that are typically not clickable (such as calls to the Text functions) don't need an ID.
-Interactive widgets (such as calls to Button buttons) need a unique ID.
+Elements that are typically not clickable (such as calls to Text() functions) don't need an ID.
+Interactive widgets (such as calls to Button() functions) need a unique ID.

 **Unique IDs are used internally to track active widgets and occasionally associate state to widgets.<BR>
 Unique IDs are implicitly built from the hash of multiple elements that identify the "path" to the UI element.**

-Since Dear ImGui 1.85, you can use `Demo>Tools>ID Stack Tool` or call `ImGui::ShowIDStackToolWindow()`. The tool display intermediate values leading to the creation of a unique ID, making things easier to debug and understand.
+You can use `Demo>Tools>ID Stack Tool` or call `ImGui::ShowIDStackToolWindow()`. The tool display intermediate values leading to the creation of a unique ID, making things easier to debug and understand.

 ![Stack tool](https://user-images.githubusercontent.com/8225057/136235657-a0ea5665-dcd1-423f-9be6-dc3f8ced8f12.png)

@@ -365,20 +452,7 @@ Button("Play##foo2");  // Label = "Play",   ID = hash of ("MyWindow", "Play##foo
 Button("##foo");       // Label = "",       ID = hash of ("MyWindow", "##foo")       // Different from window
 End();
 ```
- If you want to completely hide the label, but still need an ID:
-```cpp
-Checkbox("##On", &b);  // Label = "",       ID = hash of (..., "##On")   // No visible label, just a checkbox!
-```
- Occasionally/rarely you might want to change a label while preserving a constant ID. This allows
-you to animate labels. For example, you may want to include varying information in a window title bar,
-but windows are uniquely identified by their ID. Use "###" to pass a label that isn't part of ID:
-```cpp
-Button("Hello###ID");  // Label = "Hello",  ID = hash of (..., "###ID")
-Button("World###ID");  // Label = "World",  ID = hash of (..., "###ID")  // Same ID, different label

-sprintf(buf, "My game (%f FPS)###MyGame", fps);
-Begin(buf);            // Variable title,   ID = hash of "MyGame"
-```
 - Solving ID conflict in a more general manner:
 Use `PushID()` / `PopID()` to create scopes and manipulate the ID stack, as to avoid ID conflicts
 within the same window. This is the most convenient way of distinguishing ID when iterating and