Interface VMAAllocatorType

All Superinterfaces:

AutoCloseable, com.io7m.jmulticlose.core.CloseableType, VulkanHandleDispatchableType, VulkanHandleType

All Known Implementing Classes:

VMALWJGLAllocator

public interface VMAAllocatorType
extends VulkanHandleDispatchableType

A configured VMA allocator.

Method Summary

Modifier and Type	Method	Description
VMATotalStatistics	calculateStatistics()	Calculate the full statistics for the allocator.
VMAAllocationResult<VulkanBufferType>	createBuffer(VMAAllocationCreateInfo alloc_create_info, VulkanBufferCreateInfo buffer_create_info)	Allocate a buffer.
VMAAllocationResult<VulkanImageType>	createImage(VMAAllocationCreateInfo alloc_create_info, VulkanImageCreateInfo image_create_info)	Allocate an image.
List<VMAHeapBudget>	getHeapBudgets()	Get the current memory usage and recommended budget for each memory heap.
VMAMappedMemoryType	mapMemory(VMAAllocationType allocation)	Map the memory associated with the given allocation.
void	setCurrentFrameIndex(int frame_index)	Set the current frame index.

Methods inherited from interface com.io7m.jmulticlose.core.CloseableType

isClosed

Methods inherited from interface VulkanHandleType

close

Method Details

createBuffer

VMAAllocationResult<VulkanBufferType> createBuffer(VMAAllocationCreateInfo alloc_create_info,
 VulkanBufferCreateInfo buffer_create_info)
                                            throws VulkanException

Allocate a buffer.

Parameters:

alloc_create_info - The allocation creation info

buffer_create_info - The buffer creation info

Returns:

An allocation

Throws:

VulkanException - On errors

createImage

VMAAllocationResult<VulkanImageType> createImage(VMAAllocationCreateInfo alloc_create_info,
 VulkanImageCreateInfo image_create_info)
                                          throws VulkanException

Allocate an image.

Parameters:

alloc_create_info - The allocation creation info

image_create_info - The image creation info

Returns:

An allocation

Throws:

VulkanException - On errors

mapMemory

VMAMappedMemoryType mapMemory(VMAAllocationType allocation)
                       throws VulkanException

Map the memory associated with the given allocation.

Parameters:

allocation - The VMA allocation

Returns:

The memory, mapped

Throws:

VulkanException - On errors

getHeapBudgets

List<VMAHeapBudget> getHeapBudgets()
                            throws VulkanException

Get the current memory usage and recommended budget for each memory heap.

Returns:

A list of heap budgets, indexed by heap index

Throws:

VulkanException - On errors

calculateStatistics

VMATotalStatistics calculateStatistics()
                                throws VulkanException

Calculate the full statistics for the allocator. This traverses all internal allocator data structures and is more expensive than getHeapBudgets(). Intended for periodic monitoring or debugging, not for per-frame use.

Returns:

The full statistics

Throws:

VulkanException - On errors

setCurrentFrameIndex

void setCurrentFrameIndex(int frame_index)
                   throws VulkanException

Set the current frame index. Call once per frame when the allocator was created with VMA_ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT, so that the budget is queried from the Vulkan device.

Parameters:

frame_index - The frame index

Throws:

VulkanException - On errors