Debug tools: "Item Picker", "Show window rectangles"

[ocornut]

Update 2024

• I have promoted ImGui::DebugStartItemPicker() to public API (i am honestly not sure why it wasn't done before).
• I have also added the Item Picker option to Demo->Tools->Item Picker BUT it is greyed out if io.ConfigDebugIsDebuggerPresent is not set. This is partly to promote the discovery of both the item picker and the io.ConfigDebugIsDebuggerPresent option.
• It is still and always available from Metrics->Tools.
• See https://github.com/ocornut/imgui/wiki/Debug-Tools for details.

---

FYI
Recently added some tools in the Metrics window.

(1)
The "Item Picker" will allow you to pick an item and have dear imgui break within the call-stack of that item. This is useful if you have large UI / codebase and you would to easily find out where some UI item is emitted. This only works on item that are hoverable and have an identifier, so e.g. raw ImGui::Text() items won't work.

This will call IM_DEBUG_BREAK() which for Clang and Visual Studio default to a nice debugger break, for other compiles default to an unsatisfying IM_ASSERT(0) (can improve!). You can always #define IM_DEBUG_BREAK to anything in imconfig.h. See commit: 130b449

(2)
The "Show windows rectangles" tool allows you to visualize various rectangles which purpose may otherwise be difficult to understand. If you need to work within dear imgui codebase this can be useful to clarify what's going on.

[ocornut]

Item Picker:
I also exposed a function in imgui_internal.h ImGui::DebugStartItemPicker() to enable this, so it can be wired directly in a menu or shortcut.
This tool has been incredibly useful to me in the past few days - generally when dealing with large or foreign codebase. Highly recommend trying it out.

[ocornut]

I have promoted ImGui::DebugStartItemPicker() to public API (i am honestly not sure why it wasn't done before).

I have also added the Item Picker option to Demo->Tools BUT it is greyed out if io.ConfigDebugIsDebuggerPresent is not set. This is partly to promote the discovery of both the item picker and the io.ConfigDebugIsDebuggerPresent option.

[ocornut]

Closing this now.
Note the wiki page https://github.com/ocornut/imgui/wiki/Debug-Tools