Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Debug tools: new "Stack Tool" window, ShowIdStackToolWindow() #4631

Closed
ocornut opened this issue Oct 6, 2021 · 3 comments
Closed

Debug tools: new "Stack Tool" window, ShowIdStackToolWindow() #4631

ocornut opened this issue Oct 6, 2021 · 3 comments
Labels
label/id and id stack implicit identifiers, pushid(), id stack news/info

Comments

@ocornut
Copy link
Owner

ocornut commented Oct 6, 2021 •
edited
Loading

2023/09/24 : Renamed ShowStackToolWindow() to ShowIdStackToolWindow() as previous name was misleading.

Introducing the stack tool

(We've been using this internally as part of the unreleased automation feature but recently managed to redesign in a way allowing us to move it to the main library while not incurring significant cost.)

The tool run queries on hovered id to display details about individual components that were hashed to create an ID.
It helps both understanding the ID stack system and debugging potential ID collisions.

stack_tool_03b

stack_tool_03
@ocornut ocornut added news/info label/id and id stack implicit identifiers, pushid(), id stack labels Oct 6, 2021
ocornut added a commit that referenced this issue Oct 6, 2021
@ocornut
Stack Tool: Added Stack Tool (ShowStackToolWindow() function and avai…
2de96c4 
…lable from Demo and Metrics window). (#4631)
ocornut added a commit that referenced this issue Oct 6, 2021
@ocornut
Stack Tool: Docs (#4631) + also prevent Metrics window from displayin…
fbe78b1 
…g twice.
ocornut added a commit that referenced this issue Feb 8, 2022
@ocornut
Stack Tool: Added option to copy item path to clipboard. (#4631)
aa79d0c
edvn0 pushed a commit to edvn0/imgui that referenced this issue Feb 24, 2022
@ocornut @edvn0
Stack Tool: Added option to copy item path to clipboard. (ocornut#4631)
fe0e95b
sergeyn pushed a commit to sergeyn/imgui that referenced this issue Mar 19, 2022
@ocornut @sergeyn
Stack Tool: Added option to copy item path to clipboard. (ocornut#4631)
4a59138
@ocornut ocornut changed the title New "Stack Tool" debugging tool, ShowStackToolWindow() Debug tools: new "Stack Tool" window, ShowStackToolWindow() Nov 4, 2022
ocornut added a commit that referenced this issue Nov 4, 2022
@ocornut
Debug Tools: Added DebugLocateItem()/DebugLocateItemOnHover() to visu…
529cba1 
…ally locate items when hovering a 0xXXXXXXXX value. (#5855, #2673, #4631)
@ocornut
Copy link
Owner Author

ocornut commented Sep 11, 2023

Closing as this is now on Wiki and linked from many places:
https://github.com/ocornut/imgui/wiki/Debug-Tools

@ocornut ocornut closed this as completed Sep 11, 2023
@ocornut ocornut changed the title Debug tools: new "Stack Tool" window, ShowStackToolWindow() Debug tools: new "Stack Tool" window, ShowIdStackToolWindow() Sep 26, 2023
ocornut added a commit that referenced this issue Sep 26, 2023
@ocornut
Debug Tools: Renamed ShowStackToolWindow() ("Stack Tool") to ShowIdSt…
8175a47 
…ackToolWindow() ("ID Stack Tool"). (#4631)
@cfillion
Copy link
Contributor

cfillion commented Sep 27, 2023 •
edited
Loading

"ID" is uppercase in other functions and types in the public API (ImGuiID, ImGuiTextureID, {Get,Push,Pop}ID, GetItemID, {Get,SetNext}WindowDockID, PushTextureID etc... exceptions being enums and some struct members).

Shouldn't it be called ShowIDStackToolWindow for consistency?

@ocornut
Copy link
Owner Author

ocornut commented Sep 27, 2023 •
edited
Loading

You are right. I have pushed this change as c21278e.

ocornut added a commit that referenced this issue Sep 27, 2023
@ocornut
Debug Tools: Rename ShowIdStackToolWindow() -> ShowIDStackToolWindow(…
c21278e 
…). (#4631)

Amend 8175a47
ocornut added a commit that referenced this issue Sep 27, 2023
@ocornut
Debug Tools: Rename ShowIdStackToolWindow() -> ShowIDStackToolWindow(…
03e2a7f 
…). (#4631)

Some tool undid or didn't queue a chunk? Amend c21278e.
ocornut added a commit that referenced this issue Sep 28, 2023
@ocornut
Debug Tools: Rename ShowIdStackToolWindow() -> ShowIDStackToolWindow(…
f8aed64 
…). (#4631)

Squashed of 2 master commits.
ocornut added a commit that referenced this issue Sep 10, 2024
@ocornut
Added io.ConfigDebugHighlightIdConflicts debug feature! (#7961, #7669)
67cd4ea 
Also #74, #96, #480, #501, #647, #654, #719, #843, #894, #1057, #1173, #1390, #1414, #1556, #1768, #2041, #2116, #2330, #2475, #2562, #2667, #2807, #2885, #3102, #3375, #3526, #3964, #4008, #4070, #4158, #4172, #4199, #4375, #4395, #4471, #4548, #4612, #4631, #4657, #4796, #5210, #5303, #5360, #5393, #5533, #5692, #5707, #5729, #5773, #5787, #5884, #6046, #6093, #6186, #6223, #6364, #6387, #6567, #6692, #6724, #6939, #6984, #7246, #7270, #7375, #7421, #7434, #7472, #7581, #7724, #7926, #7937 and probably more.. Tagging to increase visibility!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
label/id and id stack implicit identifiers, pushid(), id stack news/info
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cfillion @ocornut