Vulkan.Core10.Buffer

vkCreateBuffer - Create a new buffer object

Description

Implementations may fail to create a buffer if the effective usage includes the BUFFER_USAGE_2_DESCRIPTOR_HEAP_BIT_EXT flag, and size is greater than the maximum of maxResourceHeapSize and maxSamplerHeapSize. If this happens, ERROR_OUT_OF_DEVICE_MEMORY will be returned.

This is an issue identified with VK_EXT_descriptor_heap, which we plan to tighten up for the KHR version. Applications using VK_EXT_descriptor_heap may wish to avoid suballocating heaps from the same buffer, instead creating one buffer per heap, to avoid situations where this causes issues.

Valid Usage

• device must support at least one queue family with one of the VK_QUEUE_VIDEO_ENCODE_BIT_KHR, VK_QUEUE_VIDEO_DECODE_BIT_KHR, QUEUE_SPARSE_BINDING_BIT, QUEUE_TRANSFER_BIT, QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT capabilities

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

• If the flags member of pCreateInfo includes BUFFER_CREATE_SPARSE_BINDING_BIT, the extendedSparseAddressSpace feature is enabled, and the usage member of pCreateInfo contains bits not in PhysicalDeviceExtendedSparseAddressSpacePropertiesNV::extendedSparseBufferUsageFlags, creating this Buffer must not cause the total required sparse memory for all currently valid sparse resources on the device, excluding Buffer created with usage member of pCreateInfo containing bits in PhysicalDeviceExtendedSparseAddressSpacePropertiesNV::extendedSparseBufferUsageFlags and Image created with usage member of pCreateInfo containing bits in PhysicalDeviceExtendedSparseAddressSpacePropertiesNV::extendedSparseImageUsageFlags, to exceed PhysicalDeviceLimits::sparseAddressSpaceSize

• If the flags member of pCreateInfo includes BUFFER_CREATE_SPARSE_BINDING_BIT and the extendedSparseAddressSpace feature is enabled, creating this Buffer must not cause the total required sparse memory for all currently valid sparse resources on the device to exceed PhysicalDeviceExtendedSparseAddressSpacePropertiesNV::extendedSparseAddressSpaceSize

• If using the Buffer for an import operation from a BufferCollectionFUCHSIA where a BufferCollectionBufferCreateInfoFUCHSIA has been chained to pNext, pCreateInfo must match the BufferConstraintsInfoFUCHSIA::createInfo used when setting the constraints on the buffer collection with setBufferCollectionBufferConstraintsFUCHSIA

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

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, 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

VK_VERSION_1_0, AllocationCallbacks, Buffer, Device

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

Description

usage defines the effective usage flags for the buffer. If the pNext chain includes a BufferUsageFlags2CreateInfo structure, BufferUsageFlags2CreateInfo::usage from that structure is used as the effective usage instead of usage from this structure.

Valid Usage

• If the pNext chain does not include a BufferUsageFlags2CreateInfo structure, usage must be a valid combination of BufferUsageFlagBits values

• If the pNext chain does not include a BufferUsageFlags2CreateInfo structure, usage must not be 0

• 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 the maintenance11 feature is enabled and sharingMode is SHARING_MODE_CONCURRENT, then queueFamilyIndexCount must be greater than 0

• If the maintenance11 feature is not enabled and sharingMode is SHARING_MODE_CONCURRENT, then 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 getPhysicalDeviceQueueFamilyProperties2 or getPhysicalDeviceQueueFamilyProperties for the physicalDevice that was used to create device

• If the sparseBinding feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_BINDING_BIT

• If the sparseResidencyBuffer feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_RESIDENCY_BIT

• If the sparseResidencyAliased 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 protectedMemory 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 feature or the bufferDeviceAddressCaptureReplay feature must be enabled

• If usage includes VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR or VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR, and flags does not include VK_BUFFER_CREATE_VIDEO_PROFILE_INDEPENDENT_BIT_KHR, then the pNext chain must include a VkVideoProfileListInfoKHR structure with profileCount greater than 0 and pProfiles including at least one VkVideoProfileInfoKHR structure with a videoCodecOperation member specifying a decode operation

