Graphics.Vulkan.Core10.LayerDiscovery

Documentation

type VK_MAX_DESCRIPTION_SIZE = 256

pattern VK_MAX_DESCRIPTION_SIZE :: Integral a => a

vkEnumerateInstanceLayerProperties :: ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr VkLayerProperties) -> IO VkResult

vkEnumerateInstanceLayerProperties - Returns up to requested number of global layer properties

Parameters

• pPropertyCount is a pointer to an integer related to the number of layer properties available or queried, as described below.

• pProperties is either NULL or a pointer to an array of VkLayerProperties structures.

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, VK_INCOMPLETE will be returned instead of VK_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 vkEnumerateInstanceLayerProperties 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 VkLayerProperties structures

Return Codes

Success

- VK_SUCCESS

• VK_INCOMPLETE

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkLayerProperties

vkEnumerateDeviceLayerProperties :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr VkLayerProperties) -> IO VkResult

vkEnumerateDeviceLayerProperties - Returns properties of available physical device layers

Parameters

• pPropertyCount is a pointer to an integer related to the number of layer properties available or queried.

• pProperties is either NULL or a pointer to an array of VkLayerProperties structures.

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, VK_INCOMPLETE will be returned instead of VK_SUCCESS, to indicate that not all the available layer properties were returned.

The list of layers enumerated by vkEnumerateDeviceLayerProperties must be exactly the sequence of layers enabled for the instance. The members of VkLayerProperties for each enumerated layer must be the same as the properties when the layer was enumerated by vkEnumerateInstanceLayerProperties.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle

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

Return Codes

Success

- VK_SUCCESS

• VK_INCOMPLETE

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkLayerProperties, VkPhysicalDevice

data VkLayerProperties

VkLayerProperties - Structure specifying layer properties

Description

See Also

vkEnumerateDeviceLayerProperties, vkEnumerateInstanceLayerProperties

Constructors

VkLayerProperties

Fields

• vkLayerName :: Vector VK_MAX_EXTENSION_NAME_SIZE CChar

  layerName is a null-terminated UTF-8 string specifying the name of the layer. Use this name in the ppEnabledLayerNames array passed in the VkInstanceCreateInfo structure to enable this layer for an instance.

• vkSpecVersion :: Word32

  specVersion is the Vulkan version the layer was written to, encoded as described in the API Version Numbers and Semantics section.

• vkImplementationVersion :: Word32

  implementationVersion is the version of this layer. It is an integer, increasing with backward compatible changes.

• vkDescription :: Vector VK_MAX_DESCRIPTION_SIZE CChar

  description is a null-terminated UTF-8 string providing additional details that can be used by the application to identify the layer.

Instances

Eq VkLayerProperties

Methods

(==) :: VkLayerProperties -> VkLayerProperties -> Bool

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

Show VkLayerProperties

Methods

showsPrec :: Int -> VkLayerProperties -> ShowS

show :: VkLayerProperties -> String

showList :: [VkLayerProperties] -> ShowS

Storable VkLayerProperties

Methods

sizeOf :: VkLayerProperties -> Int

alignment :: VkLayerProperties -> Int

peekElemOff :: Ptr VkLayerProperties -> Int -> IO VkLayerProperties

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

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

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

peek :: Ptr VkLayerProperties -> IO VkLayerProperties

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