VKDESTROYSWAPCHAINKH(3)

NAME
vkDestroySwapchainKHR - destroy a swapchain object.

C SPECIFICATION

    void vkDestroySwapchainKHR(
        VkDevice                                    device,
        VkSwapchainKHR                              swapchain,
        const VkAllocationCallbacks*                pAllocator);

PARAMETERS

device
    The VkDevice associated with the swapchain.

pSwapchain
    The swapchain to destroy.

pAllocator
    The allocator used for host memory allocated for the swapchain object.

DESCRIPTION

vkDestroySwapchainKHR destroys a swapchain.

VALID USAGE

    • device must be a valid VkDevice handle

    • If swapchain is not VK_NULL_HANDLE, swapchain must be a valid VkSwapchainKHR handle

    • If pAllocator is not NULL, pAllocator must be a pointer to a valid VkAllocationCallbacks structure

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

    • All uses of presentable images acquired from swapchain must have completed execution

    • If VkAllocationCallbacks were provided when swapchain was created, a compatible set of callbacks must be provided here

    • If no VkAllocationCallbacks were provided when swapchain was created, pAllocator must be NULL

HOST SYNCHRONIZATION

    • Host access to swapchain must be externally synchronized

SEE ALSO

vkCreateSwapchainKHR, vkCreateSharedSwapchainsKHR, vkGetSwapchainImagesKHR, vkAcquireNextImageKHR, vkQueuePresentKHR

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.