diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html
index 01151dc..da3ebf5 100644
--- a/docs/html/allocation_annotation.html
+++ b/docs/html/allocation_annotation.html
@@ -91,18 +91,18 @@ Allocation user data
vmaCreateBuffer (allocator, &bufCreateInfo, &allocCreateInfo, &buffer, &allocation,
nullptr );
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
Creates a new VkBuffer, allocates and binds memory for it.
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:489
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1219
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:1258
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1227
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:495
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1305
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:1344
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1313
Represents single memory allocation.
The pointer may be later retrieved as VmaAllocationInfo::pUserData :
MyBufferMetadata* pMetadata = (MyBufferMetadata*)allocInfo.
pUserData ;
void vmaGetAllocationInfo(VmaAllocator allocator, VmaAllocation allocation, VmaAllocationInfo *pAllocationInfo)
Returns current information about specified allocation.
-
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1334
-
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:1381
+
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1420
+
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:1467
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.
C VmaAllocatorCreateInfo Description of a Allocator to be created C VmaAllocatorInfo Information about existing VmaAllocator object C VmaBudget Statistics of current memory usage and available budget for a specific memory heap C VmaDefragmentationContext An opaque object that represents started defragmentation process C VmaDefragmentationInfo Parameters for defragmentation C VmaDefragmentationMove Single move of an allocation to be done for defragmentation C VmaDefragmentationPassMoveInfo Parameters for incremental defragmentation steps C VmaDefragmentationStats Statistics returned for defragmentation process in function vmaEndDefragmentation() C VmaDetailedStatistics More detailed statistics than VmaStatistics C VmaDeviceMemoryCallbacks Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory C VmaPool Represents custom memory pool C VmaPoolCreateInfo Describes parameter of created VmaPool C VmaStatistics Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool, or total C VmaTotalStatistics General statistics from current state of the Allocator - total memory usage across all memory heaps and types C VmaVirtualAllocation Represents single memory allocation done inside VmaVirtualBlock C VmaVirtualAllocationCreateInfo Parameters of created virtual allocation to be passed to vmaVirtualAllocate() C VmaVirtualAllocationInfo Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo() C VmaVirtualBlock Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory C VmaVirtualBlockCreateInfo Parameters of created VmaVirtualBlock object to be passed to vmaCreateVirtualBlock() C VmaVulkanFunctions Pointers to some Vulkan functions - a subset used by the library C VmaBufferAllocator TODO document! C VmaBufferAllocatorCreateInfo Parameters of created VmaBufferAllocator object to be passed to vmaCreateBufferAllocator() C VmaBufferSuballocation TODO document! C VmaBufferSuballocationCreateInfo Parameters of created VmaBufferSuballocation object to be passed to vmaBufferAllocatorAllocate() C VmaBufferSuballocationInfo Parameters of an existing buffer suballocation, returned by vmaGetBufferSuballocationInfo() C VmaDefragmentationContext An opaque object that represents started defragmentation process C VmaDefragmentationInfo Parameters for defragmentation C VmaDefragmentationMove Single move of an allocation to be done for defragmentation C VmaDefragmentationPassMoveInfo Parameters for incremental defragmentation steps C VmaDefragmentationStats Statistics returned for defragmentation process in function vmaEndDefragmentation() C VmaDetailedStatistics More detailed statistics than VmaStatistics C VmaDeviceMemoryCallbacks Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory C VmaPool Represents custom memory pool C VmaPoolCreateInfo Describes parameter of created VmaPool C VmaStatistics Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool, or total C VmaTotalStatistics General statistics from current state of the Allocator - total memory usage across all memory heaps and types C VmaVirtualAllocation Represents single memory allocation done inside VmaVirtualBlock C VmaVirtualAllocationCreateInfo Parameters of created virtual allocation to be passed to vmaVirtualAllocate() C VmaVirtualAllocationInfo Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo() C VmaVirtualBlock Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory C VmaVirtualBlockCreateInfo Parameters of created VmaVirtualBlock object to be passed to vmaCreateVirtualBlock() C VmaVulkanFunctions Pointers to some Vulkan functions - a subset used by the library Vulkan Memory Allocator: Buffer suballocation
+
+
+
+
+
+
+ Vulkan Memory Allocator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+
+
+
vmaCreateBuffer (allocator, &bufferInfo, &allocInfo, &buffer, &allocation,
nullptr );
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
Creates a new VkBuffer, allocates and binds memory for it.
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:489
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1219
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1227
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:495
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1305
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1313
Represents single memory allocation.
If you have a preference for putting the resource in GPU (device) memory or CPU (host) memory on systems with discrete graphics card that have the memories separate, you can use VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE or VMA_MEMORY_USAGE_AUTO_PREFER_HOST .
When using VMA_MEMORY_USAGE_AUTO* while you want to map the allocated memory, you also need to specify one of the host access flags: VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT . This will help the library decide about preferred memory type to ensure it has VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT so you can map it.
@@ -119,8 +119,8 @@ Usage
VkBuffer stagingBuffer;
vmaCreateBuffer (allocator, &stagingBufferInfo, &stagingAllocInfo, &stagingBuffer, &stagingAllocation,
nullptr );
@ VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT
Definition: vk_mem_alloc.h:595
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1221
@ VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT
Definition: vk_mem_alloc.h:601
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1307
For more examples of creating different kinds of resources, see chapter Recommended usage patterns .
Usage values VMA_MEMORY_USAGE_AUTO* are legal to use only when the library knows about the resource being created by having VkBufferCreateInfo / VkImageCreateInfo passed, so they work with functions like: vmaCreateBuffer() , vmaCreateImage() , vmaFindMemoryTypeIndexForBufferInfo() etc. If you allocate raw memory using function vmaAllocateMemory() , you have to use other means of selecting memory type, as described below.
Note Old usage values (VMA_MEMORY_USAGE_GPU_ONLY, VMA_MEMORY_USAGE_CPU_ONLY, VMA_MEMORY_USAGE_CPU_TO_GPU, VMA_MEMORY_USAGE_GPU_TO_CPU, VMA_MEMORY_USAGE_CPU_COPY) are still available and work same way as in previous versions of the library for backward compatibility, but they are not recommended. VkBuffer buffer;
vmaCreateBuffer (allocator, &bufferInfo, &allocInfo, &buffer, &allocation,
nullptr );
@ 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:546
@ VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT
Definition: vk_mem_alloc.h:607
VkMemoryPropertyFlags preferredFlags
Flags that preferably should be set in a memory type chosen for an allocation.
Definition: vk_mem_alloc.h:1237
VkMemoryPropertyFlags requiredFlags
Flags that must be set in a Memory Type chosen for an allocation.
Definition: vk_mem_alloc.h:1232
@ 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:552
@ VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT
Definition: vk_mem_alloc.h:613
VkMemoryPropertyFlags preferredFlags
Flags that preferably should be set in a memory type chosen for an allocation.
Definition: vk_mem_alloc.h:1323
VkMemoryPropertyFlags requiredFlags
Flags that must be set in a Memory Type chosen for an allocation.
Definition: vk_mem_alloc.h:1318
A memory type is chosen that has all the required flags and as many preferred flags set as possible.
Value passed in VmaAllocationCreateInfo::usage is internally converted to a set of required and preferred flags, plus some extra "magic" (heuristics).
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:1245
uint32_t memoryTypeBits
Bitmask containing one bit set for every memory type acceptable for this allocation.
Definition: vk_mem_alloc.h:1331
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/classes.html b/docs/html/classes.html
index bd2069e..149d90c 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -76,7 +76,7 @@ $(function() {
diff --git a/docs/html/custom_memory_pools.html b/docs/html/custom_memory_pools.html
index e853668..98b8fee 100644
--- a/docs/html/custom_memory_pools.html
+++ b/docs/html/custom_memory_pools.html
@@ -131,15 +131,15 @@ $(function() {
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)
Creates a new VkBuffer, allocates and binds memory for it.
VkResult vmaFindMemoryTypeIndexForBufferInfo(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, uint32_t *pMemoryTypeIndex)
Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:489
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1219
VmaPool pool
Pool that this allocation should be created in.
Definition: vk_mem_alloc.h:1251
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1227
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:495
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1305
VmaPool pool
Pool that this allocation should be created in.
Definition: vk_mem_alloc.h:1337
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1313
Represents single memory allocation.
Describes parameter of created VmaPool.
Definition: vk_mem_alloc.h:1270
uint32_t memoryTypeIndex
Vulkan memory type index to allocate this pool from.
Definition: vk_mem_alloc.h:1273
VkDeviceSize blockSize
Size of a single VkDeviceMemory block to be allocated as part of this pool, in bytes....
Definition: vk_mem_alloc.h:1286
size_t maxBlockCount
Maximum number of blocks that can be allocated in this pool. Optional.
Definition: vk_mem_alloc.h:1299
Describes parameter of created VmaPool.
Definition: vk_mem_alloc.h:1356
uint32_t memoryTypeIndex
Vulkan memory type index to allocate this pool from.
Definition: vk_mem_alloc.h:1359
VkDeviceSize blockSize
Size of a single VkDeviceMemory block to be allocated as part of this pool, in bytes....
Definition: vk_mem_alloc.h:1372
size_t maxBlockCount
Maximum number of blocks that can be allocated in this pool. Optional.
Definition: vk_mem_alloc.h:1385
Represents custom memory pool.
You have to free all allocations made from this pool before destroying it.
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index 011c9b6..5d007c8 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -141,18 +141,18 @@ $(function() {
VkResult vmaBeginDefragmentationPass(VmaAllocator allocator, VmaDefragmentationContext context, VmaDefragmentationPassMoveInfo *pPassInfo)
Starts single defragmentation pass.
VkResult vmaBeginDefragmentation(VmaAllocator allocator, const VmaDefragmentationInfo *pInfo, VmaDefragmentationContext *pContext)
Begins defragmentation process.
VkResult vmaEndDefragmentationPass(VmaAllocator allocator, VmaDefragmentationContext context, VmaDefragmentationPassMoveInfo *pPassInfo)
Ends single defragmentation pass.
-
@ VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT
Definition: vk_mem_alloc.h:703
-
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1334
-
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:1381
+
@ VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT
Definition: vk_mem_alloc.h:709
+
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:1420
+
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:1467
An opaque object that represents started defragmentation process.
-
Parameters for defragmentation.
Definition: vk_mem_alloc.h:1397
-
VmaPool pool
Custom pool to be defragmented.
Definition: vk_mem_alloc.h:1404
-
VmaDefragmentationFlags flags
Use combination of VmaDefragmentationFlagBits.
Definition: vk_mem_alloc.h:1399
-
VmaAllocation srcAllocation
Allocation that should be moved.
Definition: vk_mem_alloc.h:1423
-
VmaAllocation dstTmpAllocation
Temporary allocation pointing to destination memory that will replace srcAllocation.
Definition: vk_mem_alloc.h:1430
-
Parameters for incremental defragmentation steps.
Definition: vk_mem_alloc.h:1438
-
uint32_t moveCount
Number of elements in the pMoves array.
Definition: vk_mem_alloc.h:1440
-
VmaDefragmentationMove * pMoves
Array of moves to be performed by the user in the current defragmentation pass.
Definition: vk_mem_alloc.h:1464
+
Parameters for defragmentation.
Definition: vk_mem_alloc.h:1483
+
VmaPool pool
Custom pool to be defragmented.
Definition: vk_mem_alloc.h:1490
+
VmaDefragmentationFlags flags
Use combination of VmaDefragmentationFlagBits.
Definition: vk_mem_alloc.h:1485
+
VmaAllocation srcAllocation
Allocation that should be moved.
Definition: vk_mem_alloc.h:1509
+
VmaAllocation dstTmpAllocation
Temporary allocation pointing to destination memory that will replace srcAllocation.
Definition: vk_mem_alloc.h:1516
+
Parameters for incremental defragmentation steps.
Definition: vk_mem_alloc.h:1524
+
uint32_t moveCount
Number of elements in the pMoves array.
Definition: vk_mem_alloc.h:1526
+
VmaDefragmentationMove * pMoves
Array of moves to be performed by the user in the current defragmentation pass.
Definition: vk_mem_alloc.h:1550
Although functions like vmaCreateBuffer() , vmaCreateImage() , vmaDestroyBuffer() , vmaDestroyImage() create/destroy an allocation and a buffer/image at once, these are just a shortcut for creating the resource, allocating memory, and binding them together. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return VK_INCOMPLETE not VK_SUCCESS. In each pass:
vmaBeginDefragmentationPass() function call:
@@ -156,7 +164,7 @@ $(function() {
-flags : VmaAllocationCreateInfo , VmaAllocatorCreateInfo , VmaDefragmentationInfo , VmaPoolCreateInfo , VmaVirtualAllocationCreateInfo , VmaVirtualBlockCreateInfo
+flags : VmaAllocationCreateInfo , VmaAllocatorCreateInfo , VmaBufferAllocatorCreateInfo , VmaBufferSuballocationCreateInfo , VmaDefragmentationInfo , VmaPoolCreateInfo , VmaVirtualAllocationCreateInfo , VmaVirtualBlockCreateInfo
@@ -112,6 +117,7 @@ $(function() {
pfnFree : VmaDeviceMemoryCallbacks
pHeapSizeLimit : VmaAllocatorCreateInfo
physicalDevice : VmaAllocatorCreateInfo , VmaAllocatorInfo
-pMappedData : VmaAllocationInfo
+pMappedData : VmaAllocationInfo , VmaBufferSuballocationInfo
pMemoryAllocateNext : VmaPoolCreateInfo
pMoves : VmaDefragmentationPassMoveInfo
pName : VmaAllocationInfo
@@ -145,7 +153,7 @@ $(function() {
preferredLargeHeapBlockSize : VmaAllocatorCreateInfo
priority : VmaAllocationCreateInfo , VmaPoolCreateInfo
pTypeExternalMemoryHandleTypes : VmaAllocatorCreateInfo
-pUserData : VmaAllocationCreateInfo , VmaAllocationInfo , VmaDeviceMemoryCallbacks , VmaVirtualAllocationCreateInfo , VmaVirtualAllocationInfo
+pUserData : VmaAllocationCreateInfo , VmaAllocationInfo , VmaBufferSuballocationCreateInfo , VmaBufferSuballocationInfo , VmaDeviceMemoryCallbacks , VmaVirtualAllocationCreateInfo , VmaVirtualAllocationInfo
pVulkanFunctions : VmaAllocatorCreateInfo
@@ -156,7 +164,7 @@ $(function() {
PFN_vmaAllocateDeviceMemoryFunction : vk_mem_alloc.h
PFN_vmaFreeDeviceMemoryFunction : vk_mem_alloc.h
-
-
-
VmaVirtualBlockCreateInfo::size printf("My virtual block has %llu bytes used by %u virtual allocations\n" ,
void vmaGetVirtualBlockStatistics(VmaVirtualBlock virtualBlock, VmaStatistics *pStats)
Calculates and returns statistics about virtual allocations and memory usage in given VmaVirtualBlock...
Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool,...
Definition: vk_mem_alloc.h:1108
VkDeviceSize allocationBytes
Total number of bytes occupied by all VmaAllocation objects.
Definition: vk_mem_alloc.h:1130
uint32_t allocationCount
Number of VmaAllocation objects allocated.
Definition: vk_mem_alloc.h:1116
Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool,...
Definition: vk_mem_alloc.h:1194
VkDeviceSize allocationBytes
Total number of bytes occupied by all VmaAllocation objects.
Definition: vk_mem_alloc.h:1216
uint32_t allocationCount
Number of VmaAllocation objects allocated.
Definition: vk_mem_alloc.h:1202
You can also request a full list of allocations and free regions as a string in JSON format by calling vmaBuildVirtualBlockStatsString(). Returned string must be later freed using vmaFreeVirtualBlockStatsString(). The format of this string differs from the one returned by the main Vulkan allocator, but it is similar.
struct VmaVirtualAllocationInfo Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo() . More... struct VmaBufferAllocatorCreateInfo Parameters of created VmaBufferAllocator object to be passed to vmaCreateBufferAllocator() . More... struct VmaBufferSuballocationCreateInfo Parameters of created VmaBufferSuballocation object to be passed to vmaBufferAllocatorAllocate() . More... struct VmaBufferSuballocationInfo Parameters of an existing buffer suballocation, returned by vmaGetBufferSuballocationInfo() . More...
typedef VkFlags VmaVirtualAllocationCreateFlags Flags to be passed as VmaVirtualAllocationCreateInfo::flags . See VmaVirtualAllocationCreateFlagBits . More... typedef enum VmaBufferAllocatorCreateFlagBits VmaBufferAllocatorCreateFlagBits Flags to be passed as VmaBufferAllocatorCreateInfo::flags . More... typedef VkFlags VmaBufferAllocatorCreateFlags Flags to be passed as VmaBufferAllocatorCreateInfo::flags . See VmaBufferAllocatorCreateFlagBits . More... typedef enum VmaBufferSuballocationCreateFlagBits VmaBufferSuballocationCreateFlagBits Flags to be passed as VmaVirtualAllocationCreateInfo::flags . More... typedef VkFlags VmaBufferSuballocationCreateFlags Flags to be passed as VmaBufferSuballocationCreateInfo::flags . See VmaBufferSuballocationCreateFlagBits . More... typedef void(VKAPI_PTR * PFN_vmaAllocateDeviceMemoryFunction ) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size, void *pUserData) Callback function called after successful vkAllocateMemory. More... typedef struct VmaVirtualAllocationInfo VmaVirtualAllocationInfo Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo() . More... typedef struct VmaBufferAllocatorCreateInfo VmaBufferAllocatorCreateInfo Parameters of created VmaBufferAllocator object to be passed to vmaCreateBufferAllocator() . More... typedef struct VmaBufferSuballocationCreateInfo VmaBufferSuballocationCreateInfo Parameters of created VmaBufferSuballocation object to be passed to vmaBufferAllocatorAllocate() . More... typedef struct VmaBufferSuballocationInfo VmaBufferSuballocationInfo Parameters of an existing buffer suballocation, returned by vmaGetBufferSuballocationInfo() . More...
Flags to be passed as VmaVirtualAllocationCreateInfo::flags . More... enum VmaBufferAllocatorCreateFlagBits { VMA_BUFFER_ALLOCATOR_CREATE_LINEAR_ALGORITHM_BIT = 0x00000001
+, VMA_BUFFER_ALLOCATOR_CREATE_ALGORITHM_MASK
+, VMA_BUFFER_ALLOCATOR_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
+ } Flags to be passed as VmaBufferAllocatorCreateInfo::flags . More... enum VmaBufferSuballocationCreateFlagBits { VMA_BUFFER_SUBALLOCATION_CREATE_DEDICATED_BUFFER_BIT = 0x00000001
+, VMA_BUFFER_SUBALLOCATION_CREATE_NEVER_ALLOCATE_BIT = 0x00000002
+, VMA_BUFFER_SUBALLOCATION_CREATE_WITHIN_BUDGET_BIT = 0x00000004
+, VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT = 0x00010000
+, VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT = 0x00020000
+, VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT = 0x00040000
+, VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MASK
+, VMA_BUFFER_SUBALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
+ Flags to be passed as VmaVirtualAllocationCreateInfo::flags . More...
VK_DEFINE_NON_DISPATCHABLE_HANDLE (VmaVirtualAllocation ) VkResult vmaCreateAllocator (const VmaAllocatorCreateInfo *pCreateInfo, VmaAllocator *pAllocator) Creates VmaAllocator object. More... void vmaCalculateVirtualBlockStatistics (VmaVirtualBlock virtualBlock, VmaDetailedStatistics *pStats) Calculates and returns detailed statistics about virtual allocations and memory usage in given VmaVirtualBlock . More... VkResult vmaCreateBufferAllocator (VmaAllocator allocator, const VmaBufferAllocatorCreateInfo *pCreateInfo, VmaBufferAllocator *pBufferAllocator) TODO implement! TODO document! More... void vmaDestroyBufferAllocator (VmaAllocator allocator, VmaBufferAllocator bufferAllocator) TODO implement! TODO document! More... VkResult vmaBufferAllocatorAllocate (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, const VmaBufferSuballocationCreateInfo *pCreateInfo, VmaBufferSuballocation *pBufferSuballocation, VmaBufferSuballocationInfo *pBufferSuballocationInfo) TODO implement! TODO document! More... void vmaBufferAllocatorFree (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation) TODO implement! TODO document! More... void vmaGetBufferSuballocationInfo (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation, VmaBufferSuballocationInfo *pBufferSuballocationInfo) TODO implement! TODO document! More... void vmaSetBufferSuballocationUserData (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation, void *pUserData) TODO implement! TODO document! More... VkResult vmaMapBufferSuballocation (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation, void **ppData) TODO implement! TODO document! More... void vmaUnmapBufferSuballocation (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation) TODO implement! TODO document! More... VkResult vmaFlushBufferSuballocation (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation, VkDeviceSize offset, VkDeviceSize size) TODO implement! TODO document! More... VkResult vmaInvalidateBufferSuballocation (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, VmaBufferSuballocation bufferSuballocation, VkDeviceSize offset, VkDeviceSize size) TODO implement! TODO document! More... VkResult vmaFlushBufferSuballocations (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, uint32_t bufferSuballocationCount, const VmaBufferSuballocation *pBufferSuballocations, const VkDeviceSize *pOffset, const VkDeviceSize *pSizes) TODO implement! TODO document! More... VkResult vmaInvalidateBufferSuballocations (VmaAllocator allocator, VmaBufferAllocator bufferAllocator, const VmaBufferSuballocation *pBufferSuballocations, const VkDeviceSize *pOffset, const VkDeviceSize *pSizes) TODO implement! TODO document! More...
vmaCreateImage (allocator, &imgCreateInfo, &allocCreateInfo, &img, &alloc,
nullptr );
VkResult vmaCreateImage(VmaAllocator allocator, const VkImageCreateInfo *pImageCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkImage *pImage, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
Function similar to vmaCreateBuffer().
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:489
@ VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT
Set this flag if the allocation should have its own memory block.
Definition: vk_mem_alloc.h:525
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1219
float priority
A floating-point value between 0 and 1, indicating the priority of the allocation relative to other m...
Definition: vk_mem_alloc.h:1265
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1227
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1221
@ VMA_MEMORY_USAGE_AUTO
Definition: vk_mem_alloc.h:495
@ VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT
Set this flag if the allocation should have its own memory block.
Definition: vk_mem_alloc.h:531
Parameters of new VmaAllocation.
Definition: vk_mem_alloc.h:1305
float priority
A floating-point value between 0 and 1, indicating the priority of the allocation relative to other m...
Definition: vk_mem_alloc.h:1351
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:1313
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:1307
Represents single memory allocation.
priority member is ignored in the following situations:
diff --git a/docs/html/vk_khr_dedicated_allocation.html b/docs/html/vk_khr_dedicated_allocation.html
index 7659ddc..66d3d34 100644
--- a/docs/html/vk_khr_dedicated_allocation.html
+++ b/docs/html/vk_khr_dedicated_allocation.html
@@ -90,7 +90,7 @@ $(function() {
VkResult vmaCreateAllocator(const VmaAllocatorCreateInfo *pCreateInfo, VmaAllocator *pAllocator)
Creates VmaAllocator object.
@ VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT
Enables usage of VK_KHR_dedicated_allocation extension.
Definition: vk_mem_alloc.h:342
@ VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT
Enables usage of VK_KHR_dedicated_allocation extension.
Definition: vk_mem_alloc.h:348
That is all. The extension will be automatically used whenever you create a buffer using vmaCreateBuffer() or image using vmaCreateImage() .
When using the extension together with Vulkan Validation Layer, you will receive warnings like this:
vkBindBufferMemory(): Binding memory to buffer 0x33 but vkGetBufferMemoryRequirements() has not been called on that buffer.
diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h
index 0fe459b..9e4dc75 100644
--- a/include/vk_mem_alloc.h
+++ b/include/vk_mem_alloc.h
@@ -68,6 +68,7 @@ License: MIT
- [Allocation user data](@ref allocation_user_data)
- [Allocation names](@ref allocation_names)
- \subpage virtual_allocator
+ - \subpage buffer_suballocation
- \subpage debugging_memory_usage
- [Memory initialization](@ref debugging_memory_usage_initialization)
- [Margins](@ref debugging_memory_usage_margins)
@@ -115,6 +116,11 @@ Most basic ones being: vmaCreateBuffer(), vmaCreateImage().
\brief API elements related to the mechanism of \ref virtual_allocator - using the core allocation algorithm
for user-defined purpose without allocating any real GPU memory.
+\defgroup group_buffer_suballocation Buffer suballocation
+
+\brief API elements related to the mechanism of \ref buffer_suballocation - allocating parts of larger buffers
+that allocator can create implicitly.
+
\defgroup group_stats Statistics
\brief API elements that query current status of the allocator, from memory usage, budget, to full dump of the internal state in JSON format.
@@ -803,6 +809,76 @@ typedef VkFlags VmaVirtualAllocationCreateFlags;
/** @} */
+/**
+\addtogroup group_buffer_suballocation
+@{
+*/
+
+/// Flags to be passed as VmaBufferAllocatorCreateInfo::flags.
+typedef enum VmaBufferAllocatorCreateFlagBits
+{
+ /** \brief Enables alternative, linear allocation algorithm in this virtual block.
+
+ Specify this flag to enable linear allocation algorithm, which always creates
+ new allocations after last one and doesn't reuse space from allocations freed in
+ between. It trades memory consumption for simplified algorithm and data
+ structure, which has better performance and uses less memory for metadata.
+
+ By using this flag, you can achieve behavior of free-at-once, stack,
+ ring buffer, and double stack.
+ For details, see documentation chapter \ref linear_algorithm.
+
+ Under the hood, it uses a \ref virtual_allocator with flag #VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT.
+
+ TODO implement!
+ */
+ VMA_BUFFER_ALLOCATOR_CREATE_LINEAR_ALGORITHM_BIT = 0x00000001,
+
+ /** \brief Bit mask to extract only `ALGORITHM` bits from entire set of flags.
+ */
+ VMA_BUFFER_ALLOCATOR_CREATE_ALGORITHM_MASK =
+ VMA_BUFFER_ALLOCATOR_CREATE_LINEAR_ALGORITHM_BIT,
+
+ VMA_BUFFER_ALLOCATOR_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
+} VmaBufferAllocatorCreateFlagBits;
+/// Flags to be passed as VmaBufferAllocatorCreateInfo::flags. See #VmaBufferAllocatorCreateFlagBits.
+typedef VkFlags VmaBufferAllocatorCreateFlags;
+
+/// Flags to be passed as VmaVirtualAllocationCreateInfo::flags.
+typedef enum VmaBufferSuballocationCreateFlagBits
+{
+ /** \brief TODO document! TODO implement!
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_DEDICATED_BUFFER_BIT = 0x00000001,
+ /** \brief TODO document! TODO implement!
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_NEVER_ALLOCATE_BIT = 0x00000002,
+ /** \brief TODO document! TODO implement!
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_WITHIN_BUDGET_BIT = 0x00000004,
+ /** \brief TODO document! TODO implement!
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT = 0x00010000,
+ /** \brief TODO document! TODO implement!
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT = 0x00020000,
+ /** \brief TODO document! TODO implement!
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT = 0x00040000,
+ /** A bit mask to extract only `STRATEGY` bits from entire set of flags.
+ */
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MASK =
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT |
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT |
+ VMA_BUFFER_SUBALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT,
+
+ VMA_BUFFER_SUBALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
+} VmaBufferSuballocationCreateFlagBits;
+/// Flags to be passed as VmaBufferSuballocationCreateInfo::flags. See #VmaBufferSuballocationCreateFlagBits.
+typedef VkFlags VmaBufferSuballocationCreateFlags;
+
+/** @} */
+
#endif // _VMA_ENUM_DECLARATIONS
#ifndef _VMA_DATA_TYPES_DECLARATIONS
@@ -886,13 +962,6 @@ Use value `VK_NULL_HANDLE` to represent a null/invalid allocation.
*/
VK_DEFINE_NON_DISPATCHABLE_HANDLE(VmaVirtualAllocation)
-/** @} */
-
-/**
-\addtogroup group_virtual
-@{
-*/
-
/** \struct VmaVirtualBlock
\brief Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory.
@@ -905,6 +974,23 @@ VK_DEFINE_HANDLE(VmaVirtualBlock)
/** @} */
+/**
+\addtogroup group_buffer_suballocation
+@{
+*/
+
+/** \struct VmaBufferSuballocation
+\brief TODO document!
+*/
+VK_DEFINE_NON_DISPATCHABLE_HANDLE(VmaBufferSuballocation)
+
+/** \struct VmaBufferAllocator
+\brief TODO document!
+*/
+VK_DEFINE_HANDLE(VmaBufferAllocator)
+
+/** @} */
+
/**
\addtogroup group_init
@{
@@ -1550,6 +1636,80 @@ typedef struct VmaVirtualAllocationInfo
/** @} */
+/**
+\addtogroup group_buffer_suballocation
+@{
+*/
+
+/// Parameters of created #VmaBufferAllocator object to be passed to vmaCreateBufferAllocator().
+typedef struct VmaBufferAllocatorCreateInfo
+{
+ /** \brief TODO document! TODO implement!
+ */
+ VmaBufferAllocatorCreateFlags flags;
+ /** \brief TODO document! TODO implement!
+ */
+ VkBufferCreateInfo bufferCreateInfo;
+ /** \brief TODO document! TODO implement!
+ */
+ VmaAllocationCreateInfo allocationCreateInfo;
+ /** \brief TODO document! TODO implement!
+ */
+ size_t minBufferCount;
+ /** \brief TODO document! TODO implement!
+ */
+ size_t maxBufferCount;
+ /** \brief TODO document! TODO implement!
+ */
+ VkDeviceSize minSuballocationAlignment;
+} VmaBufferAllocatorCreateInfo;
+
+/// Parameters of created #VmaBufferSuballocation object to be passed to vmaBufferAllocatorAllocate().
+typedef struct VmaBufferSuballocationCreateInfo
+{
+ /** \brief TODO document! TODO implement!
+ */
+ VmaBufferSuballocationCreateFlags flags;
+ /** \brief TODO document! TODO implement!
+ */
+ VkDeviceSize size;
+ /** \brief TODO document! TODO implement!
+ */
+ VkDeviceSize alignment;
+ /** \brief Custom pointer to be associated with the suballocation. Optional.
+
+ It can be any value and can be used for user-defined purposes. It can be fetched or changed later.
+ */
+ void* VMA_NULLABLE pUserData;
+} VmaBufferSuballocationCreateInfo;
+
+/// Parameters of an existing buffer suballocation, returned by vmaGetBufferSuballocationInfo().
+typedef struct VmaBufferSuballocationInfo
+{
+ /** \brief TODO document! TODO implement!
+ */
+ VmaAllocation allocation;
+ /** \brief TODO document! TODO implement!
+ */
+ VkBuffer buffer;
+ /** \brief TODO document! TODO implement!
+ */
+ VkDeviceSize bufferLocalOffset;
+ /** \brief TODO document! TODO implement!
+ */
+ VkDeviceSize size;
+ /** \brief TODO document! TODO implement!
+ */
+ void* VMA_NULLABLE pMappedData;
+ /** \brief Custom pointer associated with the suballocation.
+
+ Same value as passed in VmaBufferSuballocationCreateInfo::pUserData or to vmaSetBufferSuballocationUserData().
+ */
+ void* VMA_NULLABLE pUserData;
+} VmaBufferSuballocationInfo;
+
+/** @} */
+
#endif // _VMA_DATA_TYPES_DECLARATIONS
#ifndef _VMA_FUNCTION_HEADERS
@@ -2536,6 +2696,101 @@ VMA_CALL_PRE void VMA_CALL_POST vmaCalculateVirtualBlockStatistics(
/** @} */
+/**
+\addtogroup group_buffer_suballocation
+@{
+*/
+
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateBufferAllocator(
+ VmaAllocator VMA_NOT_NULL allocator,
+ const VmaBufferAllocatorCreateInfo* VMA_NOT_NULL pCreateInfo,
+ VmaBufferAllocator VMA_NULLABLE* VMA_NOT_NULL pBufferAllocator);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE void VMA_CALL_POST vmaDestroyBufferAllocator(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NULLABLE bufferAllocator);
+
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaBufferAllocatorAllocate(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NULLABLE bufferAllocator,
+ const VmaBufferSuballocationCreateInfo* VMA_NOT_NULL pCreateInfo,
+ VmaBufferSuballocation VMA_NULLABLE* VMA_NOT_NULL pBufferSuballocation,
+ VmaBufferSuballocationInfo* VMA_NULLABLE pBufferSuballocationInfo);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE void VMA_CALL_POST vmaBufferAllocatorFree(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NULLABLE bufferSuballocation);
+
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE void VMA_CALL_POST vmaGetBufferSuballocationInfo(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NOT_NULL bufferSuballocation,
+ VmaBufferSuballocationInfo* VMA_NOT_NULL pBufferSuballocationInfo);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE void VMA_CALL_POST vmaSetBufferSuballocationUserData(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NOT_NULL bufferSuballocation,
+ void* VMA_NULLABLE pUserData);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaMapBufferSuballocation(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NOT_NULL bufferSuballocation,
+ void* VMA_NULLABLE* VMA_NOT_NULL ppData);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE void VMA_CALL_POST vmaUnmapBufferSuballocation(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NOT_NULL bufferSuballocation);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaFlushBufferSuballocation(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NOT_NULL bufferSuballocation,
+ VkDeviceSize offset,
+ VkDeviceSize size);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaInvalidateBufferSuballocation(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ VmaBufferSuballocation VMA_NOT_NULL bufferSuballocation,
+ VkDeviceSize offset,
+ VkDeviceSize size);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaFlushBufferSuballocations(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ uint32_t bufferSuballocationCount,
+ const VmaBufferSuballocation VMA_NOT_NULL* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(bufferSuballocationCount) pBufferSuballocations,
+ const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(bufferSuballocationCount) pOffset,
+ const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(bufferSuballocationCount) pSizes);
+/** \brief TODO implement! TODO document!
+*/
+VMA_CALL_PRE VkResult VMA_CALL_POST vmaInvalidateBufferSuballocations(
+ VmaAllocator VMA_NOT_NULL allocator,
+ VmaBufferAllocator VMA_NOT_NULL bufferAllocator,
+ const VmaBufferSuballocation VMA_NOT_NULL* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(bufferSuballocationCount) pBufferSuballocations,
+ const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(bufferSuballocationCount) pOffset,
+ const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(bufferSuballocationCount) pSizes);
+
+/** @} */
+
#if VMA_STATS_STRING_ENABLED
/**
\addtogroup group_stats
@@ -18827,6 +19082,11 @@ Following features are supported only by the allocator of the real GPU memory an
buffer-image granularity, `VMA_DEBUG_MARGIN`, `VMA_MIN_ALIGNMENT`.
+\page buffer_suballocation Buffer suballocation
+
+TODO document!
+
+
\page debugging_memory_usage Debugging incorrect memory usage
If you suspect a bug with memory usage, like usage of uninitialized memory or
1.9.5
+
+
+
diff --git a/docs/html/choosing_memory_type.html b/docs/html/choosing_memory_type.html
index f19939d..b44529e 100644
--- a/docs/html/choosing_memory_type.html
+++ b/docs/html/choosing_memory_type.html
@@ -101,9 +101,9 @@ Usage