VKDESTROYBUFFER(3)

NAME
vkDestroyBuffer - Destroy a buffer object

C SPECIFICATION

    void vkDestroyBuffer(
        VkDevice                                    device,
        VkBuffer                                    buffer,
        const VkAllocationCallbacks*                pAllocator);

PARAMETERS

device
    Logical device which owns the object.

buffer
    The handle of the buffer object to destroy.

DESCRIPTION

vkDestroyBuffer destroys the buffer object whose handle is specified in buffer. buffer must be a valid handle to buffer object created through a successful call to vkCreateBuffer on device. Attempts to destroy VK_NULL_HANDLE are silently ignored. After a buffer object has been destroyed, its handle becomes invalid and must not be accessed again. Furthermore, any views of the buffer previously created through calls to vkCreateBufferView on the specified buffer also become invalid and should be destroyed before the parent buffer.

VALID USAGE

    • device must be a valid VkDevice handle

    • If buffer is not VK_NULL_HANDLE, buffer must be a valid VkBuffer handle

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

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

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

    • All submitted commands that refer to buffer, either directly or via a VkBufferView, must have completed execution

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

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

HOST SYNCHRONIZATION

    • Host access to buffer must be externally synchronized

SEE ALSO

vkCreateBuffer

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.