• If usage includes VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR or VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR, and flags does not include VK_BUFFER_CREATE_VIDEO_PROFILE_INDEPENDENT_BIT_KHR, then the pNext chain must include a VkVideoProfileListInfoKHR structure with profileCount greater than 0 and pProfiles including at least one VkVideoProfileInfoKHR structure with a videoCodecOperation member specifying an encode operation

• If flags includes VK_BUFFER_CREATE_VIDEO_PROFILE_INDEPENDENT_BIT_KHR, then videoMaintenance1 must be enabled

• If the pNext chain includes a VkVideoProfileListInfoKHR structure and for any element of its pProfiles member videoCodecOperation is VK_VIDEO_CODEC_OPERATION_DECODE_VP9_BIT_KHR, then the videoDecodeVP9 feature must be enabled

• If the pNext chain includes a VkVideoProfileListInfoKHR structure and for any element of its pProfiles member videoCodecOperation is VK_VIDEO_CODEC_OPERATION_ENCODE_AV1_BIT_KHR, then the videoEncodeAV1 feature must be enabled

• If the pNext chain includes a VkVideoEncodeProfileRgbConversionInfoVALVE structure, then the videoEncodeRgbConversion feature must be enabled

• size must be less than or equal to PhysicalDeviceMaintenance4Properties::maxBufferSize

• If usage includes BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT, creating this Buffer must not cause the total required space for all currently valid buffers using this flag on the device to exceed PhysicalDeviceDescriptorBufferPropertiesEXT::samplerDescriptorBufferAddressSpaceSize or PhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferAddressSpaceSize

• If usage includes BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT, creating this Buffer must not cause the total required space for all currently valid buffers using this flag on the device to exceed PhysicalDeviceDescriptorBufferPropertiesEXT::resourceDescriptorBufferAddressSpaceSize or PhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferAddressSpaceSize

• If flags includes BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT, the descriptorBufferCaptureReplay feature must be enabled

• If the pNext chain includes a OpaqueCaptureDescriptorDataCreateInfoEXT structure, flags must contain BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT

• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, the descriptorBufferPushDescriptors feature must be enabled

• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT ::bufferlessPushDescriptors must be FALSE

• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, usage must contain at least one of BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT or BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT

• If the tileMemoryHeap feature is not enabled, usage must not include BUFFER_USAGE_TILE_MEMORY_BIT_QCOM

• If usage includes BUFFER_USAGE_TILE_MEMORY_BIT_QCOM, then flags must not contain any of the following bits

  • BUFFER_CREATE_SPARSE_BINDING_BIT

  • BUFFER_CREATE_SPARSE_RESIDENCY_BIT

  • BUFFER_CREATE_SPARSE_ALIASED_BIT

  • BUFFER_CREATE_PROTECTED_BIT

  • BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT

  • BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT

  • VK_BUFFER_CREATE_VIDEO_PROFILE_INDEPENDENT_BIT_KHR

• If usage includes BUFFER_USAGE_TILE_MEMORY_BIT_QCOM, then only the following usages may be set:

  • BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT

  • BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT

  • BUFFER_USAGE_UNIFORM_BUFFER_BIT

  • BUFFER_USAGE_STORAGE_BUFFER_BIT

  • BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT

  • and if PhysicalDeviceTileMemoryHeapPropertiesQCOM::tileBufferTransfers is TRUE then additionally BUFFER_USAGE_TRANSFER_SRC_BIT or BUFFER_USAGE_TRANSFER_DST_BIT

• If flags includes BUFFER_CREATE_PROTECTED_BIT, then the effective usage must not contain bits other than

  • BUFFER_USAGE_TRANSFER_SRC_BIT

  • BUFFER_USAGE_TRANSFER_DST_BIT

  • BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT

  • BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT

  • BUFFER_USAGE_UNIFORM_BUFFER_BIT

  • BUFFER_USAGE_STORAGE_BUFFER_BIT

  • BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT

  • BUFFER_USAGE_2_VIDEO_DECODE_SRC_BIT_KHR

  • BUFFER_USAGE_2_VIDEO_ENCODE_DST_BIT_KHR

  • BUFFER_USAGE_2_DESCRIPTOR_HEAP_BIT_EXT

• If the protectedDescriptorHeaps property is not supported and the effective usage includes the BUFFER_USAGE_2_DESCRIPTOR_HEAP_BIT_EXT flag, flags must not include the BUFFER_CREATE_PROTECTED_BIT flag

