C Specification

Information about tools providing debugging, profiling, or similar services, active for a given physical device, can be obtained by calling:

VkResult vkGetPhysicalDeviceToolPropertiesEXT(
    VkPhysicalDevice                            physicalDevice,
    uint32_t*                                   pToolCount,
    VkPhysicalDeviceToolPropertiesEXT*          pToolProperties);

Parameters

  • physicalDevice is the handle to the physical device to query for active tools.

  • pToolCount is a pointer to an integer describing the number of tools active on physicalDevice.

  • pToolProperties is either NULL or a pointer to an array of VkPhysicalDeviceToolPropertiesEXT instances.

Description

If pToolProperties is NULL, the implementation will return the number of tools currently active on physicalDevice in pToolCount.

If pToolProperties is not NULL, its elements are populate with information about active tools, up to the number stored in pToolCount; the number of elements actually returned is returned in pToolCount.

Valid Usage (Implicit)
  • physicalDevice must be a valid VkPhysicalDevice handle

  • pToolCount must be a valid pointer to a uint32_t value

  • If pToolProperties is not NULL, pToolProperties must be a valid pointer to an array of pToolCount VkPhysicalDeviceToolPropertiesEXT structures

  • If pToolProperties is not NULL, the value referenced by pToolCount must be greater than 0

Return Codes
On success, this command returns
  • VK_SUCCESS

  • VK_INCOMPLETE

See Also

Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.