Graphics.Vulkan.Core10.ExtensionDiscovery

Documentation

type VK_MAX_EXTENSION_NAME_SIZE = 256

pattern VK_MAX_EXTENSION_NAME_SIZE :: Integral a => a

vkEnumerateInstanceExtensionProperties :: ("pLayerName" ::: Ptr CChar) -> ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr VkExtensionProperties) -> IO VkResult

vkEnumerateInstanceExtensionProperties - Returns up to requested number of global extension properties

Parameters

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

• pPropertyCount is a pointer to an integer related to the number of extension properties available or queried, as described below.
• pProperties is either NULL or a pointer to an array of VkExtensionProperties structures.

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 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 extension properties available, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of extensions available, VK_INCOMPLETE will be returned instead of VK_SUCCESS, to indicate that not all the available properties were returned.

Because the list of available layers may change externally between calls to vkEnumerateInstanceExtensionProperties, 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.

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 VkExtensionProperties structures

Return Codes

Success

- VK_SUCCESS

• VK_INCOMPLETE

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

• VK_ERROR_LAYER_NOT_PRESENT

See Also

VkExtensionProperties

vkEnumerateDeviceExtensionProperties :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pLayerName" ::: Ptr CChar) -> ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr VkExtensionProperties) -> IO VkResult

vkEnumerateDeviceExtensionProperties - Returns properties of available physical device extensions

Parameters

• physicalDevice is the physical device that will be queried.

• pLayerName is either NULL or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.
• pPropertyCount is a pointer to an integer related to the number of extension properties available or queried, and is treated in the same fashion as the vkEnumerateInstanceExtensionProperties::pPropertyCount parameter.
• pProperties is either NULL or a pointer to an array of VkExtensionProperties structures.

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.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice 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 VkExtensionProperties structures

Return Codes

Success

- VK_SUCCESS

• VK_INCOMPLETE

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

• VK_ERROR_LAYER_NOT_PRESENT

See Also

VkExtensionProperties, VkPhysicalDevice

data VkExtensionProperties

VkExtensionProperties - Structure specifying a extension properties

Description

See Also

vkEnumerateDeviceExtensionProperties, vkEnumerateInstanceExtensionProperties

Constructors

VkExtensionProperties

Fields

• vkExtensionName :: Vector VK_MAX_EXTENSION_NAME_SIZE CChar

  extensionName is a null-terminated string specifying the name of the extension.

• vkSpecVersion :: Word32

  specVersion is the version of this extension. It is an integer, incremented with backward compatible changes.

Instances

Eq VkExtensionProperties

Methods

(==) :: VkExtensionProperties -> VkExtensionProperties -> Bool

(/=) :: VkExtensionProperties -> VkExtensionProperties -> Bool

Show VkExtensionProperties

Methods

showsPrec :: Int -> VkExtensionProperties -> ShowS

show :: VkExtensionProperties -> String

showList :: [VkExtensionProperties] -> ShowS

Storable VkExtensionProperties

Methods

sizeOf :: VkExtensionProperties -> Int

alignment :: VkExtensionProperties -> Int

peekElemOff :: Ptr VkExtensionProperties -> Int -> IO VkExtensionProperties

pokeElemOff :: Ptr VkExtensionProperties -> Int -> VkExtensionProperties -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkExtensionProperties

pokeByteOff :: Ptr b -> Int -> VkExtensionProperties -> IO ()

peek :: Ptr VkExtensionProperties -> IO VkExtensionProperties

poke :: Ptr VkExtensionProperties -> VkExtensionProperties -> IO ()