• If the sparseDescriptorHeaps property is not supported and the effective usage includes the BUFFER_USAGE_2_DESCRIPTOR_HEAP_BIT_EXT flag, flags must not include any of the BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT flags

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 BufferCollectionBufferCreateInfoFUCHSIA, BufferDeviceAddressCreateInfoEXT, BufferOpaqueCaptureAddressCreateInfo, BufferUsageFlags2CreateInfo, DedicatedAllocationBufferCreateInfoNV, ExternalMemoryBufferCreateInfo, OpaqueCaptureDescriptorDataCreateInfoEXT, or VkVideoProfileListInfoKHR

• The sType value of each structure in the pNext chain must be unique

• flags must be a valid combination of BufferCreateFlagBits values

• sharingMode must be a valid SharingMode value

See Also

VK_VERSION_1_0, BufferConstraintsInfoFUCHSIA, BufferCreateFlags, BufferUsageFlags, DeviceBufferMemoryRequirements, DeviceSize, SharingMode, StructureType, createBuffer

VkBuffer - Opaque handle to a buffer object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, AccelerationStructureCreateInfoKHR, BindBufferMemoryInfo, BufferCaptureDescriptorDataInfoEXT, BufferDeviceAddressInfo, BufferMemoryBarrier, BufferMemoryBarrier2, BufferMemoryRequirementsInfo2, BufferViewCreateInfo, ConditionalRenderingBeginInfoEXT, CopyBufferInfo2, CopyBufferToImageInfo2, CopyImageToBufferInfo2, DedicatedAllocationMemoryAllocateInfoNV, DescriptorBufferBindingPushDescriptorBufferHandleEXT, DescriptorBufferInfo, FrameBoundaryEXT, GeneratedCommandsInfoNV, GeometryAABBNV, GeometryTrianglesNV, IndirectCommandsStreamNV, MemoryDedicatedAllocateInfo, MicromapCreateInfoEXT, SparseBufferMemoryBindInfo, VkVideoDecodeInfoKHR, VkVideoEncodeInfoKHR, bindBufferMemory, cmdBeginTransformFeedbackEXT, cmdBindIndexBuffer, cmdBindIndexBuffer2, cmdBindIndexBuffer2, cmdBindTransformFeedbackBuffersEXT, cmdBindVertexBuffers, cmdBindVertexBuffers2, cmdBindVertexBuffers2, cmdBuildAccelerationStructureNV, cmdCopyBuffer, cmdCopyBufferToImage, cmdCopyImageToBuffer, cmdCopyQueryPoolResults, cmdDispatchIndirect, cmdDrawClusterIndirectHUAWEI, cmdDrawIndexedIndirect, cmdDrawIndexedIndirectCount, cmdDrawIndexedIndirectCount, cmdDrawIndexedIndirectCount, cmdDrawIndirect, cmdDrawIndirectByteCountEXT, cmdDrawIndirectCount, cmdDrawIndirectCount, cmdDrawIndirectCount, cmdDrawMeshTasksIndirectCountEXT, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectEXT, cmdDrawMeshTasksIndirectNV, cmdEndTransformFeedbackEXT, cmdFillBuffer, cmdTraceRaysNV, cmdUpdateBuffer, cmdWriteBufferMarker2AMD, cmdWriteBufferMarkerAMD, createBuffer, destroyBuffer, getBufferMemoryRequirements

VkSharingMode - Buffer and image sharing modes

Description

• SHARING_MODE_EXCLUSIVE specifies that access to any range or image subresource of the object will be exclusive to a single queue family at a time.

• SHARING_MODE_CONCURRENT specifies that concurrent access to any range or image subresource of the object from multiple queue families is supported.

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, unless the maintenance9 feature is enabled, the application must perform a queue family ownership transfer if it wishes to make the memory contents of a range or image subresource accessible to a different queue family. SHARING_MODE_EXCLUSIVE resources that are already owned by a queue family may be acquired by a different queue family without a queue family ownership transfer, but unless the maintenance9 feature is enabled, their contents become undefined.

