Skip to content

Render Debug Overlay #22412

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
Open
aevyrie wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Render Debug Overlay #22412

aevyrie wants to merge 15 commits into from
+885 −0

Conversation

@aevyrie
Copy link
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
@github-actions
Copy link
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
Jondolf
Jondolf reviewed Jan 7, 2026
View reviewed changes
IceSentry
IceSentry reviewed Jan 7, 2026
View reviewed changes
@aevyrie
Copy link
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
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
crates/bevy_render_debug/src/lib.rs
}
}

/// Automatically attach keybinds to make renderer debugging tools immediately available without
Copy link
Contributor

@IceSentry IceSentry Jan 9, 2026

Choose a reason for hiding this comment

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

Isn't that the same comment as the handle_input system?

IceSentry
IceSentry approved these changes Jan 9, 2026
View reviewed changes
Copy link
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

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

+2 more reviewers

@Jondolf Jondolf Jondolf left review comments

@IceSentry IceSentry IceSentry 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

Rendering
Status: No status

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

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