If the VK_EXT_validation_features extension (from the VK_LAYER_KHRONOS_validation layer) is available is it will be enabled and best practices messages enabled.

valueallocateVulkanInstance

:: MonadResource m
=> Vector ByteString
Backend-required instance extensions (e.g. from Vulkan.Utils.Init.SDL2.getRequiredInstanceExtensions). mempty for headless.
-> Maybe ApplicationInfo
-> [InstanceRequirement]
Caller's required requirements
-> [InstanceRequirement]
Caller's optional requirements
-> m Instance

Source#

Build a Vulkan Instance from a backend-supplied extension list plus caller-supplied requirements. Automatically merges portabilityRequirements into the required list and portabilityFlags into the create flags so macOS apps work without per-call plumbing.

Pass mempty for the extension list when running headless; or call allocateInstance which does so.

macOS portability

valueportabilityRequirements :: [InstanceRequirement]

valueportabilityFlags :: InstanceCreateFlags

Source#

Instance create flag bits that pair with portabilityRequirements. zero on every non-macOS platform.

valuedevicePortabilityRequirements :: [DeviceRequirement]

Source#

Device requirements needed on macOS: the Vulkan spec mandates that VK_KHR_portability_subset be enabled whenever a physical device advertises it (as MoltenVK does). Empty on every other platform.

Device creation

valueallocateDeviceFromRequirements

:: MonadResource m
=> [DeviceRequirement]
Required
-> [DeviceRequirement]
Optional
-> PhysicalDevice
-> DeviceCreateInfo '[]
-> m Device

Source#

Create a Device from some requirements.

Will throw an 'IOError in the case of unsatisfied non-optional requirements. Unsatisfied requirements will be listed on stderr.

Physical device selection

valuepickPhysicalDevice

:: (MonadIO m, Ord b)
=> Instance
-> (PhysicalDevice -> m (Maybe a))
A suitability funcion for a PhysicalDevice, Nothing if it is not to be chosen.
-> (a -> b)
Scoring function to rate this result
-> m (Maybe (a, PhysicalDevice))
The score and the device

Source#

Get a single PhysicalDevice deciding with a scoring function

Pass a function which will extract any required values from a device in the spirit of parse-don't-validate. Also provide a function to compare these results for sorting multiple suitable devices.

As an example, the suitability function could return a tuple of device memory and the compute queue family index, and the scoring function could be fst to select devices based on their memory capacity. Consider using assignQueues to find your desired queues in the suitability function.

Pehaps also use the functionality in Vulkan.Utils.Requirements and return the DeviceCreateInfo too.

If no devices are deemed suitable then a NoSuchThing IOError is thrown.