Add an Appendix/Wiki page for using a GPU debugger
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- computer-graphics, documentation
Research direction
Start with the refraction chapter and its NaN propagation example, then run the Rust binary with the wgpu Metal backend under Xcode to verify the debugging workflow. Investigate whether the example can also be stepped through with RenderDoc on Windows or Linux; done means an appendix or wiki guide covering launch, shader stepping, resource inspection, and the root cause.
Written by the indexing model from the issue text.
Description
Add a basic guide for running Xcode and RenderDoc to step through the shader code, inspect resources, etc. Launching the Rust binary with Xcode (when running with the wgpu Metal backend on macOS) is very easy. I haven't tried debugging the example code with RenderDoc on Windows / Linux though.
The appendix can use the NaN propagation bug in the refraction chapter as an example. It should go through the process of launching the debugger and walk through it step-by-step and get to the root cause. For example:
Radiance Texture and Framebuffer:
Where NaN is produced (0/0 in normalize):
Because refract returns a null ray:
@trevordblack
- Dominant language
- HTML
- Stars
- 321
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from RayTracing/gpu-tracing
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
RayTracing/gpu-tracing#37 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
RayTracing/gpu-tracing#33 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
RayTracing/gpu-tracing#26 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
RayTracing/gpu-tracing#23 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
RayTracing/gpu-tracing#17 · 1 comment ·
All issues in RayTracing/gpu-tracing
Similar issues
-
Area:Math p5.js 2.0+
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
processing/p5.js#9197 · 1 comment ·
-
Template: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
BabylonJS/Babylon-Lite#756 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
CyberAgent/psd2svg#360 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
BabylonJS/Babylon.js#18928 ·