VKRESULT

VkResult is the Vulkan API return type used by most Vulkan functions to report the outcome of an operation. It is defined as an enumeration (typically a 32‑bit signed integer) of status codes that can indicate success, non-fatal statuses, or errors.

The most common code is VK_SUCCESS, which indicates the operation completed without error. Other non-fatal statuses include VK_NOT_READY (the operation is not complete yet), VK_TIMEOUT, VK_EVENT_SET, VK_EVENT_RESET, VK_INCOMPLETE, and, in swapchain-related calls, VK_SUBOPTIMAL_KHR. These values allow programs to react to partial progress or non-ideal conditions without treating them as failures.

A range of negative values represents errors. Common examples include VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY, VK_ERROR_INITIALIZATION_FAILED, VK_ERROR_DEVICE_LOST, VK_ERROR_MEMORY_MAP_FAILED, VK_ERROR_LAYER_NOT_PRESENT, VK_ERROR_EXTENSION_NOT_PRESENT, VK_ERROR_FEATURE_NOT_PRESENT, VK_ERROR_INCOMPATIBLE_DRIVER, VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_FORMAT_NOT_SUPPORTED, and VK_ERROR_FRAGMENTED_POOL. Additional extension-specific codes exist, such as VK_ERROR_SURFACE_LOST_KHR and VK_ERROR_OUT_OF_DATE_KHR for surface and swapchain operations.

In practice, VkResult is returned by many Vulkan functions to indicate success or the specific reason for a failure. Applications typically check for VK_SUCCESS or switch on the value to handle different outcomes. The exact set of codes can evolve with Vulkan versions and extensions, so developers should consult the current Vulkan specification for a complete and updated list.

VkResult is defined by the Khronos Group as part of the Vulkan API and is used throughout the API to standardize error reporting and status feedback.