VKQUEUEPRESENTKHR(3)

NAME
vkQueuePresentKHR - Queue an image for presentation

C SPECIFICATION

After queueing all rendering commands and transitioning the image to the correct layout, to queue an image for presentation, call:

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

PARAMETERS

    • queue is a queue that is capable of presentation to the target surface’s platform on the same device as the image’s swapchain.

    • pPresentInfo is a pointer to an instance of the VkPresentInfoKHR structure specifying the parameters of the presentation.

DESCRIPTION

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

    • If more than one member of pSwapchains was created from a display surface, all display surfaces referenced that refer to the same display must use the same display mode.

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

VkPresentInfoKHR, VkQueue

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.