VkQueueFamilyGlobalPriorityPropertiesKHR(3)

# VkQueueFamilyGlobalPriorityPropertiesKHR(3) Manual Page

## Name

VkQueueFamilyGlobalPriorityPropertiesKHR - Return structure for queue family global priority information query

Loading… please wait.

## C Specification

The definition of VkQueueFamilyGlobalPriorityPropertiesKHR is:

    // Provided by VK_KHR_global_priority
    typedef struct VkQueueFamilyGlobalPriorityPropertiesKHR {
        VkStructureType             sType;
        void*                       pNext;
        uint32_t                    priorityCount;
        VkQueueGlobalPriorityKHR    priorities[VK_MAX_GLOBAL_PRIORITY_SIZE_KHR];
    } VkQueueFamilyGlobalPriorityPropertiesKHR;

or the equivalent

    // Provided by VK_EXT_global_priority_query
    typedef VkQueueFamilyGlobalPriorityPropertiesKHR VkQueueFamilyGlobalPriorityPropertiesEXT;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `priorityCount` is the number of supported global queue priorities in this queue family, and it must be greater than 0.

- `priorities` is an array of `VK_MAX_GLOBAL_PRIORITY_SIZE_EXT` VkQueueGlobalPriorityEXT enums representing all supported global queue priorities in this queue family. The first `priorityCount` elements of the array will be valid.

## Description

If the `VkQueueFamilyGlobalPriorityPropertiesKHR` structure is included in the `pNext` chain of the VkQueueFamilyProperties2 structure passed to vkGetPhysicalDeviceQueueFamilyProperties2, it is filled in with the list of supported global queue priorities for the indicated family.

The valid elements of `priorities` must not contain any duplicate values.

The valid elements of `priorities` must be a continuous sequence of VkQueueGlobalPriorityKHR enums in the ascending order.

| Note For example, returning `priorityCount` as 3 with supported `priorities` as `VK_QUEUE_GLOBAL_PRIORITY_LOW_KHR`, `VK_QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR` and `VK_QUEUE_GLOBAL_PRIORITY_REALTIME_KHR` is not allowed.

Valid Usage (Implicit)

- VUID-VkQueueFamilyGlobalPriorityPropertiesKHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_KHR`

- VUID-VkQueueFamilyGlobalPriorityPropertiesKHR-priorities-parameter
  Any given element of `priorities` must be a valid VkQueueGlobalPriorityKHR value

## See Also

VK_KHR_global_priority, VkQueueGlobalPriorityKHR, VkStructureType

## 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

Copyright 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0