Safe Haskell	None
Language	Haskell2010

Vulkan.Utils.QueueAssignment

Contents

Queue Family Predicates

Synopsis

assignQueues :: forall f m n. (Traversable f, MonadIO m, MonadIO n) => PhysicalDevice -> f (QueueSpec m) -> m (Maybe (Vector (DeviceQueueCreateInfo '[]), Device -> n (f (QueueFamilyIndex, Queue))))
data QueueSpec m = QueueSpec {
- queueSpecQueuePriority :: Float
- queueSpecFamilyPredicate :: QueueFamilyIndex -> QueueFamilyProperties -> m Bool
}
newtype QueueFamilyIndex = QueueFamilyIndex {
- unQueueFamilyIndex :: Word32
}
newtype QueueIndex = QueueIndex {
- unQueueIndex :: Word32
}
isComputeQueueFamily :: QueueFamilyProperties -> Bool
isGraphicsQueueFamily :: QueueFamilyProperties -> Bool
isTransferQueueFamily :: QueueFamilyProperties -> Bool
isTransferOnlyQueueFamily :: QueueFamilyProperties -> Bool
isPresentQueueFamily :: MonadIO m => PhysicalDevice -> SurfaceKHR -> QueueFamilyIndex -> m Bool

Documentation

assignQueues Source #

Arguments

:: forall f m n. (Traversable f, MonadIO m, MonadIO n)
=> PhysicalDevice
-> f (QueueSpec m)	A set of requirements for `Queue`s to be created
-> m (Maybe (Vector (DeviceQueueCreateInfo '[]), Device -> n (f (QueueFamilyIndex, Queue))))	A set of `DeviceQueueCreateInfo`s to pass to `createDevice` A function to extract the requested `Queue`s from the `Device` created with the `DeviceQueueCreateInfo`s `Nothing` if it wasn't possible to satisfy all the `QueueSpec`s

Given a PhysicalDevice and a set of requirements for queues, calculate an assignment of queues to queue families and return information with which to create a Device and also a function to extract the requested Queues from the device.

You may want to create a custom type with a Traversable instance to store your queues like:

data MyQueues q = MyQueues
  { computeQueue            :: q
  , graphicsAndPresentQueue :: q
  , transferQueue           :: q
  }

myQueueSpecs :: MyQueues QueueSpec
myQueueSpecs = MyQueues
  { computeQueue            = QueueSpec 0.5 isComputeQueueFamily
  , graphicsAndPresentQueue = QueueSpec 1   isPresentQueueFamily
  , transferQueue           = QueueSpec 1   isTransferOnlyQueueFamily
  }

Note, this doesn't permit differentiating queue family assignment based on whether or not the queue is protected.

data QueueSpec m Source #

Requirements for a Queue to be assigned a family by assignQueues.

To assign to a specific queue family index f:

queueSpecFamilyPredicate = i _ -> i == f

To assign to any queue family which supports compute operations:

let isComputeQueue q = QUEUE_COMPUTE_BIT .&&. queueFlags q
in QueueSpec priority (_index q -> pure (isComputeQueue q))

Constructors

QueueSpec
Fields queueSpecQueuePriority :: Float queueSpecFamilyPredicate :: QueueFamilyIndex -> QueueFamilyProperties -> m Bool

newtype QueueFamilyIndex Source #

Constructors

QueueFamilyIndex
Fields unQueueFamilyIndex :: Word32

Instances

Instances details

Enum QueueFamilyIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods succ :: QueueFamilyIndex -> QueueFamilyIndex # pred :: QueueFamilyIndex -> QueueFamilyIndex # toEnum :: Int -> QueueFamilyIndex # fromEnum :: QueueFamilyIndex -> Int # enumFrom :: QueueFamilyIndex -> [QueueFamilyIndex] # enumFromThen :: QueueFamilyIndex -> QueueFamilyIndex -> [QueueFamilyIndex] # enumFromTo :: QueueFamilyIndex -> QueueFamilyIndex -> [QueueFamilyIndex] # enumFromThenTo :: QueueFamilyIndex -> QueueFamilyIndex -> QueueFamilyIndex -> [QueueFamilyIndex] #
Eq QueueFamilyIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods (==) :: QueueFamilyIndex -> QueueFamilyIndex -> Bool # (/=) :: QueueFamilyIndex -> QueueFamilyIndex -> Bool #
Ord QueueFamilyIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods compare :: QueueFamilyIndex -> QueueFamilyIndex -> Ordering # (<) :: QueueFamilyIndex -> QueueFamilyIndex -> Bool # (<=) :: QueueFamilyIndex -> QueueFamilyIndex -> Bool # (>) :: QueueFamilyIndex -> QueueFamilyIndex -> Bool # (>=) :: QueueFamilyIndex -> QueueFamilyIndex -> Bool # max :: QueueFamilyIndex -> QueueFamilyIndex -> QueueFamilyIndex # min :: QueueFamilyIndex -> QueueFamilyIndex -> QueueFamilyIndex #
Show QueueFamilyIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods showsPrec :: Int -> QueueFamilyIndex -> ShowS # show :: QueueFamilyIndex -> String # showList :: [QueueFamilyIndex] -> ShowS #

newtype QueueIndex Source #

Constructors

QueueIndex
Fields unQueueIndex :: Word32

Instances

Instances details

Enum QueueIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods succ :: QueueIndex -> QueueIndex # pred :: QueueIndex -> QueueIndex # toEnum :: Int -> QueueIndex # fromEnum :: QueueIndex -> Int # enumFrom :: QueueIndex -> [QueueIndex] # enumFromThen :: QueueIndex -> QueueIndex -> [QueueIndex] # enumFromTo :: QueueIndex -> QueueIndex -> [QueueIndex] # enumFromThenTo :: QueueIndex -> QueueIndex -> QueueIndex -> [QueueIndex] #
Eq QueueIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods (==) :: QueueIndex -> QueueIndex -> Bool # (/=) :: QueueIndex -> QueueIndex -> Bool #
Ord QueueIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods compare :: QueueIndex -> QueueIndex -> Ordering # (<) :: QueueIndex -> QueueIndex -> Bool # (<=) :: QueueIndex -> QueueIndex -> Bool # (>) :: QueueIndex -> QueueIndex -> Bool # (>=) :: QueueIndex -> QueueIndex -> Bool # max :: QueueIndex -> QueueIndex -> QueueIndex # min :: QueueIndex -> QueueIndex -> QueueIndex #
Show QueueIndex Source #
Instance details Defined in Vulkan.Utils.QueueAssignment Methods showsPrec :: Int -> QueueIndex -> ShowS # show :: QueueIndex -> String # showList :: [QueueIndex] -> ShowS #

Queue Family Predicates

isComputeQueueFamily :: QueueFamilyProperties -> Bool Source #

isGraphicsQueueFamily :: QueueFamilyProperties -> Bool Source #

isTransferQueueFamily :: QueueFamilyProperties -> Bool Source #

isTransferOnlyQueueFamily :: QueueFamilyProperties -> Bool Source #

Does this queue have QUEUE_TRANSFER_BIT set and not QUEUE_COMPUTE_BIT or QUEUE_GRAPHICS_BIT

isPresentQueueFamily :: MonadIO m => PhysicalDevice -> SurfaceKHR -> QueueFamilyIndex -> m Bool Source #

Can this queue family present to this surface on this device