Vulkan.Core10.MemoryManagement

vkGetBufferMemoryRequirements - Returns the memory requirements for specified Vulkan object

Valid Usage (Implicit)

See Also

VK_VERSION_1_0, Buffer, Device, MemoryRequirements

vkBindBufferMemory - Bind device memory to a buffer object

Description

bindBufferMemory is equivalent to passing the same parameters through BindBufferMemoryInfo to bindBufferMemory2.

Valid Usage

• buffer must not have been bound to a memory object

• buffer must not have been created with any sparse memory binding flags

• memoryOffset must be less than the size of memory

• memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the MemoryRequirements structure returned from a call to getBufferMemoryRequirements with buffer

• If memory was not allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, memoryOffset must be an integer multiple of the alignment member of the MemoryRequirements structure returned from a call to getBufferMemoryRequirements with buffer

• If memory was allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, memoryOffset must be an integer multiple of the alignment member of the TileMemoryRequirementsQCOM structure returned from a call to getBufferMemoryRequirements with buffer

• If memory was not allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, size member of the MemoryRequirements structure returned from a call to getBufferMemoryRequirements with buffer must be less than or equal to the size of memory minus memoryOffset

• If memory was allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, size member of the TileMemoryRequirementsQCOM structure returned from a call to getBufferMemoryRequirements with buffer must be less than or equal to the size of memory minus memoryOffset

• If buffer requires a dedicated allocation (as reported by getBufferMemoryRequirements2 in MemoryDedicatedRequirements::requiresDedicatedAllocation for buffer), memory must have been allocated with MemoryDedicatedAllocateInfo::buffer equal to buffer

• If the MemoryAllocateInfo provided when memory was allocated included a MemoryDedicatedAllocateInfo structure in its pNext chain, and MemoryDedicatedAllocateInfo::buffer was not NULL_HANDLE, then buffer must equal MemoryDedicatedAllocateInfo::buffer, and memoryOffset must be zero

• If the MemoryAllocateInfo provided when memory was allocated included a MemoryDedicatedAllocateInfo structure in its pNext chain, MemoryDedicatedAllocateInfo::image must have been NULL_HANDLE

• If buffer was created with the BUFFER_CREATE_PROTECTED_BIT bit set, the buffer must be bound to a memory object allocated with a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT

• If buffer was created with the BUFFER_CREATE_PROTECTED_BIT bit not set, the buffer must not be bound to a memory object allocated with a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT

• If buffer was created with DedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to TRUE, memory must have been allocated with DedicatedAllocationMemoryAllocateInfoNV::buffer equal to a buffer handle created with identical creation parameters to buffer and memoryOffset must be zero

• If the VK_KHR_dedicated_allocation extension is not enabled, PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, and buffer was not created with DedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to TRUE, memory must not have been allocated dedicated for a specific buffer or image

• If the value of ExportMemoryAllocateInfo::handleTypes used to allocate memory is not 0, it must include at least one of the handles set in ExternalMemoryBufferCreateInfo::handleTypes when buffer was created

• If memory was allocated by a memory import operation, that is not ImportAndroidHardwareBufferInfoANDROID with a non-NULL buffer value, the external handle type of the imported memory must also have been set in ExternalMemoryBufferCreateInfo::handleTypes when buffer was created

• If memory was allocated with the ImportAndroidHardwareBufferInfoANDROID memory import operation with a non-NULL buffer value, EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID must also have been set in ExternalMemoryBufferCreateInfo::handleTypes when buffer was created

• If the PhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddress feature is enabled and buffer was created with the BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT usage flag set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT bit set

• If the PhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddressCaptureReplay feature is enabled and buffer was created with the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT bit set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT bit set

• If buffer was created with BufferCollectionBufferCreateInfoFUCHSIA chained to BufferCreateInfo::pNext, memory must be allocated with a ImportMemoryBufferCollectionFUCHSIA chained to MemoryAllocateInfo::pNext

