General

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...

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...

Enumerations
enum	VmaAllocatorFlagBits { VMA_ALLOCATOR_EXTERNALLY_SYNCHRONIZED_BIT = 0x00000001, VMA_ALLOCATOR_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF }
	Flags for created VmaAllocator. 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)

Detailed Description

Macro Definition Documentation

VMA_STATS_STRING_ENABLED

#define VMA_STATS_STRING_ENABLED   1

Typedef Documentation

PFN_vmaAllocateDeviceMemoryFunction

typedef void(VKAPI_PTR * PFN_vmaAllocateDeviceMemoryFunction) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)

Callback function called after successful vkAllocateMemory.

PFN_vmaFreeDeviceMemoryFunction

typedef void(VKAPI_PTR * PFN_vmaFreeDeviceMemoryFunction) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)

Callback function called before vkFreeMemory.

VmaAllocatorCreateInfo

typedef struct VmaAllocatorCreateInfo VmaAllocatorCreateInfo

Description of a Allocator to be created.

VmaAllocatorFlagBits

typedef enum VmaAllocatorFlagBits VmaAllocatorFlagBits

Flags for created VmaAllocator.

VmaAllocatorFlags

typedef VkFlags VmaAllocatorFlags

VmaDeviceMemoryCallbacks

typedef struct VmaDeviceMemoryCallbacks VmaDeviceMemoryCallbacks

Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory.

Provided for informative purpose, e.g. to gather statistics about number of allocations or total amount of memory allocated in Vulkan.

Used in VmaAllocatorCreateInfo::pDeviceMemoryCallbacks.

VmaStatInfo

typedef struct VmaStatInfo VmaStatInfo

Calculated statistics of memory usage in entire allocator.

VmaStats

typedef struct VmaStats VmaStats

General statistics from current state of Allocator.

VmaVulkanFunctions

typedef struct VmaVulkanFunctions VmaVulkanFunctions

Pointers to some Vulkan functions - a subset used by the library.

Used in VmaAllocatorCreateInfo::pVulkanFunctions.

Enumeration Type Documentation

VmaAllocatorFlagBits

enum VmaAllocatorFlagBits

Flags for created VmaAllocator.

Enumerator
VMA_ALLOCATOR_EXTERNALLY_SYNCHRONIZED_BIT	Allocator and all objects created from it will not be synchronized internally, so you must guarantee they are used from only one thread at a time or synchronized externally by you. Using this flag may increase performance because internal mutexes are not used.
VMA_ALLOCATOR_FLAG_BITS_MAX_ENUM

Function Documentation

vmaBuildStatsString()

void vmaBuildStatsString	(	VmaAllocator	allocator,
		char **	ppStatsString,
		VkBool32	detailedMap
	)

Builds and returns statistics as string in JSON format.

Parameters

[out]

ppStatsString

Must be freed using vmaFreeStatsString() function.

vmaCalculateStats()

void vmaCalculateStats	(	VmaAllocator	allocator,
		VmaStats *	pStats
	)

Retrieves statistics from current state of the Allocator.

vmaCreateAllocator()

VkResult vmaCreateAllocator	(	const VmaAllocatorCreateInfo *	pCreateInfo,
		VmaAllocator *	pAllocator
	)

Creates Allocator object.

vmaDestroyAllocator()

void vmaDestroyAllocator

(

VmaAllocator

allocator

)

Destroys allocator object.

vmaFreeStatsString()

void vmaFreeStatsString	(	VmaAllocator	allocator,
		char *	pStatsString
	)

vmaGetMemoryProperties()

void vmaGetMemoryProperties	(	VmaAllocator	allocator,
		const VkPhysicalDeviceMemoryProperties **	ppPhysicalDeviceMemoryProperties
	)

PhysicalDeviceMemoryProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own.

vmaGetMemoryTypeProperties()

void vmaGetMemoryTypeProperties	(	VmaAllocator	allocator,
		uint32_t	memoryTypeIndex,
		VkMemoryPropertyFlags *	pFlags
	)

Given Memory Type Index, returns Property Flags of this memory type.

This is just a convenience function. Same information can be obtained using vmaGetMemoryProperties().

vmaGetPhysicalDeviceProperties()

void vmaGetPhysicalDeviceProperties	(	VmaAllocator	allocator,
		const VkPhysicalDeviceProperties **	ppPhysicalDeviceProperties
	)

PhysicalDeviceProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own.

vmaSetCurrentFrameIndex()

void vmaSetCurrentFrameIndex	(	VmaAllocator	allocator,
		uint32_t	frameIndex
	)

Sets index of the current frame.

This function must be used if you make allocations with VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT and VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT flags to inform the allocator when a new frame begins. Allocations queried using vmaGetAllocationInfo() cannot become lost in the current frame.