vk_mem_alloc.h File Reference

#include <vulkan/vulkan.h>

Go to the source code of this file.

Classes
struct	VmaDeviceMemoryCallbacks
	Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory. More...
struct	VmaVulkanFunctions
	Pointers to some Vulkan functions - a subset used by the library. More...
struct	VmaAllocatorCreateInfo
	Description of a Allocator to be created. More...
struct	VmaStatInfo
	Calculated statistics of memory usage in entire allocator. More...
struct	VmaStats
	General statistics from current state of Allocator. More...
struct	VmaAllocationCreateInfo
struct	VmaPoolCreateInfo
	Describes parameter of created VmaPool. More...
struct	VmaPoolStats
	Describes parameter of existing VmaPool. More...
struct	VmaAllocationInfo
	Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo(). More...
struct	VmaDefragmentationInfo
	Optional configuration parameters to be passed to function vmaDefragment(). More...
struct	VmaDefragmentationStats
	Statistics returned by function vmaDefragment(). More...

Macros
#define	VMA_STATS_STRING_ENABLED   1

Typedefs
typedef void(VKAPI_PTR *	PFN_vmaAllocateDeviceMemoryFunction) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)
	Callback function called after successful vkAllocateMemory. More...
typedef void(VKAPI_PTR *	PFN_vmaFreeDeviceMemoryFunction) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)
	Callback function called before vkFreeMemory. More...
typedef struct VmaDeviceMemoryCallbacks	VmaDeviceMemoryCallbacks
	Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory. More...
typedef enum VmaAllocatorFlagBits	VmaAllocatorFlagBits
	Flags for created VmaAllocator. More...
typedef VkFlags	VmaAllocatorFlags
typedef struct VmaVulkanFunctions	VmaVulkanFunctions
	Pointers to some Vulkan functions - a subset used by the library. More...
typedef struct VmaAllocatorCreateInfo	VmaAllocatorCreateInfo
	Description of a Allocator to be created. More...
typedef struct VmaStatInfo	VmaStatInfo
	Calculated statistics of memory usage in entire allocator. More...
typedef struct VmaStats	VmaStats
	General statistics from current state of Allocator. More...
typedef enum VmaMemoryUsage	VmaMemoryUsage
typedef enum VmaAllocationCreateFlagBits	VmaAllocationCreateFlagBits
	Flags to be passed as VmaAllocationCreateInfo::flags. More...
typedef VkFlags	VmaAllocationCreateFlags
typedef struct VmaAllocationCreateInfo	VmaAllocationCreateInfo
typedef enum VmaPoolCreateFlagBits	VmaPoolCreateFlagBits
	Flags to be passed as VmaPoolCreateInfo::flags. More...
typedef VkFlags	VmaPoolCreateFlags
typedef struct VmaPoolCreateInfo	VmaPoolCreateInfo
	Describes parameter of created VmaPool. More...
typedef struct VmaPoolStats	VmaPoolStats
	Describes parameter of existing VmaPool. More...
typedef struct VmaAllocationInfo	VmaAllocationInfo
	Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo(). More...
typedef struct VmaDefragmentationInfo	VmaDefragmentationInfo
	Optional configuration parameters to be passed to function vmaDefragment(). More...
typedef struct VmaDefragmentationStats	VmaDefragmentationStats
	Statistics returned by function vmaDefragment(). More...

Enumerations
enum	VmaAllocatorFlagBits { VMA_ALLOCATOR_EXTERNALLY_SYNCHRONIZED_BIT = 0x00000001, VMA_ALLOCATOR_KHR_DEDICATED_ALLOCATION_BIT = 0x00000002, VMA_ALLOCATOR_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF }
	Flags for created VmaAllocator. More...
enum	VmaMemoryUsage {   VMA_MEMORY_USAGE_UNKNOWN = 0, VMA_MEMORY_USAGE_GPU_ONLY = 1, VMA_MEMORY_USAGE_CPU_ONLY = 2, VMA_MEMORY_USAGE_CPU_TO_GPU = 3,   VMA_MEMORY_USAGE_GPU_TO_CPU = 4, VMA_MEMORY_USAGE_MAX_ENUM = 0x7FFFFFFF }
enum	VmaAllocationCreateFlagBits {   VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT = 0x00000001, VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT = 0x00000002, VMA_ALLOCATION_CREATE_PERSISTENT_MAP_BIT = 0x00000004, VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT = 0x00000008,   VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT = 0x00000010, VMA_ALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF }
	Flags to be passed as VmaAllocationCreateInfo::flags. More...
enum	VmaPoolCreateFlagBits { VMA_POOL_CREATE_PERSISTENT_MAP_BIT = 0x00000001, VMA_POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT = 0x00000002, VMA_POOL_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF }
	Flags to be passed as VmaPoolCreateInfo::flags. More...

Functions
VkResult	vmaCreateAllocator (const VmaAllocatorCreateInfo *pCreateInfo, VmaAllocator *pAllocator)
	Creates Allocator object. More...
void	vmaDestroyAllocator (VmaAllocator allocator)
	Destroys allocator object. More...
void	vmaGetPhysicalDeviceProperties (VmaAllocator allocator, const VkPhysicalDeviceProperties **ppPhysicalDeviceProperties)
void	vmaGetMemoryProperties (VmaAllocator allocator, const VkPhysicalDeviceMemoryProperties **ppPhysicalDeviceMemoryProperties)
void	vmaGetMemoryTypeProperties (VmaAllocator allocator, uint32_t memoryTypeIndex, VkMemoryPropertyFlags *pFlags)
	Given Memory Type Index, returns Property Flags of this memory type. More...
void	vmaSetCurrentFrameIndex (VmaAllocator allocator, uint32_t frameIndex)
	Sets index of the current frame. More...
void	vmaCalculateStats (VmaAllocator allocator, VmaStats *pStats)
	Retrieves statistics from current state of the Allocator. More...
void	vmaBuildStatsString (VmaAllocator allocator, char **ppStatsString, VkBool32 detailedMap)
	Builds and returns statistics as string in JSON format. More...
void	vmaFreeStatsString (VmaAllocator allocator, char *pStatsString)
VkResult	vmaFindMemoryTypeIndex (VmaAllocator allocator, uint32_t memoryTypeBits, const VmaAllocationCreateInfo *pAllocationCreateInfo, uint32_t *pMemoryTypeIndex)
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...
void	vmaGetPoolStats (VmaAllocator allocator, VmaPool pool, VmaPoolStats *pPoolStats)
	Retrieves statistics of existing VmaPool object. More...
void	vmaMakePoolAllocationsLost (VmaAllocator allocator, VmaPool pool, size_t *pLostAllocationCount)
	Marks all allocations in given pool as lost if they are not used in current frame or VmaPoolCreateInfo::frameInUseCount back from now. More...
VkResult	vmaAllocateMemory (VmaAllocator allocator, const VkMemoryRequirements *pVkMemoryRequirements, const VmaAllocationCreateInfo *pCreateInfo, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
	General purpose memory allocation. 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, VmaAllocation allocation)
	Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(), or vmaAllocateMemoryForImage(). 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	vmaCreateLostAllocation (VmaAllocator allocator, VmaAllocation *pAllocation)
	Creates new allocation that is in lost state from the beginning. More...
VkResult	vmaMapMemory (VmaAllocator allocator, VmaAllocation allocation, void **ppData)
void	vmaUnmapMemory (VmaAllocator allocator, VmaAllocation allocation)
void	vmaUnmapPersistentlyMappedMemory (VmaAllocator allocator)
	Unmaps persistently mapped memory of types that are HOST_COHERENT and DEVICE_LOCAL. More...
VkResult	vmaMapPersistentlyMappedMemory (VmaAllocator allocator)
	Maps back persistently mapped memory of types that are HOST_COHERENT and DEVICE_LOCAL. More...
VkResult	vmaDefragment (VmaAllocator allocator, VmaAllocation *pAllocations, size_t allocationCount, VkBool32 *pAllocationsChanged, const VmaDefragmentationInfo *pDefragmentationInfo, VmaDefragmentationStats *pDefragmentationStats)
	Compacts memory by moving allocations. More...
VkResult	vmaCreateBuffer (VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
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...