Safe Haskell | None |
---|---|
Language | Haskell2010 |
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 {}
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. If pPropertyCount
is smaller than the number of layers available,
INCOMPLETE
will be returned instead of
SUCCESS
, to indicate that not all the
available layer 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)
- If
the value referenced by
pPropertyCount
is not0
, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
LayerProperties
structures
Return Codes
See Also
enumerateDeviceLayerProperties :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector LayerProperties) Source #
vkEnumerateDeviceLayerProperties - Returns properties of available physical device layers
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. If pPropertyCount
is smaller than the number of layers available,
INCOMPLETE
will be returned instead of
SUCCESS
, to indicate that not all the
available layer 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
.
Valid Usage (Implicit)
-
physicalDevice
must be a validPhysicalDevice
handle
-
pPropertyCount
must be a valid pointer to auint32_t
value - If the
value referenced by
pPropertyCount
is not0
, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
LayerProperties
structures
Return Codes
See Also
data LayerProperties Source #
VkLayerProperties - Structure specifying layer properties
See Also
enumerateDeviceLayerProperties
, enumerateInstanceLayerProperties
LayerProperties | |
|