VKQUEUEPRESENTKHR(3)

NAME
vkQueuePresentKHR - queue an image for presentation.

C SPECIFICATION

    VkResult vkQueuePresentKHR(
        VkQueue                                     queue,
        const VkPresentInfoKHR*                     pPresentInfo);

PARAMETERS

queue
    A VkQueue that is capable of presentation to the target surface.

pPresentInfo
    A pointer to a VkPresentInfoKHR structure specifying the parameters of the presentation.

DESCRIPTION

vkQueuePresentKHR queues an image for presentation.

pPresentInfo is an instance of the VkPresentInfoKHR structure, the definition of which is:

    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;

VALID USAGE

    • queue must be a valid VkQueue handle

    • pPresentInfo must be a pointer to a valid VkPresentInfoKHR structure

    • Any given element of pSwapchains member of pPresentInfo must be a swapchain that is created for a surface for which presentation is supported from queue as determined using a call to vkGetPhysicalDeviceSurfaceSupportKHR

HOST SYNCHRONIZATION

    • Host access to queue must be externally synchronized

    • Host access to pPresentInfo.pWaitSemaphores[] must be externally synchronized

    • Host access to pPresentInfo.pSwapchains[] must be externally synchronized

COMMAND PROPERTIES
Command Buffer Levels | Render Pass Scope | Supported Queue Types
- | - | Any

RETURN CODES

On success, this command returns

        • VK_SUCCESS

        • VK_SUBOPTIMAL_KHR

On failure, this command returns

        • 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

SEE ALSO

vkGetPhysicalDeviceSurfacePresentModesKHR, vkAcquireNextImageKHR, vkCreateSwapchainKHR

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.