|
Vulkan Memory Allocator
|
API elements related to the allocation, deallocation, and management of Vulkan memory, buffers, images. Most basic ones being: vmaCreateBuffer(), vmaCreateImage(). More...
Classes | |
| struct | VmaAllocationCreateInfo |
| struct | VmaPoolCreateInfo |
| Describes parameter of created VmaPool. More... | |
| struct | VmaAllocationInfo |
| Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo(). More... | |
| struct | VmaDefragmentationInfo |
| Parameters for defragmentation. More... | |
| struct | VmaDefragmentationMove |
| Single move of an allocation to be done for defragmentation. More... | |
| struct | VmaDefragmentationPassMoveInfo |
| Parameters for incremental defragmentation steps. More... | |
| struct | VmaDefragmentationStats |
| Statistics returned for defragmentation process in function vmaEndDefragmentation(). More... | |
| struct | VmaPool |
| Represents custom memory pool. More... | |
| struct | VmaAllocation |
| Represents single memory allocation. More... | |
| struct | VmaDefragmentationContext |
| An opaque object that represents started defragmentation process. More... | |
Functions | |
| VkResult | vmaFindMemoryTypeIndex (VmaAllocator allocator, uint32_t memoryTypeBits, const VmaAllocationCreateInfo *pAllocationCreateInfo, uint32_t *pMemoryTypeIndex) |
| Helps to find memoryTypeIndex, given memoryTypeBits and VmaAllocationCreateInfo. More... | |
| VkResult | vmaFindMemoryTypeIndexForBufferInfo (VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, uint32_t *pMemoryTypeIndex) |
| Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo. More... | |
| VkResult | vmaFindMemoryTypeIndexForImageInfo (VmaAllocator allocator, const VkImageCreateInfo *pImageCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, uint32_t *pMemoryTypeIndex) |
| Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo. More... | |
| VkResult | vmaCreatePool (VmaAllocator allocator, const VmaPoolCreateInfo *pCreateInfo, VmaPool *pPool) |
| Allocates Vulkan device memory and creates VmaPool object. More... | |
| void | vmaDestroyPool (VmaAllocator allocator, VmaPool pool) |
| Destroys VmaPool object and frees Vulkan device memory. More... | |
| VkResult | vmaCheckPoolCorruption (VmaAllocator allocator, VmaPool pool) |
| Checks magic number in margins around all allocations in given memory pool in search for corruptions. More... | |
| void | vmaGetPoolName (VmaAllocator allocator, VmaPool pool, const char **ppName) |
| Retrieves name of a custom pool. More... | |
| void | vmaSetPoolName (VmaAllocator allocator, VmaPool pool, const char *pName) |
| Sets name of a custom pool. More... | |
| VkResult | vmaAllocateMemory (VmaAllocator allocator, const VkMemoryRequirements *pVkMemoryRequirements, const VmaAllocationCreateInfo *pCreateInfo, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo) |
| General purpose memory allocation. More... | |
| VkResult | vmaAllocateMemoryPages (VmaAllocator allocator, const VkMemoryRequirements *pVkMemoryRequirements, const VmaAllocationCreateInfo *pCreateInfo, size_t allocationCount, VmaAllocation *pAllocations, VmaAllocationInfo *pAllocationInfo) |
| General purpose memory allocation for multiple allocation objects at once. More... | |
| VkResult | vmaAllocateMemoryForBuffer (VmaAllocator allocator, VkBuffer buffer, const VmaAllocationCreateInfo *pCreateInfo, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo) |
| VkResult | vmaAllocateMemoryForImage (VmaAllocator allocator, VkImage image, const VmaAllocationCreateInfo *pCreateInfo, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo) |
| Function similar to vmaAllocateMemoryForBuffer(). More... | |
| void | vmaFreeMemory (VmaAllocator allocator, const VmaAllocation allocation) |
| Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(), or vmaAllocateMemoryForImage(). More... | |
| void | vmaFreeMemoryPages (VmaAllocator allocator, size_t allocationCount, const VmaAllocation *pAllocations) |
| Frees memory and destroys multiple allocations. More... | |
| void | vmaGetAllocationInfo (VmaAllocator allocator, VmaAllocation allocation, VmaAllocationInfo *pAllocationInfo) |
| Returns current information about specified allocation. More... | |
| void | vmaSetAllocationUserData (VmaAllocator allocator, VmaAllocation allocation, void *pUserData) |
| Sets pUserData in given allocation to new value. More... | |
| void | vmaGetAllocationMemoryProperties (VmaAllocator allocator, VmaAllocation allocation, VkMemoryPropertyFlags *pFlags) |
| Given an allocation, returns Property Flags of its memory type. More... | |
| VkResult | vmaMapMemory (VmaAllocator allocator, VmaAllocation allocation, void **ppData) |
| Maps memory represented by given allocation and returns pointer to it. More... | |
| void | vmaUnmapMemory (VmaAllocator allocator, VmaAllocation allocation) |
| Unmaps memory represented by given allocation, mapped previously using vmaMapMemory(). More... | |
| VkResult | vmaFlushAllocation (VmaAllocator allocator, VmaAllocation allocation, VkDeviceSize offset, VkDeviceSize size) |
| Flushes memory of given allocation. More... | |
| VkResult | vmaInvalidateAllocation (VmaAllocator allocator, VmaAllocation allocation, VkDeviceSize offset, VkDeviceSize size) |
| Invalidates memory of given allocation. More... | |
| VkResult | vmaFlushAllocations (VmaAllocator allocator, uint32_t allocationCount, const VmaAllocation *allocations, const VkDeviceSize *offsets, const VkDeviceSize *sizes) |
| Flushes memory of given set of allocations. More... | |
| VkResult | vmaInvalidateAllocations (VmaAllocator allocator, uint32_t allocationCount, const VmaAllocation *allocations, const VkDeviceSize *offsets, const VkDeviceSize *sizes) |
| Invalidates memory of given set of allocations. More... | |
| VkResult | vmaCheckCorruption (VmaAllocator allocator, uint32_t memoryTypeBits) |
| Checks magic number in margins around all allocations in given memory types (in both default and custom pools) in search for corruptions. More... | |
| VkResult | vmaBeginDefragmentation (VmaAllocator allocator, const VmaDefragmentationInfo *pInfo, VmaDefragmentationContext *pContext) |
| Begins defragmentation process. More... | |
| VkResult | vmaEndDefragmentation (VmaAllocator allocator, VmaDefragmentationContext context, VmaDefragmentationStats *pStats) |
| Ends defragmentation process. More... | |
| VkResult | vmaBeginDefragmentationPass (VmaAllocator allocator, VmaDefragmentationContext context, VmaDefragmentationPassMoveInfo *pPassInfo) |
| Starts single defragmentation pass. More... | |
| VkResult | vmaEndDefragmentationPass (VmaAllocator allocator, VmaDefragmentationContext context, VmaDefragmentationPassMoveInfo *pPassInfo) |
| Ends single defragmentation pass. More... | |
| VkResult | vmaBindBufferMemory (VmaAllocator allocator, VmaAllocation allocation, VkBuffer buffer) |
| Binds buffer to allocation. More... | |
| VkResult | vmaBindBufferMemory2 (VmaAllocator allocator, VmaAllocation allocation, VkDeviceSize allocationLocalOffset, VkBuffer buffer, const void *pNext) |
| Binds buffer to allocation with additional parameters. More... | |
| VkResult | vmaBindImageMemory (VmaAllocator allocator, VmaAllocation allocation, VkImage image) |
| Binds image to allocation. More... | |
| VkResult | vmaBindImageMemory2 (VmaAllocator allocator, VmaAllocation allocation, VkDeviceSize allocationLocalOffset, VkImage image, const void *pNext) |
| Binds image to allocation with additional parameters. More... | |
| VkResult | vmaCreateBuffer (VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo) |
| VkResult | vmaCreateBufferWithAlignment (VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkDeviceSize minAlignment, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo) |
| Creates a buffer with additional minimum alignment. More... | |
| void | vmaDestroyBuffer (VmaAllocator allocator, VkBuffer buffer, VmaAllocation allocation) |
| Destroys Vulkan buffer and frees allocated memory. More... | |
| VkResult | vmaCreateImage (VmaAllocator allocator, const VkImageCreateInfo *pImageCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkImage *pImage, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo) |
| Function similar to vmaCreateBuffer(). More... | |
| void | vmaDestroyImage (VmaAllocator allocator, VkImage image, VmaAllocation allocation) |
| Destroys Vulkan image and frees allocated memory. More... | |
API elements related to the allocation, deallocation, and management of Vulkan memory, buffers, images. Most basic ones being: vmaCreateBuffer(), vmaCreateImage().
| typedef enum VmaAllocationCreateFlagBits VmaAllocationCreateFlagBits |
Flags to be passed as VmaAllocationCreateInfo::flags.
| typedef VkFlags VmaAllocationCreateFlags |
| typedef struct VmaAllocationCreateInfo VmaAllocationCreateInfo |
| typedef struct VmaAllocationInfo VmaAllocationInfo |
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
| typedef enum VmaDefragmentationFlagBits VmaDefragmentationFlagBits |
Flags to be passed as VmaDefragmentationInfo::flags.
| typedef VkFlags VmaDefragmentationFlags |
| typedef struct VmaDefragmentationInfo VmaDefragmentationInfo |
Parameters for defragmentation.
To be used with function vmaBeginDefragmentation().
| typedef struct VmaDefragmentationMove VmaDefragmentationMove |
Single move of an allocation to be done for defragmentation.
Operation performed on single defragmentation move.
| typedef struct VmaDefragmentationPassMoveInfo VmaDefragmentationPassMoveInfo |
Parameters for incremental defragmentation steps.
To be used with function vmaBeginDefragmentationPass().
| typedef struct VmaDefragmentationStats VmaDefragmentationStats |
Statistics returned for defragmentation process in function vmaEndDefragmentation().
| typedef enum VmaMemoryUsage VmaMemoryUsage |
Intended usage of the allocated memory.
| typedef enum VmaPoolCreateFlagBits VmaPoolCreateFlagBits |
Flags to be passed as VmaPoolCreateInfo::flags.
| typedef VkFlags VmaPoolCreateFlags |
Flags to be passed as VmaPoolCreateInfo::flags. See VmaPoolCreateFlagBits.
| typedef struct VmaPoolCreateInfo VmaPoolCreateInfo |
Describes parameter of created VmaPool.
Flags to be passed as VmaAllocationCreateInfo::flags.
| Enumerator | |
|---|---|
| VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT | Set this flag if the allocation should have its own memory block. Use it for special, big resources, like fullscreen images used as attachments. |
| VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT | Set this flag to only try to allocate from existing If new allocation cannot be placed in any of the existing blocks, allocation fails with You should not use VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT and VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT at the same time. It makes no sense. If VmaAllocationCreateInfo::pool is not null, this flag is implied and ignored. |
| VMA_ALLOCATION_CREATE_MAPPED_BIT | Set this flag to use a memory that will be persistently mapped and retrieve pointer to it. Pointer to mapped memory will be returned through VmaAllocationInfo::pMappedData. It is valid to use this flag for allocation made from memory type that is not |
| VMA_ALLOCATION_CREATE_RESERVED_1_BIT |
|
| VMA_ALLOCATION_CREATE_RESERVED_2_BIT |
|
| VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT | Set this flag to treat VmaAllocationCreateInfo::pUserData as pointer to a null-terminated string. Instead of copying pointer value, a local copy of the string is made and stored in allocation's |
| VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT | Allocation will be created from upper stack in a double stack pool. This flag is only allowed for custom pools created with VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT flag. |
| VMA_ALLOCATION_CREATE_DONT_BIND_BIT | Create both buffer/image and allocation, but don't bind them together. It is useful when you want to bind yourself to do some more advanced binding, e.g. using some extensions. The flag is meaningful only with functions that bind by default: vmaCreateBuffer(), vmaCreateImage(). Otherwise it is ignored. |
| 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 |
| VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT | Set this flag if the allocated memory will have aliasing resources. Usage of this flag prevents supplying |
| VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT | Requests possibility to map the allocation (using vmaMapMemory() or VMA_ALLOCATION_CREATE_MAPPED_BIT).
Declares that mapped memory will only be written sequentially, e.g. using
|
| VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT | Requests possibility to map the allocation (using vmaMapMemory() or VMA_ALLOCATION_CREATE_MAPPED_BIT).
Declares that mapped memory can be read, written, and accessed in random order, so a |
| VMA_ALLOCATION_CREATE_HOST_ACCESS_ALLOW_TRANSFER_INSTEAD_BIT | Together with VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT, it says that despite request for host access, a not- By using this flag, you declare that you will check if the allocation ended up in a |
| VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT | Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time. |
| VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT | Allocation strategy that chooses first suitable free range for the allocation - not necessarily in terms of the smallest offset but the one that is easiest and fastest to find to minimize allocation time, possibly at the expense of allocation quality. |
| VMA_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT | Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data. Used internally by defragmentation, not recomended in typical usage. |
| VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT | |
| VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT | |
| VMA_ALLOCATION_CREATE_STRATEGY_MASK | A bit mask to extract only |
| VMA_ALLOCATION_CREATE_FLAG_BITS_MAX_ENUM | |
Flags to be passed as VmaDefragmentationInfo::flags.
| Enumerator | |
|---|---|
| VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT | |
| VMA_DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED_BIT | |
| VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT | |
| VMA_DEFRAGMENTATION_FLAG_ALGORITHM_EXTENSIVE_BIT | Use the most roboust algorithm at the cost of time to compute and number of copies to make. Only available when bufferImageGranularity is greater than 1, since it aims to reduce alignment issues between different types of resources. Otherwise falls back to same behavior as VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT. |
| VMA_DEFRAGMENTATION_FLAG_ALGORITHM_MASK | A bit mask to extract only |
| VMA_DEFRAGMENTATION_FLAG_BITS_MAX_ENUM | |
Operation performed on single defragmentation move.
| Enumerator | |
|---|---|
| VMA_DEFRAGMENTATION_MOVE_OPERATION_COPY | Buffer/image has been recreated at |
| VMA_DEFRAGMENTATION_MOVE_OPERATION_IGNORE | Set this value if you cannot move the allocation. New place reserved |
| VMA_DEFRAGMENTATION_MOVE_OPERATION_DESTROY | Set this value if you decide to abandon the allocation and you destroyed the buffer/image. New place reserved |
| enum VmaMemoryUsage |
Intended usage of the allocated memory.
| Enumerator | |
|---|---|
| VMA_MEMORY_USAGE_UNKNOWN | No intended memory usage specified. Use other members of VmaAllocationCreateInfo to specify your requirements. |
| 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 |
|
| VMA_MEMORY_USAGE_GPU_LAZILY_ALLOCATED | Lazily allocated GPU memory having Usage: Memory for transient attachment images (color attachments, depth attachments etc.), created with Allocations with this usage are always created as dedicated - it implies VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT. |
| VMA_MEMORY_USAGE_AUTO | Selects best memory type automatically. This flag is recommended for most common use cases. When using this flag, if you want to map the allocation (using vmaMapMemory() or VMA_ALLOCATION_CREATE_MAPPED_BIT), you must pass one of the flags: VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT in VmaAllocationCreateInfo::flags. It can be used only with functions that let the library know |
| VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE | Selects best memory type automatically with preference for GPU (device) memory. When using this flag, if you want to map the allocation (using vmaMapMemory() or VMA_ALLOCATION_CREATE_MAPPED_BIT), you must pass one of the flags: VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT in VmaAllocationCreateInfo::flags. It can be used only with functions that let the library know |
| VMA_MEMORY_USAGE_AUTO_PREFER_HOST | Selects best memory type automatically with preference for CPU (host) memory. When using this flag, if you want to map the allocation (using vmaMapMemory() or VMA_ALLOCATION_CREATE_MAPPED_BIT), you must pass one of the flags: VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT in VmaAllocationCreateInfo::flags. It can be used only with functions that let the library know |
| VMA_MEMORY_USAGE_MAX_ENUM | |
Flags to be passed as VmaPoolCreateInfo::flags.
| Enumerator | |
|---|---|
| VMA_POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT | Use this flag if you always allocate only buffers and linear images or only optimal images out of this pool and so Buffer-Image Granularity can be ignored. This is an optional optimization flag. If you always allocate using vmaCreateBuffer(), vmaCreateImage(), vmaAllocateMemoryForBuffer(), then you don't need to use it because allocator knows exact type of your allocations so it can handle Buffer-Image Granularity in the optimal way. If you also allocate using vmaAllocateMemoryForImage() or vmaAllocateMemory(), exact type of such allocations is not known, so allocator must be conservative in handling Buffer-Image Granularity, which can lead to suboptimal allocation (wasted memory). In that case, if you can make sure you always allocate only buffers and linear images or only optimal images out of this pool, use this flag to make allocator disregard Buffer-Image Granularity and so make allocations faster and more optimal. |
| VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT | Enables alternative, linear allocation algorithm in this pool. 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 Linear allocation algorithm. |
| VMA_POOL_CREATE_ALGORITHM_MASK | Bit mask to extract only |
| VMA_POOL_CREATE_FLAG_BITS_MAX_ENUM | |
| VkResult vmaAllocateMemory | ( | VmaAllocator | allocator, |
| const VkMemoryRequirements * | pVkMemoryRequirements, | ||
| const VmaAllocationCreateInfo * | pCreateInfo, | ||
| VmaAllocation * | pAllocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
General purpose memory allocation.
| allocator | ||
| pVkMemoryRequirements | ||
| pCreateInfo | ||
| [out] | pAllocation | Handle to allocated memory. |
| [out] | pAllocationInfo | Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo(). |
You should free the memory using vmaFreeMemory() or vmaFreeMemoryPages().
It is recommended to use vmaAllocateMemoryForBuffer(), vmaAllocateMemoryForImage(), vmaCreateBuffer(), vmaCreateImage() instead whenever possible.
| VkResult vmaAllocateMemoryForBuffer | ( | VmaAllocator | allocator, |
| VkBuffer | buffer, | ||
| const VmaAllocationCreateInfo * | pCreateInfo, | ||
| VmaAllocation * | pAllocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
| allocator | ||
| buffer | ||
| pCreateInfo | ||
| [out] | pAllocation | Handle to allocated memory. |
| [out] | pAllocationInfo | Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo(). |
You should free the memory using vmaFreeMemory().
| VkResult vmaAllocateMemoryForImage | ( | VmaAllocator | allocator, |
| VkImage | image, | ||
| const VmaAllocationCreateInfo * | pCreateInfo, | ||
| VmaAllocation * | pAllocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
Function similar to vmaAllocateMemoryForBuffer().
| VkResult vmaAllocateMemoryPages | ( | VmaAllocator | allocator, |
| const VkMemoryRequirements * | pVkMemoryRequirements, | ||
| const VmaAllocationCreateInfo * | pCreateInfo, | ||
| size_t | allocationCount, | ||
| VmaAllocation * | pAllocations, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
General purpose memory allocation for multiple allocation objects at once.
| allocator | Allocator object. | |
| pVkMemoryRequirements | Memory requirements for each allocation. | |
| pCreateInfo | Creation parameters for each allocation. | |
| allocationCount | Number of allocations to make. | |
| [out] | pAllocations | Pointer to array that will be filled with handles to created allocations. |
| [out] | pAllocationInfo | Optional. Pointer to array that will be filled with parameters of created allocations. |
You should free the memory using vmaFreeMemory() or vmaFreeMemoryPages().
Word "pages" is just a suggestion to use this function to allocate pieces of memory needed for sparse binding. It is just a general purpose allocation function able to make multiple allocations at once. It may be internally optimized to be more efficient than calling vmaAllocateMemory() allocationCount times.
All allocations are made using same parameters. All of them are created out of the same memory pool and type. If any allocation fails, all allocations already made within this function call are also freed, so that when returned result is not VK_SUCCESS, pAllocation array is always entirely filled with VK_NULL_HANDLE.
| VkResult vmaBeginDefragmentation | ( | VmaAllocator | allocator, |
| const VmaDefragmentationInfo * | pInfo, | ||
| VmaDefragmentationContext * | pContext | ||
| ) |
Begins defragmentation process.
| allocator | Allocator object. | |
| pInfo | Structure filled with parameters of defragmentation. | |
| [out] | pContext | Context object that must be passed to vmaEndDefragmentation() to finish defragmentation. |
For more information about defragmentation, see documentation chapter: Defragmentation.
| VkResult vmaBeginDefragmentationPass | ( | VmaAllocator | allocator, |
| VmaDefragmentationContext | context, | ||
| VmaDefragmentationPassMoveInfo * | pPassInfo | ||
| ) |
Starts single defragmentation pass.
| allocator | Allocator object. | |
| context | Context object that has been created by vmaBeginDefragmentation(). | |
| [out] | pPassInfo | Computed informations for current pass. |
VK_SUCCESS if no more moves are possible. Then you can omit call to vmaEndDefragmentationPass() and simply end whole defragmentation.VK_INCOMPLETE if there are pending moves returned in pPassInfo. You need to perform them, call vmaEndDefragmentationPass(), and then preferably try another pass with vmaBeginDefragmentationPass(). | VkResult vmaBindBufferMemory | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkBuffer | buffer | ||
| ) |
Binds buffer to allocation.
Binds specified buffer to region of memory represented by specified allocation. Gets VkDeviceMemory handle and offset from the allocation. If you want to create a buffer, allocate memory for it and bind them together separately, you should use this function for binding instead of standard vkBindBufferMemory(), because it ensures proper synchronization so that when a VkDeviceMemory object is used by multiple allocations, calls to vkBind*Memory() or vkMapMemory() won't happen from multiple threads simultaneously (which is illegal in Vulkan).
It is recommended to use function vmaCreateBuffer() instead of this one.
| VkResult vmaBindBufferMemory2 | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkDeviceSize | allocationLocalOffset, | ||
| VkBuffer | buffer, | ||
| const void * | pNext | ||
| ) |
Binds buffer to allocation with additional parameters.
| allocator | |
| allocation | |
| allocationLocalOffset | Additional offset to be added while binding, relative to the beginning of the allocation. Normally it should be 0. |
| buffer | |
| pNext | A chain of structures to be attached to VkBindBufferMemoryInfoKHR structure used internally. Normally it should be null. |
This function is similar to vmaBindBufferMemory(), but it provides additional parameters.
If pNext is not null, VmaAllocator object must have been created with VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT flag or with VmaAllocatorCreateInfo::vulkanApiVersion >= VK_API_VERSION_1_1. Otherwise the call fails.
| VkResult vmaBindImageMemory | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkImage | image | ||
| ) |
Binds image to allocation.
Binds specified image to region of memory represented by specified allocation. Gets VkDeviceMemory handle and offset from the allocation. If you want to create an image, allocate memory for it and bind them together separately, you should use this function for binding instead of standard vkBindImageMemory(), because it ensures proper synchronization so that when a VkDeviceMemory object is used by multiple allocations, calls to vkBind*Memory() or vkMapMemory() won't happen from multiple threads simultaneously (which is illegal in Vulkan).
It is recommended to use function vmaCreateImage() instead of this one.
| VkResult vmaBindImageMemory2 | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkDeviceSize | allocationLocalOffset, | ||
| VkImage | image, | ||
| const void * | pNext | ||
| ) |
Binds image to allocation with additional parameters.
| allocator | |
| allocation | |
| allocationLocalOffset | Additional offset to be added while binding, relative to the beginning of the allocation. Normally it should be 0. |
| image | |
| pNext | A chain of structures to be attached to VkBindImageMemoryInfoKHR structure used internally. Normally it should be null. |
This function is similar to vmaBindImageMemory(), but it provides additional parameters.
If pNext is not null, VmaAllocator object must have been created with VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT flag or with VmaAllocatorCreateInfo::vulkanApiVersion >= VK_API_VERSION_1_1. Otherwise the call fails.
| VkResult vmaCheckCorruption | ( | VmaAllocator | allocator, |
| uint32_t | memoryTypeBits | ||
| ) |
Checks magic number in margins around all allocations in given memory types (in both default and custom pools) in search for corruptions.
| allocator | |
| memoryTypeBits | Bit mask, where each bit set means that a memory type with that index should be checked. |
Corruption detection is enabled only when VMA_DEBUG_DETECT_CORRUPTION macro is defined to nonzero, VMA_DEBUG_MARGIN is defined to nonzero and only for memory types that are HOST_VISIBLE and HOST_COHERENT. For more information, see Corruption detection.
Possible return values:
VK_ERROR_FEATURE_NOT_PRESENT - corruption detection is not enabled for any of specified memory types.VK_SUCCESS - corruption detection has been performed and succeeded.VK_ERROR_UNKNOWN - corruption detection has been performed and found memory corruptions around one of the allocations. VMA_ASSERT is also fired in that case.| VkResult vmaCheckPoolCorruption | ( | VmaAllocator | allocator, |
| VmaPool | pool | ||
| ) |
Checks magic number in margins around all allocations in given memory pool in search for corruptions.
Corruption detection is enabled only when VMA_DEBUG_DETECT_CORRUPTION macro is defined to nonzero, VMA_DEBUG_MARGIN is defined to nonzero and the pool is created in memory type that is HOST_VISIBLE and HOST_COHERENT. For more information, see Corruption detection.
Possible return values:
VK_ERROR_FEATURE_NOT_PRESENT - corruption detection is not enabled for specified pool.VK_SUCCESS - corruption detection has been performed and succeeded.VK_ERROR_UNKNOWN - corruption detection has been performed and found memory corruptions around one of the allocations. VMA_ASSERT is also fired in that case.| VkResult vmaCreateBuffer | ( | VmaAllocator | allocator, |
| const VkBufferCreateInfo * | pBufferCreateInfo, | ||
| const VmaAllocationCreateInfo * | pAllocationCreateInfo, | ||
| VkBuffer * | pBuffer, | ||
| VmaAllocation * | pAllocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
| allocator | ||
| pBufferCreateInfo | ||
| pAllocationCreateInfo | ||
| [out] | pBuffer | Buffer that was created. |
| [out] | pAllocation | Allocation that was created. |
| [out] | pAllocationInfo | Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo(). |
This function automatically:
If any of these operations fail, buffer and allocation are not created, returned value is negative error code, *pBuffer and *pAllocation are null.
If the function succeeded, you must destroy both buffer and allocation when you no longer need them using either convenience function vmaDestroyBuffer() or separately, using vkDestroyBuffer() and vmaFreeMemory().
If VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT flag was used, VK_KHR_dedicated_allocation extension is used internally to query driver whether it requires or prefers the new buffer to have dedicated allocation. If yes, and if dedicated allocation is possible (VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT is not used), it creates dedicated allocation for this buffer, just like when using VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.
VkBuffer. Sub-allocation of parts of one large buffer, although recommended as a good practice, is out of scope of this library and could be implemented by the user as a higher-level logic on top of VMA. | VkResult vmaCreateBufferWithAlignment | ( | VmaAllocator | allocator, |
| const VkBufferCreateInfo * | pBufferCreateInfo, | ||
| const VmaAllocationCreateInfo * | pAllocationCreateInfo, | ||
| VkDeviceSize | minAlignment, | ||
| VkBuffer * | pBuffer, | ||
| VmaAllocation * | pAllocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
Creates a buffer with additional minimum alignment.
Similar to vmaCreateBuffer() but provides additional parameter minAlignment which allows to specify custom, minimum alignment to be used when placing the buffer inside a larger memory block, which may be needed e.g. for interop with OpenGL.
| VkResult vmaCreateImage | ( | VmaAllocator | allocator, |
| const VkImageCreateInfo * | pImageCreateInfo, | ||
| const VmaAllocationCreateInfo * | pAllocationCreateInfo, | ||
| VkImage * | pImage, | ||
| VmaAllocation * | pAllocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
Function similar to vmaCreateBuffer().
| VkResult vmaCreatePool | ( | VmaAllocator | allocator, |
| const VmaPoolCreateInfo * | pCreateInfo, | ||
| VmaPool * | pPool | ||
| ) |
Allocates Vulkan device memory and creates VmaPool object.
| allocator | Allocator object. | |
| pCreateInfo | Parameters of pool to create. | |
| [out] | pPool | Handle to created pool. |
| void vmaDestroyBuffer | ( | VmaAllocator | allocator, |
| VkBuffer | buffer, | ||
| VmaAllocation | allocation | ||
| ) |
Destroys Vulkan buffer and frees allocated memory.
This is just a convenience function equivalent to:
It it safe to pass null as buffer and/or allocation.
| void vmaDestroyImage | ( | VmaAllocator | allocator, |
| VkImage | image, | ||
| VmaAllocation | allocation | ||
| ) |
Destroys Vulkan image and frees allocated memory.
This is just a convenience function equivalent to:
It it safe to pass null as image and/or allocation.
| void vmaDestroyPool | ( | VmaAllocator | allocator, |
| VmaPool | pool | ||
| ) |
Destroys VmaPool object and frees Vulkan device memory.
| VkResult vmaEndDefragmentation | ( | VmaAllocator | allocator, |
| VmaDefragmentationContext | context, | ||
| VmaDefragmentationStats * | pStats | ||
| ) |
Ends defragmentation process.
| allocator | Allocator object. | |
| context | Context object that has been created by vmaBeginDefragmentation(). | |
| [out] | pStats | Optional stats for the defragmentation. Can be null. |
Use this function to finish defragmentation started by vmaBeginDefragmentation().
| VkResult vmaEndDefragmentationPass | ( | VmaAllocator | allocator, |
| VmaDefragmentationContext | context, | ||
| VmaDefragmentationPassMoveInfo * | pPassInfo | ||
| ) |
Ends single defragmentation pass.
| allocator | Allocator object. |
| context | Context object that has been created by vmaBeginDefragmentation(). |
| pPassInfo | Computed informations for current pass filled by vmaBeginDefragmentationPass() and possibly modified by you. |
Returns VK_SUCCESS if no more moves are possible or VK_INCOMPLETE if more defragmentations are possible.
Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
pPassInfo[i].srcAllocation that had pPassInfo[i].operation == VMA_DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.pPassInfo[i].srcAllocation that had pPassInfo[i].operation == VMA_DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be freed.If no more moves are possible you can end whole defragmentation.
| VkResult vmaFindMemoryTypeIndex | ( | VmaAllocator | allocator, |
| uint32_t | memoryTypeBits, | ||
| const VmaAllocationCreateInfo * | pAllocationCreateInfo, | ||
| uint32_t * | pMemoryTypeIndex | ||
| ) |
Helps to find memoryTypeIndex, given memoryTypeBits and VmaAllocationCreateInfo.
This algorithm tries to find a memory type that:
| VkResult vmaFindMemoryTypeIndexForBufferInfo | ( | VmaAllocator | allocator, |
| const VkBufferCreateInfo * | pBufferCreateInfo, | ||
| const VmaAllocationCreateInfo * | pAllocationCreateInfo, | ||
| uint32_t * | pMemoryTypeIndex | ||
| ) |
Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.
It can be useful e.g. to determine value to be used as VmaPoolCreateInfo::memoryTypeIndex. It internally creates a temporary, dummy buffer that never has memory bound.
| VkResult vmaFindMemoryTypeIndexForImageInfo | ( | VmaAllocator | allocator, |
| const VkImageCreateInfo * | pImageCreateInfo, | ||
| const VmaAllocationCreateInfo * | pAllocationCreateInfo, | ||
| uint32_t * | pMemoryTypeIndex | ||
| ) |
Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo.
It can be useful e.g. to determine value to be used as VmaPoolCreateInfo::memoryTypeIndex. It internally creates a temporary, dummy image that never has memory bound.
| VkResult vmaFlushAllocation | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkDeviceSize | offset, | ||
| VkDeviceSize | size | ||
| ) |
Flushes memory of given allocation.
Calls vkFlushMappedMemoryRanges() for memory associated with given range of given allocation. It needs to be called after writing to a mapped memory for memory types that are not HOST_COHERENT. Unmap operation doesn't do that automatically.
offset must be relative to the beginning of allocation.size can be VK_WHOLE_SIZE. It means all memory from offset the the end of given allocation.offset and size don't have to be aligned. They are internally rounded down/up to multiply of nonCoherentAtomSize.size is 0, this call is ignored.allocation belongs to is not HOST_VISIBLE or it is HOST_COHERENT, this call is ignored.Warning! offset and size are relative to the contents of given allocation. If you mean whole allocation, you can pass 0 and VK_WHOLE_SIZE, respectively. Do not pass allocation's offset as offset!!!
This function returns the VkResult from vkFlushMappedMemoryRanges if it is called, otherwise VK_SUCCESS.
| VkResult vmaFlushAllocations | ( | VmaAllocator | allocator, |
| uint32_t | allocationCount, | ||
| const VmaAllocation * | allocations, | ||
| const VkDeviceSize * | offsets, | ||
| const VkDeviceSize * | sizes | ||
| ) |
Flushes memory of given set of allocations.
Calls vkFlushMappedMemoryRanges() for memory associated with given ranges of given allocations. For more information, see documentation of vmaFlushAllocation().
| allocator | |
| allocationCount | |
| allocations | |
| offsets | If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero. |
| sizes | If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means VK_WHOLE_SIZE for all allocations. |
This function returns the VkResult from vkFlushMappedMemoryRanges if it is called, otherwise VK_SUCCESS.
| void vmaFreeMemory | ( | VmaAllocator | allocator, |
| const VmaAllocation | allocation | ||
| ) |
Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(), or vmaAllocateMemoryForImage().
Passing VK_NULL_HANDLE as allocation is valid. Such function call is just skipped.
| void vmaFreeMemoryPages | ( | VmaAllocator | allocator, |
| size_t | allocationCount, | ||
| const VmaAllocation * | pAllocations | ||
| ) |
Frees memory and destroys multiple allocations.
Word "pages" is just a suggestion to use this function to free pieces of memory used for sparse binding. It is just a general purpose function to free memory and destroy allocations made using e.g. vmaAllocateMemory(), vmaAllocateMemoryPages() and other functions. It may be internally optimized to be more efficient than calling vmaFreeMemory() allocationCount times.
Allocations in pAllocations array can come from any memory pools and types. Passing VK_NULL_HANDLE as elements of pAllocations array is valid. Such entries are just skipped.
| void vmaGetAllocationInfo | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VmaAllocationInfo * | pAllocationInfo | ||
| ) |
Returns current information about specified allocation.
Current paramteres of given allocation are returned in pAllocationInfo.
Although this function doesn't lock any mutex, so it should be quite efficient, you should avoid calling it too often. You can retrieve same VmaAllocationInfo structure while creating your resource, from function vmaCreateBuffer(), vmaCreateImage(). You can remember it if you are sure parameters don't change (e.g. due to defragmentation).
| void vmaGetAllocationMemoryProperties | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkMemoryPropertyFlags * | pFlags | ||
| ) |
Given an allocation, returns Property Flags of its memory type.
This is just a convenience function. Same information can be obtained using vmaGetAllocationInfo() + vmaGetMemoryProperties().
| void vmaGetPoolName | ( | VmaAllocator | allocator, |
| VmaPool | pool, | ||
| const char ** | ppName | ||
| ) |
Retrieves name of a custom pool.
After the call ppName is either null or points to an internally-owned null-terminated string containing name of the pool that was previously set. The pointer becomes invalid when the pool is destroyed or its name is changed using vmaSetPoolName().
| VkResult vmaInvalidateAllocation | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| VkDeviceSize | offset, | ||
| VkDeviceSize | size | ||
| ) |
Invalidates memory of given allocation.
Calls vkInvalidateMappedMemoryRanges() for memory associated with given range of given allocation. It needs to be called before reading from a mapped memory for memory types that are not HOST_COHERENT. Map operation doesn't do that automatically.
offset must be relative to the beginning of allocation.size can be VK_WHOLE_SIZE. It means all memory from offset the the end of given allocation.offset and size don't have to be aligned. They are internally rounded down/up to multiply of nonCoherentAtomSize.size is 0, this call is ignored.allocation belongs to is not HOST_VISIBLE or it is HOST_COHERENT, this call is ignored.Warning! offset and size are relative to the contents of given allocation. If you mean whole allocation, you can pass 0 and VK_WHOLE_SIZE, respectively. Do not pass allocation's offset as offset!!!
This function returns the VkResult from vkInvalidateMappedMemoryRanges if it is called, otherwise VK_SUCCESS.
| VkResult vmaInvalidateAllocations | ( | VmaAllocator | allocator, |
| uint32_t | allocationCount, | ||
| const VmaAllocation * | allocations, | ||
| const VkDeviceSize * | offsets, | ||
| const VkDeviceSize * | sizes | ||
| ) |
Invalidates memory of given set of allocations.
Calls vkInvalidateMappedMemoryRanges() for memory associated with given ranges of given allocations. For more information, see documentation of vmaInvalidateAllocation().
| allocator | |
| allocationCount | |
| allocations | |
| offsets | If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero. |
| sizes | If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means VK_WHOLE_SIZE for all allocations. |
This function returns the VkResult from vkInvalidateMappedMemoryRanges if it is called, otherwise VK_SUCCESS.
| VkResult vmaMapMemory | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| void ** | ppData | ||
| ) |
Maps memory represented by given allocation and returns pointer to it.
Maps memory represented by given allocation to make it accessible to CPU code. When succeeded, *ppData contains pointer to first byte of this memory.
VkDeviceMemory block, returned pointer is correctly offsetted to the beginning of region assigned to this particular allocation. Unlike the result of vkMapMemory, it points to the allocation, not to the beginning of the whole block. You should not add VmaAllocationInfo::offset to it!Mapping is internally reference-counted and synchronized, so despite raw Vulkan function vkMapMemory() cannot be used to map same block of VkDeviceMemory multiple times simultaneously, it is safe to call this function on allocations assigned to the same memory block. Actual Vulkan memory will be mapped on first mapping and unmapped on last unmapping.
If the function succeeded, you must call vmaUnmapMemory() to unmap the allocation when mapping is no longer needed or before freeing the allocation, at the latest.
It also safe to call this function multiple times on the same allocation. You must call vmaUnmapMemory() same number of times as you called vmaMapMemory().
It is also safe to call this function on allocation created with VMA_ALLOCATION_CREATE_MAPPED_BIT flag. Its memory stays mapped all the time. You must still call vmaUnmapMemory() same number of times as you called vmaMapMemory(). You must not call vmaUnmapMemory() additional time to free the "0-th" mapping made automatically due to VMA_ALLOCATION_CREATE_MAPPED_BIT flag.
This function fails when used on allocation made in memory type that is not HOST_VISIBLE.
This function doesn't automatically flush or invalidate caches. If the allocation is made from a memory types that is not HOST_COHERENT, you also need to use vmaInvalidateAllocation() / vmaFlushAllocation(), as required by Vulkan specification.
| void vmaSetAllocationUserData | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation, | ||
| void * | pUserData | ||
| ) |
Sets pUserData in given allocation to new value.
If the allocation was created with VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT, pUserData must be either null, or pointer to a null-terminated string. The function makes local copy of the string and sets it as allocation's pUserData. String passed as pUserData doesn't need to be valid for whole lifetime of the allocation - you can free it after this call. String previously pointed by allocation's pUserData is freed from memory.
If the flag was not used, the value of pointer pUserData is just copied to allocation's pUserData. It is opaque, so you can use it however you want - e.g. as a pointer, ordinal number or some handle to you own data.
| void vmaSetPoolName | ( | VmaAllocator | allocator, |
| VmaPool | pool, | ||
| const char * | pName | ||
| ) |
Sets name of a custom pool.
pName can be either null or pointer to a null-terminated string with new name for the pool. Function makes internal copy of the string, so it can be changed or freed immediately after this call.
| void vmaUnmapMemory | ( | VmaAllocator | allocator, |
| VmaAllocation | allocation | ||
| ) |
Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().
For details, see description of vmaMapMemory().
This function doesn't automatically flush or invalidate caches. If the allocation is made from a memory types that is not HOST_COHERENT, you also need to use vmaInvalidateAllocation() / vmaFlushAllocation(), as required by Vulkan specification.
1.9.2