• If the buffer was created with the BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT bit set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT bit set

• If the buffer was created with the BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT bit set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT bit set

• If the buffer was created with the BUFFER_USAGE_DESCRIPTOR_HEAP_BIT_EXT or BUFFER_USAGE_2_DESCRIPTOR_HEAP_BIT_EXT bit set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT bit set

Valid Usage (Implicit)

• device must be a valid Device handle

• buffer must be a valid Buffer handle

• memory must be a valid DeviceMemory handle

• buffer must have been created, allocated, or retrieved from device

• memory must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to buffer must be externally synchronized

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, Buffer, Device, DeviceMemory, DeviceSize

vkGetImageMemoryRequirements - Returns the memory requirements for specified Vulkan object

Valid Usage

• image must not have been created with the IMAGE_CREATE_DISJOINT_BIT flag set

• If image was created with the EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID external memory handle type, then image must be bound to memory

• If image was created with the EXTERNAL_MEMORY_HANDLE_TYPE_SCREEN_BUFFER_BIT_QNX external memory handle type, then image must be bound to memory

Valid Usage (Implicit)

• device must be a valid Device handle

• image must be a valid Image handle

• pMemoryRequirements must be a valid pointer to a MemoryRequirements structure

• image must have been created, allocated, or retrieved from device

See Also

VK_VERSION_1_0, Device, Image, MemoryRequirements

vkBindImageMemory - Bind device memory to an image object

Description

bindImageMemory is equivalent to passing the same parameters through BindImageMemoryInfo to bindImageMemory2.

Valid Usage

• image must not have been bound to a memory object

• image must not have been created with any sparse memory binding flags

• memoryOffset must be less than the size of memory

• If image requires a dedicated allocation (as reported by getImageMemoryRequirements2 in MemoryDedicatedRequirements::requiresDedicatedAllocation for image), memory must have been created with MemoryDedicatedAllocateInfo::image equal to image

• If the dedicatedAllocationImageAliasing feature is not enabled, and the MemoryAllocateInfo provided when memory was allocated included a MemoryDedicatedAllocateInfo structure in its pNext chain, and MemoryDedicatedAllocateInfo::image was not NULL_HANDLE, then image must equal MemoryDedicatedAllocateInfo::image and memoryOffset must be zero

• If the dedicatedAllocationImageAliasing feature is enabled, and the MemoryAllocateInfo provided when memory was allocated included a MemoryDedicatedAllocateInfo structure in its pNext chain, and MemoryDedicatedAllocateInfo::image was not NULL_HANDLE, then memoryOffset must be zero, and image must be either equal to MemoryDedicatedAllocateInfo::image or an image that was created using the same parameters in ImageCreateInfo, with the exception that extent and arrayLayers may differ subject to the following restrictions: every dimension in the extent parameter of the image being bound must be equal to or smaller than the original image for which the allocation was created; and the arrayLayers parameter of the image being bound must be equal to or smaller than the original image for which the allocation was created

• If the MemoryAllocateInfo provided when memory was allocated included a MemoryDedicatedAllocateInfo structure in its pNext chain, MemoryDedicatedAllocateInfo::buffer must have been NULL_HANDLE

• If image was created with the IMAGE_CREATE_PROTECTED_BIT bit set, the image must be bound to a memory object allocated with a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT

• If image was created with the IMAGE_CREATE_PROTECTED_BIT bit not set, the image must not be bound to a memory object created with a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT

• If image was created with DedicatedAllocationImageCreateInfoNV::dedicatedAllocation equal to TRUE, memory must have been created with DedicatedAllocationMemoryAllocateInfoNV::image equal to an image handle created with identical creation parameters to image and memoryOffset must be zero

• If the VK_KHR_dedicated_allocation extension is not enabled, PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, and image was not created with DedicatedAllocationImageCreateInfoNV::dedicatedAllocation equal to TRUE, memory must not have been allocated dedicated for a specific buffer or image

