vkCreateBuffer - Create a new buffer object

Valid Usage

• 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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

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

If a BufferUsageFlags2CreateInfoKHR structure is present in the pNext chain, BufferUsageFlags2CreateInfoKHR::usage from that structure is used instead of usage from this structure.

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 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 or bufferDeviceAddressCaptureReplayEXT feature must be enabled
• If usage includes VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR or VK_BUFFER_USAGE_VIDEO_DECODE_DST_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, 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
• 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 pNext chain does not include a BufferUsageFlags2CreateInfoKHR structure, usage must be a valid combination of BufferUsageFlagBits values
• If the pNext chain does not include a BufferUsageFlags2CreateInfoKHR structure, usage must not be 0

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, BufferUsageFlags2CreateInfoKHR, DedicatedAllocationBufferCreateInfoNV, ExternalMemoryBufferCreateInfo, OpaqueCaptureDescriptorDataCreateInfoEXT, or VkVideoProfileListInfoKHR
• The sType value of each struct 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_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, cmdBindIndexBuffer2KHR, cmdBindTransformFeedbackBuffersEXT, cmdBindVertexBuffers, cmdBindVertexBuffers2, cmdBindVertexBuffers2EXT, cmdBuildAccelerationStructureNV, cmdCopyBuffer, cmdCopyBufferToImage, cmdCopyImageToBuffer, cmdCopyQueryPoolResults, cmdDispatchIndirect, cmdDrawClusterIndirectHUAWEI, cmdDrawIndexedIndirect, cmdDrawIndexedIndirectCount, cmdDrawIndexedIndirectCountAMD, cmdDrawIndexedIndirectCountKHR, cmdDrawIndirect, cmdDrawIndirectByteCountEXT, cmdDrawIndirectCount, cmdDrawIndirectCountAMD, cmdDrawIndirectCountKHR, cmdDrawMeshTasksIndirectCountEXT, cmdDrawMeshTasksIndirectCountNV, cmdDrawMeshTasksIndirectEXT, cmdDrawMeshTasksIndirectNV, cmdEndTransformFeedbackEXT, cmdFillBuffer, cmdTraceRaysNV, cmdUpdateBuffer, cmdWriteBufferMarker2AMD, 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

VK_VERSION_1_0, BufferCreateInfo, ImageCreateInfo, PhysicalDeviceImageDrmFormatModifierInfoEXT, SwapchainCreateInfoKHR

VkBufferUsageFlagBits - Bitmask specifying allowed usage of a buffer

See Also

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

VK_VERSION_1_0, BufferCreateFlags