Vulkan.Utils.Requirements

Instance requirements

checkInstanceRequirements

Arguments

:: forall m o r es. (MonadIO m, Traversable r, Traversable o)

=> r InstanceRequirement

Required requests

-> o InstanceRequirement

Optional requests

-> InstanceCreateInfo es

An InstanceCreateInfo, this will be returned appropriately modified by the requirements

-> m (Maybe (InstanceCreateInfo es), r RequirementResult, o RequirementResult)

Device requirements

checkDeviceRequirements

Arguments

:: forall m o r. (MonadIO m, Traversable r, Traversable o)

=> r DeviceRequirement

Required requests

-> o DeviceRequirement

Optional requests

-> PhysicalDevice

-> DeviceCreateInfo '[]

A deviceCreateInfo with no extensions. If you need elements in the struct chain you can add them later with extendSomeStruct

-> m (Maybe (SomeStruct DeviceCreateInfo), r RequirementResult, o RequirementResult)

Results

data RequirementResult

Constructors

Satisfied

All the requirements were met

UnattemptedProperties ByteString

Didn't attempt this check because it required getPhysicalDeviceProperties2 which wasn't loaded

UnattemptedFeatures ByteString

Didn't attempt this check because it required getPhysicalDeviceFeatures2 which wasn't loaded

MissingLayer ByteString

A Layer was not found

UnsatisfiedDeviceVersion (Unsatisfied Word32)

A device version didn't meet the minimum requested

UnsatisfiedInstanceVersion (Unsatisfied Word32)

The instance version didn't meet the minimum requested

UnsatisfiedLayerVersion ByteString (Unsatisfied Word32)

A layer version didn't meet the minimum requested

UnsatisfiedFeature ByteString

A feature was missing

UnsatisfiedProperty ByteString

A propery was not an appropriate value

UnsatisfiedDeviceExtension ByteString

A device extension was missing

UnsatisfiedDeviceExtensionVersion ByteString (Unsatisfied Word32)

A device extension was found but the version didn't meet requirements

UnsatisfiedInstanceExtension ByteString

An instance extension was missing

UnsatisfiedInstanceExtensionVersion ByteString (Unsatisfied Word32)

An instance extension was found but the version didn't meet requirements

Instances

Eq RequirementResult

Defined in Vulkan.Utils.Requirements

Methods

(==) :: RequirementResult -> RequirementResult -> Bool

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

Ord RequirementResult

Defined in Vulkan.Utils.Requirements

Methods

compare :: RequirementResult -> RequirementResult -> Ordering

(<) :: RequirementResult -> RequirementResult -> Bool

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

(>) :: RequirementResult -> RequirementResult -> Bool

(>=) :: RequirementResult -> RequirementResult -> Bool

max :: RequirementResult -> RequirementResult -> RequirementResult

min :: RequirementResult -> RequirementResult -> RequirementResult

data Unsatisfied a

Constructors

Unsatisfied

Fields

• unsatisfiedMinimum :: a

  The minimum value to be accepted

• unsatisfiedActual :: a

  The value we got, less than unsatisfiedMinumum

Instances

Eq a => Eq (Unsatisfied a)

Defined in Vulkan.Utils.Requirements

Methods

(==) :: Unsatisfied a -> Unsatisfied a -> Bool

(/=) :: Unsatisfied a -> Unsatisfied a -> Bool

Ord a => Ord (Unsatisfied a)

Defined in Vulkan.Utils.Requirements

Methods

compare :: Unsatisfied a -> Unsatisfied a -> Ordering

(<) :: Unsatisfied a -> Unsatisfied a -> Bool

(<=) :: Unsatisfied a -> Unsatisfied a -> Bool

(>) :: Unsatisfied a -> Unsatisfied a -> Bool

(>=) :: Unsatisfied a -> Unsatisfied a -> Bool

max :: Unsatisfied a -> Unsatisfied a -> Unsatisfied a

min :: Unsatisfied a -> Unsatisfied a -> Unsatisfied a

requirementReport :: (Foldable r, Foldable o) => r RequirementResult -> o RequirementResult -> Maybe String

Generate a string describing which requirements were not met, if everything was satisfied return Nothing.

prettyRequirementResult :: RequirementResult -> String