• If the value of ExportMemoryAllocateInfo::handleTypes used to allocate memory is not 0, it must include at least one of the handles set in ExternalMemoryImageCreateInfo::handleTypes when image was created

• If memory was created by a memory import operation, that is not ImportAndroidHardwareBufferInfoANDROID with a non-NULL buffer value, the external handle type of the imported memory must also have been set in ExternalMemoryImageCreateInfo::handleTypes when image was created

• If memory was created with the ImportAndroidHardwareBufferInfoANDROID memory import operation with a non-NULL buffer value, EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID must also have been set in ExternalMemoryImageCreateInfo::handleTypes when image was created

• If the image was created with the IMAGE_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_EXT bit set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT bit set

• If the image was created with the IMAGE_CREATE_DESCRIPTOR_HEAP_CAPTURE_REPLAY_BIT_EXT bit set, memory must have been allocated with the MEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT bit set

• image must not have been created with the IMAGE_CREATE_DISJOINT_BIT set

• memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the MemoryRequirements structure returned from a call to getImageMemoryRequirements with image

• If memory was not allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, memoryOffset must be an integer multiple of the alignment member of the MemoryRequirements structure returned from a call to getImageMemoryRequirements with image

• If memory was allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, memoryOffset must be an integer multiple of the alignment member of the TileMemoryRequirementsQCOM structure returned from a call to getImageMemoryRequirements2 with image

• If memory was not allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, size member of the MemoryRequirements structure returned from a call to getImageMemoryRequirements with image must be less than or equal to the size of memory minus memoryOffset

• If memory was allocated from a memory heap with the MEMORY_HEAP_TILE_MEMORY_BIT_QCOM property set, size member of the TileMemoryRequirementsQCOM structure returned from a call to getImageMemoryRequirements2 with image must be less than or equal to the size of memory minus memoryOffset

• If image was created with BufferCollectionImageCreateInfoFUCHSIA chained to ImageCreateInfo::pNext, memory must be allocated with a ImportMemoryBufferCollectionFUCHSIA chained to MemoryAllocateInfo::pNext

Valid Usage (Implicit)

• device must be a valid Device handle

• image must be a valid Image handle

• memory must be a valid DeviceMemory handle

• image must have been created, allocated, or retrieved from device

• memory must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to image must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, Device, DeviceMemory, DeviceSize, Image

VkMemoryRequirements - Structure specifying memory requirements

See Also

VK_VERSION_1_0, DeviceSize, MemoryRequirements2, VkVideoSessionMemoryRequirementsKHR, getBufferMemoryRequirements, getImageMemoryRequirements

VkDeviceMemory - Opaque handle to a device memory object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, BindAccelerationStructureMemoryInfoNV, BindBufferMemoryInfo, BindDataGraphPipelineSessionMemoryInfoARM, BindImageMemoryInfo, BindTensorMemoryInfoARM, VkBindVideoSessionMemoryInfoKHR, DeviceMemoryOpaqueCaptureAddressInfo, ExportMetalBufferInfoEXT, MappedMemoryRange, MemoryGetAndroidHardwareBufferInfoANDROID, MemoryGetFdInfoKHR, MemoryGetMetalHandleInfoEXT, VkMemoryGetNativeBufferInfoOHOS, MemoryGetRemoteAddressInfoNV, MemoryGetWin32HandleInfoKHR, MemoryGetZirconHandleInfoFUCHSIA, MemoryMapInfo, MemoryUnmapInfo, SparseImageMemoryBind, SparseMemoryBind, TileMemoryBindInfoQCOM, Win32KeyedMutexAcquireReleaseInfoKHR, Win32KeyedMutexAcquireReleaseInfoNV, allocateMemory, bindBufferMemory, bindImageMemory, freeMemory, getDeviceMemoryCommitment, getMemoryWin32HandleNV, mapMemory, setDeviceMemoryPriorityEXT, unmapMemory