vkCreateBuffer - Create a new buffer object

Valid Usage

• If the flags member of pCreateInfo includes BUFFER_CREATE_SPARSE_BINDING_BIT, creating this Buffer must not cause the total required sparse memory for all currently valid sparse resources on the device to exceed PhysicalDeviceLimits::sparseAddressSpaceSize

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid BufferCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pBuffer must be a valid pointer to a Buffer handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

See Also

AllocationCallbacks, Buffer, BufferCreateInfo, Device

A convenience wrapper to make a compatible pair of calls to createBuffer and destroyBuffer

To ensure that destroyBuffer is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyBuffer - Destroy a buffer object

Valid Usage

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

• If AllocationCallbacks were provided when buffer was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when buffer was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If buffer is not NULL_HANDLE, buffer must be a valid Buffer handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If buffer is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to buffer must be externally synchronized

See Also

AllocationCallbacks, Buffer, Device

VkBufferCreateInfo - Structure specifying the parameters of a newly created buffer object

Valid Usage

• size must be greater than 0

• If sharingMode is SHARING_MODE_CONCURRENT, pQueueFamilyIndices must be a valid pointer to an array of queueFamilyIndexCount uint32_t values
• If sharingMode is SHARING_MODE_CONCURRENT, queueFamilyIndexCount must be greater than 1
• If sharingMode is SHARING_MODE_CONCURRENT, each element of pQueueFamilyIndices must be unique and must be less than pQueueFamilyPropertyCount returned by either getPhysicalDeviceQueueFamilyProperties or getPhysicalDeviceQueueFamilyProperties2 for the physicalDevice that was used to create device
• If the sparse bindings feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_BINDING_BIT
• If the sparse buffer residency feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_RESIDENCY_BIT
• If the sparse aliased residency feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_ALIASED_BIT
• If flags contains BUFFER_CREATE_SPARSE_RESIDENCY_BIT or BUFFER_CREATE_SPARSE_ALIASED_BIT, it must also contain BUFFER_CREATE_SPARSE_BINDING_BIT
• If the pNext chain includes a ExternalMemoryBufferCreateInfo structure, its handleTypes member must only contain bits that are also in ExternalBufferProperties::externalMemoryProperties.compatibleHandleTypes, as returned by getPhysicalDeviceExternalBufferProperties with pExternalBufferInfo->handleType equal to any one of the handle types specified in ExternalMemoryBufferCreateInfo::handleTypes
• If the protected memory feature is not enabled, flags must not contain BUFFER_CREATE_PROTECTED_BIT
• If any of the bits BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT are set, BUFFER_CREATE_PROTECTED_BIT must not also be set
• If the pNext chain includes a DedicatedAllocationBufferCreateInfoNV structure, and the dedicatedAllocation member of the chained structure is TRUE, then flags must not include BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT
• If BufferDeviceAddressCreateInfoEXT::deviceAddress is not zero, flags must include BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT
• If BufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress is not zero, flags must include BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT
• If flags includes BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT, the bufferDeviceAddressCaptureReplay or ::bufferDeviceAddressCaptureReplay feature must be enabled

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of BufferDeviceAddressCreateInfoEXT, BufferOpaqueCaptureAddressCreateInfo, DedicatedAllocationBufferCreateInfoNV, or ExternalMemoryBufferCreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of BufferCreateFlagBits values
• usage must be a valid combination of BufferUsageFlagBits values
• usage must not be 0
• sharingMode must be a valid SharingMode value

See Also

BufferCreateFlags, BufferUsageFlags, DeviceSize, SharingMode, StructureType, createBuffer

VkBuffer - Opaque handle to a buffer object

See Also

AccelerationStructureCreateInfoKHR, BindBufferMemoryInfo, BufferDeviceAddressInfo, BufferMemoryBarrier, BufferMemoryRequirementsInfo2, BufferViewCreateInfo, ConditionalRenderingBeginInfoEXT, CopyBufferInfo2KHR, CopyBufferToImageInfo2KHR, CopyImageToBufferInfo2KHR, DedicatedAllocationMemoryAllocateInfoNV, DescriptorBufferInfo, GeneratedCommandsInfoNV, GeometryAABBNV, GeometryTrianglesNV, IndirectCommandsStreamNV, MemoryDedicatedAllocateInfo, SparseBufferMemoryBindInfo, bindBufferMemory, cmdBeginTransformFeedbackEXT, cmdBindIndexBuffer, cmdBindTransformFeedbackBuffersEXT, cmdBindVertexBuffers, cmdBindVertexBuffers2EXT, cmdBuildAccelerationStructureNV, cmdCopyBuffer, cmdCopyBufferToImage, cmdCopyImageToBuffer, cmdCopyQueryPoolResults, cmdDispatchIndirect, cmdDrawIndexedIndirect, cmdDrawIndexedIndirectCount, cmdDrawIndexedIndirectCountAMD, cmdDrawIndexedIndirectCountKHR, cmdDrawIndirect, cmdDrawIndirectByteCountEXT, cmdDrawIndirectCount, cmdDrawIndirectCountAMD, cmdDrawIndirectCountKHR, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectNV, cmdEndTransformFeedbackEXT, cmdFillBuffer, cmdTraceRaysNV, cmdUpdateBuffer, cmdWriteBufferMarkerAMD, createBuffer, destroyBuffer, getBufferMemoryRequirements

VkSharingMode - Buffer and image sharing modes

Description

Note

SHARING_MODE_CONCURRENT may result in lower performance access to the buffer or image than SHARING_MODE_EXCLUSIVE.

Ranges of buffers and image subresources of image objects created using SHARING_MODE_EXCLUSIVE must only be accessed by queues in the queue family that has ownership of the resource. Upon creation, such resources are not owned by any queue family; ownership is implicitly acquired upon first use within a queue. Once a resource using SHARING_MODE_EXCLUSIVE is owned by some queue family, the application must perform a queue family ownership transfer to make the memory contents of a range or image subresource accessible to a different queue family.

Note

Images still require a layout transition from IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED before being used on the first queue.

A queue family can take ownership of an image subresource or buffer range of a resource created with SHARING_MODE_EXCLUSIVE, without an ownership transfer, in the same way as for a resource that was just created; however, taking ownership in this way has the effect that the contents of the image subresource or buffer range are undefined.

Ranges of buffers and image subresources of image objects created using SHARING_MODE_CONCURRENT must only be accessed by queues from the queue families specified through the queueFamilyIndexCount and pQueueFamilyIndices members of the corresponding create info structures.

See Also

BufferCreateInfo, ImageCreateInfo, PhysicalDeviceImageDrmFormatModifierInfoEXT, SwapchainCreateInfoKHR

VkBufferUsageFlagBits - Bitmask specifying allowed usage of a buffer

See Also

BufferUsageFlags

VkBufferCreateFlagBits - Bitmask specifying additional parameters of a buffer

Description

See Sparse Resource Features and Physical Device Features for details of the sparse memory features supported on a device.

See Also

BufferCreateFlags