HORIZON HASKELLDocslts/ghc-9.14.x45dd5372026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · 45dd537 · 2026-10-11

Modulevulkan-3.27GHC2021

Vulkan.Core10.LayerDiscovery

  • 1 type
  • 2 values
  • Packagevulkan-3.27
  • Exports3
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceLayerDiscovery.hs
valueenumerateInstanceLayerProperties :: MonadIO io => io (Result, "properties" ::: Vector LayerProperties)
#

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 application 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
Failure

See Also

VK_VERSION_1_0, LayerProperties

valueenumerateDeviceLayerProperties
  1. :: MonadIO io
  2. => PhysicalDevice

    physicalDevice is the physical device that will be queried.

  3. -> io (Result, "properties" ::: Vector LayerProperties)
#

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 application 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.

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

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
Failure

See Also

VK_VERSION_1_0, LayerProperties, PhysicalDevice

datadata LayerProperties
#

VkLayerProperties - Structure specifying layer properties

See Also

VK_VERSION_1_0, enumerateDeviceLayerProperties, enumerateInstanceLayerProperties

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero