Vulkan.Extensions.VK_EXT_global_priority

Name

VK_EXT_global_priority - device extension

VK_EXT_global_priority

Name String

VK_EXT_global_priority

Extension Type

Device extension

Registered Extension Number

175

Revision

2

Extension and Version Dependencies

• Requires support for Vulkan 1.0

Deprecation state

• Promoted to VK_KHR_global_priority extension

Contact

• Andres Rodriguez @lostgoat%0A*Here describe the issue or question you have about the VK_EXT_global_priority extension*

Other Extension Metadata

Last Modified Date

2017-10-06

IP Status

No known IP claims.

Contributors

• Andres Rodriguez, Valve
• Pierre-Loup Griffais, Valve
• Dan Ginsburg, Valve
• Mitch Singer, AMD

Description

In Vulkan, users can specify device-scope queue priorities. In some cases it may be useful to extend this concept to a system-wide scope. This extension provides a mechanism for callers to set their system-wide priority. The default queue priority is QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT.

The driver implementation will attempt to skew hardware resource allocation in favour of the higher-priority task. Therefore, higher-priority work may retain similar latency and throughput characteristics even if the system is congested with lower priority work.

The global priority level of a queue shall take precedence over the per-process queue priority (DeviceQueueCreateInfo::pQueuePriorities).

Abuse of this feature may result in starving the rest of the system from hardware resources. Therefore, the driver implementation may deny requests to acquire a priority above the default priority (QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT) if the caller does not have sufficient privileges. In this scenario ERROR_NOT_PERMITTED_EXT is returned.

The driver implementation may fail the queue allocation request if resources required to complete the operation have been exhausted (either by the same process or a different process). In this scenario ERROR_INITIALIZATION_FAILED is returned.

New Structures

• Extending DeviceQueueCreateInfo:

  • DeviceQueueGlobalPriorityCreateInfoEXT

New Enums

• QueueGlobalPriorityEXT

New Enum Constants

• EXT_GLOBAL_PRIORITY_EXTENSION_NAME

• EXT_GLOBAL_PRIORITY_SPEC_VERSION

• Extending Result:

  • ERROR_NOT_PERMITTED_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT

Version History

• Revision 2, 2017-11-03 (Andres Rodriguez)

  • Fixed VkQueueGlobalPriorityEXT missing _EXT suffix

• Revision 1, 2017-10-06 (Andres Rodriguez)

  • First version.

See Also

DeviceQueueGlobalPriorityCreateInfoEXT, QueueGlobalPriorityEXT

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

pattern STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT :: StructureType

pattern ERROR_NOT_PERMITTED_EXT :: Result

type QueueGlobalPriorityEXT = QueueGlobalPriorityKHR

type DeviceQueueGlobalPriorityCreateInfoEXT = DeviceQueueGlobalPriorityCreateInfoKHR

type EXT_GLOBAL_PRIORITY_SPEC_VERSION = 2

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

type EXT_GLOBAL_PRIORITY_EXTENSION_NAME = "VK_EXT_global_priority"

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

data DeviceQueueGlobalPriorityCreateInfoKHR

VkDeviceQueueGlobalPriorityCreateInfoKHR - Specify a system wide priority

Description

Queues created without specifying DeviceQueueGlobalPriorityCreateInfoKHR will default to QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR.

Valid Usage (Implicit)

See Also

VK_EXT_global_priority, VK_KHR_global_priority, QueueGlobalPriorityKHR, StructureType

Constructors

DeviceQueueGlobalPriorityCreateInfoKHR

Fields

• globalPriority :: QueueGlobalPriorityKHR

  globalPriority is the system-wide priority associated to these queues as specified by QueueGlobalPriorityEXT

  globalPriority must be a valid QueueGlobalPriorityKHR value

Instances

Storable DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

sizeOf :: DeviceQueueGlobalPriorityCreateInfoKHR -> Int

alignment :: DeviceQueueGlobalPriorityCreateInfoKHR -> Int

peekElemOff :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> Int -> IO DeviceQueueGlobalPriorityCreateInfoKHR

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

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

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

peek :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO DeviceQueueGlobalPriorityCreateInfoKHR

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

Show DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

showsPrec :: Int -> DeviceQueueGlobalPriorityCreateInfoKHR -> ShowS

show :: DeviceQueueGlobalPriorityCreateInfoKHR -> String

showList :: [DeviceQueueGlobalPriorityCreateInfoKHR] -> ShowS

Eq DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

(==) :: DeviceQueueGlobalPriorityCreateInfoKHR -> DeviceQueueGlobalPriorityCreateInfoKHR -> Bool

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

FromCStruct DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

peekCStruct :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO DeviceQueueGlobalPriorityCreateInfoKHR

ToCStruct DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

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

pokeCStruct :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> DeviceQueueGlobalPriorityCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

zero :: DeviceQueueGlobalPriorityCreateInfoKHR

newtype QueueGlobalPriorityKHR

VkQueueGlobalPriorityKHR - 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, VK_KHR_global_priority, DeviceQueueGlobalPriorityCreateInfoKHR, QueueFamilyGlobalPriorityPropertiesKHR

Constructors

QueueGlobalPriorityKHR Int32

Bundled Patterns

pattern QUEUE_GLOBAL_PRIORITY_LOW_KHR :: QueueGlobalPriorityKHR

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

pattern QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR is the system default priority.

pattern QUEUE_GLOBAL_PRIORITY_HIGH_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_HIGH_KHR is above the system default.

pattern QUEUE_GLOBAL_PRIORITY_REALTIME_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_REALTIME_KHR is the highest priority. Useful for critical tasks.

Instances

Storable QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

sizeOf :: QueueGlobalPriorityKHR -> Int

alignment :: QueueGlobalPriorityKHR -> Int

peekElemOff :: Ptr QueueGlobalPriorityKHR -> Int -> IO QueueGlobalPriorityKHR

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

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

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

peek :: Ptr QueueGlobalPriorityKHR -> IO QueueGlobalPriorityKHR

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

Read QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

readsPrec :: Int -> ReadS QueueGlobalPriorityKHR

readList :: ReadS [QueueGlobalPriorityKHR]

readPrec :: ReadPrec QueueGlobalPriorityKHR

readListPrec :: ReadPrec [QueueGlobalPriorityKHR]

Show QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

showsPrec :: Int -> QueueGlobalPriorityKHR -> ShowS

show :: QueueGlobalPriorityKHR -> String

showList :: [QueueGlobalPriorityKHR] -> ShowS

Eq QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

(==) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

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

Ord QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

compare :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Ordering

(<) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

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

(>) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

(>=) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

max :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR

min :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR

Zero QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

zero :: QueueGlobalPriorityKHR