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

Parameters for defragmentation. More...

#include <vk_mem_alloc.h>

Public Attributes

VmaDefragmentationFlags flags
 Use combination of VmaDefragmentationFlagBits.
 
VmaPool VMA_NULLABLE pool
 Custom pool to be defragmented.
 
VkDeviceSize maxBytesPerPass
 Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
 
uint32_t maxAllocationsPerPass
 Maximum number of allocations that can be moved during single pass to a different place.
 
PFN_vmaCheckDefragmentationBreakFunction VMA_NULLABLE pfnBreakCallback
 Optional custom callback for stopping vmaBeginDefragmentation().
 
void *VMA_NULLABLE pBreakCallbackUserData
 Optional data to pass to custom callback for stopping pass of defragmentation.
 

Detailed Description

Parameters for defragmentation.

To be used with function vmaBeginDefragmentation().

Member Data Documentation

◆ maxAllocationsPerPass

uint32_t VmaDefragmentationInfo::maxAllocationsPerPass

Maximum number of allocations that can be moved during single pass to a different place.

0 means no limit.

◆ maxBytesPerPass

VkDeviceSize VmaDefragmentationInfo::maxBytesPerPass

Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.

0 means no limit.

◆ pfnBreakCallback

PFN_vmaCheckDefragmentationBreakFunction VMA_NULLABLE VmaDefragmentationInfo::pfnBreakCallback

Optional custom callback for stopping vmaBeginDefragmentation().

Have to return true for breaking current defragmentation pass.

◆ pool

VmaPool VMA_NULLABLE VmaDefragmentationInfo::pool

Custom pool to be defragmented.

If null then default pools will undergo defragmentation process.


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