VKGETSWAPCHAINIMAGES(3)

NAME
vkGetSwapchainImagesKHR - obtain the array of presentable images associated with a swapchain.

C SPECIFICATION

    VkResult vkGetSwapchainImagesKHR(
        VkDevice                                    device,
        VkSwapchainKHR                              swapchain,
        uint32_t*                                   pSwapchainImageCount,
        VkImage*                                    pSwapchainImages);

PARAMETERS

device
    The VkDevice associated with swapchain.

swapchain
    The swwapchain.

pSwapchainImageCount
    The number of elements in the array pointed by pSwapchainImages.

pSwapchainImages
    The returned array of images.

DESCRIPTION

vkGetSwapchainImagesKHR gets the array of images from a swapchain.

VALID USAGE

    • device must be a valid VkDevice handle

    • swapchain must be a valid VkSwapchainKHR handle

    • pSwapchainImageCount must be a pointer to a uint32_t value

    • If the value referenced by pSwapchainImageCount is not 0, and pSwapchainImages is not NULL, pSwapchainImages must be a pointer to an array of pSwapchainImageCount VkImage handles

    • Each of swapchain and device must have been created, allocated or retrieved from the same VkInstance

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

SEE ALSO

vkCreateSwapchainKHR, vkCreateSharedSwapchainsKHR, vkAcquireNextImageKHR, vkDestroySwapchainKHR

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.