VKDESTROYSURFACEKHR(3)

NAME
vkDestroySurfaceKHR - Destroy a VkSurfaceKHR object

C SPECIFICATION

To destroy a VkSurfaceKHR object, call:

    void vkDestroySurfaceKHR(
        VkInstance                                  instance,
        VkSurfaceKHR                                surface,
        const VkAllocationCallbacks*                pAllocator);

PARAMETERS

    • instance is the instance used to create the surface.

    • surface is the surface to destroy.

    • pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

DESCRIPTION

Destroying a VkSurfaceKHR merely severs the connection between Vulkan and the native surface, and doesn’t imply destroying the native surface, closing a window, or similar behavior.

VALID USAGE

    • instance must be a valid VkInstance handle

    • If surface is not VK_NULL_HANDLE, surface must be a valid VkSurfaceKHR handle

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

    • If surface is a valid handle, it must have been created, allocated, or retrieved from instance

    • All VkSwapchainKHR objects created for surface must have been destroyed prior to destroying surface

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

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

HOST SYNCHRONIZATION

    • Host access to surface must be externally synchronized

SEE ALSO

VkAllocationCallbacks, VkInstance, VkSurfaceKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.