#include <vk_mem_alloc.h>

Public Attributes
VmaAllocationCreateFlags	flags
	Use VmaAllocationCreateFlagBits enum. More...

VmaMemoryUsage	usage
	Intended usage of memory. More...

VkMemoryPropertyFlags	requiredFlags
	Flags that must be set in a Memory Type chosen for an allocation. More...

VkMemoryPropertyFlags	preferredFlags
	Flags that preferably should be set in a memory type chosen for an allocation. More...

uint32_t	memoryTypeBits
	Bitmask containing one bit set for every memory type acceptable for this allocation. More...

VmaPool	pool
	Pool that this allocation should be created in. More...

void *	pUserData
	Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using vmaSetAllocationUserData(). More...

Member Data Documentation

◆ flags

VmaAllocationCreateFlags _::flags

Use VmaAllocationCreateFlagBits enum.

◆ memoryTypeBits

uint32_t _::memoryTypeBits

Bitmask containing one bit set for every memory type acceptable for this allocation.

Value 0 is equivalent to UINT32_MAX - it means any memory type is accepted if it meets other requirements specified by this structure, with no further restrictions on memory type index.
If pool is not null, this member is ignored.

◆ pool

VmaPool _::pool

Pool that this allocation should be created in.

Leave VK_NULL_HANDLE to allocate from default pool. If not null, members: usage, requiredFlags, preferredFlags, memoryTypeBits are ignored.

◆ preferredFlags

VkMemoryPropertyFlags _::preferredFlags

Flags that preferably should be set in a memory type chosen for an allocation.

Set to 0 if no additional flags are prefered.
If pool is not null, this member is ignored.

◆ pUserData

void* _::pUserData

Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using vmaSetAllocationUserData().

If VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT is used, it must be either null or pointer to a null-terminated string. The string will be then copied to internal buffer, so it doesn't need to be valid after allocation call.