Open 3D Engine Atom Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
VmaVirtualAllocationCreateInfo Struct Reference

Parameters of created virtual allocation to be passed to vmaVirtualAllocate(). More...

#include <vk_mem_alloc.h>

Public Attributes

VkDeviceSize size
 Size of the allocation. More...
 
VkDeviceSize alignment
 Required alignment of the allocation. Optional. More...
 
VmaVirtualAllocationCreateFlags flags
 Use combination of VmaVirtualAllocationCreateFlagBits.
 
void *VMA_NULLABLE pUserData
 Custom pointer to be associated with the allocation. Optional. More...
 

Detailed Description

Parameters of created virtual allocation to be passed to vmaVirtualAllocate().

Member Data Documentation

◆ alignment

VkDeviceSize VmaVirtualAllocationCreateInfo::alignment

Required alignment of the allocation. Optional.

Must be power of two. Special value 0 has the same meaning as 1 - means no special alignment is required, so allocation can start at any offset.

◆ pUserData

void* VMA_NULLABLE VmaVirtualAllocationCreateInfo::pUserData

Custom pointer to be associated with the allocation. Optional.

It can be any value and can be used for user-defined purposes. It can be fetched or changed later.

◆ size

VkDeviceSize VmaVirtualAllocationCreateInfo::size

Size of the allocation.

Cannot be zero.


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