archive-gh-me/wgpu
1
0
Fork 0
mirror of https://github.com/gfx-rs/wgpu.git synced 2025-12-08 21:26:17 +00:00
Code Issues Projects Releases Wiki Activity

docs(vulkan): clarify safety contract for DeviceShared::set_object_name (#8055)

Browse Source 
* docs(vulkan): clarify safety contract for `DeviceShared::set_object_name`
This commit is contained in:
Erich Gubler 2025-08-20 11:22:35 -04:00 committed by GitHub
parent 9aaed2c0cc
commit 57d89b4a4f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
wgpu-hal/src/vulkan/device.rs
View File

@ -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:
///
/// - `object` must be a valid handle for one of the following:
/// - An instance-level object from the same instance as this device.
/// - A physical-device-level object that descends from the same physical device as this
/// device.
/// - A device-level object that descends from this device.
/// - `object` must be externally synchronized—only the calling thread should access it during
/// this call.
///
/// [`vkSetDebugUtilsObjectName`]: https://registry.khronos.org/vulkan/specs/latest/man/html/vkSetDebugUtilsObjectNameEXT.html
pub(super) unsafe fn set_object_name(&self, object: impl vk::Handle, name: &str) {
let Some(extension) = self.extension_fns.debug_utils.as_ref() else {
return;