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	deviceMemory
	Handle to Vulkan memory object. More...

VkDeviceSize	offset
	Offset into deviceMemory object to the beginning of this allocation, in bytes. More...

VkDeviceSize	size
	Size of this allocation, in bytes. More...

void *	pMappedData
	Pointer to the beginning of this allocation as mapped data. More...

void *	pUserData
	Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vmaSetAllocationUserData(). More...

Detailed Description

Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().

Definition at line 2531 of file vk_mem_alloc.h.

Member Data Documentation

◆ deviceMemory

VkDeviceMemory VmaAllocationInfo::deviceMemory

Handle to Vulkan memory object.

Same memory object can be shared by multiple allocations.

It can change after call to vmaDefragment() if this allocation is passed to the function, or if allocation is lost.

If the allocation is lost, it is equal to VK_NULL_HANDLE.

Definition at line 2545 of file vk_mem_alloc.h.

Referenced by CreateDrawBuffers(), CreateStaticBuffers(), Draw_StretchRaw(), LM_UploadBlock(), Vk_BeginBuildingLightmaps(), and Vk_LoadPic().

◆ memoryType

uint32_t VmaAllocationInfo::memoryType

Memory type index that this allocation was allocated from.

It never changes.

Definition at line 2536 of file vk_mem_alloc.h.

◆ offset

VkDeviceSize VmaAllocationInfo::offset

Offset into deviceMemory object to the beginning of this allocation, in bytes.

(deviceMemory, offset) pair is unique to this allocation.

It can change after call to vmaDefragment() if this allocation is passed to the function, or if allocation is lost.

Definition at line 2550 of file vk_mem_alloc.h.

◆ pMappedData

void* 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 null.

It can change after call to vmaMapMemory(), vmaUnmapMemory(). It can also change after call to vmaDefragment() if this allocation is passed to the function.

Definition at line 2564 of file vk_mem_alloc.h.

Referenced by CreateStagingBuffers(), QVk_GetIndexBuffer(), QVk_GetStagingBuffer(), QVk_GetUniformBuffer(), QVk_GetVertexBuffer(), and QVk_ReadPixels().

◆ pUserData

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

Definition at line 2569 of file vk_mem_alloc.h.

◆ size

VkDeviceSize VmaAllocationInfo::size

Size of this allocation, in bytes.

It never changes, unless allocation is lost.

Definition at line 2555 of file vk_mem_alloc.h.

Public Attributes