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

  • 1 type
  • 2 values
  • Packagevulkan-3.27
  • Exports3
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceExtensionDiscovery.hs
valueenumerateInstanceExtensionProperties
  1. :: MonadIO io
  2. => "layerName" ::: Maybe ByteString

    pLayerName is either NULL or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.

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

vkEnumerateInstanceExtensionProperties - Returns up to requested number of global extension properties

Description

When pLayerName parameter is NULL, only extensions provided by the Vulkan implementation or by implicitly enabled layers are returned. When pLayerName is the name of a layer, the instance extensions provided by that layer are returned.

If pProperties is NULL, then the number of extensions 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 extension 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.

Because the list of available layers may change externally between calls to enumerateInstanceExtensionProperties, two calls may retrieve different results if a pLayerName is available in one call but not in another. The extensions supported by a layer may also change between two calls, e.g. if the layer implementation is replaced by a different version between those calls.

Implementations must not advertise any pair of extensions that cannot be enabled together due to behavioral differences, or any extension that cannot be enabled against the advertised version.

Valid Usage (Implicit)

  • If pLayerName is not NULL, pLayerName must be a null-terminated UTF-8 string

  • 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 ExtensionProperties structures

Return Codes

Success
Failure

See Also

VK_VERSION_1_0, ExtensionProperties

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

    physicalDevice is the physical device that will be queried.

  3. -> "layerName" ::: Maybe ByteString

    pLayerName is either NULL or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.

  4. -> io (Result, "properties" ::: Vector ExtensionProperties)
#

vkEnumerateDeviceExtensionProperties - Returns properties of available physical device extensions

Description

When pLayerName parameter is NULL, only extensions provided by the Vulkan implementation or by implicitly enabled layers are returned. When pLayerName is the name of a layer, the device extensions provided by that layer are returned.

Implementations must not advertise any pair of extensions that cannot be enabled together due to behavioral differences, or any extension that cannot be enabled against the advertised version.

If the VK_KHR_ray_tracing_pipeline extension is advertised as supported by this query, the VK_KHR_pipeline_library extension must also be supported.

If the VK_EXT_descriptor_heap extension is advertised as supported by this query, the VK_KHR_shader_untyped_pointers extension must also be supported.

Implementations claiming support for the Roadmap 2022 profile must advertise the VK_KHR_global_priority extension in pProperties.

Implementations claiming support for the Roadmap 2024 profile must advertise the following extensions in pProperties:

Due to platform details on Android, enumerateDeviceExtensionProperties 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)

  • If pLayerName is not NULL, pLayerName must be a null-terminated UTF-8 string

  • 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 ExtensionProperties structures

Return Codes

Success
Failure

See Also

VK_VERSION_1_0, ExtensionProperties, PhysicalDevice

datadata ExtensionProperties
#

VkExtensionProperties - Structure specifying an extension properties

See Also

VK_VERSION_1_0, VkVideoCapabilitiesKHR, VkVideoSessionCreateInfoKHR, enumerateDeviceExtensionProperties, enumerateInstanceExtensionProperties

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero