Vulkan.Extensions.VK_EXT_global_priority_query

Name

VK_EXT_global_priority_query - device extension

VK_EXT_global_priority_query

Name String

VK_EXT_global_priority_query

Extension Type

Device extension

Registered Extension Number

389

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_EXT_global_priority
• Requires VK_KHR_get_physical_device_properties2

Contact

• Yiwei Zhang @zhangyiwei%0A<<Here describe the issue or question you have about the VK_EXT_global_priority_query extension> >

Other Extension Metadata

Last Modified Date

2021-03-29

IP Status

No known IP claims.

Contributors

• Yiwei Zhang, Google

Description

This device extension allows applications to query the global queue priorities supported by a queue family. It allows implementations to report which global priority levels are treated differently by the implementation, instead of silently mapping multiple requested global priority levels to the same internal priority, or using device creation failure to signal that a requested priority is not supported. It is intended primarily for use by system integration along with certain platform-specific priority enforcement rules.

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceGlobalPriorityQueryFeaturesEXT

• Extending QueueFamilyProperties2:

  • QueueFamilyGlobalPriorityPropertiesEXT

New Enum Constants

• EXT_GLOBAL_PRIORITY_QUERY_EXTENSION_NAME

• EXT_GLOBAL_PRIORITY_QUERY_SPEC_VERSION
• MAX_GLOBAL_PRIORITY_SIZE_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_GLOBAL_PRIORITY_QUERY_FEATURES_EXT
  • STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_EXT

Issues

1) Can we additionally query whether a caller is permitted to acquire a specific global queue priority in this extension?

RESOLVED: No. Whether a caller has enough privilege goes with the OS, and the Vulkan driver cannot really guarantee that the privilege will not change in between this query and the actual queue creation call.

2) If more than 1 queue using global priority is requested, is there a good way to know which queue is failing the device creation?

RESOLVED: No. There is not a good way at this moment, and it is also not quite actionable for the applications to know that because the information may not be accurate. Queue creation can fail because of runtime constraints like insufficient privilege or lack of resource, and the failure is not necessarily tied to that particular queue configuration requested.

Version History

• Revision 1, 2021-03-29 (Yiwei Zhang)

See Also

MAX_GLOBAL_PRIORITY_SIZE_EXT, PhysicalDeviceGlobalPriorityQueryFeaturesEXT, QueueFamilyGlobalPriorityPropertiesEXT

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

data PhysicalDeviceGlobalPriorityQueryFeaturesEXT

VkPhysicalDeviceGlobalPriorityQueryFeaturesEXT - Structure describing whether global priority query can be supported by an implementation

Members

The members of the PhysicalDeviceGlobalPriorityQueryFeaturesEXT structure describe the following features:

Description

If the PhysicalDeviceGlobalPriorityQueryFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceGlobalPriorityQueryFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_EXT_global_priority_query, Bool32, StructureType

Constructors

PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Fields

• globalPriorityQuery :: Bool

  globalPriorityQuery indicates whether the implementation supports the ability to query global queue priorities.

Instances

Eq PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

(==) :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> Bool

(/=) :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> Bool

Show PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

showsPrec :: Int -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> ShowS

show :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> String

showList :: [PhysicalDeviceGlobalPriorityQueryFeaturesEXT] -> ShowS

Storable PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

sizeOf :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> Int

alignment :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> Int -> IO PhysicalDeviceGlobalPriorityQueryFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> Int -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceGlobalPriorityQueryFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO PhysicalDeviceGlobalPriorityQueryFeaturesEXT

poke :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO ()

FromCStruct PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

peekCStruct :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO PhysicalDeviceGlobalPriorityQueryFeaturesEXT

ToCStruct PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

