docs(vulkan): clarify safety contract for DeviceShared::set_object_name
#8055
Conversation
This file contains hidden or 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
ErichDonGubler
commented
Aug 6, 2025
| @@ -27,7 +27,17 @@ impl super::DeviceShared { | |||
| /// | |||
| /// # Safety | |||
| /// | |||
| /// It must be valid to set `object`'s debug name | |||
| /// This method inherits the safety contract from [`vkSetDebugUtilsObjectName`]. In particular: | |||
There was a problem hiding this comment.
question: I think this might be stricter of a requirement than actually necessary. I suspect the only requirement here is that the object in question hasn't been destroyed in the Vulkan runtime yet.
There was a problem hiding this comment.
Just tried summarizing the relevant parts of the Vulkan spec. with 2e1f81d, rather than a hot-take must-be-safe approach that doesn't necessarily mesh with Vulkan terminology.
6 tasks
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.
Motivated by discussion in #8043.