Function Prototype

vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM

Reports properties of the by region performance counters available on a queue family of a device

To enumerate the by region performance counters available on a queue family of a physical device, call:

VkResult vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM(
    VkPhysicalDevice physicalDevice,
    uint32_t queueFamilyIndex,
    uint32_t* pCounterCount,
    VkPerformanceCounterARM* pCounters,
    VkPerformanceCounterDescriptionARM* pCounterDescriptions);
  • physicalDevice is the handle to the physical device whose queue family by region performance 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 either NULL or a pointer to an array of VkPerformanceCounterARM structures.
  • pCounterDescriptions is either NULL or a pointer to an array of VkPerformanceCounterDescriptionARM structures.

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 application 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.

Valid Usage (Implicit)

VUID-vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM-pCounters-parameter

If the value referenced by pCounterCount is not 0, and pCounters is not NULL, pCounters must be a valid pointer to an array of pCounterCount VkPerformanceCounterARM structures

VUID-vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM-pCounterDescriptions-parameter

If the value referenced by pCounterCount is not 0, and pCounterDescriptions is not NULL, pCounterDescriptions must be a valid pointer to an array of pCounterCount VkPerformanceCounterDescriptionARM structures