-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Replace the wgpu_trace
feature with a field in bevy_render::settings::WgpuSettings
#14842
Replace the wgpu_trace
feature with a field in bevy_render::settings::WgpuSettings
#14842
Conversation
…gs::WgpuSettings`
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
…l hardcoded folder name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor grammar and wording clarification, but otherwise looks pretty good to me.
…Bevy Co-authored-by: TrialDragon <[email protected]>
Co-authored-by: TrialDragon <[email protected]>
Co-authored-by: TrialDragon <[email protected]>
Although I feel confident writing documentation, I am by no means a professional documentation writer - so it'd be appreciated if anybody else could give feedback to the updated WGPU Tracing guide, found in P.S. @TrialDragon Thank you for the feedback! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, docs-wise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs look great!
Objective
wgpu_trace
feature while still making it easy/possible to record wgpu traces for debugging.Solution
This PR performs the above objective by removing the
wgpu_trace
feature from allCargo.toml
files.However, wgpu traces are still useful for debugging - but to record them, you need to pass in a directory path to store the traces in. To avoid forcing users into manually creating the renderer,
bevy_render::settings::WgpuSettings
now has atrace_path
field, so that all of Bevy's automatic initialization can happen while still allowing for tracing.Testing
cargo run -p ci
. I am hoping the Github Actions workflows will catch anything I missed.docs/debugging.md
) section on WGPU Tracing.stable-x86_64-pc-windows-msvc
toolchain. I do not have anything set up for other platforms or targets (though I can't imagine this needs testing on other platforms).Migration Guide
bevy/wgpu_trace
,bevy_render/wgpu_trace
, andbevy_internal/wgpu_trace
features no longer exist. Remove them from yourCargo.toml
, CI, tooling, and what-not.docs/debugging.md
file in the repository, under the WGPU Tracing section.Because of the changes made, you can now generate traces to any path, rather than the hardcoded
%WorkspaceRoot%/wgpu_trace
(where%WorkspaceRoot%
is... the root of your crate's workspace) folder.(If WGPU hasn't restored tracing functionality...) Do note that WGPU has not yet restored tracing functionality. However, once it does, the above should be sufficient to generate new traces.