diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html
index a1aab0f..c60bdf0 100644
--- a/docs/html/allocation_annotation.html
+++ b/docs/html/allocation_annotation.html
@@ -84,9 +84,9 @@ Allocation user data
VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &allocCreateInfo, &buffer, &allocation,
nullptr);
-Definition: vk_mem_alloc.h:1003
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:1042
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
Definition: vk_mem_alloc.h:1009
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:1048
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
Represents single memory allocation.
@ VMA_MEMORY_USAGE_GPU_ONLY
Definition: vk_mem_alloc.h:845
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
MyBufferMetadata* pMetadata = (MyBufferMetadata*)allocInfo.
pUserData;
-
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1368
-
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:1417
+
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1374
+
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:1423
void vmaGetAllocationInfo(VmaAllocator allocator, VmaAllocation allocation, VmaAllocationInfo *pAllocationInfo)
Returns current information about specified allocation and atomically marks it as used in current fra...
It can also be changed using function vmaSetAllocationUserData().
Values of (non-zero) allocations' pUserData are printed in JSON report created by vmaBuildStatsString(), in hexadecimal form.
@@ -116,7 +116,7 @@ Allocation names
VkImage image;
vmaCreateImage(allocator, &imageInfo, &allocCreateInfo, &image, &allocation,
nullptr);
-VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1005
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1011
VkResult vmaCreateImage(VmaAllocator allocator, const VkImageCreateInfo *pImageCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkImage *pImage, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
Function similar to vmaCreateBuffer().
@ VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT
Definition: vk_mem_alloc.h:948
The value of pUserData pointer of the allocation will be different than the one you passed when setting allocation's name - pointing to a buffer managed internally that holds copy of the string.
diff --git a/docs/html/choosing_memory_type.html b/docs/html/choosing_memory_type.html
index fa841bf..06a56fc 100644
--- a/docs/html/choosing_memory_type.html
+++ b/docs/html/choosing_memory_type.html
@@ -93,8 +93,8 @@ Usage
VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &allocInfo, &buffer, &allocation,
nullptr);
-Definition: vk_mem_alloc.h:1003
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
Definition: vk_mem_alloc.h:1009
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
Represents single memory allocation.
@ VMA_MEMORY_USAGE_GPU_ONLY
Definition: vk_mem_alloc.h:845
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &allocInfo, &buffer, &allocation,
nullptr);
-VkMemoryPropertyFlags preferredFlags
Flags that preferably should be set in a memory type chosen for an allocation.
Definition: vk_mem_alloc.h:1021
VkMemoryPropertyFlags requiredFlags
Flags that must be set in a Memory Type chosen for an allocation.
Definition: vk_mem_alloc.h:1016
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1005
VkMemoryPropertyFlags preferredFlags
Flags that preferably should be set in a memory type chosen for an allocation.
Definition: vk_mem_alloc.h:1027
VkMemoryPropertyFlags requiredFlags
Flags that must be set in a Memory Type chosen for an allocation.
Definition: vk_mem_alloc.h:1022
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1011
@ VMA_ALLOCATION_CREATE_MAPPED_BIT
Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.
Definition: vk_mem_alloc.h:922
A memory type is chosen that has all the required flags and as many preferred flags set as possible.
If you use VmaAllocationCreateInfo::usage, it is just internally converted to a set of required and preferred flags.
@@ -127,7 +127,7 @@ Explicit memory types
VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &allocInfo, &buffer, &allocation,
nullptr);
-uint32_t memoryTypeBits
Bitmask containing one bit set for every memory type acceptable for this allocation.
Definition: vk_mem_alloc.h:1029
uint32_t memoryTypeBits
Bitmask containing one bit set for every memory type acceptable for this allocation.
Definition: vk_mem_alloc.h:1035
Custom memory pools
If you allocate from custom memory pool, all the ways of specifying memory requirements described above are not applicable and the aforementioned members of VmaAllocationCreateInfo structure are ignored. Memory type is selected explicitly when creating the pool and then used to make all the allocations from that pool. For further details, see Custom memory pools.
diff --git a/docs/html/custom_memory_pools.html b/docs/html/custom_memory_pools.html
index dd83c24..84a6dd7 100644
--- a/docs/html/custom_memory_pools.html
+++ b/docs/html/custom_memory_pools.html
@@ -106,13 +106,13 @@ $(function() {
vmaCreateBuffer(allocator, &bufCreateInfo, &allocCreateInfo, &buf, &alloc, &allocInfo);
-Definition: vk_mem_alloc.h:1003
VmaPool pool
Pool that this allocation should be created in.
Definition: vk_mem_alloc.h:1035
Definition: vk_mem_alloc.h:1009
VmaPool pool
Pool that this allocation should be created in.
Definition: vk_mem_alloc.h:1041
Represents single memory allocation.
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1368
Describes parameter of created VmaPool.
Definition: vk_mem_alloc.h:1169
uint32_t memoryTypeIndex
Vulkan memory type index to allocate this pool from.
Definition: vk_mem_alloc.h:1172
size_t maxBlockCount
Maximum number of blocks that can be allocated in this pool. Optional.
Definition: vk_mem_alloc.h:1197
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1374
Describes parameter of created VmaPool.
Definition: vk_mem_alloc.h:1175
uint32_t memoryTypeIndex
Vulkan memory type index to allocate this pool from.
Definition: vk_mem_alloc.h:1178
size_t maxBlockCount
Maximum number of blocks that can be allocated in this pool. Optional.
Definition: vk_mem_alloc.h:1203
Represents custom memory pool.
VkResult vmaCreatePool(VmaAllocator allocator, const VmaPoolCreateInfo *pCreateInfo, VmaPool *pPool)
Allocates Vulkan device memory and creates VmaPool object.
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
@ VMA_MEMORY_USAGE_GPU_ONLY
Definition: vk_mem_alloc.h:845
VkResult vmaFindMemoryTypeIndexForBufferInfo(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, uint32_t *pMemoryTypeIndex)
Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.
When creating buffers/images allocated in that pool, provide following parameters:
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index a2ddd3a..53d59a8 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -129,15 +129,15 @@ Defragmenting CPU memory
}
}
-Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1368
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1374
Represents main object of this library initialized.
Represents Opaque object that represents started defragmentation process.
Parameters for defragmentation.
Definition: vk_mem_alloc.h:1785
uint32_t allocationCount
Number of allocations in pAllocations array.
Definition: vk_mem_alloc.h:1791
VkBool32 * pAllocationsChanged
Optional, output. Pointer to array that will be filled with information whether the allocation at cer...
Definition: vk_mem_alloc.h:1806
uint32_t maxCpuAllocationsToMove
Maximum number of allocations that can be moved to a different place using transfers on CPU side,...
Definition: vk_mem_alloc.h:1835
const VmaAllocation * pAllocations
Pointer to array of allocations that can be defragmented.
Definition: vk_mem_alloc.h:1800
VkDeviceSize maxCpuBytesToMove
Maximum total numbers of bytes that can be copied while moving allocations to different places using ...
Definition: vk_mem_alloc.h:1830
Parameters for defragmentation.
Definition: vk_mem_alloc.h:1791
uint32_t allocationCount
Number of allocations in pAllocations array.
Definition: vk_mem_alloc.h:1797
VkBool32 * pAllocationsChanged
Optional, output. Pointer to array that will be filled with information whether the allocation at cer...
Definition: vk_mem_alloc.h:1812
uint32_t maxCpuAllocationsToMove
Maximum number of allocations that can be moved to a different place using transfers on CPU side,...
Definition: vk_mem_alloc.h:1841
const VmaAllocation * pAllocations
Pointer to array of allocations that can be defragmented.
Definition: vk_mem_alloc.h:1806
VkDeviceSize maxCpuBytesToMove
Maximum total numbers of bytes that can be copied while moving allocations to different places using ...
Definition: vk_mem_alloc.h:1836
VkResult vmaDefragmentationBegin(VmaAllocator allocator, const VmaDefragmentationInfo2 *pInfo, VmaDefragmentationStats *pStats, VmaDefragmentationContext *pContext)
Begins defragmentation process.
VkResult vmaBindBufferMemory(VmaAllocator allocator, VmaAllocation allocation, VkBuffer buffer)
Binds buffer to allocation.
void vmaGetAllocationInfo(VmaAllocator allocator, VmaAllocation allocation, VmaAllocationInfo *pAllocationInfo)
Returns current information about specified allocation and atomically marks it as used in current fra...
}
}
-uint32_t maxGpuAllocationsToMove
Maximum number of allocations that can be moved to a different place using transfers on GPU side,...
Definition: vk_mem_alloc.h:1845
VkDeviceSize maxGpuBytesToMove
Maximum total numbers of bytes that can be copied while moving allocations to different places using ...
Definition: vk_mem_alloc.h:1840
VkCommandBuffer commandBuffer
Optional. Command buffer where GPU copy commands will be posted.
Definition: vk_mem_alloc.h:1854
uint32_t maxGpuAllocationsToMove
Maximum number of allocations that can be moved to a different place using transfers on GPU side,...
Definition: vk_mem_alloc.h:1851
VkDeviceSize maxGpuBytesToMove
Maximum total numbers of bytes that can be copied while moving allocations to different places using ...
Definition: vk_mem_alloc.h:1846
VkCommandBuffer commandBuffer
Optional. Command buffer where GPU copy commands will be posted.
Definition: vk_mem_alloc.h:1860
You can combine these two methods by specifying non-zero maxGpu* as well as maxCpu* parameters. The library automatically chooses best method to defragment each memory pool.
You may try not to block your entire program to wait until defragmentation finishes, but do it in the background, as long as you carefully fullfill requirements described in function vmaDefragmentationBegin().
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 5d14fa6..714e723 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -73,6 +73,7 @@ $(function() {
- v -
- VK_DEFINE_HANDLE() : vk_mem_alloc.h
- VK_ERROR_UNKNOWN : vk_mem_alloc.h
+- VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT : vk_mem_alloc.h
- VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT : vk_mem_alloc.h
- VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT : vk_mem_alloc.h
- VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT : vk_mem_alloc.h
@@ -192,7 +193,7 @@ $(function() {
- vmaGetAllocationInfo() : vk_mem_alloc.h
- vmaGetAllocationMemoryProperties() : vk_mem_alloc.h
- vmaGetAllocatorInfo() : vk_mem_alloc.h
-- vmaGetBudget() : vk_mem_alloc.h
+- vmaGetHeapBudgets() : vk_mem_alloc.h
- vmaGetMemoryProperties() : vk_mem_alloc.h
- vmaGetMemoryTypeProperties() : vk_mem_alloc.h
- vmaGetPhysicalDeviceProperties() : vk_mem_alloc.h
diff --git a/docs/html/globals_eval.html b/docs/html/globals_eval.html
index 7de569c..fde4df2 100644
--- a/docs/html/globals_eval.html
+++ b/docs/html/globals_eval.html
@@ -65,6 +65,7 @@ $(function() {
- v -
+- VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT : vk_mem_alloc.h
- VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT : vk_mem_alloc.h
- VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT : vk_mem_alloc.h
- VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT : vk_mem_alloc.h
diff --git a/docs/html/globals_func.html b/docs/html/globals_func.html
index 10a9099..3574644 100644
--- a/docs/html/globals_func.html
+++ b/docs/html/globals_func.html
@@ -110,7 +110,7 @@ $(function() {
- vmaGetAllocationInfo() : vk_mem_alloc.h
- vmaGetAllocationMemoryProperties() : vk_mem_alloc.h
- vmaGetAllocatorInfo() : vk_mem_alloc.h
-- vmaGetBudget() : vk_mem_alloc.h
+- vmaGetHeapBudgets() : vk_mem_alloc.h
- vmaGetMemoryProperties() : vk_mem_alloc.h
- vmaGetMemoryTypeProperties() : vk_mem_alloc.h
- vmaGetPhysicalDeviceProperties() : vk_mem_alloc.h
diff --git a/docs/html/lost_allocations.html b/docs/html/lost_allocations.html
index 7ba7872..eb64bdc 100644
--- a/docs/html/lost_allocations.html
+++ b/docs/html/lost_allocations.html
@@ -117,9 +117,9 @@ $(function() {
vmaCreateBuffer(allocator, &bufCreateInfo, &allocCreateInfo, &m_Buf, &m_Alloc,
nullptr);
}
-Definition: vk_mem_alloc.h:1003
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1005
Definition: vk_mem_alloc.h:1009
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1011
Represents single memory allocation.
void vmaDestroyBuffer(VmaAllocator allocator, VkBuffer buffer, VmaAllocation allocation)
Destroys Vulkan buffer and frees allocated memory.
VkBool32 vmaTouchAllocation(VmaAllocator allocator, VmaAllocation allocation)
Returns VK_TRUE if allocation is not lost and atomically marks it as used in current frame.
memcpy(allocInfo.
pMappedData, &constantBufferData,
sizeof(constantBufferData));
Definition: vk_mem_alloc.h:1003
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1005
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1368
void * pMappedData
Pointer to the beginning of this allocation as mapped data.
Definition: vk_mem_alloc.h:1412
Definition: vk_mem_alloc.h:1009
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1011
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1374
void * pMappedData
Pointer to the beginning of this allocation as mapped data.
Definition: vk_mem_alloc.h:1418
@ VMA_MEMORY_USAGE_CPU_ONLY
Definition: vk_mem_alloc.h:855
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
@ VMA_ALLOCATION_CREATE_MAPPED_BIT
Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.
Definition: vk_mem_alloc.h:922
}
-VkMemoryPropertyFlags preferredFlags
Flags that preferably should be set in a memory type chosen for an allocation.
Definition: vk_mem_alloc.h:1021
VkMemoryPropertyFlags preferredFlags
Flags that preferably should be set in a memory type chosen for an allocation.
Definition: vk_mem_alloc.h:1027
void vmaGetAllocationMemoryProperties(VmaAllocator allocator, VmaAllocation allocation, VkMemoryPropertyFlags *pFlags)
Given an allocation, returns Property Flags of its memory type.
@ VMA_MEMORY_USAGE_GPU_ONLY
Definition: vk_mem_alloc.h:845
You can even use VMA_ALLOCATION_CREATE_MAPPED_BIT flag while creating allocations that are not necessarily HOST_VISIBLE (e.g. using VMA_MEMORY_USAGE_GPU_ONLY). If the allocation ends up in memory type that is HOST_VISIBLE, it will be persistently mapped and you can use it directly. If not, the flag is just ignored. Example:
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index a6a7280..ea55094 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -130,8 +130,8 @@ Resource allocation
VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &allocInfo, &buffer, &allocation,
nullptr);
-Definition: vk_mem_alloc.h:1003
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
Definition: vk_mem_alloc.h:1009
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
Represents single memory allocation.
@ VMA_MEMORY_USAGE_GPU_ONLY
Definition: vk_mem_alloc.h:845
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
vkDestroyImage(allocator, img2, nullptr);
vkDestroyImage(allocator, img1, nullptr);
-Definition: vk_mem_alloc.h:1003
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1011
Definition: vk_mem_alloc.h:1009
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1017
Represents single memory allocation.
VkResult vmaBindImageMemory(VmaAllocator allocator, VmaAllocation allocation, VkImage image)
Binds image to allocation.
void vmaFreeMemory(VmaAllocator allocator, const VmaAllocation allocation)
Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...
Querying for budget
-To query for current memory usage and available budget, use function vmaGetBudget(). Returned structure VmaBudget contains quantities expressed in bytes, per Vulkan memory heap.
-Please note that this function returns different information and works faster than vmaCalculateStats(). vmaGetBudget() can be called every frame or even before every allocation, while vmaCalculateStats() is intended to be used rarely, only to obtain statistical information, e.g. for debugging purposes.
+To query for current memory usage and available budget, use function vmaGetHeapBudgets(). Returned structure VmaBudget contains quantities expressed in bytes, per Vulkan memory heap.
+Please note that this function returns different information and works faster than vmaCalculateStats(). vmaGetHeapBudgets() can be called every frame or even before every allocation, while vmaCalculateStats() is intended to be used rarely, only to obtain statistical information, e.g. for debugging purposes.
It is recommended to use VK_EXT_memory_budget device extension to obtain information about the budget from Vulkan device. VMA is able to use this extension automatically. When not enabled, the allocator behaves same way, but then it estimates current usage and available budget based on its internal information and Vulkan memory heap sizes, which may be less precise. In order to use this extension:
- Make sure extensions VK_EXT_memory_budget and VK_KHR_get_physical_device_properties2 required by it are available and enable them. Please note that the first is a device extension and the second is instance extension!
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 5ff0e77..8925431 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -83,8 +83,8 @@ Creating virtual block
-Parameters of created VmaVirtualBlock object to be passed to vmaCreateVirtualBlock().
Definition: vk_mem_alloc.h:2213
VkDeviceSize size
Total size of the virtual block.
Definition: vk_mem_alloc.h:2219
Parameters of created VmaVirtualBlock object to be passed to vmaCreateVirtualBlock().
Definition: vk_mem_alloc.h:2219
VkDeviceSize size
Total size of the virtual block.
Definition: vk_mem_alloc.h:2225
Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...
VkResult vmaCreateVirtualBlock(const VmaVirtualBlockCreateInfo *pCreateInfo, VmaVirtualBlock *pVirtualBlock)
Creates new VmaVirtualBlock object.
@@ -109,8 +109,8 @@ Making virtual allocations
{
}
-Parameters of created virtual allocation to be passed to vmaVirtualAllocate().
Definition: vk_mem_alloc.h:2261
VkDeviceSize size
Size of the allocation.
Definition: vk_mem_alloc.h:2266
Parameters of created virtual allocation to be passed to vmaVirtualAllocate().
Definition: vk_mem_alloc.h:2267
VkDeviceSize size
Size of the allocation.
Definition: vk_mem_alloc.h:2272
VkResult vmaVirtualAllocate(VmaVirtualBlock virtualBlock, const VmaVirtualAllocationCreateInfo *pCreateInfo, VkDeviceSize *pOffset)
Allocates new virtual allocation inside given VmaVirtualBlock.
Deallocation
@@ -137,8 +137,8 @@ Allocation parameters
delete (CustomAllocData*)allocInfo.
pUserData;
-Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo().
Definition: vk_mem_alloc.h:2284
void * pUserData
Custom pointer associated with the allocation.
Definition: vk_mem_alloc.h:2294
Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo().
Definition: vk_mem_alloc.h:2290
void * pUserData
Custom pointer associated with the allocation.
Definition: vk_mem_alloc.h:2300
void vmaGetVirtualAllocationInfo(VmaVirtualBlock virtualBlock, VkDeviceSize offset, VmaVirtualAllocationInfo *pVirtualAllocInfo)
Returns information about a specific virtual allocation within a virtual block, like its size and pUs...
Alignment and units
@@ -149,7 +149,7 @@ Alignment and units
VkDeviceSize allocOffset;
-VkDeviceSize alignment
Required alignment of the allocation. Optional.
Definition: vk_mem_alloc.h:2271
VkDeviceSize alignment
Required alignment of the allocation. Optional.
Definition: vk_mem_alloc.h:2277
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- VmaVirtualBlockCreateInfo::size
diff --git a/docs/html/vk__mem__alloc_8h.html b/docs/html/vk__mem__alloc_8h.html
index a3d9954..721309e 100644
--- a/docs/html/vk__mem__alloc_8h.html
+++ b/docs/html/vk__mem__alloc_8h.html
@@ -308,16 +308,17 @@ Enumerations
, VMA_ALLOCATION_CREATE_DONT_BIND_BIT = 0x00000080
,
VMA_ALLOCATION_CREATE_WITHIN_BUDGET_BIT = 0x00000100
+, VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT = 0x00000200
, VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT = 0x00010000
, VMA_ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT = 0x00020000
-, VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT = 0x00040000
,
- VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT = VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT
+ VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT = 0x00040000
+, VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT = VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT
, VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT = VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT
, VMA_ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT = VMA_ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT
-, VMA_ALLOCATION_CREATE_STRATEGY_MASK
,
- VMA_ALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
+ VMA_ALLOCATION_CREATE_STRATEGY_MASK
+, VMA_ALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
}
| | Flags to be passed as VmaAllocationCreateInfo::flags. More...
|
@@ -382,9 +383,9 @@ Functions
| void | vmaCalculateStats (VmaAllocator allocator, VmaStats *pStats) |
| | Retrieves statistics from current state of the Allocator. More...
|
| |
-| void | vmaGetBudget (VmaAllocator allocator, VmaBudget *pBudget) |
-| | Retrieves information about current memory budget for all memory heaps. More...
|
-| |
+| void | vmaGetHeapBudgets (VmaAllocator allocator, VmaBudget *pBudgets) |
+| | Retrieves information about current memory budget for all memory heaps. More...
|
+| |
| void | vmaBuildStatsString (VmaAllocator allocator, char **ppStatsString, VkBool32 detailedMap) |
| | Builds and returns statistics as a null-terminated string in JSON format. More...
|
| |
@@ -1278,6 +1279,9 @@ Functions
| VMA_ALLOCATION_CREATE_WITHIN_BUDGET_BIT | Create allocation only if additional device memory required for it, if any, won't exceed memory budget. Otherwise return VK_ERROR_OUT_OF_DEVICE_MEMORY.
|
+| VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT | Set this flag if the allocated memory will have aliasing resources.
+Usage of this flag prevents supplying VkMemoryDedicatedAllocateInfoKHR when VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT is specified. Otherwise created dedicated memory will not be suitable for aliasing resources, resulting in Vulkan Validation Layer errors.
+ |
| VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT | Allocation strategy that chooses smallest possible free range for the allocation.
|
| VMA_ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT | Allocation strategy that chooses biggest possible free range for the allocation.
@@ -2146,7 +2150,7 @@ Functions |
Retrieves statistics from current state of the Allocator.
-
This function is called "calculate" not "get" because it has to traverse all internal data structures, so it may be quite slow. For faster but more brief statistics suitable to be called every frame or every allocation, use vmaGetBudget().
+
This function is called "calculate" not "get" because it has to traverse all internal data structures, so it may be quite slow. For faster but more brief statistics suitable to be called every frame or every allocation, use vmaGetHeapBudgets().
Note that when using allocator from multiple threads, returned information may immediately become outdated.
@@ -3467,14 +3471,14 @@ Functions
-
-◆ vmaGetBudget()
+
+◆ vmaGetHeapBudgets()
- | void vmaGetBudget |
+ void vmaGetHeapBudgets |
( |
VmaAllocator |
allocator, |
@@ -3483,7 +3487,7 @@ Functions
|
|
VmaBudget * |
- pBudget |
+ pBudgets |
|
@@ -3497,7 +3501,7 @@ Functions
- Parameters
-
| allocator | |
- | [out] | pBudget | Must point to array with number of elements at least equal to number of memory heaps in physical device used. |
+ | [out] | pBudgets | Must point to array with number of elements at least equal to number of memory heaps in physical device used. |
diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h
index acb0900..f45a074 100644
--- a/include/vk_mem_alloc.h
+++ b/include/vk_mem_alloc.h
@@ -722,7 +722,7 @@ typedef struct VmaStats
This function is called "calculate" not "get" because it has to traverse all
internal data structures, so it may be quite slow. For faster but more brief statistics
-suitable to be called every frame or every allocation, use vmaGetBudget().
+suitable to be called every frame or every allocation, use vmaGetHeapBudgets().
Note that when using allocator from multiple threads, returned information may immediately
become outdated.
@@ -775,7 +775,7 @@ typedef struct VmaBudget
/** \brief Retrieves information about current memory budget for all memory heaps.
\param allocator
-\param[out] pBudget Must point to array with number of elements at least equal to number of memory heaps in physical device used.
+\param[out] pBudgets Must point to array with number of elements at least equal to number of memory heaps in physical device used.
This function is called "get" not "calculate" because it is very fast, suitable to be called
every frame or every allocation. For more detailed statistics use vmaCalculateStats().
@@ -783,9 +783,9 @@ every frame or every allocation. For more detailed statistics use vmaCalculateSt
Note that when using allocator from multiple threads, returned information may immediately
become outdated.
*/
-VMA_CALL_PRE void VMA_CALL_POST vmaGetBudget(
+VMA_CALL_PRE void VMA_CALL_POST vmaGetHeapBudgets(
VmaAllocator VMA_NOT_NULL allocator,
- VmaBudget* VMA_NOT_NULL pBudget);
+ VmaBudget* VMA_NOT_NULL pBudgets);
#ifndef VMA_STATS_STRING_ENABLED
#define VMA_STATS_STRING_ENABLED 1
@@ -6911,8 +6911,8 @@ public:
void CalculateStats(VmaStats* pStats);
- void GetBudget(
- VmaBudget* outBudget, uint32_t firstHeap, uint32_t heapCount);
+ void GetHeapBudgets(
+ VmaBudget* outBudgets, uint32_t firstHeap, uint32_t heapCount);
#if VMA_STATS_STRING_ENABLED
void PrintDetailedMap(class VmaJsonWriter& json);
@@ -11905,7 +11905,7 @@ VkResult VmaBlockVector::AllocatePage(
{
const uint32_t heapIndex = m_hAllocator->MemoryTypeIndexToHeapIndex(m_MemoryTypeIndex);
VmaBudget heapBudget = {};
- m_hAllocator->GetBudget(&heapBudget, heapIndex, 1);
+ m_hAllocator->GetHeapBudgets(&heapBudget, heapIndex, 1);
freeMemory = (heapBudget.usage < heapBudget.budget) ? (heapBudget.budget - heapBudget.usage) : 0;
}
@@ -12275,7 +12275,7 @@ void VmaBlockVector::Free(
{
const uint32_t heapIndex = m_hAllocator->MemoryTypeIndexToHeapIndex(m_MemoryTypeIndex);
VmaBudget heapBudget = {};
- m_hAllocator->GetBudget(&heapBudget, heapIndex, 1);
+ m_hAllocator->GetHeapBudgets(&heapBudget, heapIndex, 1);
budgetExceeded = heapBudget.usage >= heapBudget.budget;
}
@@ -15481,7 +15481,7 @@ VkResult VmaAllocator_T::AllocateDedicatedMemory(
{
const uint32_t heapIndex = MemoryTypeIndexToHeapIndex(memTypeIndex);
VmaBudget heapBudget = {};
- GetBudget(&heapBudget, heapIndex, 1);
+ GetHeapBudgets(&heapBudget, heapIndex, 1);
if(heapBudget.usage + size * allocationCount > heapBudget.budget)
{
return VK_ERROR_OUT_OF_DEVICE_MEMORY;
@@ -15975,7 +15975,7 @@ void VmaAllocator_T::CalculateStats(VmaStats* pStats)
VmaPostprocessCalcStatInfo(pStats->memoryHeap[i]);
}
-void VmaAllocator_T::GetBudget(VmaBudget* outBudget, uint32_t firstHeap, uint32_t heapCount)
+void VmaAllocator_T::GetHeapBudgets(VmaBudget* outBudgets, uint32_t firstHeap, uint32_t heapCount)
{
#if VMA_MEMORY_BUDGET
if(m_UseExtMemoryBudget)
@@ -15983,46 +15983,46 @@ void VmaAllocator_T::GetBudget(VmaBudget* outBudget, uint32_t firstHeap, uint32_
if(m_Budget.m_OperationsSinceBudgetFetch < 30)
{
VmaMutexLockRead lockRead(m_Budget.m_BudgetMutex, m_UseMutex);
- for(uint32_t i = 0; i < heapCount; ++i, ++outBudget)
+ for(uint32_t i = 0; i < heapCount; ++i, ++outBudgets)
{
const uint32_t heapIndex = firstHeap + i;
- outBudget->blockBytes = m_Budget.m_BlockBytes[heapIndex];
- outBudget->allocationBytes = m_Budget.m_AllocationBytes[heapIndex];
+ outBudgets->blockBytes = m_Budget.m_BlockBytes[heapIndex];
+ outBudgets->allocationBytes = m_Budget.m_AllocationBytes[heapIndex];
- if(m_Budget.m_VulkanUsage[heapIndex] + outBudget->blockBytes > m_Budget.m_BlockBytesAtBudgetFetch[heapIndex])
+ if(m_Budget.m_VulkanUsage[heapIndex] + outBudgets->blockBytes > m_Budget.m_BlockBytesAtBudgetFetch[heapIndex])
{
- outBudget->usage = m_Budget.m_VulkanUsage[heapIndex] +
- outBudget->blockBytes - m_Budget.m_BlockBytesAtBudgetFetch[heapIndex];
+ outBudgets->usage = m_Budget.m_VulkanUsage[heapIndex] +
+ outBudgets->blockBytes - m_Budget.m_BlockBytesAtBudgetFetch[heapIndex];
}
else
{
- outBudget->usage = 0;
+ outBudgets->usage = 0;
}
// Have to take MIN with heap size because explicit HeapSizeLimit is included in it.
- outBudget->budget = VMA_MIN(
+ outBudgets->budget = VMA_MIN(
m_Budget.m_VulkanBudget[heapIndex], m_MemProps.memoryHeaps[heapIndex].size);
}
}
else
{
UpdateVulkanBudget(); // Outside of mutex lock
- GetBudget(outBudget, firstHeap, heapCount); // Recursion
+ GetHeapBudgets(outBudgets, firstHeap, heapCount); // Recursion
}
}
else
#endif
{
- for(uint32_t i = 0; i < heapCount; ++i, ++outBudget)
+ for(uint32_t i = 0; i < heapCount; ++i, ++outBudgets)
{
const uint32_t heapIndex = firstHeap + i;
- outBudget->blockBytes = m_Budget.m_BlockBytes[heapIndex];
- outBudget->allocationBytes = m_Budget.m_AllocationBytes[heapIndex];
+ outBudgets->blockBytes = m_Budget.m_BlockBytes[heapIndex];
+ outBudgets->allocationBytes = m_Budget.m_AllocationBytes[heapIndex];
- outBudget->usage = outBudget->blockBytes;
- outBudget->budget = m_MemProps.memoryHeaps[heapIndex].size * 8 / 10; // 80% heuristics.
+ outBudgets->usage = outBudgets->blockBytes;
+ outBudgets->budget = m_MemProps.memoryHeaps[heapIndex].size * 8 / 10; // 80% heuristics.
}
}
}
@@ -17156,13 +17156,13 @@ VMA_CALL_PRE void VMA_CALL_POST vmaCalculateStats(
allocator->CalculateStats(pStats);
}
-VMA_CALL_PRE void VMA_CALL_POST vmaGetBudget(
+VMA_CALL_PRE void VMA_CALL_POST vmaGetHeapBudgets(
VmaAllocator allocator,
- VmaBudget* pBudget)
+ VmaBudget* pBudgets)
{
- VMA_ASSERT(allocator && pBudget);
+ VMA_ASSERT(allocator && pBudgets);
VMA_DEBUG_GLOBAL_MUTEX_LOCK
- allocator->GetBudget(pBudget, 0, allocator->GetMemoryHeapCount());
+ allocator->GetHeapBudgets(pBudgets, 0, allocator->GetMemoryHeapCount());
}
#if VMA_STATS_STRING_ENABLED
@@ -17180,8 +17180,8 @@ VMA_CALL_PRE void VMA_CALL_POST vmaBuildStatsString(
VmaJsonWriter json(allocator->GetAllocationCallbacks(), sb);
json.BeginObject();
- VmaBudget budget[VK_MAX_MEMORY_HEAPS];
- allocator->GetBudget(budget, 0, allocator->GetMemoryHeapCount());
+ VmaBudget budgets[VK_MAX_MEMORY_HEAPS];
+ allocator->GetHeapBudgets(budgets, 0, allocator->GetMemoryHeapCount());
VmaStats stats;
allocator->CalculateStats(&stats);
@@ -17211,13 +17211,13 @@ VMA_CALL_PRE void VMA_CALL_POST vmaBuildStatsString(
json.BeginObject();
{
json.WriteString("BlockBytes");
- json.WriteNumber(budget[heapIndex].blockBytes);
+ json.WriteNumber(budgets[heapIndex].blockBytes);
json.WriteString("AllocationBytes");
- json.WriteNumber(budget[heapIndex].allocationBytes);
+ json.WriteNumber(budgets[heapIndex].allocationBytes);
json.WriteString("Usage");
- json.WriteNumber(budget[heapIndex].usage);
+ json.WriteNumber(budgets[heapIndex].usage);
json.WriteString("Budget");
- json.WriteNumber(budget[heapIndex].budget);
+ json.WriteNumber(budgets[heapIndex].budget);
}
json.EndObject();
@@ -19275,11 +19275,11 @@ operating system:
\section staying_within_budget_querying_for_budget Querying for budget
-To query for current memory usage and available budget, use function vmaGetBudget().
+To query for current memory usage and available budget, use function vmaGetHeapBudgets().
Returned structure #VmaBudget contains quantities expressed in bytes, per Vulkan memory heap.
Please note that this function returns different information and works faster than
-vmaCalculateStats(). vmaGetBudget() can be called every frame or even before every
+vmaCalculateStats(). vmaGetHeapBudgets() can be called every frame or even before every
allocation, while vmaCalculateStats() is intended to be used rarely,
only to obtain statistical information, e.g. for debugging purposes.
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 44efe30..b2e796b 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -5473,7 +5473,7 @@ static void TestBudget()
vmaSetCurrentFrameIndex(g_hAllocator, ++g_FrameIndex);
VmaBudget budgetBeg[VK_MAX_MEMORY_HEAPS] = {};
- vmaGetBudget(g_hAllocator, budgetBeg);
+ vmaGetHeapBudgets(g_hAllocator, budgetBeg);
for(uint32_t i = 0; i < memProps->memoryHeapCount; ++i)
{
@@ -5514,7 +5514,7 @@ static void TestBudget()
}
VmaBudget budgetWithBufs[VK_MAX_MEMORY_HEAPS] = {};
- vmaGetBudget(g_hAllocator, budgetWithBufs);
+ vmaGetHeapBudgets(g_hAllocator, budgetWithBufs);
// DESTROY BUFFERS
for(size_t bufIndex = BUF_COUNT; bufIndex--; )
@@ -5523,7 +5523,7 @@ static void TestBudget()
}
VmaBudget budgetEnd[VK_MAX_MEMORY_HEAPS] = {};
- vmaGetBudget(g_hAllocator, budgetEnd);
+ vmaGetHeapBudgets(g_hAllocator, budgetEnd);
// CHECK
for(uint32_t i = 0; i < memProps->memoryHeapCount; ++i)