docs: mention primitive restart in the description of strip_index_format #5350
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
Wumpf
reviewed
Mar 6, 2024
There was a problem hiding this comment.
Thank you! Good to have that in here 👍
Though, after a cursory look at the implementation, strip_index_format only seems to be actually required on Vulkan and DX12, as Metal has it always enabled? I’m not sure if that would be worth mentioning as an implementation quirk…
That's an implementation detail, no point in mentioning it when it's actually important to the behavior. So good as is
Wumpf
approved these changes
Mar 9, 2024
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
Link to the issues addressed by this PR, or dependent PRs in other repositories
N/A
Description
Describe what problem this is solving, and how it's solved.
Currently, the wgpu documentation is rather unclear on why
PrimitiveState::strip_index_formatexists and what its purpose is, unless you’ve read the webgpu spec and know that it enables primitive restart. Since primitive restart is also never mentioned anywhere else in the documentation, I thought it would be nice to clarify this doc comment to include it here.(Though, after a cursory look at the implementation, strip_index_format only seems to be actually required on Vulkan and DX12, as Metal has it always enabled? I’m not sure if that would be worth mentioning as an implementation quirk…)
Testing
Explain how this change is tested.
this PR contains no code changes, but all tests still pass!
Checklist
cargo fmt.cargo clippy. If applicable, add:--target wasm32-unknown-unknown--target wasm32-unknown-emscriptencargo xtask testto run tests.CHANGELOG.md. See simple instructions inside file.