vkQuake2 doxygen  1.0 dev
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...
 
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...
 
voidpUserData
 Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using vmaSetAllocationUserData(). More...
 

Detailed Description

Definition at line 2214 of file vk_mem_alloc.h.

Member Data Documentation

◆ flags

VmaAllocationCreateFlags VmaAllocationCreateInfo::flags

Use VmaAllocationCreateFlagBits enum.

Definition at line 2217 of file vk_mem_alloc.h.

Referenced by QVk_CreateBuffer(), and QVk_CreateImage().

◆ memoryTypeBits

uint32_t VmaAllocationCreateInfo::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.

Definition at line 2241 of file vk_mem_alloc.h.

◆ pool

VmaPool VmaAllocationCreateInfo::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.

Definition at line 2247 of file vk_mem_alloc.h.

◆ 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.
If pool is not null, this member is ignored.

Definition at line 2233 of file vk_mem_alloc.h.

◆ pUserData

void* VmaAllocationCreateInfo::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.

Definition at line 2254 of file vk_mem_alloc.h.

◆ requiredFlags

VkMemoryPropertyFlags VmaAllocationCreateInfo::requiredFlags

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

Leave 0 if you specify memory requirements in other way.
If pool is not null, this member is ignored.

Definition at line 2228 of file vk_mem_alloc.h.

◆ usage

VmaMemoryUsage VmaAllocationCreateInfo::usage

Intended usage of memory.

You can leave VMA_MEMORY_USAGE_UNKNOWN if you specify memory requirements in other way.
If pool is not null, this member is ignored.

Definition at line 2223 of file vk_mem_alloc.h.