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.

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

Hope to add description information to some classes to help debugging #12209

Open
onsummer opened this issue Sep 22, 2024 · 1 comment
Open

Comments

@onsummer
Copy link
Contributor

onsummer commented Sep 22, 2024

Feature

When debugging some rendering-related code, I always don't know who DrawCommand, Framebuffer, and PassState belong to.

Inspired by #12119, I think we can add a description field to the above classes to help debugging, such as:

image

@javagl
Copy link
Contributor

javagl commented Sep 24, 2024

The task to open an issue was still on my TODO list (as of a comment in the linked PR). So this is done now 🙂

The PR contains some further details and examples of what such a description may look like, and where it could be useful.

For me, this mainly referred to the DrawCommand (because that was the core part of my task back then). But I could imagine that some other classes could benefit from some sort of description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants