Safe Haskell	None
Language	Haskell2010

Vulkan.Core10.ExtensionDiscovery

Synopsis

enumerateInstanceExtensionProperties :: MonadIO io => ("layerName" ::: Maybe ByteString) -> io (Result, "properties" ::: Vector ExtensionProperties)
enumerateDeviceExtensionProperties :: MonadIO io => PhysicalDevice -> ("layerName" ::: Maybe ByteString) -> io (Result, "properties" ::: Vector ExtensionProperties)
data ExtensionProperties = ExtensionProperties {
- extensionName :: ByteString
- specVersion :: Word32
}

Documentation

enumerateInstanceExtensionProperties Source #

Arguments

:: MonadIO io
=> ("layerName" ::: Maybe ByteString)	`pLayerName` is either `NULL` or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.
-> 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

INCOMPLETE
SUCCESS

Failure

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)

physicalDevice must be a valid PhysicalDevice handle

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

INCOMPLETE
SUCCESS

Failure

ExtensionProperties
Fields extensionName :: ByteString `extensionName` is an array of `MAX_EXTENSION_NAME_SIZE` `char` containing a null-terminated UTF-8 string which is the name of the extension. specVersion :: Word32 `specVersion` is the version of this extension. It is an integer, incremented with backward compatible changes.

Instances

Instances details

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

Documentation

Description

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage (Implicit)

Return Codes

See Also

See Also

Instances

:: MonadIO io
=> PhysicalDevice	`physicalDevice` is the physical device that will be queried.
-> ("layerName" ::: Maybe ByteString)	`pLayerName` is either `NULL` or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.
-> io (Result, "properties" ::: Vector ExtensionProperties)