VKENUMERATEDEVICELAY(3)

NAME
vkEnumerateDeviceLayerProperties - Returns properties of available physical device layers.

C SPECIFICATION

    VkResult vkEnumerateDeviceLayerProperties(
        VkPhysicalDevice                            physicalDevice,
        uint32_t*                                   pPropertyCount,
        VkLayerProperties*                          pProperties);

PARAMETERS

physicalDevice
    Physical device to query.

pPropertyCount
    Count indicating number of VkLayerProperties pointed to by pProperties.

pProperties
    Pointer to an array of VkLayerProperties.

DESCRIPTION

vkEnumerateDeviceLayerProperties retrieves properties for layers on a physical device whose handle is given in physicalDevice. pPropertyCount must be a valid pointer to an integer set to the size of the VkLayerProperties array pointed to by pProperties. pProperties must be NULL or a pointer to an array of VkLayerProperties to be filled out. If NULL, vkEnumerateDeviceLayerProperties will update pPropertyCount with the number of layers found. The definition of VkLayerProperties is as follows:

    typedef struct VkLayerProperties {
        char        layerName[VK_MAX_EXTENSION_NAME_SIZE];
        uint32_t    specVersion;
        uint32_t    implementationVersion;
        char        description[VK_MAX_DESCRIPTION_SIZE];
    } VkLayerProperties;

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • pPropertyCount must be a pointer to a uint32_t value

    • If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a pointer to an array of pPropertyCount VkLayerProperties structures

RETURN CODES

On success, this command returns

        • VK_SUCCESS

        • VK_INCOMPLETE

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

vkEnumerateDeviceLayerProperties, vkCreateDevice

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.