diff --git a/docs/CHANGELOG.txt b/docs/CHANGELOG.txt index ebb60f9a9..344d5e228 100644 --- a/docs/CHANGELOG.txt +++ b/docs/CHANGELOG.txt @@ -45,6 +45,9 @@ Other Changes: - IO: added ImGuiPlatformIO::ClearPlatformHandlers(), ClearRendererHandlers() helpers to null all handlers. (#8945, #2769) +- Misc: Debuggers: added type formatters for the LLDB debuggers (e.g. Xcode, + Android Studio & more) to provide nicer display for ImVec2, ImVec4, ImVector etc. + See misc/debuggers/ for details. (#8950) [@mentlerd] - Backends: all backends call ImGuiPlatformIO::ClearPlatformHandlers() and ClearRendererHandlers() on shutdown, so as not to leave function pointers which may be dangling when using backend in e.g. DLL. (#8945, #2769) diff --git a/misc/README.txt b/misc/README.txt index b4ce89f03..58c00ee8c 100644 --- a/misc/README.txt +++ b/misc/README.txt @@ -4,8 +4,8 @@ misc/cpp/ This is also an example of how you may wrap your own similar types. misc/debuggers/ - Helper files for popular debuggers. - With the .natvis file, types like ImVector<> will be displayed nicely in Visual Studio debugger. + Helper files for popular debuggers (Visual Studio, GDB, LLDB). + e.g. With the .natvis file, types like ImVector<> will be displayed nicely in Visual Studio debugger. misc/fonts/ Fonts loading/merging instructions (e.g. How to handle glyph ranges, how to merge icons fonts). diff --git a/misc/debuggers/README.txt b/misc/debuggers/README.txt index 77a78b9e5..ad6f491fe 100644 --- a/misc/debuggers/README.txt +++ b/misc/debuggers/README.txt @@ -15,6 +15,7 @@ imgui.natvis (read comments inside file for details) imgui_lldb.py - LLDB: synthetic children provider and summaries for Dear ImGui types. + LLDB-based debuggers (*): synthetic children provider and summaries for Dear ImGui types. With this, types like ImVector<> will be displayed nicely in the debugger. (read comments inside file for details) + (*) Xcode, Android Studio, may be used from VS Code, C++Builder, CLion, Eclipse etc. diff --git a/misc/debuggers/imgui_lldb.py b/misc/debuggers/imgui_lldb.py index 336d3f513..7d3c6bfcb 100644 --- a/misc/debuggers/imgui_lldb.py +++ b/misc/debuggers/imgui_lldb.py @@ -1,4 +1,6 @@ -# This file implements synthetic children providers and summaries for various ImGui types for LLDB. +# This file implements synthetic children providers and summaries for various Dear ImGui types for LLDB. +# LLDB is used by Xcode, Android Studio, and may be used from VS Code, C++Builder, CLion, Eclipse etc. + # # Useful links/documentation related to the feature: # - https://lldb.llvm.org/use/variable.html#summary-strings