Skip to content

Commit

Permalink
Make the WGPU Tracing guide a little more concise
Browse files Browse the repository at this point in the history
  • Loading branch information
LikeLakers2 committed Aug 21, 2024
1 parent d01c903 commit a1cfa7f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ To capture a wgpu trace:
2. Pass the path to the folder you created for your wgpu trace to `bevy_render::RenderPlugin`, using the `render_creation` field.
* If you're manually creating the renderer resources, pass the path to wgpu when creating the `RenderDevice` and `RenderQueue`.
* Otherwise, pass the path to Bevy via the `trace_path` field in `bevy_render::settings::WgpuSettings`.
3. Enable wgpu's trace feature and run your application
1. Add `wgpu = "*"` to your Cargo.toml (this is effectively saying it can be *any* version of the wgpu crate, so it will not try to pull in a different version of wgpu than what is already pulled in by Bevy).
2. Execute `cargo run --features wgpu/trace`.
4. Zip up the folder and attach it to the relevant issue. New wgpu issues should generally be created [in the wgpu repository](https://github.com/gfx-rs/wgpu). Please include the wgpu revision in your bug reports. You can find the revision in the `Cargo.lock` file in your workspace.
3. Add `wgpu = { version = "*", features = ["trace"]}` to your Cargo.toml.
* `version = "*"` tells Rust that this can be *any* version of the wgpu crate, so it will not try to pull in a different version of wgpu than what is already pulled in by Bevy.
4. Compile and run your application, performing any in-app actions necessary to replicate the wgpu error.

Once you've captured a wgpu trace, zip up the folder and attach it to the relevant issue. New wgpu issues should generally be created [in the wgpu repository](https://github.com/gfx-rs/wgpu). Please include the wgpu revision in your bug reports. You can find the revision in the `Cargo.lock` file in your workspace.

0 comments on commit a1cfa7f

Please sign in to comment.