VKCREATEBUFFERVIEW(3)

NAME
vkCreateBufferView - Create a new buffer view object.

C SPECIFICATION

    VkResult vkCreateBufferView(
        VkDevice                                    device,
        const VkBufferViewCreateInfo*               pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkBufferView*                               pView);

PARAMETERS

device
    The device with which to create the buffer view.

pCreateInfo
    A pointer to a structure containing information to be placed in the object.

pView
    A pointer to a variable which will receive the handle to the new object.

DESCRIPTION

vkCreateBufferView creates a new buffer view using the information contained in pCreateInfo and the device specified in device. Upon success, a handle to the new view object is deposited in the variable pointed to by pView. pCreateInfo should point to an instance of the VkBufferViewCreateInfo structure, the definition of which is:

    typedef struct VkBufferViewCreateInfo {
        VkStructureType            sType;
        const void*                pNext;
        VkBufferViewCreateFlags    flags;
        VkBuffer                   buffer;
        VkFormat                   format;
        VkDeviceSize               offset;
        VkDeviceSize               range;
    } VkBufferViewCreateInfo;

VALID USAGE

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkBufferViewCreateInfo structure

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

    • pView must be a pointer to a VkBufferView handle

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

vkCreateBufferView

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.