VKENUMERATEINSTANCEE(3)

NAME
vkEnumerateInstanceExtensionProperties - Returns up to requested number of global extension properties.

C SPECIFICATION

    VkResult vkEnumerateInstanceExtensionProperties(
        const char*                                 pLayerName,
        uint32_t*                                   pPropertyCount,
        VkExtensionProperties*                      pProperties);

PARAMETERS

pLayerName
    Pointer to optional layer name. If not null, will only return extension properties for the requested layer.

pPropertyCount
    Pointer to count indicating space available on input and structures returned on output.

pProperties
    Pointer to a data structure to receive the results.

DESCRIPTION

vkEnumerateInstanceExtensionProperties retrieves properties for global extensions of the loader or the optionally specified layer. pProperties points to an array of VkExtensionProperties where the return data will be stored. If NULL, vkEnumerateInstanceExtensionProperties will update the count with the number of global extensions found. pPropertyCount must point to a count indicating the number of VkExtensionProperties structures available. The definition of VkExtensionProperties is as follows:

    typedef struct VkExtensionProperties {
        char        extensionName[VK_MAX_EXTENSION_NAME_SIZE];
        uint32_t    specVersion;
    } VkExtensionProperties;

VALID USAGE

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

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

    • If pLayerName is not NULL, it must be the name of a layer returned by vkEnumerateInstanceLayerProperties

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

RETURN VALUE

Upon success, vkEnumerateInstanceExtensionProperties returns VK_SUCCESS or VK_INCOMPLETE. VK_INCOMPLETE indicates that the number of extension properties found exceeds the given count. An app will need to call again with a larger array and count to get all available extension properties. The number of available extensions could change from one call to the next if an application updates or installs Vulkan components.

SEE ALSO

vkEnumerateInstanceLayerProperties, vkCreateInstance

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.