Function Prototype
vkGetPrivateData
Retrieve data associated with a Vulkan object
To retrieve application-defined data from a slot associated with a Vulkan object, call:
void vkGetPrivateData(
VkDevice device,
VkObjectType objectType,
uint64_t objectHandle,
VkPrivateDataSlot privateDataSlot,
uint64_t* pData);
pub fn get_private_data(
device: vk::Device,
object_type: vk::ObjectType,
object_handle: u64,
private_data_slot: vk::PrivateDataSlot,
p_data: *mut u64,
);
void vkGetPrivateDataEXT(
VkDevice device,
VkObjectType objectType,
uint64_t objectHandle,
VkPrivateDataSlot privateDataSlot,
uint64_t* pData);
pub fn get_private_data_ext(
device: vk::Device,
object_type: vk::ObjectType,
object_handle: u64,
private_data_slot: vk::PrivateDataSlot,
p_data: *mut u64,
);
deviceis the device that created the objectobjectTypeis a VkObjectType specifying the type of object data is associated with.objectHandleis a handle to the object data is associated with.privateDataSlotis a handle to a VkPrivateDataSlot specifying location of private data pointer storage.pDatais a pointer to specify where application-defined data is returned. IfprivateDataSlotwas not created withVK_PRIVATE_DATA_SLOT_CREATE_BASE_OBJECT_HANDLE_BIT_NV,0will be written in the absence of a previous call tovkSetPrivateDatausing the object specified byobjectHandle. IfprivateDataSlotwas created withVK_PRIVATE_DATA_SLOT_CREATE_BASE_OBJECT_HANDLE_BIT_NV, the implementation’s base handle for the object is written topData. The base handle is the value ofobjectHandleas received by the implementation after traversal of the dispatch chain.
Due to platform details on Android, implementations might not be able to
reliably return
0 from calls to vkGetPrivateData for
VkSwapchainKHR objects on which vkSetPrivateData has not
previously been called.
This erratum is exclusive to the Android platform and objects of type
VkSwapchainKHR.Valid Usage
VUID-vkGetPrivateData-objectType-04018
objectHandle must be device or a child of device
VUID-vkGetPrivateData-objectHandle-09498
objectHandle must be a valid handle to an object of type
objectType
Valid Usage (Implicit)
VUID-vkGetPrivateData-device-parameter
device must be a valid VkDevice handle
VUID-vkGetPrivateData-objectType-parameter
objectType must be a valid VkObjectType value
VUID-vkGetPrivateData-privateDataSlot-parameter
privateDataSlot must be a valid VkPrivateDataSlot handle
VUID-vkGetPrivateData-pData-parameter
pData must be a valid pointer to a uint64_t value
VUID-vkGetPrivateData-privateDataSlot-parent
privateDataSlot must have been created, allocated, or retrieved from device
Parent
VK_VERSION_1_3Type
Function Prototype