C Specification
To obtain the array of presentable images associated with a swapchain, call:
VkResult vkGetSwapchainImagesKHR(
VkDevice device,
VkSwapchainKHR swapchain,
uint32_t* pSwapchainImageCount,
VkImage* pSwapchainImages);
Parameters
-
deviceis the device associated withswapchain. -
swapchainis the swapchain to query. -
pSwapchainImageCountis a pointer to an integer related to the number of presentable images available or queried, as described below. -
pSwapchainImagesis eitherNULLor a pointer to an array ofVkImagehandles.
Description
If pSwapchainImages is NULL, then the number of presentable images
for swapchain is returned in pSwapchainImageCount.
Otherwise, pSwapchainImageCount must point to a variable set by the
user to the number of elements in the pSwapchainImages array, and on
return the variable is overwritten with the number of structures actually
written to pSwapchainImages.
If the value of pSwapchainImageCount is less than the number of
presentable images for swapchain, at most pSwapchainImageCount
structures will be written.
If pSwapchainImageCount is smaller than the number of presentable
images for swapchain, VK_INCOMPLETE will be returned instead of
VK_SUCCESS to indicate that not all the available values were
returned.
See Also
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 (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.