VKPRESENTINFOKHR(3)

NAME
VkPresentInfoKHR - Structure describing parameters of a queue presentation

C SPECIFICATION

The VkPresentInfoKHR structure is defined as:

    typedef struct VkPresentInfoKHR {
        VkStructureType          sType;
        const void*              pNext;
        uint32_t                 waitSemaphoreCount;
        const VkSemaphore*       pWaitSemaphores;
        uint32_t                 swapchainCount;
        const VkSwapchainKHR*    pSwapchains;
        const uint32_t*          pImageIndices;
        VkResult*                pResults;
    } VkPresentInfoKHR;

MEMBERS

    • sType is the type of this structure and must be VK_STRUCTURE_TYPE_PRESENT_INFO_KHR.

    • pNext is NULL or a pointer to an extension-specific structure.

    • waitSemaphoreCount is the number of semaphores to wait for before issuing the present request. The number may be zero.

    • pWaitSemaphores, if not VK_NULL_HANDLE, is an array of VkSemaphore objects with waitSemaphoreCount entries, and specifies the semaphores to wait for before issuing the present request.

    • swapchainCount is the number of swapchains being presented to by this command.

    • pSwapchains is an array of VkSwapchainKHR objects with swapchainCount entries. A given swapchain must not appear in this list more than once.

    • pImageIndices is an array of indices into the array of each swapchain’s presentable images, with swapchainCount entries. Each entry in this array identifies the image to present on the corresponding entry in the pSwapchains array.

    • pResults is an array of VkResult typed elements with swapchainCount entries. Applications that don’t need per-swapchain results can use NULL for pResults. If non-NULL, each entry in pResults will be set to the VkResult for presenting the swapchain corresponding to the same index in pSwapchains.

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_PRESENT_INFO_KHR

    • pNext must be NULL

    • If waitSemaphoreCount is not 0, and pWaitSemaphores is not NULL, pWaitSemaphores must be a pointer to an array of waitSemaphoreCount valid VkSemaphore handles

    • pSwapchains must be a pointer to an array of swapchainCount valid VkSwapchainKHR handles

    • pImageIndices must be a pointer to an array of swapchainCount uint32_t values

    • If pResults is not NULL, pResults must be a pointer to an array of swapchainCount VkResult values

    • swapchainCount must be greater than 0

    • Any given element of pImageIndices must be the index of a presentable image acquired from the swapchain specified by the corresponding element of the pSwapchains array

    • Any given element of VkSemaphore in pWaitSemaphores must refer to a prior signal of that VkSemaphore that will not be consumed by any other wait on that semaphore

SEE ALSO

VkResult, VkSemaphore, VkStructureType, VkSwapchainKHR, vkQueuePresentKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkPresentInfoKHR

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

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.