withCStruct :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> (Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceGlobalPriorityQueryFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

zero :: PhysicalDeviceGlobalPriorityQueryFeaturesEXT

data QueueFamilyGlobalPriorityPropertiesEXT

VkQueueFamilyGlobalPriorityPropertiesEXT - Return structure for queue family global priority information query

Description

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

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

Note

For example, returning priorityCount as 3 with supported priorities as QUEUE_GLOBAL_PRIORITY_LOW_EXT, QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT and QUEUE_GLOBAL_PRIORITY_REALTIME_EXT is not allowed.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_EXT

• Any given element of priorities must be a valid QueueGlobalPriorityEXT value

See Also

VK_EXT_global_priority_query, QueueGlobalPriorityEXT, StructureType

Constructors

QueueFamilyGlobalPriorityPropertiesEXT

Fields

• priorityCount :: Word32

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

• priorities :: Vector QueueGlobalPriorityEXT

  priorities is an array of MAX_GLOBAL_PRIORITY_SIZE_EXT QueueGlobalPriorityEXT enums representing all supported global queue priorities in this queue family. The first priorityCount elements of the array will be valid.

Instances

Show QueueFamilyGlobalPriorityPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

showsPrec :: Int -> QueueFamilyGlobalPriorityPropertiesEXT -> ShowS

show :: QueueFamilyGlobalPriorityPropertiesEXT -> String

showList :: [QueueFamilyGlobalPriorityPropertiesEXT] -> ShowS

Storable QueueFamilyGlobalPriorityPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

sizeOf :: QueueFamilyGlobalPriorityPropertiesEXT -> Int

alignment :: QueueFamilyGlobalPriorityPropertiesEXT -> Int

peekElemOff :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> Int -> IO QueueFamilyGlobalPriorityPropertiesEXT

pokeElemOff :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> Int -> QueueFamilyGlobalPriorityPropertiesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueueFamilyGlobalPriorityPropertiesEXT

pokeByteOff :: Ptr b -> Int -> QueueFamilyGlobalPriorityPropertiesEXT -> IO ()

peek :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> IO QueueFamilyGlobalPriorityPropertiesEXT

poke :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> QueueFamilyGlobalPriorityPropertiesEXT -> IO ()

FromCStruct QueueFamilyGlobalPriorityPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

peekCStruct :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> IO QueueFamilyGlobalPriorityPropertiesEXT

ToCStruct QueueFamilyGlobalPriorityPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

withCStruct :: QueueFamilyGlobalPriorityPropertiesEXT -> (Ptr QueueFamilyGlobalPriorityPropertiesEXT -> IO b) -> IO b

pokeCStruct :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> QueueFamilyGlobalPriorityPropertiesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr QueueFamilyGlobalPriorityPropertiesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr QueueFamilyGlobalPriorityPropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero QueueFamilyGlobalPriorityPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority_query

Methods

zero :: QueueFamilyGlobalPriorityPropertiesEXT

type EXT_GLOBAL_PRIORITY_QUERY_SPEC_VERSION = 1

pattern EXT_GLOBAL_PRIORITY_QUERY_SPEC_VERSION :: forall a. Integral a => a

type EXT_GLOBAL_PRIORITY_QUERY_EXTENSION_NAME = "VK_EXT_global_priority_query"

pattern EXT_GLOBAL_PRIORITY_QUERY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype QueueGlobalPriorityEXT

VkQueueGlobalPriorityEXT - Values specifying a system-wide queue priority

Description

Priority values are sorted in ascending order. A comparison operation on the enum values can be used to determine the priority order.

See Also

VK_EXT_global_priority, DeviceQueueGlobalPriorityCreateInfoEXT, QueueFamilyGlobalPriorityPropertiesEXT

Constructors

QueueGlobalPriorityEXT Int32

Bundled Patterns

pattern QUEUE_GLOBAL_PRIORITY_LOW_EXT :: QueueGlobalPriorityEXT

QUEUE_GLOBAL_PRIORITY_LOW_EXT is below the system default. Useful for non-interactive tasks.

pattern QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT :: QueueGlobalPriorityEXT

QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT is the system default priority.

pattern QUEUE_GLOBAL_PRIORITY_HIGH_EXT :: QueueGlobalPriorityEXT

QUEUE_GLOBAL_PRIORITY_HIGH_EXT is above the system default.

pattern QUEUE_GLOBAL_PRIORITY_REALTIME_EXT :: QueueGlobalPriorityEXT

QUEUE_GLOBAL_PRIORITY_REALTIME_EXT is the highest priority. Useful for critical tasks.

Instances

Eq QueueGlobalPriorityEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority

Methods

(==) :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Bool

(/=) :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Bool

Ord QueueGlobalPriorityEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority

Methods

compare :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Ordering

(<) :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Bool

(<=) :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Bool

(>) :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Bool

(>=) :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> Bool

max :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT

min :: QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT

Read QueueGlobalPriorityEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority

Methods

readsPrec :: Int -> ReadS QueueGlobalPriorityEXT

readList :: ReadS [QueueGlobalPriorityEXT]

readPrec :: ReadPrec QueueGlobalPriorityEXT

readListPrec :: ReadPrec [QueueGlobalPriorityEXT]

Show QueueGlobalPriorityEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority

Methods

showsPrec :: Int -> QueueGlobalPriorityEXT -> ShowS

show :: QueueGlobalPriorityEXT -> String

showList :: [QueueGlobalPriorityEXT] -> ShowS

Storable QueueGlobalPriorityEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority

Methods

sizeOf :: QueueGlobalPriorityEXT -> Int

alignment :: QueueGlobalPriorityEXT -> Int

peekElemOff :: Ptr QueueGlobalPriorityEXT -> Int -> IO QueueGlobalPriorityEXT

pokeElemOff :: Ptr QueueGlobalPriorityEXT -> Int -> QueueGlobalPriorityEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueueGlobalPriorityEXT

pokeByteOff :: Ptr b -> Int -> QueueGlobalPriorityEXT -> IO ()

peek :: Ptr QueueGlobalPriorityEXT -> IO QueueGlobalPriorityEXT

poke :: Ptr QueueGlobalPriorityEXT -> QueueGlobalPriorityEXT -> IO ()

Zero QueueGlobalPriorityEXT

Defined in Vulkan.Extensions.VK_EXT_global_priority

Methods

zero :: QueueGlobalPriorityEXT

type MAX_GLOBAL_PRIORITY_SIZE_EXT = 16

pattern MAX_GLOBAL_PRIORITY_SIZE_EXT :: forall a. Integral a => a