If the maintenance9 feature is enabled, the contents of buffer resources, and of linear image resources (i.e., those created with tiling set to IMAGE_TILING_LINEAR) are always preserved when they are implicitly acquired by a different queue family on the same logical device (i.e., neither queue family is QUEUE_FAMILY_FOREIGN_EXT or QUEUE_FAMILY_EXTERNAL). This means that whenever the maintenance9 feature is enabled, explicit queue family ownership transfers of buffer and linear image resources between different queue families on the same logical device are optional.

Additionally, if the maintenance9 feature is enabled, the contents of some optimal image resources (i.e., those created with IMAGE_TILING_OPTIMAL) are always preserved when they are implicitly acquired by a different queue family on the same logical device (i.e., neither queue family is QUEUE_FAMILY_FOREIGN_EXT or QUEUE_FAMILY_EXTERNAL). This applies only to optimal images that are being implicitly acquired by a queue family whose index bit is set in the current queue family’s QueueFamilyOwnershipTransferPropertiesKHR::optimalImageTransferToQueueFamilies, and that were created without any of the following bits set in usage:

• IMAGE_USAGE_COLOR_ATTACHMENT_BIT

• IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT

• IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT

• IMAGE_USAGE_INPUT_ATTACHMENT_BIT

• IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT

• IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

This means that whenever the maintenance9 feature is enabled, explicit queue family ownership transfers of such image resources between such combinations of queue families are optional. For all other optimal images and/or combinations of queue families, the application must still perform an explicit queue family ownership transfer if it wishes to make the memory contents of an optimal image subresource already owned by a queue family accessible to a different queue family.

Applications are allowed to perform explicit queue family ownership transfers in circumstances where they are not required, but there is no functional nor performance advantage in doing so. Performing explicit transfers in such cases remains supported for backward compatibility and is not recommended for new applications.

Before being used on the first queue, images still require a layout transition from these layouts:

• IMAGE_LAYOUT_UNDEFINED

• IMAGE_LAYOUT_PREINITIALIZED

• IMAGE_LAYOUT_ZERO_INITIALIZED_EXT

A queue family can take ownership of an image subresource, tensor 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, tensor subresources of tensor objects, 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

VK_VERSION_1_0, BufferCreateInfo, ImageCreateInfo, PhysicalDeviceImageDrmFormatModifierInfoEXT, SwapchainCreateInfoKHR, TensorCreateInfoARM

VkBufferUsageFlagBits - Bitmask specifying allowed usage of a buffer

Description

