|
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.
|
|
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.
|
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo(). More...
#include <vk_mem_alloc.h>
Public Attributes | |
| uint32_t | memoryType |
| Memory type index that this allocation was allocated from. More... | |
| VkDeviceMemory VMA_NULLABLE_NON_DISPATCHABLE | deviceMemory |
| Handle to Vulkan memory object. More... | |
| VkDeviceSize | offset |
Offset in VkDeviceMemory object to the beginning of this allocation, in bytes. (deviceMemory, offset) pair is unique to this allocation. More... | |
| VkDeviceSize | size |
| Size of this allocation, in bytes. More... | |
| void *VMA_NULLABLE | pMappedData |
| Pointer to the beginning of this allocation as mapped data. More... | |
| void *VMA_NULLABLE | pUserData |
| Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vmaSetAllocationUserData(). More... | |
| const char *VMA_NULLABLE | pName |
| Custom allocation name that was set with vmaSetAllocationName(). More... | |
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
| VkDeviceMemory VMA_NULLABLE_NON_DISPATCHABLE VmaAllocationInfo::deviceMemory |
Handle to Vulkan memory object.
Same memory object can be shared by multiple allocations.
It can change after the allocation is moved during Defragmentation.
| uint32_t VmaAllocationInfo::memoryType |
Memory type index that this allocation was allocated from.
It never changes.
| VkDeviceSize VmaAllocationInfo::offset |
Offset in VkDeviceMemory object to the beginning of this allocation, in bytes. (deviceMemory, offset) pair is unique to this allocation.
You usually don't need to use this offset. If you create a buffer or an image together with the allocation using e.g. function vmaCreateBuffer(), vmaCreateImage(), functions that operate on these resources refer to the beginning of the buffer or image, not entire device memory block. Functions like vmaMapMemory(), vmaBindBufferMemory() also refer to the beginning of the allocation and apply this offset automatically.
It can change after the allocation is moved during Defragmentation.
| void* VMA_NULLABLE VmaAllocationInfo::pMappedData |
Pointer to the beginning of this allocation as mapped data.
If the allocation hasn't been mapped using vmaMapMemory() and hasn't been created with VMA_ALLOCATION_CREATE_MAPPED_BIT flag, this value is null.
It can change after call to vmaMapMemory(), vmaUnmapMemory(). It can also change after the allocation is moved during Defragmentation.
| const char* VMA_NULLABLE VmaAllocationInfo::pName |
Custom allocation name that was set with vmaSetAllocationName().
It can change after call to vmaSetAllocationName() for this allocation.
Another way to set custom name is to pass it in VmaAllocationCreateInfo::pUserData with additional flag VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT set [DEPRECATED].
| void* VMA_NULLABLE VmaAllocationInfo::pUserData |
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vmaSetAllocationUserData().
It can change after call to vmaSetAllocationUserData() for this allocation.
| VkDeviceSize VmaAllocationInfo::size |
Size of this allocation, in bytes.
It never changes.
VkBufferCreateInfo::size. Whole size of the allocation is accessible for operations on memory e.g. using a pointer after mapping with vmaMapMemory(), but operations on the resource e.g. using vkCmdCopyBuffer must be limited to the size of the resource. 
1.9.1