Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Core10.LayerDiscovery

Synopsis

enumerateInstanceLayerProperties :: forall io. MonadIO io => io (Result, "properties" ::: Vector LayerProperties)
enumerateDeviceLayerProperties :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector LayerProperties)
data LayerProperties = LayerProperties {
- layerName :: ByteString
- specVersion :: Word32
- implementationVersion :: Word32
- description :: ByteString
}

Documentation

enumerateInstanceLayerProperties :: forall io. MonadIO io => io (Result, "properties" ::: Vector LayerProperties) Source #

vkEnumerateInstanceLayerProperties - Returns up to requested number of global layer properties

Description

If pProperties is NULL, then the number of layer properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of layer properties available, at most pPropertyCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available properties were returned.

The list of available layers may change at any time due to actions outside of the Vulkan implementation, so two calls to enumerateInstanceLayerProperties with the same parameters may return different results, or retrieve different pPropertyCount values or pProperties contents. Once an instance has been created, the layers enabled for that instance will continue to be enabled and valid for the lifetime of that instance, even if some of them become unavailable for future instances.

Valid Usage (Implicit)

pPropertyCount must be a valid pointer to a uint32_t value

If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount LayerProperties structures

Return Codes

Success

SUCCESS
INCOMPLETE

Failure

Description

If pProperties is NULL, then the number of layer properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of layer properties available, at most pPropertyCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available properties were returned.

The list of layers enumerated by enumerateDeviceLayerProperties must be exactly the sequence of layers enabled for the instance. The members of LayerProperties for each enumerated layer must be the same as the properties when the layer was enumerated by enumerateInstanceLayerProperties.

Note

Due to platform details on Android, enumerateDeviceLayerProperties may be called with physicalDevice equal to NULL during layer discovery. This behaviour will only be observed by layer implementations, and not the underlying Vulkan driver.

Valid Usage (Implicit)

physicalDevice must be a valid PhysicalDevice handle

pPropertyCount must be a valid pointer to a uint32_t value
If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount LayerProperties structures

Return Codes

Success

SUCCESS
INCOMPLETE

Failure

layerName :: ByteString
layerName is an array of MAX_EXTENSION_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the layer. Use this name in the ppEnabledLayerNames array passed in the InstanceCreateInfo structure to enable this layer for an instance.
specVersion :: Word32
specVersion is the Vulkan version the layer was written to, encoded as described in https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#extendingvulkan-coreversions-versionnumbers.
implementationVersion :: Word32
implementationVersion is the version of this layer. It is an integer, increasing with backward compatible changes.
description :: ByteString
description is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which provides additional details that can be used by the application to identify the layer.

Instances

Instances details

Storable LayerProperties Source #
Instance details Defined in Vulkan.Core10.LayerDiscovery Methods sizeOf :: LayerProperties -> Int # alignment :: LayerProperties -> Int # peekElemOff :: Ptr LayerProperties -> Int -> IO LayerProperties # pokeElemOff :: Ptr LayerProperties -> Int -> LayerProperties -> IO () # peekByteOff :: Ptr b -> Int -> IO LayerProperties # pokeByteOff :: Ptr b -> Int -> LayerProperties -> IO () # peek :: Ptr LayerProperties -> IO LayerProperties # poke :: Ptr LayerProperties -> LayerProperties -> IO () #
Show LayerProperties Source #
Instance details Defined in Vulkan.Core10.LayerDiscovery Methods showsPrec :: Int -> LayerProperties -> ShowS # show :: LayerProperties -> String # showList :: [LayerProperties] -> ShowS #
FromCStruct LayerProperties Source #
Instance details Defined in Vulkan.Core10.LayerDiscovery Methods peekCStruct :: Ptr LayerProperties -> IO LayerProperties Source #
ToCStruct LayerProperties Source #
Instance details Defined in Vulkan.Core10.LayerDiscovery Methods withCStruct :: LayerProperties -> (Ptr LayerProperties -> IO b) -> IO b Source # pokeCStruct :: Ptr LayerProperties -> LayerProperties -> IO b -> IO b Source # withZeroCStruct :: (Ptr LayerProperties -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr LayerProperties -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero LayerProperties Source #
Instance details Defined in Vulkan.Core10.LayerDiscovery Methods zero :: LayerProperties Source #

Documentation

Description

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage (Implicit)

Return Codes

See Also

See Also

Instances

:: forall io. MonadIO io
=> PhysicalDevice	`physicalDevice` is the physical device that will be queried.
-> io (Result, "properties" ::: Vector LayerProperties)