Add documentation for the raytracing API #6747
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Vecvec
commented
Dec 16, 2024
etc/ray_tracing.md
Outdated
| `Committed`. | ||
| - Calling `rayQueryProceed` when `rayQueryInitialize` has not previously been called on this ray query | ||
|
|
||
| *this is only known undefined behaviour. |
There was a problem hiding this comment.
This section deliberately does not mention undefined behavior from #6752
cwfitzgerald
approved these changes
Dec 16, 2024
|
looks good! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Connections
Suggested by @cwfitzgerald on matrix
Description
Currently the raytracing API (especially in naga) is hard to find and and sometimes missing, this attempts to specify the naga API and to give some basics for how to use the wgpu API the users can follow up in the specific function's documentation.
This is correct to the best of my knowledge, but I may have missed something.
Testing
Docs change so no testing
Checklist
cargo fmt.taplo format.cargo clippy. If applicable, add:--target wasm32-unknown-unknown--target wasm32-unknown-emscriptencargo xtask testto run tests.CHANGELOG.md. See simple instructions inside file.