Skip to content

Render Debug Overlay#22412

Merged
alice-i-cecile merged 24 commits intobevyengine:mainfrom
aevyrie:render-debug-overlay
Jan 17, 2026
Merged

Render Debug Overlay#22412
alice-i-cecile merged 24 commits intobevyengine:mainfrom
aevyrie:render-debug-overlay

Conversation

@aevyrie
Copy link
Copy Markdown
Member

@aevyrie aevyrie commented Jan 7, 2026 •
edited
Loading

Objective

  • Make it easy to peek at the depth/normals/motion/hi-z

Solution

  • Add a small crate and a plugin behind a flag

Testing

  • Robust against components, deferred, etc

Showcase

Screen.Recording.2026-01-07.at.8.41.08.PM.mp4

mockersf
mockersf reviewed Jan 7, 2026
View reviewed changes
Comment thread crates/bevy_render_debug/src/lib.rs Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 7, 2026

You added a new feature but didn't update the readme. Please run cargo run -p build-templated-pages -- update features to update it, and commit the file change.

Jondolf
Jondolf reviewed Jan 7, 2026
View reviewed changes
Comment thread crates/bevy_render_debug/src/lib.rs Outdated
Jondolf
Jondolf reviewed Jan 7, 2026
View reviewed changes
Comment thread crates/bevy_render_debug/src/lib.rs Outdated
IceSentry
IceSentry reviewed Jan 7, 2026
View reviewed changes
Comment thread crates/bevy_render_debug/src/debug_overlay.wgsl Outdated
@aevyrie
Copy link
Copy Markdown
Member Author

aevyrie commented Jan 7, 2026

This generally needs a cleanup pass, I was mostly interested if others thought this was a sensible approach for the shader and bindings. 🙂

@alice-i-cecile alice-i-cecile added C-Feature A new feature, making something new possible A-Rendering Drawing game state to the screen M-Release-Note Work that should be called out in the blog due to impact A-Dev-Tools Tools used to debug Bevy applications. S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 7, 2026
@alice-i-cecile alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 7, 2026
@aevyrie

This comment was marked as outdated.

Sign in to view
@JMS55
Copy link
Copy Markdown
Contributor

JMS55 commented Jan 8, 2026

I've wanted this for a while. I'll try to get to a review this weekend.

IceSentry
IceSentry reviewed Jan 9, 2026
View reviewed changes
Comment thread crates/bevy_render_debug/src/lib.rs Outdated
IceSentry
IceSentry approved these changes Jan 9, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@IceSentry IceSentry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be cool if there was a way to render that to an intermediate texture so we could throw it in a UI node and have a bunch of those debug views in separate textures. Definitely more of a long term idea, doesn't have to be in this PR.

Other than the comment that looks copied LGTM

@alice-i-cecile alice-i-cecile added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jan 12, 2026
@alice-i-cecile alice-i-cecile added this to the 0.19 milestone Jan 12, 2026
atlv24
atlv24 approved these changes Jan 13, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@atlv24 atlv24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice job

@atlv24 atlv24 added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 13, 2026
@mockersf
Copy link
Copy Markdown
Member

mockersf commented Jan 13, 2026

I would prefer this to be in the bevy_dev_tools crate, is there a reason to do a new one?

@atlv24 atlv24 added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Jan 13, 2026
@atlv24
Copy link
Copy Markdown
Contributor

atlv24 commented Jan 13, 2026

Agree

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 16, 2026

You added a new example but didn't add metadata for it. Please update the root Cargo.toml file.

@aevyrie aevyrie force-pushed the render-debug-overlay branch from 292912c to 6645454 Compare January 16, 2026 03:28
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 17, 2026
Merged via the queue into bevyengine:main with commit d8a022a Jan 17, 2026
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mockersf mockersf mockersf left review comments

+3 more reviewers

@Jondolf Jondolf Jondolf left review comments

@IceSentry IceSentry IceSentry approved these changes

@atlv24 atlv24 atlv24 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-Dev-Tools Tools used to debug Bevy applications. A-Rendering Drawing game state to the screen C-Feature A new feature, making something new possible M-Release-Note Work that should be called out in the blog due to impact S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged

Projects

No open projects
Rendering (Old)
Status: Done

Milestone

0.19

Development

Successfully merging this pull request may close these issues.

7 participants

@aevyrie @JMS55 @mockersf @atlv24 @IceSentry @Jondolf @alice-i-cecile