C Specification

To query the set of object types that require periodic refreshing, call:

// Provided by VK_KHR_object_refresh
VkResult vkGetPhysicalDeviceRefreshableObjectTypesKHR(
    VkPhysicalDevice                            physicalDevice,
    uint32_t*                                   pRefreshableObjectTypeCount,
    VkObjectType*                               pRefreshableObjectTypes);

Parameters

  • physicalDevice is the physical device from which to query the set of refreshable object types.

  • pRefreshableObjectTypeCount is a pointer to an integer related to the number of refreshable object types available or queried, as described below.

  • pRefreshableObjectTypes is either NULL or a pointer to an array of VkObjectType values, indicating the supported refreshable object types.

Description

If pRefreshableObjectTypes is NULL, then the number of refreshable object types supported for the given physicalDevice is returned in pRefreshableObjectTypeCount. Otherwise, pRefreshableObjectTypeCount must point to a variable set by the application to the number of elements in the pRefreshableObjectTypes array, and on return the variable is overwritten with the number of object types actually written to pRefreshableObjectTypes. If the value of pRefreshableObjectTypeCount is less than the number of refreshable object types supported, at most pRefreshableObjectTypeCount object types will be written, and VK_INCOMPLETE will be returned instead of VK_SUCCESS, to indicate that not all the available object types were returned.

Valid Usage (Implicit)

  • VUID-vkGetPhysicalDeviceRefreshableObjectTypesKHR-physicalDevice-parameter
    physicalDevice must be a valid VkPhysicalDevice handle

  • VUID-vkGetPhysicalDeviceRefreshableObjectTypesKHR-pRefreshableObjectTypeCount-parameter
    pRefreshableObjectTypeCount must be a valid pointer to a uint32_t value

  • VUID-vkGetPhysicalDeviceRefreshableObjectTypesKHR-pRefreshableObjectTypes-parameter
    If the value referenced by pRefreshableObjectTypeCount is not 0, and pRefreshableObjectTypes is not NULL, pRefreshableObjectTypes must be a valid pointer to an array of pRefreshableObjectTypeCount VkObjectType values

Return Codes
On success, this command returns

  • VK_SUCCESS

  • VK_INCOMPLETE

This command does not return any failure codes

See Also

VK_KHR_object_refresh, VkObjectType, VkPhysicalDevice

Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0