Vulkan Memory Allocator
Public Attributes | List of all members
VmaAllocationCreateInfo Struct Reference

#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...
 
void * pUserData
 Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using vmaSetAllocationUserData(). More...
 
VmaPool pool
 Pool that this allocation should be created in. More...
 

Member Data Documentation

◆ flags

VmaAllocationCreateFlags VmaAllocationCreateInfo::flags

Use VmaAllocationCreateFlagBits enum.

◆ pool

VmaPool VmaAllocationCreateInfo::pool

Pool that this allocation should be created in.

Leave VK_NULL_HANDLE to allocate from general memory.

◆ preferredFlags

VkMemoryPropertyFlags VmaAllocationCreateInfo::preferredFlags

Flags that preferably should be set in a Memory Type chosen for an allocation.

Set to 0 if no additional flags are prefered and only requiredFlags should be used.
If not 0, it must be a superset or equal to requiredFlags.
If pool is not null, this member is ignored.

◆ pUserData

void* VmaAllocationCreateInfo::pUserData

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

◆ requiredFlags

VkMemoryPropertyFlags VmaAllocationCreateInfo::requiredFlags

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

Leave 0 if you specify requirement via usage.
If pool is not null, this member is ignored.

◆ usage

VmaMemoryUsage VmaAllocationCreateInfo::usage

Intended usage of memory.

Leave VMA_MEMORY_USAGE_UNKNOWN if you specify requiredFlags. You can also use both.
If pool is not null, this member is ignored.


The documentation for this struct was generated from the following file: