Detailed Description

Represents single memory allocation.

It may be either dedicated block of VkDeviceMemory or a specific region of a bigger block of this type plus unique offset.

There are multiple ways to create such object. You need to fill structure VmaAllocationCreateInfo. For more information see Choosing memory type.

Although the library provides convenience functions that create Vulkan buffer or image, allocate memory for it and bind them together, binding of the allocation to a buffer or an image is out of scope of the allocation itself. Allocation object can exist without buffer/image bound, binding can be done manually by the user, and destruction of it can be done independently of destruction of the allocation.

The object also remembers its size and some other information. To retrieve this information, use function vmaGetAllocationInfo() and inspect returned structure VmaAllocationInfo.

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

/home/docker/jenkins/workspace/technical-docs/source/third_party/vma/vk_mem_alloc.h