• BUFFER_USAGE_TRANSFER_SRC_BIT specifies that the buffer can be used as the source of a transfer command (see the definition of https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#synchronization-pipeline-stages-transfer).

• BUFFER_USAGE_TRANSFER_DST_BIT specifies that the buffer can be used as the destination of a transfer command.

• BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT specifies that the buffer can be used to create a BufferView suitable for occupying a DescriptorSet slot of type DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER.

• BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT specifies that the buffer can be used to create a BufferView suitable for occupying a DescriptorSet slot of type DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER.

• BUFFER_USAGE_UNIFORM_BUFFER_BIT specifies that the buffer can be used in a DescriptorBufferInfo suitable for occupying a DescriptorSet slot either of type DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC.

• BUFFER_USAGE_STORAGE_BUFFER_BIT specifies that the buffer can be used in a DescriptorBufferInfo suitable for occupying a DescriptorSet slot either of type DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC.

• BUFFER_USAGE_INDEX_BUFFER_BIT specifies that the buffer is suitable for passing as the buffer parameter to cmdBindIndexBuffer2 and cmdBindIndexBuffer.

• BUFFER_USAGE_VERTEX_BUFFER_BIT specifies that the buffer is suitable for passing as an element of the pBuffers array to cmdBindVertexBuffers.

• BUFFER_USAGE_INDIRECT_BUFFER_BIT specifies that the buffer is suitable for passing as the buffer parameter to cmdDrawIndirect, cmdDrawIndexedIndirect, cmdDrawMeshTasksIndirectNV, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectEXT, cmdDrawMeshTasksIndirectCountEXT, cmdDrawClusterIndirectHUAWEI, or cmdDispatchIndirect. It is also suitable for passing as the buffer member of IndirectCommandsStreamNV, or sequencesCountBuffer or sequencesIndexBuffer or preprocessedBuffer member of GeneratedCommandsInfoNV. It is also suitable for passing as the underlying buffer of either the preprocessAddress or sequenceCountAddress members of GeneratedCommandsInfoEXT.

• BUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT specifies that the buffer is suitable for passing as the buffer parameter to cmdBeginConditionalRenderingEXT.

• BUFFER_USAGE_TRANSFORM_FEEDBACK_BUFFER_BIT_EXT specifies that the buffer is suitable for using for binding as a transform feedback buffer with cmdBindTransformFeedbackBuffers2EXT or cmdBindTransformFeedbackBuffersEXT.

• BUFFER_USAGE_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT specifies that the buffer is suitable for using as a counter buffer with cmdBeginTransformFeedback2EXT, cmdEndTransformFeedback2EXT, cmdBeginTransformFeedbackEXT, and cmdEndTransformFeedbackEXT.

• BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT specifies that the buffer is suitable to contain sampler and combined image sampler descriptors when bound as a descriptor buffer. Buffers containing combined image sampler descriptors must also specify BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT.

• BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT specifies that the buffer is suitable to contain resource descriptors when bound as a descriptor buffer.

• BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT specifies that the buffer, when bound, can be used by the implementation to support push descriptors when using descriptor buffers.

• BUFFER_USAGE_MICROMAP_BUILD_INPUT_READ_ONLY_BIT_EXT specifies that when building a MicromapEXT, the buffer can be used as a read-only micromap build input, which includes the data and triangleArray parameters

• BUFFER_USAGE_MICROMAP_STORAGE_BIT_EXT specifies that the buffer can be used to create objects.

• BUFFER_USAGE_TILE_MEMORY_BIT_QCOM specifies that the buffer can be bound to DeviceMemory allocated from a MemoryHeap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property.

• BUFFER_USAGE_RAY_TRACING_BIT_NV specifies that the buffer is suitable for use in cmdTraceRaysNV.

• BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR specifies that the buffer is suitable for use as a Shader Binding Table.

• BUFFER_USAGE_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR specifies that the buffer is suitable for use as a read-only input to an acceleration structure build.

• BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR specifies that the buffer is suitable for storage space for a AccelerationStructureKHR.

• BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT specifies that the buffer can be used to retrieve a buffer device address via getBufferDeviceAddress and use that address to access the buffer’s memory from a shader.

• VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR specifies that the buffer can be used as the source video bitstream buffer in a video decode operation.

• VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR is reserved for future use.

• VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR specifies that the buffer can be used as the destination video bitstream buffer in a video encode operation.

• VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR is reserved for future use.

• BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX specifies that the buffer can be used for as scratch memory for execution graph dispatch.

• BUFFER_USAGE_DESCRIPTOR_HEAP_BIT_EXT specifies that the buffer can be used as a descriptor heap.

See Also

VK_VERSION_1_0, BufferUsageFlags

VkBufferCreateFlagBits - Bitmask specifying additional parameters of a buffer

Description

• BUFFER_CREATE_SPARSE_BINDING_BIT specifies that the buffer will be backed using sparse memory binding.

• BUFFER_CREATE_SPARSE_RESIDENCY_BIT specifies that the buffer can be partially backed using sparse memory binding. Buffers created with this flag must also be created with the BUFFER_CREATE_SPARSE_BINDING_BIT flag.

• BUFFER_CREATE_SPARSE_ALIASED_BIT specifies that the buffer will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another buffer (or another portion of the same buffer). Buffers created with this flag must also be created with the BUFFER_CREATE_SPARSE_BINDING_BIT flag.

• BUFFER_CREATE_PROTECTED_BIT specifies that the buffer is a protected buffer.

• BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT specifies that the buffer’s address can be saved and reused on a subsequent run (e.g. for trace capture and replay), see BufferOpaqueCaptureAddressCreateInfo for more detail.

• BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT specifies that the buffer can be used with descriptor buffers when capturing and replaying (e.g. for trace capture and replay), see OpaqueCaptureDescriptorDataCreateInfoEXT for more detail.

• VK_BUFFER_CREATE_VIDEO_PROFILE_INDEPENDENT_BIT_KHR specifies that the buffer can be used in video coding operations without having to specify at buffer creation time the set of video profiles the buffer will be used with.

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

See Also

VK_VERSION_1_0, BufferCreateFlags