C Specification
To enumerate the performance query counters available on a queue family of a physical device, call:
// Provided by VK_KHR_performance_query
VkResult vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR(
VkPhysicalDevice physicalDevice,
uint32_t queueFamilyIndex,
uint32_t* pCounterCount,
VkPerformanceCounterKHR* pCounters,
VkPerformanceCounterDescriptionKHR* pCounterDescriptions);
Parameters
-
physicalDevice
is the handle to the physical device whose queue family performance query counter properties will be queried. -
queueFamilyIndex
is the index into the queue family of the physical device we want to get properties for. -
pCounterCount
is a pointer to an integer related to the number of counters available or queried, as described below. -
pCounters
is eitherNULL
or a pointer to an array of VkPerformanceCounterKHR structures. -
pCounterDescriptions
is eitherNULL
or a pointer to an array of VkPerformanceCounterDescriptionKHR structures.
Description
If pCounters
is NULL
and pCounterDescriptions
is NULL
, then
the number of counters available is returned in pCounterCount
.
Otherwise, pCounterCount
must point to a variable set by the user to
the number of elements in the pCounters
, pCounterDescriptions
,
or both arrays and on return the variable is overwritten with the number of
structures actually written out.
If pCounterCount
is less than the number of counters available, at
most pCounterCount
structures will be written, and VK_INCOMPLETE
will be returned instead of VK_SUCCESS
, to indicate that not all the
available counters were returned.
If
VkPhysicalDeviceVulkanSC10Properties::deviceNoDynamicHostAllocations
is VK_TRUE
, vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR
must not return
VK_ERROR_OUT_OF_HOST_MEMORY
.
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.