{-# language CPP #-} -- | = 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 -- -- [__Ratification Status__] -- Not ratified -- -- [__Extension and Version Dependencies__] -- None -- -- [__Deprecation State__] -- -- - /Promoted/ to -- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_global_priority VK_KHR_global_priority> -- extension -- -- - Which in turn was /promoted/ to -- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#versions-1.4-promotions Vulkan 1.4> -- -- [__Contact__] -- -- - Andres Rodriguez -- <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_EXT_global_priority] @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 favor 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 -- ('Vulkan.Core10.Device.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 -- 'Vulkan.Core10.Enums.Result.ERROR_INITIALIZATION_FAILED' is returned. -- -- == New Structures -- -- - Extending 'Vulkan.Core10.Device.DeviceQueueCreateInfo': -- -- - 'DeviceQueueGlobalPriorityCreateInfoEXT' -- -- == New Enums -- -- - 'QueueGlobalPriorityEXT' -- -- == New Enum Constants -- -- - 'EXT_GLOBAL_PRIORITY_EXTENSION_NAME' -- -- - 'EXT_GLOBAL_PRIORITY_SPEC_VERSION' -- -- - Extending -- 'Vulkan.Core14.Enums.QueueGlobalPriority.QueueGlobalPriority': -- -- - 'QUEUE_GLOBAL_PRIORITY_HIGH_EXT' -- -- - 'QUEUE_GLOBAL_PRIORITY_LOW_EXT' -- -- - 'QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT' -- -- - 'QUEUE_GLOBAL_PRIORITY_REALTIME_EXT' -- -- - Extending 'Vulkan.Core10.Enums.Result.Result': -- -- - 'ERROR_NOT_PERMITTED_EXT' -- -- - Extending 'Vulkan.Core10.Enums.StructureType.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 -- -- No cross-references are available -- -- == Document Notes -- -- For more information, see the -- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VK_EXT_global_priority Vulkan Specification>. -- -- This page is a generated document. Fixes and changes should be made to -- the generator scripts, not directly. module Vulkan.Extensions.VK_EXT_global_priority ( pattern STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT , pattern ERROR_NOT_PERMITTED_EXT , pattern QUEUE_GLOBAL_PRIORITY_LOW_EXT , pattern QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT , pattern QUEUE_GLOBAL_PRIORITY_HIGH_EXT , pattern QUEUE_GLOBAL_PRIORITY_REALTIME_EXT , QueueGlobalPriorityEXT , DeviceQueueGlobalPriorityCreateInfoEXT , EXT_GLOBAL_PRIORITY_SPEC_VERSION , pattern EXT_GLOBAL_PRIORITY_SPEC_VERSION , EXT_GLOBAL_PRIORITY_EXTENSION_NAME , pattern EXT_GLOBAL_PRIORITY_EXTENSION_NAME ) where import Data.String (IsString) import Vulkan.Core14.Promoted_From_VK_KHR_global_priority (DeviceQueueGlobalPriorityCreateInfo) import Vulkan.Core14.Enums.QueueGlobalPriority (QueueGlobalPriority) import Vulkan.Core10.Enums.Result (Result(ERROR_NOT_PERMITTED)) import Vulkan.Core14.Enums.QueueGlobalPriority (QueueGlobalPriority(QUEUE_GLOBAL_PRIORITY_HIGH)) import Vulkan.Core14.Enums.QueueGlobalPriority (QueueGlobalPriority(QUEUE_GLOBAL_PRIORITY_LOW)) import Vulkan.Core14.Enums.QueueGlobalPriority (QueueGlobalPriority(QUEUE_GLOBAL_PRIORITY_MEDIUM)) import Vulkan.Core14.Enums.QueueGlobalPriority (QueueGlobalPriority(QUEUE_GLOBAL_PRIORITY_REALTIME)) import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO)) -- No documentation found for TopLevel "VK_STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT" pattern $mSTRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT :: forall {r}. StructureType -> ((# #) -> r) -> ((# #) -> r) -> r $bSTRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT :: StructureType STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_EXT = STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO -- No documentation found for TopLevel "VK_ERROR_NOT_PERMITTED_EXT" pattern $mERROR_NOT_PERMITTED_EXT :: forall {r}. Result -> ((# #) -> r) -> ((# #) -> r) -> r $bERROR_NOT_PERMITTED_EXT :: Result ERROR_NOT_PERMITTED_EXT = ERROR_NOT_PERMITTED -- No documentation found for TopLevel "VK_QUEUE_GLOBAL_PRIORITY_LOW_EXT" pattern $mQUEUE_GLOBAL_PRIORITY_LOW_EXT :: forall {r}. QueueGlobalPriority -> ((# #) -> r) -> ((# #) -> r) -> r $bQUEUE_GLOBAL_PRIORITY_LOW_EXT :: QueueGlobalPriority QUEUE_GLOBAL_PRIORITY_LOW_EXT = QUEUE_GLOBAL_PRIORITY_LOW -- No documentation found for TopLevel "VK_QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT" pattern $mQUEUE_GLOBAL_PRIORITY_MEDIUM_EXT :: forall {r}. QueueGlobalPriority -> ((# #) -> r) -> ((# #) -> r) -> r $bQUEUE_GLOBAL_PRIORITY_MEDIUM_EXT :: QueueGlobalPriority QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT = QUEUE_GLOBAL_PRIORITY_MEDIUM -- No documentation found for TopLevel "VK_QUEUE_GLOBAL_PRIORITY_HIGH_EXT" pattern $mQUEUE_GLOBAL_PRIORITY_HIGH_EXT :: forall {r}. QueueGlobalPriority -> ((# #) -> r) -> ((# #) -> r) -> r $bQUEUE_GLOBAL_PRIORITY_HIGH_EXT :: QueueGlobalPriority QUEUE_GLOBAL_PRIORITY_HIGH_EXT = QUEUE_GLOBAL_PRIORITY_HIGH -- No documentation found for TopLevel "VK_QUEUE_GLOBAL_PRIORITY_REALTIME_EXT" pattern $mQUEUE_GLOBAL_PRIORITY_REALTIME_EXT :: forall {r}. QueueGlobalPriority -> ((# #) -> r) -> ((# #) -> r) -> r $bQUEUE_GLOBAL_PRIORITY_REALTIME_EXT :: QueueGlobalPriority QUEUE_GLOBAL_PRIORITY_REALTIME_EXT = QUEUE_GLOBAL_PRIORITY_REALTIME -- No documentation found for TopLevel "VkQueueGlobalPriorityEXT" type QueueGlobalPriorityEXT = QueueGlobalPriority -- No documentation found for TopLevel "VkDeviceQueueGlobalPriorityCreateInfoEXT" type DeviceQueueGlobalPriorityCreateInfoEXT = DeviceQueueGlobalPriorityCreateInfo type EXT_GLOBAL_PRIORITY_SPEC_VERSION = 2 -- No documentation found for TopLevel "VK_EXT_GLOBAL_PRIORITY_SPEC_VERSION" pattern EXT_GLOBAL_PRIORITY_SPEC_VERSION :: forall a . Integral a => a pattern $mEXT_GLOBAL_PRIORITY_SPEC_VERSION :: forall {r} {a}. Integral a => a -> ((# #) -> r) -> ((# #) -> r) -> r $bEXT_GLOBAL_PRIORITY_SPEC_VERSION :: forall a. Integral a => a EXT_GLOBAL_PRIORITY_SPEC_VERSION = 2 type EXT_GLOBAL_PRIORITY_EXTENSION_NAME = "VK_EXT_global_priority" -- No documentation found for TopLevel "VK_EXT_GLOBAL_PRIORITY_EXTENSION_NAME" pattern EXT_GLOBAL_PRIORITY_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a pattern $mEXT_GLOBAL_PRIORITY_EXTENSION_NAME :: forall {r} {a}. (Eq a, IsString a) => a -> ((# #) -> r) -> ((# #) -> r) -> r $bEXT_GLOBAL_PRIORITY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a EXT_GLOBAL_PRIORITY_EXTENSION_NAME = "VK_EXT_global_priority"