Function Prototype
vkGetSwapchainStatusKHR
Get a swapchain's status
In order to query a swapchain’s status when rendering to a shared presentable image, call:
VkResult vkGetSwapchainStatusKHR(
VkDevice device,
VkSwapchainKHR swapchain);
pub fn get_swapchain_status_khr(
device: vk::Device,
swapchain: vk::SwapchainKHR,
) -> vk::Result;
deviceis the device associated withswapchain.swapchainis the swapchain to query.
Valid Usage (Implicit)
VUID-vkGetSwapchainStatusKHR-device-parameter
device must be a valid VkDevice handle
VUID-vkGetSwapchainStatusKHR-swapchain-parameter
swapchain must be a valid VkSwapchainKHR handle
VUID-vkGetSwapchainStatusKHR-swapchain-parent
swapchain must have been created, allocated, or retrieved from device
Host Synchronization
- Host access to
swapchainmust be externally synchronized
Type
Function Prototype
Return Values
VK_SUCCESS
VK_SUBOPTIMAL_KHR
VK_ERROR_OUT_OF_HOST_MEMORY
VK_ERROR_OUT_OF_DEVICE_MEMORY
VK_ERROR_DEVICE_LOST
VK_ERROR_OUT_OF_DATE_KHR
VK_ERROR_SURFACE_LOST_KHR
VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT
VK_ERROR_UNKNOWN
VK_ERROR_VALIDATION_FAILED