VulkanMemoryAllocator

Documentation

createAllocator :: forall io. MonadIO io => AllocatorCreateInfo -> io Allocator

Creates Allocator object.

withAllocator :: forall io r. MonadIO io => AllocatorCreateInfo -> (io Allocator -> (Allocator -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createAllocator and destroyAllocator

To ensure that destroyAllocator is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyAllocator :: forall io. MonadIO io => Allocator -> io ()

Destroys allocator object.

getAllocatorInfo :: forall io. MonadIO io => Allocator -> io AllocatorInfo

Returns information about existing Allocator object - handle to Vulkan device etc.

It might be useful if you want to keep just the Allocator handle and fetch other required handles to VkPhysicalDevice, VkDevice etc. every time using this function.

getPhysicalDeviceProperties :: forall io. MonadIO io => Allocator -> io (Ptr PhysicalDeviceProperties)

PhysicalDeviceProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own.

getMemoryProperties :: forall io. MonadIO io => Allocator -> io (Ptr PhysicalDeviceMemoryProperties)

PhysicalDeviceMemoryProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own.

getMemoryTypeProperties :: forall io. MonadIO io => Allocator -> ("memoryTypeIndex" ::: Word32) -> io MemoryPropertyFlags

Given Memory Type Index, returns Property Flags of this memory type.

This is just a convenience function. Same information can be obtained using getMemoryProperties.

setCurrentFrameIndex :: forall io. MonadIO io => Allocator -> ("frameIndex" ::: Word32) -> io ()

Sets index of the current frame.

This function must be used if you make allocations with ALLOCATION_CREATE_CAN_BECOME_LOST_BIT and ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT flags to inform the allocator when a new frame begins. Allocations queried using getAllocationInfo cannot become lost in the current frame.

calculateStats :: forall io. MonadIO io => Allocator -> io Stats

Retrieves statistics from current state of the Allocator.

This function is called "calculate" not "get" because it has to traverse all internal data structures, so it may be quite slow. For faster but more brief statistics suitable to be called every frame or every allocation, use getBudget.

Note that when using allocator from multiple threads, returned information may immediately become outdated.

getBudget :: forall io. MonadIO io => Allocator -> io ("budget" ::: Vector Budget)

Retrieves information about current memory budget for all memory heaps.

Parameters

out

pBudget

Must point to array with number of elements at least equal to number of memory heaps in physical device used.

This function is called "get" not "calculate" because it is very fast, suitable to be called every frame or every allocation. For more detailed statistics use calculateStats.

Note that when using allocator from multiple threads, returned information may immediately become outdated.

buildStatsString :: forall io. MonadIO io => Allocator -> ("detailedMap" ::: Bool) -> io ("statsString" ::: Ptr CChar)

Builds and returns statistics as string in JSON format.

Parameters

out

ppStatsString

Must be freed using freeStatsString function.

freeStatsString :: forall io. MonadIO io => Allocator -> ("statsString" ::: Ptr CChar) -> io ()

findMemoryTypeIndex :: forall io. MonadIO io => Allocator -> ("memoryTypeBits" ::: Word32) -> AllocationCreateInfo -> io ("memoryTypeIndex" ::: Word32)

Helps to find memoryTypeIndex, given memoryTypeBits and AllocationCreateInfo.

This algorithm tries to find a memory type that:

• Is allowed by memoryTypeBits.
• Contains all the flags from pAllocationCreateInfo->requiredFlags.
• Matches intended usage.
• Has as many flags from pAllocationCreateInfo->preferredFlags as possible.

Returns

Returns VK_ERROR_FEATURE_NOT_PRESENT if not found. Receiving such result from this function or any other allocating function probably means that your device doesn't support any memory type with requested features for the specific type of resource you want to use it for. Please check parameters of your resource, like image layout (OPTIMAL versus LINEAR) or mip level count.

findMemoryTypeIndexForBufferInfo :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo a -> AllocationCreateInfo -> io ("memoryTypeIndex" ::: Word32)

Helps to find memoryTypeIndex, given VkBufferCreateInfo and AllocationCreateInfo.

It can be useful e.g. to determine value to be used as VmaPoolCreateInfo::memoryTypeIndex. It internally creates a temporary, dummy buffer that never has memory bound. It is just a convenience function, equivalent to calling:

• vkCreateBuffer

• vkGetBufferMemoryRequirements

• findMemoryTypeIndex

• vkDestroyBuffer

findMemoryTypeIndexForImageInfo :: forall a io. (Extendss ImageCreateInfo a, PokeChain a, MonadIO io) => Allocator -> ImageCreateInfo a -> AllocationCreateInfo -> io ("memoryTypeIndex" ::: Word32)

Helps to find memoryTypeIndex, given VkImageCreateInfo and AllocationCreateInfo.

It can be useful e.g. to determine value to be used as VmaPoolCreateInfo::memoryTypeIndex. It internally creates a temporary, dummy image that never has memory bound. It is just a convenience function, equivalent to calling:

• vkCreateImage

• vkGetImageMemoryRequirements

• findMemoryTypeIndex

• vkDestroyImage

createPool :: forall io. MonadIO io => Allocator -> PoolCreateInfo -> io Pool

Allocates Vulkan device memory and creates Pool object.

Parameters

	allocator	Allocator object.
	pCreateInfo	Parameters of pool to create.
out	pPool	Handle to created pool.

withPool :: forall io r. MonadIO io => Allocator -> PoolCreateInfo -> (io Pool -> (Pool -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createPool and destroyPool

To ensure that destroyPool is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyPool :: forall io. MonadIO io => Allocator -> Pool -> io ()

Destroys Pool object and frees Vulkan device memory.

getPoolStats :: forall io. MonadIO io => Allocator -> Pool -> io PoolStats

Retrieves statistics of existing Pool object.

Parameters

	allocator	Allocator object.
	pool	Pool object.
out	pPoolStats	Statistics of specified pool.

makePoolAllocationsLost :: forall io. MonadIO io => Allocator -> Pool -> io ("lostAllocationCount" ::: Word64)

Marks all allocations in given pool as lost if they are not used in current frame or VmaPoolCreateInfo::frameInUseCount back from now.

Parameters

	allocator	Allocator object.
	pool	Pool.
out	pLostAllocationCount	Number of allocations marked as lost. Optional - pass null if you don't need this information.

checkPoolCorruption :: forall io. MonadIO io => Allocator -> Pool -> io ()

Checks magic number in margins around all allocations in given memory pool in search for corruptions.

Corruption detection is enabled only when VMA_DEBUG_DETECT_CORRUPTION macro is defined to nonzero, VMA_DEBUG_MARGIN is defined to nonzero and the pool is created in memory type that is HOST_VISIBLE and HOST_COHERENT. For more information, see Corruption detection.

Possible return values:

• VK_ERROR_FEATURE_NOT_PRESENT - corruption detection is not enabled for specified pool.
• VK_SUCCESS - corruption detection has been performed and succeeded.
• VK_ERROR_VALIDATION_FAILED_EXT - corruption detection has been performed and found memory corruptions around one of the allocations. VMA_ASSERT is also fired in that case.
• Other value: Error returned by Vulkan, e.g. memory mapping failure.

getPoolName :: forall io. MonadIO io => Allocator -> Pool -> io ("name" ::: Ptr CChar)

Retrieves name of a custom pool.

After the call ppName is either null or points to an internally-owned null-terminated string containing name of the pool that was previously set. The pointer becomes invalid when the pool is destroyed or its name is changed using setPoolName.

setPoolName :: forall io. MonadIO io => Allocator -> Pool -> ("name" ::: Maybe ByteString) -> io ()

Sets name of a custom pool.

pName can be either null or pointer to a null-terminated string with new name for the pool. Function makes internal copy of the string, so it can be changed or freed immediately after this call.

allocateMemory :: forall io. MonadIO io => Allocator -> ("vkMemoryRequirements" ::: MemoryRequirements) -> AllocationCreateInfo -> io (Allocation, AllocationInfo)

General purpose memory allocation.

Parameters

out	pAllocation	Handle to allocated memory.
out	pAllocationInfo	Optional. Information about allocated memory. It can be later fetched using function getAllocationInfo.

You should free the memory using freeMemory or freeMemoryPages.

It is recommended to use allocateMemoryForBuffer, allocateMemoryForImage, createBuffer, createImage instead whenever possible.

withMemory :: forall io r. MonadIO io => Allocator -> MemoryRequirements -> AllocationCreateInfo -> (io (Allocation, AllocationInfo) -> ((Allocation, AllocationInfo) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to allocateMemory and freeMemory

To ensure that freeMemory is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

allocateMemoryPages :: forall io. MonadIO io => Allocator -> ("vkMemoryRequirements" ::: Vector MemoryRequirements) -> ("createInfo" ::: Vector AllocationCreateInfo) -> io ("allocations" ::: Vector Allocation, "allocationInfo" ::: Vector AllocationInfo)

General purpose memory allocation for multiple allocation objects at once.

Parameters

	allocator	Allocator object.
	pVkMemoryRequirements	Memory requirements for each allocation.
	pCreateInfo	Creation parameters for each alloction.
	allocationCount	Number of allocations to make.
out	pAllocations	Pointer to array that will be filled with handles to created allocations.
out	pAllocationInfo	Optional. Pointer to array that will be filled with parameters of created allocations.

You should free the memory using freeMemory or freeMemoryPages.

Word "pages" is just a suggestion to use this function to allocate pieces of memory needed for sparse binding. It is just a general purpose allocation function able to make multiple allocations at once. It may be internally optimized to be more efficient than calling allocateMemory allocationCount times.

All allocations are made using same parameters. All of them are created out of the same memory pool and type. If any allocation fails, all allocations already made within this function call are also freed, so that when returned result is not VK_SUCCESS, pAllocation array is always entirely filled with VK_NULL_HANDLE.

withMemoryPages :: forall io r. MonadIO io => Allocator -> Vector MemoryRequirements -> Vector AllocationCreateInfo -> (io (Vector Allocation, Vector AllocationInfo) -> ((Vector Allocation, Vector AllocationInfo) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to allocateMemoryPages and freeMemoryPages

To ensure that freeMemoryPages is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

allocateMemoryForBuffer :: forall io. MonadIO io => Allocator -> Buffer -> AllocationCreateInfo -> io (Allocation, AllocationInfo)

Parameters

out	pAllocation	Handle to allocated memory.
out	pAllocationInfo	Optional. Information about allocated memory. It can be later fetched using function getAllocationInfo.

You should free the memory using freeMemory.

withMemoryForBuffer :: forall io r. MonadIO io => Allocator -> Buffer -> AllocationCreateInfo -> (io (Allocation, AllocationInfo) -> ((Allocation, AllocationInfo) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to allocateMemoryForBuffer and freeMemory

To ensure that freeMemory is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

allocateMemoryForImage :: forall io. MonadIO io => Allocator -> Image -> AllocationCreateInfo -> io (Allocation, AllocationInfo)

Function similar to allocateMemoryForBuffer.

withMemoryForImage :: forall io r. MonadIO io => Allocator -> Image -> AllocationCreateInfo -> (io (Allocation, AllocationInfo) -> ((Allocation, AllocationInfo) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to allocateMemoryForImage and freeMemory

To ensure that freeMemory is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

freeMemory :: forall io. MonadIO io => Allocator -> Allocation -> io ()

Frees memory previously allocated using allocateMemory, allocateMemoryForBuffer, or allocateMemoryForImage.

Passing VK_NULL_HANDLE as allocation is valid. Such function call is just skipped.

freeMemoryPages :: forall io. MonadIO io => Allocator -> ("allocations" ::: Vector Allocation) -> io ()

Frees memory and destroys multiple allocations.

Word "pages" is just a suggestion to use this function to free pieces of memory used for sparse binding. It is just a general purpose function to free memory and destroy allocations made using e.g. allocateMemory, allocateMemoryPages and other functions. It may be internally optimized to be more efficient than calling freeMemory allocationCount times.

Allocations in pAllocations array can come from any memory pools and types. Passing VK_NULL_HANDLE as elements of pAllocations array is valid. Such entries are just skipped.

getAllocationInfo :: forall io. MonadIO io => Allocator -> Allocation -> io AllocationInfo

Returns current information about specified allocation and atomically marks it as used in current frame.

Current paramteres of given allocation are returned in pAllocationInfo.

This function also atomically "touches" allocation - marks it as used in current frame, just like touchAllocation. If the allocation is in lost state, pAllocationInfo->deviceMemory == VK_NULL_HANDLE.

Although this function uses atomics and doesn't lock any mutex, so it should be quite efficient, you can avoid calling it too often.

• You can retrieve same AllocationInfo structure while creating your resource, from function createBuffer, createImage. You can remember it if you are sure parameters don't change (e.g. due to defragmentation or allocation becoming lost).
• If you just want to check if allocation is not lost, touchAllocation will work faster.

touchAllocation :: forall io. MonadIO io => Allocator -> Allocation -> io Bool

Returns VK_TRUE if allocation is not lost and atomically marks it as used in current frame.

If the allocation has been created with ALLOCATION_CREATE_CAN_BECOME_LOST_BIT flag, this function returns VK_TRUE if it's not in lost state, so it can still be used. It then also atomically "touches" the allocation - marks it as used in current frame, so that you can be sure it won't become lost in current frame or next frameInUseCount frames.

If the allocation is in lost state, the function returns VK_FALSE. Memory of such allocation, as well as buffer or image bound to it, should not be used. Lost allocation and the buffer/image still need to be destroyed.

If the allocation has been created without ALLOCATION_CREATE_CAN_BECOME_LOST_BIT flag, this function always returns VK_TRUE.

setAllocationUserData :: forall io. MonadIO io => Allocator -> Allocation -> ("userData" ::: Ptr ()) -> io ()

Sets pUserData in given allocation to new value.

If the allocation was created with VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT, pUserData must be either null, or pointer to a null-terminated string. The function makes local copy of the string and sets it as allocation's pUserData. String passed as pUserData doesn't need to be valid for whole lifetime of the allocation - you can free it after this call. String previously pointed by allocation's pUserData is freed from memory.

If the flag was not used, the value of pointer pUserData is just copied to allocation's pUserData. It is opaque, so you can use it however you want - e.g. as a pointer, ordinal number or some handle to you own data.

createLostAllocation :: forall io. MonadIO io => Allocator -> io Allocation

Creates new allocation that is in lost state from the beginning.

It can be useful if you need a dummy, non-null allocation.

You still need to destroy created object using freeMemory.

Returned allocation is not tied to any specific memory pool or memory type and not bound to any image or buffer. It has size = 0. It cannot be turned into a real, non-empty allocation.

withLostAllocation :: forall io r. MonadIO io => Allocator -> (io Allocation -> (Allocation -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createLostAllocation and freeMemory

To ensure that freeMemory is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

mapMemory :: forall io. MonadIO io => Allocator -> Allocation -> io ("data" ::: Ptr ())

Maps memory represented by given allocation and returns pointer to it.

Maps memory represented by given allocation to make it accessible to CPU code. When succeeded, *ppData contains pointer to first byte of this memory. If the allocation is part of bigger VkDeviceMemory block, the pointer is correctly offsetted to the beginning of region assigned to this particular allocation.

Mapping is internally reference-counted and synchronized, so despite raw Vulkan function vkMapMemory() cannot be used to map same block of VkDeviceMemory multiple times simultaneously, it is safe to call this function on allocations assigned to the same memory block. Actual Vulkan memory will be mapped on first mapping and unmapped on last unmapping.

If the function succeeded, you must call unmapMemory to unmap the allocation when mapping is no longer needed or before freeing the allocation, at the latest.

It also safe to call this function multiple times on the same allocation. You must call unmapMemory same number of times as you called mapMemory.

It is also safe to call this function on allocation created with ALLOCATION_CREATE_MAPPED_BIT flag. Its memory stays mapped all the time. You must still call unmapMemory same number of times as you called mapMemory. You must not call unmapMemory additional time to free the "0-th" mapping made automatically due to ALLOCATION_CREATE_MAPPED_BIT flag.

This function fails when used on allocation made in memory type that is not HOST_VISIBLE.

This function always fails when called for allocation that was created with ALLOCATION_CREATE_CAN_BECOME_LOST_BIT flag. Such allocations cannot be mapped.

This function doesn't automatically flush or invalidate caches. If the allocation is made from a memory types that is not HOST_COHERENT, you also need to use invalidateAllocation / flushAllocation, as required by Vulkan specification.

withMappedMemory :: forall io r. MonadIO io => Allocator -> Allocation -> (io (Ptr ()) -> (Ptr () -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to mapMemory and unmapMemory

To ensure that unmapMemory is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

unmapMemory :: forall io. MonadIO io => Allocator -> Allocation -> io ()

Unmaps memory represented by given allocation, mapped previously using mapMemory.

For details, see description of mapMemory.

This function doesn't automatically flush or invalidate caches. If the allocation is made from a memory types that is not HOST_COHERENT, you also need to use invalidateAllocation / flushAllocation, as required by Vulkan specification.

flushAllocation :: forall io. MonadIO io => Allocator -> Allocation -> ("offset" ::: DeviceSize) -> DeviceSize -> io ()

Flushes memory of given allocation.

Calls vkFlushMappedMemoryRanges() for memory associated with given range of given allocation. It needs to be called after writing to a mapped memory for memory types that are not HOST_COHERENT. Unmap operation doesn't do that automatically.

• offset must be relative to the beginning of allocation.
• size can be VK_WHOLE_SIZE. It means all memory from offset the the end of given allocation.
• offset and size don't have to be aligned. They are internally rounded down/up to multiply of nonCoherentAtomSize.
• If size is 0, this call is ignored.
• If memory type that the allocation belongs to is not HOST_VISIBLE or it is HOST_COHERENT, this call is ignored.

Warning! offset and size are relative to the contents of given allocation. If you mean whole allocation, you can pass 0 and VK_WHOLE_SIZE, respectively. Do not pass allocation's offset as offset!!!

This function returns the VkResult from vkFlushMappedMemoryRanges if it is called, otherwise VK_SUCCESS.

invalidateAllocation :: forall io. MonadIO io => Allocator -> Allocation -> ("offset" ::: DeviceSize) -> DeviceSize -> io ()

Invalidates memory of given allocation.

Calls vkInvalidateMappedMemoryRanges() for memory associated with given range of given allocation. It needs to be called before reading from a mapped memory for memory types that are not HOST_COHERENT. Map operation doesn't do that automatically.

• offset must be relative to the beginning of allocation.
• size can be VK_WHOLE_SIZE. It means all memory from offset the the end of given allocation.
• offset and size don't have to be aligned. They are internally rounded down/up to multiply of nonCoherentAtomSize.
• If size is 0, this call is ignored.
• If memory type that the allocation belongs to is not HOST_VISIBLE or it is HOST_COHERENT, this call is ignored.

Warning! offset and size are relative to the contents of given allocation. If you mean whole allocation, you can pass 0 and VK_WHOLE_SIZE, respectively. Do not pass allocation's offset as offset!!!

This function returns the VkResult from vkInvalidateMappedMemoryRanges if it is called, otherwise VK_SUCCESS.

flushAllocations :: forall io. MonadIO io => Allocator -> ("allocations" ::: Vector Allocation) -> ("offsets" ::: Vector DeviceSize) -> ("sizes" ::: Vector DeviceSize) -> io ()

Flushes memory of given set of allocations.

Calls vkFlushMappedMemoryRanges() for memory associated with given ranges of given allocations. For more information, see documentation of flushAllocation.

Parameters

allocator
allocationCount
allocations
offsets	If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero.
sizes	If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means VK_WHOLE_SIZE for all allocations.

This function returns the VkResult from vkFlushMappedMemoryRanges if it is called, otherwise VK_SUCCESS.

invalidateAllocations :: forall io. MonadIO io => Allocator -> ("allocations" ::: Vector Allocation) -> ("offsets" ::: Vector DeviceSize) -> ("sizes" ::: Vector DeviceSize) -> io ()

Invalidates memory of given set of allocations.

Calls vkInvalidateMappedMemoryRanges() for memory associated with given ranges of given allocations. For more information, see documentation of invalidateAllocation.

Parameters

allocator
allocationCount
allocations
offsets	If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero.
sizes	If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means VK_WHOLE_SIZE for all allocations.

This function returns the VkResult from vkInvalidateMappedMemoryRanges if it is called, otherwise VK_SUCCESS.

checkCorruption :: forall io. MonadIO io => Allocator -> ("memoryTypeBits" ::: Word32) -> io ()

Checks magic number in margins around all allocations in given memory types (in both default and custom pools) in search for corruptions.

Parameters

memoryTypeBits

Bit mask, where each bit set means that a memory type with that index should be checked.

Corruption detection is enabled only when VMA_DEBUG_DETECT_CORRUPTION macro is defined to nonzero, VMA_DEBUG_MARGIN is defined to nonzero and only for memory types that are HOST_VISIBLE and HOST_COHERENT. For more information, see Corruption detection.

Possible return values:

• VK_ERROR_FEATURE_NOT_PRESENT - corruption detection is not enabled for any of specified memory types.
• VK_SUCCESS - corruption detection has been performed and succeeded.
• VK_ERROR_VALIDATION_FAILED_EXT - corruption detection has been performed and found memory corruptions around one of the allocations. VMA_ASSERT is also fired in that case.
• Other value: Error returned by Vulkan, e.g. memory mapping failure.

defragmentationBegin :: forall io. MonadIO io => Allocator -> DefragmentationInfo2 -> io (Result, DefragmentationStats, DefragmentationContext)

Begins defragmentation process.

Parameters

	allocator	Allocator object.
	pInfo	Structure filled with parameters of defragmentation.
out	pStats	Optional. Statistics of defragmentation. You can pass null if you are not interested in this information.
out	pContext	Context object that must be passed to defragmentationEnd to finish defragmentation.

Returns

VK_SUCCESS and *pContext == null if defragmentation finished within this function call. VK_NOT_READY and *pContext != null if defragmentation has been started and you need to call defragmentationEnd to finish it. Negative value in case of error.

Use this function instead of old, deprecated defragment.

Warning! Between the call to defragmentationBegin and defragmentationEnd:

• You should not use any of allocations passed as pInfo->pAllocations or any allocations that belong to pools passed as pInfo->pPools, including calling getAllocationInfo, touchAllocation, or access their data.
• Some mutexes protecting internal data structures may be locked, so trying to make or free any allocations, bind buffers or images, map memory, or launch another simultaneous defragmentation in between may cause stall (when done on another thread) or deadlock (when done on the same thread), unless you are 100% sure that defragmented allocations are in different pools.
• Information returned via pStats and pInfo->pAllocationsChanged are undefined. They become valid after call to defragmentationEnd.
• If pInfo->commandBuffer is not null, you must submit that command buffer and make sure it finished execution before calling defragmentationEnd.

For more information and important limitations regarding defragmentation, see documentation chapter: Defragmentation.

withDefragmentation :: forall io r. MonadIO io => Allocator -> DefragmentationInfo2 -> (io (Result, DefragmentationStats, DefragmentationContext) -> ((Result, DefragmentationStats, DefragmentationContext) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to defragmentationBegin and defragmentationEnd

To ensure that defragmentationEnd is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

defragmentationEnd :: forall io. MonadIO io => Allocator -> DefragmentationContext -> io ()

Ends defragmentation process.

Use this function to finish defragmentation started by defragmentationBegin. It is safe to pass context == null. The function then does nothing.

beginDefragmentationPass :: forall io. MonadIO io => Allocator -> DefragmentationContext -> io DefragmentationPassInfo

useDefragmentationPass :: forall io r. MonadIO io => Allocator -> DefragmentationContext -> (DefragmentationPassInfo -> io r) -> io r

This function will call the supplied action between calls to beginDefragmentationPass and endDefragmentationPass

Note that endDefragmentationPass is *not* called if an exception is thrown by the inner action.

endDefragmentationPass :: forall io. MonadIO io => Allocator -> DefragmentationContext -> io ()

defragment :: forall io. MonadIO io => Allocator -> ("allocations" ::: Vector Allocation) -> ("defragmentationInfo" ::: Maybe DefragmentationInfo) -> io ("allocationsChanged" ::: Vector Bool, DefragmentationStats)

Deprecated. Compacts memory by moving allocations.

Parameters

	pAllocations	Array of allocations that can be moved during this compation.
	allocationCount	Number of elements in pAllocations and pAllocationsChanged arrays.
out	pAllocationsChanged	Array of boolean values that will indicate whether matching allocation in pAllocations array has been moved. This parameter is optional. Pass null if you don't need this information.
	pDefragmentationInfo	Configuration parameters. Optional - pass null to use default values.
out	pDefragmentationStats	Statistics returned by the function. Optional - pass null if you don't need this information.

Returns

VK_SUCCESS if completed, negative error code in case of error.

Deprecated

This is a part of the old interface. It is recommended to use structure DefragmentationInfo2 and function defragmentationBegin instead.

This function works by moving allocations to different places (different VkDeviceMemory objects and/or different offsets) in order to optimize memory usage. Only allocations that are in pAllocations array can be moved. All other allocations are considered nonmovable in this call. Basic rules:

• Only allocations made in memory types that have VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT and VK_MEMORY_PROPERTY_HOST_COHERENT_BIT flags can be compacted. You may pass other allocations but it makes no sense - these will never be moved.
• Custom pools created with POOL_CREATE_LINEAR_ALGORITHM_BIT or POOL_CREATE_BUDDY_ALGORITHM_BIT flag are not defragmented. Allocations passed to this function that come from such pools are ignored.
• Allocations created with ALLOCATION_CREATE_DEDICATED_MEMORY_BIT or created as dedicated allocations for any other reason are also ignored.
• Both allocations made with or without ALLOCATION_CREATE_MAPPED_BIT flag can be compacted. If not persistently mapped, memory will be mapped temporarily inside this function if needed.
• You must not pass same Allocation object multiple times in pAllocations array.

The function also frees empty VkDeviceMemory blocks.

Warning: This function may be time-consuming, so you shouldn't call it too often (like after every resource creation/destruction). You can call it on special occasions (like when reloading a game level or when you just destroyed a lot of objects). Calling it every frame may be OK, but you should measure that on your platform.

For more information, see Defragmentation chapter.

bindBufferMemory :: forall io. MonadIO io => Allocator -> Allocation -> Buffer -> io ()

Binds buffer to allocation.

Binds specified buffer to region of memory represented by specified allocation. Gets VkDeviceMemory handle and offset from the allocation. If you want to create a buffer, allocate memory for it and bind them together separately, you should use this function for binding instead of standard vkBindBufferMemory(), because it ensures proper synchronization so that when a VkDeviceMemory object is used by multiple allocations, calls to vkBind*Memory() or vkMapMemory() won't happen from multiple threads simultaneously (which is illegal in Vulkan).

It is recommended to use function createBuffer instead of this one.

bindBufferMemory2 :: forall io. MonadIO io => Allocator -> Allocation -> ("allocationLocalOffset" ::: DeviceSize) -> Buffer -> ("next" ::: Ptr ()) -> io ()

Binds buffer to allocation with additional parameters.

Parameters

allocationLocalOffset	Additional offset to be added while binding, relative to the beginning of the allocation. Normally it should be 0.
pNext	A chain of structures to be attached to VkBindBufferMemoryInfoKHR structure used internally. Normally it should be null.

This function is similar to bindBufferMemory, but it provides additional parameters.

If pNext is not null, Allocator object must have been created with ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT flag or with VmaAllocatorCreateInfo::vulkanApiVersion >= VK_API_VERSION_1_1. Otherwise the call fails.

bindImageMemory :: forall io. MonadIO io => Allocator -> Allocation -> Image -> io ()

Binds image to allocation.

Binds specified image to region of memory represented by specified allocation. Gets VkDeviceMemory handle and offset from the allocation. If you want to create an image, allocate memory for it and bind them together separately, you should use this function for binding instead of standard vkBindImageMemory(), because it ensures proper synchronization so that when a VkDeviceMemory object is used by multiple allocations, calls to vkBind*Memory() or vkMapMemory() won't happen from multiple threads simultaneously (which is illegal in Vulkan).

It is recommended to use function createImage instead of this one.

bindImageMemory2 :: forall io. MonadIO io => Allocator -> Allocation -> ("allocationLocalOffset" ::: DeviceSize) -> Image -> ("next" ::: Ptr ()) -> io ()

Binds image to allocation with additional parameters.

Parameters

allocationLocalOffset	Additional offset to be added while binding, relative to the beginning of the allocation. Normally it should be 0.
pNext	A chain of structures to be attached to VkBindImageMemoryInfoKHR structure used internally. Normally it should be null.

This function is similar to bindImageMemory, but it provides additional parameters.

If pNext is not null, Allocator object must have been created with ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT flag or with VmaAllocatorCreateInfo::vulkanApiVersion >= VK_API_VERSION_1_1. Otherwise the call fails.

createBuffer :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo a -> AllocationCreateInfo -> io (Buffer, Allocation, AllocationInfo)

Parameters

out	pBuffer	Buffer that was created.
out	pAllocation	Allocation that was created.
out	pAllocationInfo	Optional. Information about allocated memory. It can be later fetched using function getAllocationInfo.

This function automatically:

1. Creates buffer.
2. Allocates appropriate memory for it.
3. Binds the buffer with the memory.

If any of these operations fail, buffer and allocation are not created, returned value is negative error code, *pBuffer and *pAllocation are null.

If the function succeeded, you must destroy both buffer and allocation when you no longer need them using either convenience function destroyBuffer or separately, using vkDestroyBuffer() and freeMemory.

If ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT flag was used, VK_KHR_dedicated_allocation extension is used internally to query driver whether it requires or prefers the new buffer to have dedicated allocation. If yes, and if dedicated allocation is possible (VmaAllocationCreateInfo::pool is null and ALLOCATION_CREATE_NEVER_ALLOCATE_BIT is not used), it creates dedicated allocation for this buffer, just like when using ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.

Note

This function creates a new VkBuffer. Sub-allocation of parts of one large buffer, although recommended as a good practice, is out of scope of this library and could be implemented by the user as a higher-level logic on top of VMA.

withBuffer :: forall a io r. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo a -> AllocationCreateInfo -> (io (Buffer, Allocation, AllocationInfo) -> ((Buffer, Allocation, AllocationInfo) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createBuffer and destroyBuffer

To ensure that destroyBuffer is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

createBufferWithAlignment :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo a -> AllocationCreateInfo -> ("minAlignment" ::: DeviceSize) -> io (Buffer, Allocation, AllocationInfo)

Creates a buffer with additional minimum alignment.

Similar to createBuffer but provides additional parameter minAlignment which allows to specify custom, minimum alignment to be used when placing the buffer inside a larger memory block, which may be needed e.g. for interop with OpenGL.

destroyBuffer :: forall io. MonadIO io => Allocator -> Buffer -> Allocation -> io ()

Destroys Vulkan buffer and frees allocated memory.

This is just a convenience function equivalent to:

vkDestroyBuffer(device, buffer, allocationCallbacks);
vmaFreeMemory(allocator, allocation);

It it safe to pass null as buffer and/or allocation.

createImage :: forall a io. (Extendss ImageCreateInfo a, PokeChain a, MonadIO io) => Allocator -> ImageCreateInfo a -> AllocationCreateInfo -> io (Image, Allocation, AllocationInfo)

Function similar to createBuffer.

withImage :: forall a io r. (Extendss ImageCreateInfo a, PokeChain a, MonadIO io) => Allocator -> ImageCreateInfo a -> AllocationCreateInfo -> (io (Image, Allocation, AllocationInfo) -> ((Image, Allocation, AllocationInfo) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createImage and destroyImage

To ensure that destroyImage is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyImage :: forall io. MonadIO io => Allocator -> Image -> Allocation -> io ()

Destroys Vulkan image and frees allocated memory.

This is just a convenience function equivalent to:

vkDestroyImage(device, image, allocationCallbacks);
vmaFreeMemory(allocator, allocation);

It it safe to pass null as image and/or allocation.

newtype Allocator

VmaAllocator

Represents main object of this library initialized.

Fill structure AllocatorCreateInfo and call function createAllocator to create it. Call function destroyAllocator to destroy it.

It is recommended to create just one object of this type per VkDevice object, right after Vulkan is initialized and keep it alive until before Vulkan device is destroyed.

Constructors

Allocator Word64

Instances

Eq Allocator

Defined in VulkanMemoryAllocator

Methods

(==) :: Allocator -> Allocator -> Bool

(/=) :: Allocator -> Allocator -> Bool

Ord Allocator

Defined in VulkanMemoryAllocator

Methods

compare :: Allocator -> Allocator -> Ordering

(<) :: Allocator -> Allocator -> Bool

(<=) :: Allocator -> Allocator -> Bool

(>) :: Allocator -> Allocator -> Bool

(>=) :: Allocator -> Allocator -> Bool

max :: Allocator -> Allocator -> Allocator

min :: Allocator -> Allocator -> Allocator

Show Allocator

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> Allocator -> ShowS

show :: Allocator -> String

showList :: [Allocator] -> ShowS

Storable Allocator

Defined in VulkanMemoryAllocator

Methods

sizeOf :: Allocator -> Int

alignment :: Allocator -> Int

peekElemOff :: Ptr Allocator -> Int -> IO Allocator

pokeElemOff :: Ptr Allocator -> Int -> Allocator -> IO ()

peekByteOff :: Ptr b -> Int -> IO Allocator

pokeByteOff :: Ptr b -> Int -> Allocator -> IO ()

peek :: Ptr Allocator -> IO Allocator

poke :: Ptr Allocator -> Allocator -> IO ()

IsHandle Allocator

Defined in VulkanMemoryAllocator

Zero Allocator

Defined in VulkanMemoryAllocator

Methods

zero :: Allocator

type PFN_vmaAllocateDeviceMemoryFunction = FunPtr FN_vmaAllocateDeviceMemoryFunction

type FN_vmaAllocateDeviceMemoryFunction = Allocator -> ("memoryType" ::: Word32) -> DeviceMemory -> DeviceSize -> ("pUserData" ::: Ptr ()) -> IO ()

type PFN_vmaFreeDeviceMemoryFunction = FunPtr FN_vmaFreeDeviceMemoryFunction

type FN_vmaFreeDeviceMemoryFunction = Allocator -> ("memoryType" ::: Word32) -> DeviceMemory -> DeviceSize -> ("pUserData" ::: Ptr ()) -> IO ()

data DeviceMemoryCallbacks

VmaDeviceMemoryCallbacks

Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory.

Provided for informative purpose, e.g. to gather statistics about number of allocations or total amount of memory allocated in Vulkan.

Used in VmaAllocatorCreateInfo::pDeviceMemoryCallbacks.

Constructors

DeviceMemoryCallbacks

Fields

• pfnAllocate :: PFN_vmaAllocateDeviceMemoryFunction

  Optional, can be null.

• pfnFree :: PFN_vmaFreeDeviceMemoryFunction

  Optional, can be null.

• userData :: Ptr ()

  Optional, can be null.

Instances

Show DeviceMemoryCallbacks

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DeviceMemoryCallbacks -> ShowS

show :: DeviceMemoryCallbacks -> String

showList :: [DeviceMemoryCallbacks] -> ShowS

Storable DeviceMemoryCallbacks

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DeviceMemoryCallbacks -> Int

alignment :: DeviceMemoryCallbacks -> Int

peekElemOff :: Ptr DeviceMemoryCallbacks -> Int -> IO DeviceMemoryCallbacks

pokeElemOff :: Ptr DeviceMemoryCallbacks -> Int -> DeviceMemoryCallbacks -> IO ()

peekByteOff :: Ptr b -> Int -> IO DeviceMemoryCallbacks

pokeByteOff :: Ptr b -> Int -> DeviceMemoryCallbacks -> IO ()

peek :: Ptr DeviceMemoryCallbacks -> IO DeviceMemoryCallbacks

poke :: Ptr DeviceMemoryCallbacks -> DeviceMemoryCallbacks -> IO ()

Zero DeviceMemoryCallbacks

Defined in VulkanMemoryAllocator

Methods

zero :: DeviceMemoryCallbacks

ToCStruct DeviceMemoryCallbacks

Defined in VulkanMemoryAllocator

Methods

withCStruct :: DeviceMemoryCallbacks -> (Ptr DeviceMemoryCallbacks -> IO b) -> IO b

pokeCStruct :: Ptr DeviceMemoryCallbacks -> DeviceMemoryCallbacks -> IO b -> IO b

withZeroCStruct :: (Ptr DeviceMemoryCallbacks -> IO b) -> IO b

pokeZeroCStruct :: Ptr DeviceMemoryCallbacks -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DeviceMemoryCallbacks

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr DeviceMemoryCallbacks -> IO DeviceMemoryCallbacks

type AllocatorCreateFlags = AllocatorCreateFlagBits

newtype AllocatorCreateFlagBits

Flags for created Allocator.

Constructors

AllocatorCreateFlagBits Flags

Bundled Patterns

pattern ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT :: AllocatorCreateFlagBits

Allocator and all objects created from it will not be synchronized internally, so you must guarantee they are used from only one thread at a time or synchronized externally by you.

Using this flag may increase performance because internal mutexes are not used.

pattern ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT :: AllocatorCreateFlagBits

Enables usage of VK_KHR_dedicated_allocation extension.

The flag works only if VmaAllocatorCreateInfo::vulkanApiVersion == VK_API_VERSION_1_0. When it's VK_API_VERSION_1_1, the flag is ignored because the extension has been promoted to Vulkan 1.1.

Using this extension will automatically allocate dedicated blocks of memory for some buffers and images instead of suballocating place for them out of bigger memory blocks (as if you explicitly used ALLOCATION_CREATE_DEDICATED_MEMORY_BIT flag) when it is recommended by the driver. It may improve performance on some GPUs.

You may set this flag only if you found out that following device extensions are supported, you enabled them while creating Vulkan device passed as VmaAllocatorCreateInfo::device, and you want them to be used internally by this library:

• VK_KHR_get_memory_requirements2 (device extension)
• VK_KHR_dedicated_allocation (device extension)

When this flag is set, you can experience following warnings reported by Vulkan validation layer. You can ignore them.

vkBindBufferMemory(): Binding memory to buffer 0x2d but vkGetBufferMemoryRequirements() has not been called on that buffer.

pattern ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT :: AllocatorCreateFlagBits

Enables usage of VK_KHR_bind_memory2 extension.

The flag works only if VmaAllocatorCreateInfo::vulkanApiVersion == VK_API_VERSION_1_0. When it's VK_API_VERSION_1_1, the flag is ignored because the extension has been promoted to Vulkan 1.1.

You may set this flag only if you found out that this device extension is supported, you enabled it while creating Vulkan device passed as VmaAllocatorCreateInfo::device, and you want it to be used internally by this library.

The extension provides functions vkBindBufferMemory2KHR and vkBindImageMemory2KHR, which allow to pass a chain of pNext structures while binding. This flag is required if you use pNext parameter in bindBufferMemory2 or bindImageMemory2.

pattern ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT :: AllocatorCreateFlagBits

Enables usage of VK_EXT_memory_budget extension.

You may set this flag only if you found out that this device extension is supported, you enabled it while creating Vulkan device passed as VmaAllocatorCreateInfo::device, and you want it to be used internally by this library, along with another instance extension VK_KHR_get_physical_device_properties2, which is required by it (or Vulkan 1.1, where this extension is promoted).

The extension provides query for current memory usage and budget, which will probably be more accurate than an estimation used by the library otherwise.

pattern ALLOCATOR_CREATE_AMD_DEVICE_COHERENT_MEMORY_BIT :: AllocatorCreateFlagBits

Enables usage of VK_AMD_device_coherent_memory extension.

You may set this flag only if you:

• found out that this device extension is supported and enabled it while creating Vulkan device passed as VmaAllocatorCreateInfo::device,
• checked that VkPhysicalDeviceCoherentMemoryFeaturesAMD::deviceCoherentMemory is true and set it while creating the Vulkan device,
• want it to be used internally by this library.

The extension and accompanying device feature provide access to memory types with VK_MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD and VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD flags. They are useful mostly for writing breadcrumb markers - a common method for debugging GPU crash/hang/TDR.

When the extension is not enabled, such memory types are still enumerated, but their usage is illegal. To protect from this error, if you don't create the allocator with this flag, it will refuse to allocate any memory or create a custom pool in such memory type, returning VK_ERROR_FEATURE_NOT_PRESENT.

pattern ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT :: AllocatorCreateFlagBits

Enables usage of "buffer device address" feature, which allows you to use function vkGetBufferDeviceAddress* to get raw GPU pointer to a buffer and pass it for usage inside a shader.

You may set this flag only if you:

1. (For Vulkan version < 1.2) Found as available and enabled device extension VK_KHR_buffer_device_address. This extension is promoted to core Vulkan 1.2.
2. Found as available and enabled device feature VkPhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddress.

When this flag is set, you can create buffers with VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT using VMA. The library automatically adds VK_MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT to allocated memory blocks wherever it might be needed.

For more information, see documentation chapter /Enabling buffer device address/.

pattern ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT :: AllocatorCreateFlagBits

Enables usage of VK_EXT_memory_priority extension in the library.

You may set this flag only if you found available and enabled this device extension, along with VkPhysicalDeviceMemoryPriorityFeaturesEXT::memoryPriority == VK_TRUE, while creating Vulkan device passed as VmaAllocatorCreateInfo::device.

When this flag is used, VmaAllocationCreateInfo::priority and VmaPoolCreateInfo::priority are used to set priorities of allocated Vulkan memory. Without it, these variables are ignored.

A priority must be a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent. It is automatically passed to every call to vkAllocateMemory done by the library using structure VkMemoryPriorityAllocateInfoEXT. The value to be used for default priority is 0.5. For more details, see the documentation of the VK_EXT_memory_priority extension.

Instances

Eq AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

(==) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Bool

(/=) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Bool

Ord AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

compare :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Ordering

(<) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Bool

(<=) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Bool

(>) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Bool

(>=) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> Bool

max :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> AllocatorCreateFlagBits

min :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> AllocatorCreateFlagBits

Read AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

readsPrec :: Int -> ReadS AllocatorCreateFlagBits

readList :: ReadS [AllocatorCreateFlagBits]

readPrec :: ReadPrec AllocatorCreateFlagBits

readListPrec :: ReadPrec [AllocatorCreateFlagBits]

Show AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> AllocatorCreateFlagBits -> ShowS

show :: AllocatorCreateFlagBits -> String

showList :: [AllocatorCreateFlagBits] -> ShowS

Storable AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

sizeOf :: AllocatorCreateFlagBits -> Int

alignment :: AllocatorCreateFlagBits -> Int

peekElemOff :: Ptr AllocatorCreateFlagBits -> Int -> IO AllocatorCreateFlagBits

pokeElemOff :: Ptr AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO AllocatorCreateFlagBits

pokeByteOff :: Ptr b -> Int -> AllocatorCreateFlagBits -> IO ()

peek :: Ptr AllocatorCreateFlagBits -> IO AllocatorCreateFlagBits

poke :: Ptr AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> IO ()

Bits AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

(.&.) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> AllocatorCreateFlagBits

(.|.) :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> AllocatorCreateFlagBits

xor :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits -> AllocatorCreateFlagBits

complement :: AllocatorCreateFlagBits -> AllocatorCreateFlagBits

shift :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

rotate :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

zeroBits :: AllocatorCreateFlagBits

bit :: Int -> AllocatorCreateFlagBits

setBit :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

clearBit :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

complementBit :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

testBit :: AllocatorCreateFlagBits -> Int -> Bool

bitSizeMaybe :: AllocatorCreateFlagBits -> Maybe Int

bitSize :: AllocatorCreateFlagBits -> Int

isSigned :: AllocatorCreateFlagBits -> Bool

shiftL :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

unsafeShiftL :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

shiftR :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

unsafeShiftR :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

rotateL :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

rotateR :: AllocatorCreateFlagBits -> Int -> AllocatorCreateFlagBits

popCount :: AllocatorCreateFlagBits -> Int

FiniteBits AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

finiteBitSize :: AllocatorCreateFlagBits -> Int

countLeadingZeros :: AllocatorCreateFlagBits -> Int

countTrailingZeros :: AllocatorCreateFlagBits -> Int

Zero AllocatorCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

zero :: AllocatorCreateFlagBits

data VulkanFunctions

VmaVulkanFunctions

Pointers to some Vulkan functions - a subset used by the library.

Used in VmaAllocatorCreateInfo::pVulkanFunctions.

Constructors

VulkanFunctions

Fields

• vkGetPhysicalDeviceProperties :: PFN_vkGetPhysicalDeviceProperties
• vkGetPhysicalDeviceMemoryProperties :: PFN_vkGetPhysicalDeviceMemoryProperties
• vkAllocateMemory :: PFN_vkAllocateMemory
• vkFreeMemory :: PFN_vkFreeMemory
• vkMapMemory :: PFN_vkMapMemory
• vkUnmapMemory :: PFN_vkUnmapMemory
• vkFlushMappedMemoryRanges :: PFN_vkFlushMappedMemoryRanges
• vkInvalidateMappedMemoryRanges :: PFN_vkInvalidateMappedMemoryRanges
• vkBindBufferMemory :: PFN_vkBindBufferMemory
• vkBindImageMemory :: PFN_vkBindImageMemory
• vkGetBufferMemoryRequirements :: PFN_vkGetBufferMemoryRequirements
• vkGetImageMemoryRequirements :: PFN_vkGetImageMemoryRequirements
• vkCreateBuffer :: PFN_vkCreateBuffer
• vkDestroyBuffer :: PFN_vkDestroyBuffer
• vkCreateImage :: PFN_vkCreateImage
• vkDestroyImage :: PFN_vkDestroyImage
• vkCmdCopyBuffer :: PFN_vkCmdCopyBuffer
• vkGetBufferMemoryRequirements2KHR :: PFN_vkGetBufferMemoryRequirements2KHR
• vkGetImageMemoryRequirements2KHR :: PFN_vkGetImageMemoryRequirements2KHR
• vkBindBufferMemory2KHR :: PFN_vkBindBufferMemory2KHR
• vkBindImageMemory2KHR :: PFN_vkBindImageMemory2KHR
• vkGetPhysicalDeviceMemoryProperties2KHR :: PFN_vkGetPhysicalDeviceMemoryProperties2KHR

Instances

Eq VulkanFunctions

Defined in VulkanMemoryAllocator

Methods

(==) :: VulkanFunctions -> VulkanFunctions -> Bool

(/=) :: VulkanFunctions -> VulkanFunctions -> Bool

Show VulkanFunctions

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> VulkanFunctions -> ShowS

show :: VulkanFunctions -> String

showList :: [VulkanFunctions] -> ShowS

Storable VulkanFunctions

Defined in VulkanMemoryAllocator

Methods

sizeOf :: VulkanFunctions -> Int

alignment :: VulkanFunctions -> Int

peekElemOff :: Ptr VulkanFunctions -> Int -> IO VulkanFunctions

pokeElemOff :: Ptr VulkanFunctions -> Int -> VulkanFunctions -> IO ()

peekByteOff :: Ptr b -> Int -> IO VulkanFunctions

pokeByteOff :: Ptr b -> Int -> VulkanFunctions -> IO ()

peek :: Ptr VulkanFunctions -> IO VulkanFunctions

poke :: Ptr VulkanFunctions -> VulkanFunctions -> IO ()

Zero VulkanFunctions

Defined in VulkanMemoryAllocator

Methods

zero :: VulkanFunctions

ToCStruct VulkanFunctions

Defined in VulkanMemoryAllocator

Methods

withCStruct :: VulkanFunctions -> (Ptr VulkanFunctions -> IO b) -> IO b

pokeCStruct :: Ptr VulkanFunctions -> VulkanFunctions -> IO b -> IO b

withZeroCStruct :: (Ptr VulkanFunctions -> IO b) -> IO b

pokeZeroCStruct :: Ptr VulkanFunctions -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct VulkanFunctions

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr VulkanFunctions -> IO VulkanFunctions

type RecordFlags = RecordFlagBits

newtype RecordFlagBits

Flags to be used in VmaRecordSettings::flags.

Constructors

RecordFlagBits Flags

Bundled Patterns

pattern RECORD_FLUSH_AFTER_CALL_BIT :: RecordFlagBits

Enables flush after recording every function call.

Enable it if you expect your application to crash, which may leave recording file truncated. It may degrade performance though.

Instances

Eq RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

(==) :: RecordFlagBits -> RecordFlagBits -> Bool

(/=) :: RecordFlagBits -> RecordFlagBits -> Bool

Ord RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

compare :: RecordFlagBits -> RecordFlagBits -> Ordering

(<) :: RecordFlagBits -> RecordFlagBits -> Bool

(<=) :: RecordFlagBits -> RecordFlagBits -> Bool

(>) :: RecordFlagBits -> RecordFlagBits -> Bool

(>=) :: RecordFlagBits -> RecordFlagBits -> Bool

max :: RecordFlagBits -> RecordFlagBits -> RecordFlagBits

min :: RecordFlagBits -> RecordFlagBits -> RecordFlagBits

Read RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

readsPrec :: Int -> ReadS RecordFlagBits

readList :: ReadS [RecordFlagBits]

readPrec :: ReadPrec RecordFlagBits

readListPrec :: ReadPrec [RecordFlagBits]

Show RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> RecordFlagBits -> ShowS

show :: RecordFlagBits -> String

showList :: [RecordFlagBits] -> ShowS

Storable RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

sizeOf :: RecordFlagBits -> Int

alignment :: RecordFlagBits -> Int

peekElemOff :: Ptr RecordFlagBits -> Int -> IO RecordFlagBits

pokeElemOff :: Ptr RecordFlagBits -> Int -> RecordFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO RecordFlagBits

pokeByteOff :: Ptr b -> Int -> RecordFlagBits -> IO ()

peek :: Ptr RecordFlagBits -> IO RecordFlagBits

poke :: Ptr RecordFlagBits -> RecordFlagBits -> IO ()

Bits RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

(.&.) :: RecordFlagBits -> RecordFlagBits -> RecordFlagBits

(.|.) :: RecordFlagBits -> RecordFlagBits -> RecordFlagBits

xor :: RecordFlagBits -> RecordFlagBits -> RecordFlagBits

complement :: RecordFlagBits -> RecordFlagBits

shift :: RecordFlagBits -> Int -> RecordFlagBits

rotate :: RecordFlagBits -> Int -> RecordFlagBits

zeroBits :: RecordFlagBits

bit :: Int -> RecordFlagBits

setBit :: RecordFlagBits -> Int -> RecordFlagBits

clearBit :: RecordFlagBits -> Int -> RecordFlagBits

complementBit :: RecordFlagBits -> Int -> RecordFlagBits

testBit :: RecordFlagBits -> Int -> Bool

bitSizeMaybe :: RecordFlagBits -> Maybe Int

bitSize :: RecordFlagBits -> Int

isSigned :: RecordFlagBits -> Bool

shiftL :: RecordFlagBits -> Int -> RecordFlagBits

unsafeShiftL :: RecordFlagBits -> Int -> RecordFlagBits

shiftR :: RecordFlagBits -> Int -> RecordFlagBits

unsafeShiftR :: RecordFlagBits -> Int -> RecordFlagBits

rotateL :: RecordFlagBits -> Int -> RecordFlagBits

rotateR :: RecordFlagBits -> Int -> RecordFlagBits

popCount :: RecordFlagBits -> Int

FiniteBits RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

finiteBitSize :: RecordFlagBits -> Int

countLeadingZeros :: RecordFlagBits -> Int

countTrailingZeros :: RecordFlagBits -> Int

Zero RecordFlagBits

Defined in VulkanMemoryAllocator

Methods

zero :: RecordFlagBits

data RecordSettings

VmaRecordSettings

Parameters for recording calls to VMA functions. To be used in VmaAllocatorCreateInfo::pRecordSettings.

Constructors

RecordSettings

Fields

• flags :: RecordFlags

  Flags for recording. Use RecordFlagBits enum.

• filePath :: ByteString

  Path to the file that should be written by the recording.

  Suggested extension: "csv". If the file already exists, it will be overwritten. It will be opened for the whole time Allocator object is alive. If opening this file fails, creation of the whole allocator object fails.

Instances

Show RecordSettings

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> RecordSettings -> ShowS

show :: RecordSettings -> String

showList :: [RecordSettings] -> ShowS

Zero RecordSettings

Defined in VulkanMemoryAllocator

Methods

zero :: RecordSettings

ToCStruct RecordSettings

Defined in VulkanMemoryAllocator

Methods

withCStruct :: RecordSettings -> (Ptr RecordSettings -> IO b) -> IO b

pokeCStruct :: Ptr RecordSettings -> RecordSettings -> IO b -> IO b

withZeroCStruct :: (Ptr RecordSettings -> IO b) -> IO b

pokeZeroCStruct :: Ptr RecordSettings -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct RecordSettings

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr RecordSettings -> IO RecordSettings

data AllocatorCreateInfo

VmaAllocatorCreateInfo

Description of a Allocator to be created.

Constructors

AllocatorCreateInfo

Fields

• flags :: AllocatorCreateFlags

  Flags for created allocator. Use AllocatorCreateFlagBits enum.

• physicalDevice :: Ptr PhysicalDevice_T

  Vulkan physical device.

  It must be valid throughout whole lifetime of created allocator.

• device :: Ptr Device_T

  Vulkan device.

  It must be valid throughout whole lifetime of created allocator.

• preferredLargeHeapBlockSize :: DeviceSize

  Preferred size of a single VkDeviceMemory block to be allocated from large heaps > 1 GiB. Optional.

  Set to 0 to use default, which is currently 256 MiB.

• allocationCallbacks :: Maybe AllocationCallbacks

  Custom CPU memory allocation callbacks. Optional.

  Optional, can be null. When specified, will also be used for all CPU-side memory allocations.

• deviceMemoryCallbacks :: Maybe DeviceMemoryCallbacks

  Informative callbacks for vkAllocateMemory, vkFreeMemory. Optional.

  Optional, can be null.

• frameInUseCount :: Word32

  Maximum number of additional frames that are in use at the same time as current frame.

  This value is used only when you make allocations with VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT flag. Such allocation cannot become lost if allocation.lastUseFrameIndex >= allocator.currentFrameIndex - frameInUseCount.

  For example, if you double-buffer your command buffers, so resources used for rendering in previous frame may still be in use by the GPU at the moment you allocate resources needed for the current frame, set this value to 1.

  If you want to allow any allocations other than used in the current frame to become lost, set this value to 0.

• heapSizeLimit :: Ptr DeviceSize

  Either null or a pointer to an array of limits on maximum number of bytes that can be allocated out of particular Vulkan memory heap.

  If not NULL, it must be a pointer to an array of VkPhysicalDeviceMemoryProperties::memoryHeapCount elements, defining limit on maximum number of bytes that can be allocated out of particular Vulkan memory heap.

  Any of the elements may be equal to VK_WHOLE_SIZE, which means no limit on that heap. This is also the default in case of pHeapSizeLimit = NULL.

  If there is a limit defined for a heap:

  • If user tries to allocate more memory from that heap using this allocator, the allocation fails with VK_ERROR_OUT_OF_DEVICE_MEMORY.
  • If the limit is smaller than heap size reported in VkMemoryHeap::size, the value of this limit will be reported instead when using getMemoryProperties.

  Warning! Using this feature may not be equivalent to installing a GPU with smaller amount of memory, because graphics driver doesn't necessary fail new allocations with VK_ERROR_OUT_OF_DEVICE_MEMORY result when memory capacity is exceeded. It may return success and just silently migrate some device memory blocks to system RAM. This driver behavior can also be controlled using VK_AMD_memory_overallocation_behavior extension.

• vulkanFunctions :: Maybe VulkanFunctions

  Pointers to Vulkan functions. Can be null.

  For details see Pointers to Vulkan functions.

• recordSettings :: Maybe RecordSettings

  Parameters for recording of VMA calls. Can be null.

  If not null, it enables recording of calls to VMA functions to a file. If support for recording is not enabled using VMA_RECORDING_ENABLED macro, creation of the allocator object fails with VK_ERROR_FEATURE_NOT_PRESENT.

• instance' :: Ptr Instance_T

  Handle to Vulkan instance object.

  Starting from version 3.0.0 this member is no longer optional, it must be set!

• vulkanApiVersion :: Word32

  Optional. The highest version of Vulkan that the application is designed to use.

  It must be a value in the format as created by macro VK_MAKE_VERSION or a constant like: VK_API_VERSION_1_1, VK_API_VERSION_1_0. The patch version number specified is ignored. Only the major and minor versions are considered. It must be less or equal (preferably equal) to value as passed to vkCreateInstance as VkApplicationInfo::apiVersion. Only versions 1.0, 1.1, 1.2 are supported by the current implementation. Leaving it initialized to zero is equivalent to VK_API_VERSION_1_0.

• typeExternalMemoryHandleTypes :: Ptr ExternalMemoryHandleTypeFlagsKHR

  Either null or a pointer to an array of external memory handle types for each Vulkan memory type.

  If not NULL, it must be a pointer to an array of VkPhysicalDeviceMemoryProperties::memoryTypeCount elements, defining external memory handle types of particular Vulkan memory type, to be passed using VkExportMemoryAllocateInfoKHR.

  Any of the elements may be equal to 0, which means not to use VkExportMemoryAllocateInfoKHR on this memory type. This is also the default in case of pTypeExternalMemoryHandleTypes = NULL.

Instances

Show AllocatorCreateInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> AllocatorCreateInfo -> ShowS

show :: AllocatorCreateInfo -> String

showList :: [AllocatorCreateInfo] -> ShowS

Zero AllocatorCreateInfo

Defined in VulkanMemoryAllocator

Methods

zero :: AllocatorCreateInfo

ToCStruct AllocatorCreateInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: AllocatorCreateInfo -> (Ptr AllocatorCreateInfo -> IO b) -> IO b

pokeCStruct :: Ptr AllocatorCreateInfo -> AllocatorCreateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr AllocatorCreateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr AllocatorCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct AllocatorCreateInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr AllocatorCreateInfo -> IO AllocatorCreateInfo

data AllocatorInfo

VmaAllocatorInfo

Information about existing Allocator object.

Constructors

AllocatorInfo

Fields

• instance' :: Ptr Instance_T

  Handle to Vulkan instance object.

  This is the same value as has been passed through VmaAllocatorCreateInfo::instance.

• physicalDevice :: Ptr PhysicalDevice_T

  Handle to Vulkan physical device object.

  This is the same value as has been passed through VmaAllocatorCreateInfo::physicalDevice.

• device :: Ptr Device_T

  Handle to Vulkan device object.

  This is the same value as has been passed through VmaAllocatorCreateInfo::device.

Instances

Eq AllocatorInfo

Defined in VulkanMemoryAllocator

Methods

(==) :: AllocatorInfo -> AllocatorInfo -> Bool

(/=) :: AllocatorInfo -> AllocatorInfo -> Bool

Show AllocatorInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> AllocatorInfo -> ShowS

show :: AllocatorInfo -> String

showList :: [AllocatorInfo] -> ShowS

Storable AllocatorInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: AllocatorInfo -> Int

alignment :: AllocatorInfo -> Int

peekElemOff :: Ptr AllocatorInfo -> Int -> IO AllocatorInfo

pokeElemOff :: Ptr AllocatorInfo -> Int -> AllocatorInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO AllocatorInfo

pokeByteOff :: Ptr b -> Int -> AllocatorInfo -> IO ()

peek :: Ptr AllocatorInfo -> IO AllocatorInfo

poke :: Ptr AllocatorInfo -> AllocatorInfo -> IO ()

Zero AllocatorInfo

Defined in VulkanMemoryAllocator

Methods

zero :: AllocatorInfo

ToCStruct AllocatorInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: AllocatorInfo -> (Ptr AllocatorInfo -> IO b) -> IO b

pokeCStruct :: Ptr AllocatorInfo -> AllocatorInfo -> IO b -> IO b

withZeroCStruct :: (Ptr AllocatorInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr AllocatorInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct AllocatorInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr AllocatorInfo -> IO AllocatorInfo

data StatInfo

VmaStatInfo

Calculated statistics of memory usage in entire allocator.

Constructors

StatInfo

Fields

• blockCount :: Word32

  Number of VkDeviceMemory Vulkan memory blocks allocated.

• allocationCount :: Word32

  Number of Allocation allocation objects allocated.

• unusedRangeCount :: Word32

  Number of free ranges of memory between allocations.

• usedBytes :: DeviceSize

  Total number of bytes occupied by all allocations.

• unusedBytes :: DeviceSize

  Total number of bytes occupied by unused ranges.

• allocationSizeMin :: DeviceSize
• allocationSizeAvg :: DeviceSize
• allocationSizeMax :: DeviceSize
• unusedRangeSizeMin :: DeviceSize
• unusedRangeSizeAvg :: DeviceSize
• unusedRangeSizeMax :: DeviceSize

Instances

Eq StatInfo

Defined in VulkanMemoryAllocator

Methods

(==) :: StatInfo -> StatInfo -> Bool

(/=) :: StatInfo -> StatInfo -> Bool

Show StatInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> StatInfo -> ShowS

show :: StatInfo -> String

showList :: [StatInfo] -> ShowS

Storable StatInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: StatInfo -> Int

alignment :: StatInfo -> Int

peekElemOff :: Ptr StatInfo -> Int -> IO StatInfo

pokeElemOff :: Ptr StatInfo -> Int -> StatInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO StatInfo

pokeByteOff :: Ptr b -> Int -> StatInfo -> IO ()

peek :: Ptr StatInfo -> IO StatInfo

poke :: Ptr StatInfo -> StatInfo -> IO ()

Zero StatInfo

Defined in VulkanMemoryAllocator

Methods

zero :: StatInfo

ToCStruct StatInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: StatInfo -> (Ptr StatInfo -> IO b) -> IO b

pokeCStruct :: Ptr StatInfo -> StatInfo -> IO b -> IO b

withZeroCStruct :: (Ptr StatInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr StatInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct StatInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr StatInfo -> IO StatInfo

data Stats

VmaStats

• StatInfo memoryType [VK_MAX_MEMORY_TYPES]
• StatInfo memoryHeap [VK_MAX_MEMORY_HEAPS]
• StatInfo total

General statistics from current state of Allocator.

memoryHeap

memoryHeap VmaStats VmaStats memoryHeap VmaStatInfo VmaStats::memoryHeap[VK_MAX_MEMORY_HEAPS]

memoryType

memoryType VmaStats VmaStats memoryType VmaStatInfo VmaStats::memoryType[VK_MAX_MEMORY_TYPES]

Constructors

Stats

Fields

• memoryType :: Vector StatInfo
• memoryHeap :: Vector StatInfo
• total :: StatInfo

Instances

Show Stats

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> Stats -> ShowS

show :: Stats -> String

showList :: [Stats] -> ShowS

Storable Stats

Defined in VulkanMemoryAllocator

Methods

sizeOf :: Stats -> Int

alignment :: Stats -> Int

peekElemOff :: Ptr Stats -> Int -> IO Stats

pokeElemOff :: Ptr Stats -> Int -> Stats -> IO ()

peekByteOff :: Ptr b -> Int -> IO Stats

pokeByteOff :: Ptr b -> Int -> Stats -> IO ()

peek :: Ptr Stats -> IO Stats

poke :: Ptr Stats -> Stats -> IO ()

Zero Stats

Defined in VulkanMemoryAllocator

Methods

zero :: Stats

ToCStruct Stats

Defined in VulkanMemoryAllocator

Methods

withCStruct :: Stats -> (Ptr Stats -> IO b) -> IO b

pokeCStruct :: Ptr Stats -> Stats -> IO b -> IO b

withZeroCStruct :: (Ptr Stats -> IO b) -> IO b

pokeZeroCStruct :: Ptr Stats -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Stats

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr Stats -> IO Stats

data Budget

VmaBudget

Statistics of current memory usage and available budget, in bytes, for specific memory heap.

Constructors

Budget

Fields

• blockBytes :: DeviceSize

  Sum size of all VkDeviceMemory blocks allocated from particular heap, in bytes.

• allocationBytes :: DeviceSize

  Sum size of all allocations created in particular heap, in bytes.

  Usually less or equal than blockBytes. Difference blockBytes - allocationBytes is the amount of memory allocated but unused - available for new allocations or wasted due to fragmentation.

  It might be greater than blockBytes if there are some allocations in lost state, as they account to this value as well.

• usage :: DeviceSize

  Estimated current memory usage of the program, in bytes.

  Fetched from system using VK_EXT_memory_budget extension if enabled.

  It might be different than blockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipelines, descriptor heaps, command buffers, or VkDeviceMemory blocks allocated outside of this library, if any.

• budget :: DeviceSize

  Estimated amount of memory available to the program, in bytes.

  Fetched from system using VK_EXT_memory_budget extension if enabled.

  It might be different (most probably smaller) than VkMemoryHeap::size[heapIndex] due to factors external to the program, like other programs also consuming system resources. Difference budget - usage is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.

Instances

Eq Budget

Defined in VulkanMemoryAllocator

Methods

(==) :: Budget -> Budget -> Bool

(/=) :: Budget -> Budget -> Bool

Show Budget

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> Budget -> ShowS

show :: Budget -> String

showList :: [Budget] -> ShowS

Storable Budget

Defined in VulkanMemoryAllocator

Methods

sizeOf :: Budget -> Int

alignment :: Budget -> Int

peekElemOff :: Ptr Budget -> Int -> IO Budget

pokeElemOff :: Ptr Budget -> Int -> Budget -> IO ()

peekByteOff :: Ptr b -> Int -> IO Budget

pokeByteOff :: Ptr b -> Int -> Budget -> IO ()

peek :: Ptr Budget -> IO Budget

poke :: Ptr Budget -> Budget -> IO ()

Zero Budget

Defined in VulkanMemoryAllocator

Methods

zero :: Budget

ToCStruct Budget

Defined in VulkanMemoryAllocator

Methods

withCStruct :: Budget -> (Ptr Budget -> IO b) -> IO b

pokeCStruct :: Ptr Budget -> Budget -> IO b -> IO b

withZeroCStruct :: (Ptr Budget -> IO b) -> IO b

pokeZeroCStruct :: Ptr Budget -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Budget

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr Budget -> IO Budget

newtype Pool

VmaPool

Represents custom memory pool.

Fill structure PoolCreateInfo and call function createPool to create it. Call function destroyPool to destroy it.

For more information see Custom memory pools.

Constructors

Pool Word64

Instances

Eq Pool

Defined in VulkanMemoryAllocator

Methods

(==) :: Pool -> Pool -> Bool

(/=) :: Pool -> Pool -> Bool

Ord Pool

Defined in VulkanMemoryAllocator

Methods

compare :: Pool -> Pool -> Ordering

(<) :: Pool -> Pool -> Bool

(<=) :: Pool -> Pool -> Bool

(>) :: Pool -> Pool -> Bool

(>=) :: Pool -> Pool -> Bool

max :: Pool -> Pool -> Pool

min :: Pool -> Pool -> Pool

Show Pool

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> Pool -> ShowS

show :: Pool -> String

showList :: [Pool] -> ShowS

Storable Pool

Defined in VulkanMemoryAllocator

Methods

sizeOf :: Pool -> Int

alignment :: Pool -> Int

peekElemOff :: Ptr Pool -> Int -> IO Pool

pokeElemOff :: Ptr Pool -> Int -> Pool -> IO ()

peekByteOff :: Ptr b -> Int -> IO Pool

pokeByteOff :: Ptr b -> Int -> Pool -> IO ()

peek :: Ptr Pool -> IO Pool

poke :: Ptr Pool -> Pool -> IO ()

IsHandle Pool

Defined in VulkanMemoryAllocator

Zero Pool

Defined in VulkanMemoryAllocator

Methods

zero :: Pool

newtype MemoryUsage

Constructors

MemoryUsage Int32

Bundled Patterns

pattern MEMORY_USAGE_UNKNOWN :: MemoryUsage

No intended memory usage specified. Use other members of AllocationCreateInfo to specify your requirements.

pattern MEMORY_USAGE_GPU_ONLY :: MemoryUsage

Memory will be used on device only, so fast access from the device is preferred. It usually means device-local GPU (video) memory. No need to be mappable on host. It is roughly equivalent of D3D12_HEAP_TYPE_DEFAULT.

Usage:

• Resources written and read by device, e.g. images used as attachments.
• Resources transferred from host once (immutable) or infrequently and read by device multiple times, e.g. textures to be sampled, vertex buffers, uniform (constant) buffers, and majority of other types of resources used on GPU.

Allocation may still end up in HOST_VISIBLE memory on some implementations. In such case, you are free to map it. You can use ALLOCATION_CREATE_MAPPED_BIT with this usage type.

pattern MEMORY_USAGE_CPU_ONLY :: MemoryUsage

Memory will be mappable on host. It usually means CPU (system) memory. Guarantees to be HOST_VISIBLE and HOST_COHERENT. CPU access is typically uncached. Writes may be write-combined. Resources created in this pool may still be accessible to the device, but access to them can be slow. It is roughly equivalent of D3D12_HEAP_TYPE_UPLOAD.

Usage: Staging copy of resources used as transfer source.

pattern MEMORY_USAGE_CPU_TO_GPU :: MemoryUsage

Memory that is both mappable on host (guarantees to be HOST_VISIBLE) and preferably fast to access by GPU. CPU access is typically uncached. Writes may be write-combined.

Usage: Resources written frequently by host (dynamic), read by device. E.g. textures (with LINEAR layout), vertex buffers, uniform buffers updated every frame or every draw call.

pattern MEMORY_USAGE_GPU_TO_CPU :: MemoryUsage

Memory mappable on host (guarantees to be HOST_VISIBLE) and cached. It is roughly equivalent of D3D12_HEAP_TYPE_READBACK.

Usage:

• Resources written by device, read by host - results of some computations, e.g. screen capture, average scene luminance for HDR tone mapping.
• Any resources read or accessed randomly on host, e.g. CPU-side copy of vertex buffer used as source of transfer, but also used for collision detection.

pattern MEMORY_USAGE_CPU_COPY :: MemoryUsage

CPU memory - memory that is preferably not DEVICE_LOCAL, but also not guaranteed to be HOST_VISIBLE.

Usage: Staging copy of resources moved from GPU memory to CPU memory as part of custom paging/residency mechanism, to be moved back to GPU memory when needed.

pattern MEMORY_USAGE_GPU_LAZILY_ALLOCATED :: MemoryUsage

Lazily allocated GPU memory having VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT. Exists mostly on mobile platforms. Using it on desktop PC or other GPUs with no such memory type present will fail the allocation.

Usage: Memory for transient attachment images (color attachments, depth attachments etc.), created with VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT.

Allocations with this usage are always created as dedicated - it implies ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.

Instances

Eq MemoryUsage

Defined in VulkanMemoryAllocator

Methods

(==) :: MemoryUsage -> MemoryUsage -> Bool

(/=) :: MemoryUsage -> MemoryUsage -> Bool

Ord MemoryUsage

Defined in VulkanMemoryAllocator

Methods

compare :: MemoryUsage -> MemoryUsage -> Ordering

(<) :: MemoryUsage -> MemoryUsage -> Bool

(<=) :: MemoryUsage -> MemoryUsage -> Bool

(>) :: MemoryUsage -> MemoryUsage -> Bool

(>=) :: MemoryUsage -> MemoryUsage -> Bool

max :: MemoryUsage -> MemoryUsage -> MemoryUsage

min :: MemoryUsage -> MemoryUsage -> MemoryUsage

Read MemoryUsage

Defined in VulkanMemoryAllocator

Methods

readsPrec :: Int -> ReadS MemoryUsage

readList :: ReadS [MemoryUsage]

readPrec :: ReadPrec MemoryUsage

readListPrec :: ReadPrec [MemoryUsage]

Show MemoryUsage

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> MemoryUsage -> ShowS

show :: MemoryUsage -> String

showList :: [MemoryUsage] -> ShowS

Storable MemoryUsage

Defined in VulkanMemoryAllocator

Methods

sizeOf :: MemoryUsage -> Int

alignment :: MemoryUsage -> Int

peekElemOff :: Ptr MemoryUsage -> Int -> IO MemoryUsage

pokeElemOff :: Ptr MemoryUsage -> Int -> MemoryUsage -> IO ()

peekByteOff :: Ptr b -> Int -> IO MemoryUsage

pokeByteOff :: Ptr b -> Int -> MemoryUsage -> IO ()

peek :: Ptr MemoryUsage -> IO MemoryUsage

poke :: Ptr MemoryUsage -> MemoryUsage -> IO ()

Zero MemoryUsage

Defined in VulkanMemoryAllocator

Methods

zero :: MemoryUsage

type AllocationCreateFlags = AllocationCreateFlagBits

newtype AllocationCreateFlagBits

Flags to be passed as VmaAllocationCreateInfo::flags.

Constructors

AllocationCreateFlagBits Flags

Bundled Patterns

pattern ALLOCATION_CREATE_DEDICATED_MEMORY_BIT :: AllocationCreateFlagBits

Set this flag if the allocation should have its own memory block.

Use it for special, big resources, like fullscreen images used as attachments.

You should not use this flag if VmaAllocationCreateInfo::pool is not null.

pattern ALLOCATION_CREATE_NEVER_ALLOCATE_BIT :: AllocationCreateFlagBits

Set this flag to only try to allocate from existing VkDeviceMemory blocks and never create new such block.

If new allocation cannot be placed in any of the existing blocks, allocation fails with VK_ERROR_OUT_OF_DEVICE_MEMORY error.

You should not use ALLOCATION_CREATE_DEDICATED_MEMORY_BIT and ALLOCATION_CREATE_NEVER_ALLOCATE_BIT at the same time. It makes no sense.

If VmaAllocationCreateInfo::pool is not null, this flag is implied and ignored.

pattern ALLOCATION_CREATE_MAPPED_BIT :: AllocationCreateFlagBits

Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.

Pointer to mapped memory will be returned through VmaAllocationInfo::pMappedData.

It is valid to use this flag for allocation made from memory type that is not HOST_VISIBLE. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (DEVICE_LOCAL) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).

You should not use this flag together with ALLOCATION_CREATE_CAN_BECOME_LOST_BIT.

pattern ALLOCATION_CREATE_CAN_BECOME_LOST_BIT :: AllocationCreateFlagBits

Allocation created with this flag can become lost as a result of another allocation with ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT flag, so you must check it before use.

To check if allocation is not lost, call getAllocationInfo and check if VmaAllocationInfo::deviceMemory is not VK_NULL_HANDLE.

For details about supporting lost allocations, see Lost Allocations chapter of User Guide on Main Page.

You should not use this flag together with ALLOCATION_CREATE_MAPPED_BIT.

pattern ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT :: AllocationCreateFlagBits

While creating allocation using this flag, other allocations that were created with flag ALLOCATION_CREATE_CAN_BECOME_LOST_BIT can become lost.

For details about supporting lost allocations, see Lost Allocations chapter of User Guide on Main Page.

pattern ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT :: AllocationCreateFlagBits

Set this flag to treat VmaAllocationCreateInfo::pUserData as pointer to a null-terminated string. Instead of copying pointer value, a local copy of the string is made and stored in allocation's pUserData. The string is automatically freed together with the allocation. It is also used in buildStatsString.

pattern ALLOCATION_CREATE_UPPER_ADDRESS_BIT :: AllocationCreateFlagBits

Allocation will be created from upper stack in a double stack pool.

This flag is only allowed for custom pools created with POOL_CREATE_LINEAR_ALGORITHM_BIT flag.

pattern ALLOCATION_CREATE_DONT_BIND_BIT :: AllocationCreateFlagBits

Create both buffer/image and allocation, but don't bind them together. It is useful when you want to bind yourself to do some more advanced binding, e.g. using some extensions. The flag is meaningful only with functions that bind by default: createBuffer, createImage. Otherwise it is ignored.

pattern ALLOCATION_CREATE_WITHIN_BUDGET_BIT :: AllocationCreateFlagBits

Create allocation only if additional device memory required for it, if any, won't exceed memory budget. Otherwise return VK_ERROR_OUT_OF_DEVICE_MEMORY.

pattern ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT :: AllocationCreateFlagBits

Allocation strategy that chooses smallest possible free range for the allocation.

pattern ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT :: AllocationCreateFlagBits

Allocation strategy that chooses biggest possible free range for the allocation.

pattern ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT :: AllocationCreateFlagBits

Allocation strategy that chooses first suitable free range for the allocation.

"First" doesn't necessarily means the one with smallest offset in memory, but rather the one that is easiest and fastest to find.

pattern ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT :: AllocationCreateFlagBits

Allocation strategy that tries to minimize memory usage.

pattern ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT :: AllocationCreateFlagBits

Allocation strategy that tries to minimize allocation time.

pattern ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT :: AllocationCreateFlagBits

Allocation strategy that tries to minimize memory fragmentation.

pattern ALLOCATION_CREATE_STRATEGY_MASK :: AllocationCreateFlagBits

A bit mask to extract only STRATEGY bits from entire set of flags.

Instances

Eq AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

(==) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Bool

(/=) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Bool

Ord AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

compare :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Ordering

(<) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Bool

(<=) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Bool

(>) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Bool

(>=) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> Bool

max :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> AllocationCreateFlagBits

min :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> AllocationCreateFlagBits

Read AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

readsPrec :: Int -> ReadS AllocationCreateFlagBits

readList :: ReadS [AllocationCreateFlagBits]

readPrec :: ReadPrec AllocationCreateFlagBits

readListPrec :: ReadPrec [AllocationCreateFlagBits]

Show AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> AllocationCreateFlagBits -> ShowS

show :: AllocationCreateFlagBits -> String

showList :: [AllocationCreateFlagBits] -> ShowS

Storable AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

sizeOf :: AllocationCreateFlagBits -> Int

alignment :: AllocationCreateFlagBits -> Int

peekElemOff :: Ptr AllocationCreateFlagBits -> Int -> IO AllocationCreateFlagBits

pokeElemOff :: Ptr AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO AllocationCreateFlagBits

pokeByteOff :: Ptr b -> Int -> AllocationCreateFlagBits -> IO ()

peek :: Ptr AllocationCreateFlagBits -> IO AllocationCreateFlagBits

poke :: Ptr AllocationCreateFlagBits -> AllocationCreateFlagBits -> IO ()

Bits AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

(.&.) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> AllocationCreateFlagBits

(.|.) :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> AllocationCreateFlagBits

xor :: AllocationCreateFlagBits -> AllocationCreateFlagBits -> AllocationCreateFlagBits

complement :: AllocationCreateFlagBits -> AllocationCreateFlagBits

shift :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

rotate :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

zeroBits :: AllocationCreateFlagBits

bit :: Int -> AllocationCreateFlagBits

setBit :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

clearBit :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

complementBit :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

testBit :: AllocationCreateFlagBits -> Int -> Bool

bitSizeMaybe :: AllocationCreateFlagBits -> Maybe Int

bitSize :: AllocationCreateFlagBits -> Int

isSigned :: AllocationCreateFlagBits -> Bool

shiftL :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

unsafeShiftL :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

shiftR :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

unsafeShiftR :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

rotateL :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

rotateR :: AllocationCreateFlagBits -> Int -> AllocationCreateFlagBits

popCount :: AllocationCreateFlagBits -> Int

FiniteBits AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

finiteBitSize :: AllocationCreateFlagBits -> Int

countLeadingZeros :: AllocationCreateFlagBits -> Int

countTrailingZeros :: AllocationCreateFlagBits -> Int

Zero AllocationCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

zero :: AllocationCreateFlagBits

data AllocationCreateInfo

VmaAllocationCreateInfo

Constructors

AllocationCreateInfo

Fields

• flags :: AllocationCreateFlags

  Use AllocationCreateFlagBits enum.

• usage :: MemoryUsage

  Intended usage of memory.

  You can leave MEMORY_USAGE_UNKNOWN if you specify memory requirements in other way.

  If pool is not null, this member is ignored.

• requiredFlags :: MemoryPropertyFlags

  Flags that must be set in a Memory Type chosen for an allocation.

  Leave 0 if you specify memory requirements in other way.

  If pool is not null, this member is ignored.

• preferredFlags :: MemoryPropertyFlags

  Flags that preferably should be set in a memory type chosen for an allocation.

  Set to 0 if no additional flags are preferred.

  If pool is not null, this member is ignored.

• memoryTypeBits :: Word32

  Bitmask containing one bit set for every memory type acceptable for this allocation.

  Value 0 is equivalent to UINT32_MAX - it means any memory type is accepted if it meets other requirements specified by this structure, with no further restrictions on memory type index.

  If pool is not null, this member is ignored.

• pool :: Pool

  Pool that this allocation should be created in.

  Leave VK_NULL_HANDLE to allocate from default pool. If not null, members: usage, requiredFlags, preferredFlags, memoryTypeBits are ignored.

• userData :: Ptr ()

  Custom general-purpose pointer that will be stored in Allocation, can be read as VmaAllocationInfo::pUserData and changed using setAllocationUserData.

  If ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT is used, it must be either null or pointer to a null-terminated string. The string will be then copied to internal buffer, so it doesn't need to be valid after allocation call.

• priority :: Float

  A floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.

  It is used only when ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the Allocator object and this allocation ends up as dedicated or is explicitly forced as dedicated using ALLOCATION_CREATE_DEDICATED_MEMORY_BIT. Otherwise, it has the priority of a memory block where it is placed and this variable is ignored.

Instances

Show AllocationCreateInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> AllocationCreateInfo -> ShowS

show :: AllocationCreateInfo -> String

showList :: [AllocationCreateInfo] -> ShowS

Storable AllocationCreateInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: AllocationCreateInfo -> Int

alignment :: AllocationCreateInfo -> Int

peekElemOff :: Ptr AllocationCreateInfo -> Int -> IO AllocationCreateInfo

pokeElemOff :: Ptr AllocationCreateInfo -> Int -> AllocationCreateInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO AllocationCreateInfo

pokeByteOff :: Ptr b -> Int -> AllocationCreateInfo -> IO ()

peek :: Ptr AllocationCreateInfo -> IO AllocationCreateInfo

poke :: Ptr AllocationCreateInfo -> AllocationCreateInfo -> IO ()

Zero AllocationCreateInfo

Defined in VulkanMemoryAllocator

Methods

zero :: AllocationCreateInfo

ToCStruct AllocationCreateInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: AllocationCreateInfo -> (Ptr AllocationCreateInfo -> IO b) -> IO b

pokeCStruct :: Ptr AllocationCreateInfo -> AllocationCreateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr AllocationCreateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr AllocationCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct AllocationCreateInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr AllocationCreateInfo -> IO AllocationCreateInfo

type PoolCreateFlags = PoolCreateFlagBits

newtype PoolCreateFlagBits

Flags to be passed as VmaPoolCreateInfo::flags.

Constructors

PoolCreateFlagBits Flags

Bundled Patterns

pattern POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT :: PoolCreateFlagBits

Use this flag if you always allocate only buffers and linear images or only optimal images out of this pool and so Buffer-Image Granularity can be ignored.

This is an optional optimization flag.

If you always allocate using createBuffer, createImage, allocateMemoryForBuffer, then you don't need to use it because allocator knows exact type of your allocations so it can handle Buffer-Image Granularity in the optimal way.

If you also allocate using allocateMemoryForImage or allocateMemory, exact type of such allocations is not known, so allocator must be conservative in handling Buffer-Image Granularity, which can lead to suboptimal allocation (wasted memory). In that case, if you can make sure you always allocate only buffers and linear images or only optimal images out of this pool, use this flag to make allocator disregard Buffer-Image Granularity and so make allocations faster and more optimal.

pattern POOL_CREATE_LINEAR_ALGORITHM_BIT :: PoolCreateFlagBits

Enables alternative, linear allocation algorithm in this pool.

Specify this flag to enable linear allocation algorithm, which always creates new allocations after last one and doesn't reuse space from allocations freed in between. It trades memory consumption for simplified algorithm and data structure, which has better performance and uses less memory for metadata.

By using this flag, you can achieve behavior of free-at-once, stack, ring buffer, and double stack. For details, see documentation chapter Linear allocation algorithm.

When using this flag, you must specify VmaPoolCreateInfo::maxBlockCount == 1 (or 0 for default).

For more details, see Linear allocation algorithm.

pattern POOL_CREATE_BUDDY_ALGORITHM_BIT :: PoolCreateFlagBits

Enables alternative, buddy allocation algorithm in this pool.

It operates on a tree of blocks, each having size that is a power of two and a half of its parent's size. Comparing to default algorithm, this one provides faster allocation and deallocation and decreased external fragmentation, at the expense of more memory wasted (internal fragmentation).

For more details, see Buddy allocation algorithm.

pattern POOL_CREATE_ALGORITHM_MASK :: PoolCreateFlagBits

Bit mask to extract only ALGORITHM bits from entire set of flags.

Instances

Eq PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

(==) :: PoolCreateFlagBits -> PoolCreateFlagBits -> Bool

(/=) :: PoolCreateFlagBits -> PoolCreateFlagBits -> Bool

Ord PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

compare :: PoolCreateFlagBits -> PoolCreateFlagBits -> Ordering

(<) :: PoolCreateFlagBits -> PoolCreateFlagBits -> Bool

(<=) :: PoolCreateFlagBits -> PoolCreateFlagBits -> Bool

(>) :: PoolCreateFlagBits -> PoolCreateFlagBits -> Bool

(>=) :: PoolCreateFlagBits -> PoolCreateFlagBits -> Bool

max :: PoolCreateFlagBits -> PoolCreateFlagBits -> PoolCreateFlagBits

min :: PoolCreateFlagBits -> PoolCreateFlagBits -> PoolCreateFlagBits

Read PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

readsPrec :: Int -> ReadS PoolCreateFlagBits

readList :: ReadS [PoolCreateFlagBits]

readPrec :: ReadPrec PoolCreateFlagBits

readListPrec :: ReadPrec [PoolCreateFlagBits]

Show PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> PoolCreateFlagBits -> ShowS

show :: PoolCreateFlagBits -> String

showList :: [PoolCreateFlagBits] -> ShowS

Storable PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

sizeOf :: PoolCreateFlagBits -> Int

alignment :: PoolCreateFlagBits -> Int

peekElemOff :: Ptr PoolCreateFlagBits -> Int -> IO PoolCreateFlagBits

pokeElemOff :: Ptr PoolCreateFlagBits -> Int -> PoolCreateFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO PoolCreateFlagBits

pokeByteOff :: Ptr b -> Int -> PoolCreateFlagBits -> IO ()

peek :: Ptr PoolCreateFlagBits -> IO PoolCreateFlagBits

poke :: Ptr PoolCreateFlagBits -> PoolCreateFlagBits -> IO ()

Bits PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

(.&.) :: PoolCreateFlagBits -> PoolCreateFlagBits -> PoolCreateFlagBits

(.|.) :: PoolCreateFlagBits -> PoolCreateFlagBits -> PoolCreateFlagBits

xor :: PoolCreateFlagBits -> PoolCreateFlagBits -> PoolCreateFlagBits

complement :: PoolCreateFlagBits -> PoolCreateFlagBits

shift :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

rotate :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

zeroBits :: PoolCreateFlagBits

bit :: Int -> PoolCreateFlagBits

setBit :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

clearBit :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

complementBit :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

testBit :: PoolCreateFlagBits -> Int -> Bool

bitSizeMaybe :: PoolCreateFlagBits -> Maybe Int

bitSize :: PoolCreateFlagBits -> Int

isSigned :: PoolCreateFlagBits -> Bool

shiftL :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

unsafeShiftL :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

shiftR :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

unsafeShiftR :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

rotateL :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

rotateR :: PoolCreateFlagBits -> Int -> PoolCreateFlagBits

popCount :: PoolCreateFlagBits -> Int

FiniteBits PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

finiteBitSize :: PoolCreateFlagBits -> Int

countLeadingZeros :: PoolCreateFlagBits -> Int

countTrailingZeros :: PoolCreateFlagBits -> Int

Zero PoolCreateFlagBits

Defined in VulkanMemoryAllocator

Methods

zero :: PoolCreateFlagBits

data PoolCreateInfo

VmaPoolCreateInfo

Describes parameter of created Pool.

Constructors

PoolCreateInfo

Fields

• memoryTypeIndex :: Word32

  Vulkan memory type index to allocate this pool from.

• flags :: PoolCreateFlags

  Use combination of PoolCreateFlagBits.

• blockSize :: DeviceSize

  Size of a single VkDeviceMemory block to be allocated as part of this pool, in bytes. Optional.

  Specify nonzero to set explicit, constant size of memory blocks used by this pool.

  Leave 0 to use default and let the library manage block sizes automatically. Sizes of particular blocks may vary.

• minBlockCount :: Word64

  Minimum number of blocks to be always allocated in this pool, even if they stay empty.

  Set to 0 to have no preallocated blocks and allow the pool be completely empty.

• maxBlockCount :: Word64

  Maximum number of blocks that can be allocated in this pool. Optional.

  Set to 0 to use default, which is SIZE_MAX, which means no limit.

  Set to same value as VmaPoolCreateInfo::minBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.

• frameInUseCount :: Word32

  Maximum number of additional frames that are in use at the same time as current frame.

  This value is used only when you make allocations with ALLOCATION_CREATE_CAN_BECOME_LOST_BIT flag. Such allocation cannot become lost if allocation.lastUseFrameIndex >= allocator.currentFrameIndex - frameInUseCount.

  For example, if you double-buffer your command buffers, so resources used for rendering in previous frame may still be in use by the GPU at the moment you allocate resources needed for the current frame, set this value to 1.

  If you want to allow any allocations other than used in the current frame to become lost, set this value to 0.

• priority :: Float

  A floating-point value between 0 and 1, indicating the priority of the allocations in this pool relative to other memory allocations.

  It is used only when ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the Allocator object. Otherwise, this variable is ignored.

• minAllocationAlignment :: DeviceSize

  Additional minimum alignment to be used for all allocations created from this pool. Can be 0.

  Leave 0 (default) not to impose any additional alignment. If not 0, it must be a power of two. It can be useful in cases where alignment returned by Vulkan by functions like vkGetBufferMemoryRequirements is not enough, e.g. when doing interop with OpenGL.

• memoryAllocateNext :: Ptr ()

  Additional pNext chain to be attached to VkMemoryAllocateInfo used for every allocation made by this pool. Optional.

  Optional, can be null. If not null, it must point to a pNext chain of structures that can be attached to VkMemoryAllocateInfo. It can be useful for special needs such as adding VkExportMemoryAllocateInfoKHR. Structures pointed by this member must remain alive and unchanged for the whole lifetime of the custom pool.

  Please note that some structures, e.g. VkMemoryPriorityAllocateInfoEXT, VkMemoryDedicatedAllocateInfoKHR, can be attached automatically by this library when using other, more convenient of its features.

Instances

Show PoolCreateInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> PoolCreateInfo -> ShowS

show :: PoolCreateInfo -> String

showList :: [PoolCreateInfo] -> ShowS

Storable PoolCreateInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: PoolCreateInfo -> Int

alignment :: PoolCreateInfo -> Int

peekElemOff :: Ptr PoolCreateInfo -> Int -> IO PoolCreateInfo

pokeElemOff :: Ptr PoolCreateInfo -> Int -> PoolCreateInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO PoolCreateInfo

pokeByteOff :: Ptr b -> Int -> PoolCreateInfo -> IO ()

peek :: Ptr PoolCreateInfo -> IO PoolCreateInfo

poke :: Ptr PoolCreateInfo -> PoolCreateInfo -> IO ()

Zero PoolCreateInfo

Defined in VulkanMemoryAllocator

Methods

zero :: PoolCreateInfo

ToCStruct PoolCreateInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: PoolCreateInfo -> (Ptr PoolCreateInfo -> IO b) -> IO b

pokeCStruct :: Ptr PoolCreateInfo -> PoolCreateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr PoolCreateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr PoolCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct PoolCreateInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr PoolCreateInfo -> IO PoolCreateInfo

data PoolStats

VmaPoolStats

Describes parameter of existing Pool.

Constructors

PoolStats

Fields

• size :: DeviceSize

  Total amount of VkDeviceMemory allocated from Vulkan for this pool, in bytes.

• unusedSize :: DeviceSize

  Total number of bytes in the pool not used by any Allocation.

• allocationCount :: Word64

  Number of Allocation objects created from this pool that were not destroyed or lost.

• unusedRangeCount :: Word64

  Number of continuous memory ranges in the pool not used by any Allocation.

• unusedRangeSizeMax :: DeviceSize

  Size of the largest continuous free memory region available for new allocation.

  Making a new allocation of that size is not guaranteed to succeed because of possible additional margin required to respect alignment and buffer/image granularity.

• blockCount :: Word64

  Number of VkDeviceMemory blocks allocated for this pool.

Instances

Eq PoolStats

Defined in VulkanMemoryAllocator

Methods

(==) :: PoolStats -> PoolStats -> Bool

(/=) :: PoolStats -> PoolStats -> Bool

Show PoolStats

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> PoolStats -> ShowS

show :: PoolStats -> String

showList :: [PoolStats] -> ShowS

Storable PoolStats

Defined in VulkanMemoryAllocator

Methods

sizeOf :: PoolStats -> Int

alignment :: PoolStats -> Int

peekElemOff :: Ptr PoolStats -> Int -> IO PoolStats

pokeElemOff :: Ptr PoolStats -> Int -> PoolStats -> IO ()

peekByteOff :: Ptr b -> Int -> IO PoolStats

pokeByteOff :: Ptr b -> Int -> PoolStats -> IO ()

peek :: Ptr PoolStats -> IO PoolStats

poke :: Ptr PoolStats -> PoolStats -> IO ()

Zero PoolStats

Defined in VulkanMemoryAllocator

Methods

zero :: PoolStats

ToCStruct PoolStats

Defined in VulkanMemoryAllocator

Methods

withCStruct :: PoolStats -> (Ptr PoolStats -> IO b) -> IO b

pokeCStruct :: Ptr PoolStats -> PoolStats -> IO b -> IO b

withZeroCStruct :: (Ptr PoolStats -> IO b) -> IO b

pokeZeroCStruct :: Ptr PoolStats -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct PoolStats

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr PoolStats -> IO PoolStats

newtype Allocation

VmaAllocation

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 AllocationCreateInfo. 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 getAllocationInfo and inspect returned structure AllocationInfo.

Some kinds allocations can be in lost state. For more information, see Lost allocations.

Constructors

Allocation Word64

Instances

Eq Allocation

Defined in VulkanMemoryAllocator

Methods

(==) :: Allocation -> Allocation -> Bool

(/=) :: Allocation -> Allocation -> Bool

Ord Allocation

Defined in VulkanMemoryAllocator

Methods

compare :: Allocation -> Allocation -> Ordering

(<) :: Allocation -> Allocation -> Bool

(<=) :: Allocation -> Allocation -> Bool

(>) :: Allocation -> Allocation -> Bool

(>=) :: Allocation -> Allocation -> Bool

max :: Allocation -> Allocation -> Allocation

min :: Allocation -> Allocation -> Allocation

Show Allocation

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> Allocation -> ShowS

show :: Allocation -> String

showList :: [Allocation] -> ShowS

Storable Allocation

Defined in VulkanMemoryAllocator

Methods

sizeOf :: Allocation -> Int

alignment :: Allocation -> Int

peekElemOff :: Ptr Allocation -> Int -> IO Allocation

pokeElemOff :: Ptr Allocation -> Int -> Allocation -> IO ()

peekByteOff :: Ptr b -> Int -> IO Allocation

pokeByteOff :: Ptr b -> Int -> Allocation -> IO ()

peek :: Ptr Allocation -> IO Allocation

poke :: Ptr Allocation -> Allocation -> IO ()

IsHandle Allocation

Defined in VulkanMemoryAllocator

Zero Allocation

Defined in VulkanMemoryAllocator

Methods

zero :: Allocation

data AllocationInfo

VmaAllocationInfo

Parameters of Allocation objects, that can be retrieved using function getAllocationInfo.

Constructors

AllocationInfo

Fields

• memoryType :: Word32

  Memory type index that this allocation was allocated from.

  It never changes.

• deviceMemory :: DeviceMemory

  Handle to Vulkan memory object.

  Same memory object can be shared by multiple allocations.

  It can change after call to defragment 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.

• offset :: DeviceSize

  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 createBuffer, createImage, functions that operate on these resources refer to the beginning of the buffer or image, not entire device memory block. Functions like mapMemory, bindBufferMemory also refer to the beginning of the allocation and apply this offset automatically.

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

• size :: DeviceSize

  Size of this allocation, in bytes.

  It never changes, unless allocation is lost.

  Note

  Allocation size returned in this variable may be greater than the size requested for the resource e.g. as VkBufferCreateInfo::size. Whole size of the allocation is accessible for operations on memory e.g. using a pointer after mapping with mapMemory, but operations on the resource e.g. using vkCmdCopyBuffer must be limited to the size of the resource.

• mappedData :: Ptr ()

  Pointer to the beginning of this allocation as mapped data.

  If the allocation hasn't been mapped using mapMemory and hasn't been created with ALLOCATION_CREATE_MAPPED_BIT flag, this value is null.

  It can change after call to mapMemory, unmapMemory. It can also change after call to defragment if this allocation is passed to the function.

• userData :: Ptr ()

  Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using setAllocationUserData.

  It can change after call to setAllocationUserData for this allocation.

Instances

Show AllocationInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> AllocationInfo -> ShowS

show :: AllocationInfo -> String

showList :: [AllocationInfo] -> ShowS

Storable AllocationInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: AllocationInfo -> Int

alignment :: AllocationInfo -> Int

peekElemOff :: Ptr AllocationInfo -> Int -> IO AllocationInfo

pokeElemOff :: Ptr AllocationInfo -> Int -> AllocationInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO AllocationInfo

pokeByteOff :: Ptr b -> Int -> AllocationInfo -> IO ()

peek :: Ptr AllocationInfo -> IO AllocationInfo

poke :: Ptr AllocationInfo -> AllocationInfo -> IO ()

Zero AllocationInfo

Defined in VulkanMemoryAllocator

Methods

zero :: AllocationInfo

ToCStruct AllocationInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: AllocationInfo -> (Ptr AllocationInfo -> IO b) -> IO b

pokeCStruct :: Ptr AllocationInfo -> AllocationInfo -> IO b -> IO b

withZeroCStruct :: (Ptr AllocationInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr AllocationInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct AllocationInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr AllocationInfo -> IO AllocationInfo

newtype DefragmentationContext

VmaDefragmentationContext

Represents Opaque object that represents started defragmentation process.

Fill structure DefragmentationInfo2 and call function defragmentationBegin to create it. Call function defragmentationEnd to destroy it.

Constructors

DefragmentationContext Word64

Instances

Eq DefragmentationContext

Defined in VulkanMemoryAllocator

Methods

(==) :: DefragmentationContext -> DefragmentationContext -> Bool

(/=) :: DefragmentationContext -> DefragmentationContext -> Bool

Ord DefragmentationContext

Defined in VulkanMemoryAllocator

Methods

compare :: DefragmentationContext -> DefragmentationContext -> Ordering

(<) :: DefragmentationContext -> DefragmentationContext -> Bool

(<=) :: DefragmentationContext -> DefragmentationContext -> Bool

(>) :: DefragmentationContext -> DefragmentationContext -> Bool

(>=) :: DefragmentationContext -> DefragmentationContext -> Bool

max :: DefragmentationContext -> DefragmentationContext -> DefragmentationContext

min :: DefragmentationContext -> DefragmentationContext -> DefragmentationContext

Show DefragmentationContext

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationContext -> ShowS

show :: DefragmentationContext -> String

showList :: [DefragmentationContext] -> ShowS

Storable DefragmentationContext

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DefragmentationContext -> Int

alignment :: DefragmentationContext -> Int

peekElemOff :: Ptr DefragmentationContext -> Int -> IO DefragmentationContext

pokeElemOff :: Ptr DefragmentationContext -> Int -> DefragmentationContext -> IO ()

peekByteOff :: Ptr b -> Int -> IO DefragmentationContext

pokeByteOff :: Ptr b -> Int -> DefragmentationContext -> IO ()

peek :: Ptr DefragmentationContext -> IO DefragmentationContext

poke :: Ptr DefragmentationContext -> DefragmentationContext -> IO ()

IsHandle DefragmentationContext

Defined in VulkanMemoryAllocator

Zero DefragmentationContext

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationContext

type DefragmentationFlags = DefragmentationFlagBits

newtype DefragmentationFlagBits

Flags to be used in defragmentationBegin. None at the moment. Reserved for future use.

Constructors

DefragmentationFlagBits Flags

Bundled Patterns

pattern DEFRAGMENTATION_FLAG_INCREMENTAL :: DefragmentationFlagBits

Instances

Eq DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

(==) :: DefragmentationFlagBits -> DefragmentationFlagBits -> Bool

(/=) :: DefragmentationFlagBits -> DefragmentationFlagBits -> Bool

Ord DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

compare :: DefragmentationFlagBits -> DefragmentationFlagBits -> Ordering

(<) :: DefragmentationFlagBits -> DefragmentationFlagBits -> Bool

(<=) :: DefragmentationFlagBits -> DefragmentationFlagBits -> Bool

(>) :: DefragmentationFlagBits -> DefragmentationFlagBits -> Bool

(>=) :: DefragmentationFlagBits -> DefragmentationFlagBits -> Bool

max :: DefragmentationFlagBits -> DefragmentationFlagBits -> DefragmentationFlagBits

min :: DefragmentationFlagBits -> DefragmentationFlagBits -> DefragmentationFlagBits

Read DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

readsPrec :: Int -> ReadS DefragmentationFlagBits

readList :: ReadS [DefragmentationFlagBits]

readPrec :: ReadPrec DefragmentationFlagBits

readListPrec :: ReadPrec [DefragmentationFlagBits]

Show DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationFlagBits -> ShowS

show :: DefragmentationFlagBits -> String

showList :: [DefragmentationFlagBits] -> ShowS

Storable DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DefragmentationFlagBits -> Int

alignment :: DefragmentationFlagBits -> Int

peekElemOff :: Ptr DefragmentationFlagBits -> Int -> IO DefragmentationFlagBits

pokeElemOff :: Ptr DefragmentationFlagBits -> Int -> DefragmentationFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO DefragmentationFlagBits

pokeByteOff :: Ptr b -> Int -> DefragmentationFlagBits -> IO ()

peek :: Ptr DefragmentationFlagBits -> IO DefragmentationFlagBits

poke :: Ptr DefragmentationFlagBits -> DefragmentationFlagBits -> IO ()

Bits DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

(.&.) :: DefragmentationFlagBits -> DefragmentationFlagBits -> DefragmentationFlagBits

(.|.) :: DefragmentationFlagBits -> DefragmentationFlagBits -> DefragmentationFlagBits

xor :: DefragmentationFlagBits -> DefragmentationFlagBits -> DefragmentationFlagBits

complement :: DefragmentationFlagBits -> DefragmentationFlagBits

shift :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

rotate :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

zeroBits :: DefragmentationFlagBits

bit :: Int -> DefragmentationFlagBits

setBit :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

clearBit :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

complementBit :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

testBit :: DefragmentationFlagBits -> Int -> Bool

bitSizeMaybe :: DefragmentationFlagBits -> Maybe Int

bitSize :: DefragmentationFlagBits -> Int

isSigned :: DefragmentationFlagBits -> Bool

shiftL :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

unsafeShiftL :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

shiftR :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

unsafeShiftR :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

rotateL :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

rotateR :: DefragmentationFlagBits -> Int -> DefragmentationFlagBits

popCount :: DefragmentationFlagBits -> Int

FiniteBits DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

finiteBitSize :: DefragmentationFlagBits -> Int

countLeadingZeros :: DefragmentationFlagBits -> Int

countTrailingZeros :: DefragmentationFlagBits -> Int

Zero DefragmentationFlagBits

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationFlagBits

data DefragmentationInfo2

VmaDefragmentationInfo2

Parameters for defragmentation.

To be used with function defragmentationBegin.

Constructors

DefragmentationInfo2

Fields

• flags :: DefragmentationFlags

  Reserved for future use. Should be 0.

• allocations :: Vector Allocation

  Pointer to array of allocations that can be defragmented.

  The array should have allocationCount elements. The array should not contain nulls. Elements in the array should be unique - same allocation cannot occur twice. It is safe to pass allocations that are in the lost state - they are ignored. All allocations not present in this array are considered non-moveable during this defragmentation.

• allocationsChanged :: Ptr Bool32

  Optional, output. Pointer to array that will be filled with information whether the allocation at certain index has been changed during defragmentation.

  The array should have allocationCount elements. You can pass null if you are not interested in this information.

• pools :: Vector Pool

  Either null or pointer to array of pools to be defragmented.

  All the allocations in the specified pools can be moved during defragmentation and there is no way to check if they were really moved as in pAllocationsChanged, so you must query all the allocations in all these pools for new VkDeviceMemory and offset using getAllocationInfo if you might need to recreate buffers and images bound to them.

  The array should have poolCount elements. The array should not contain nulls. Elements in the array should be unique - same pool cannot occur twice.

  Using this array is equivalent to specifying all allocations from the pools in pAllocations. It might be more efficient.

• maxCpuBytesToMove :: DeviceSize

  Maximum total numbers of bytes that can be copied while moving allocations to different places using transfers on CPU side, like memcpy(), memmove().

  VK_WHOLE_SIZE means no limit.

• maxCpuAllocationsToMove :: Word32

  Maximum number of allocations that can be moved to a different place using transfers on CPU side, like memcpy(), memmove().

  UINT32_MAX means no limit.

• maxGpuBytesToMove :: DeviceSize

  Maximum total numbers of bytes that can be copied while moving allocations to different places using transfers on GPU side, posted to commandBuffer.

  VK_WHOLE_SIZE means no limit.

• maxGpuAllocationsToMove :: Word32

  Maximum number of allocations that can be moved to a different place using transfers on GPU side, posted to commandBuffer.

  UINT32_MAX means no limit.

• commandBuffer :: Ptr CommandBuffer_T

  Optional. Command buffer where GPU copy commands will be posted.

  If not null, it must be a valid command buffer handle that supports Transfer queue type. It must be in the recording state and outside of a render pass instance. You need to submit it and make sure it finished execution before calling defragmentationEnd.

  Passing null means that only CPU defragmentation will be performed.

Instances

Show DefragmentationInfo2

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationInfo2 -> ShowS

show :: DefragmentationInfo2 -> String

showList :: [DefragmentationInfo2] -> ShowS

Zero DefragmentationInfo2

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationInfo2

ToCStruct DefragmentationInfo2

Defined in VulkanMemoryAllocator

Methods

withCStruct :: DefragmentationInfo2 -> (Ptr DefragmentationInfo2 -> IO b) -> IO b

pokeCStruct :: Ptr DefragmentationInfo2 -> DefragmentationInfo2 -> IO b -> IO b

withZeroCStruct :: (Ptr DefragmentationInfo2 -> IO b) -> IO b

pokeZeroCStruct :: Ptr DefragmentationInfo2 -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DefragmentationInfo2

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr DefragmentationInfo2 -> IO DefragmentationInfo2

data DefragmentationPassMoveInfo

VmaDefragmentationPassMoveInfo

Constructors

DefragmentationPassMoveInfo

Fields

• allocation :: Allocation
• memory :: DeviceMemory
• offset :: DeviceSize

Instances

Eq DefragmentationPassMoveInfo

Defined in VulkanMemoryAllocator

Methods

(==) :: DefragmentationPassMoveInfo -> DefragmentationPassMoveInfo -> Bool

(/=) :: DefragmentationPassMoveInfo -> DefragmentationPassMoveInfo -> Bool

Show DefragmentationPassMoveInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationPassMoveInfo -> ShowS

show :: DefragmentationPassMoveInfo -> String

showList :: [DefragmentationPassMoveInfo] -> ShowS

Storable DefragmentationPassMoveInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DefragmentationPassMoveInfo -> Int

alignment :: DefragmentationPassMoveInfo -> Int

peekElemOff :: Ptr DefragmentationPassMoveInfo -> Int -> IO DefragmentationPassMoveInfo

pokeElemOff :: Ptr DefragmentationPassMoveInfo -> Int -> DefragmentationPassMoveInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO DefragmentationPassMoveInfo

pokeByteOff :: Ptr b -> Int -> DefragmentationPassMoveInfo -> IO ()

peek :: Ptr DefragmentationPassMoveInfo -> IO DefragmentationPassMoveInfo

poke :: Ptr DefragmentationPassMoveInfo -> DefragmentationPassMoveInfo -> IO ()

Zero DefragmentationPassMoveInfo

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationPassMoveInfo

ToCStruct DefragmentationPassMoveInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: DefragmentationPassMoveInfo -> (Ptr DefragmentationPassMoveInfo -> IO b) -> IO b

pokeCStruct :: Ptr DefragmentationPassMoveInfo -> DefragmentationPassMoveInfo -> IO b -> IO b

withZeroCStruct :: (Ptr DefragmentationPassMoveInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr DefragmentationPassMoveInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DefragmentationPassMoveInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr DefragmentationPassMoveInfo -> IO DefragmentationPassMoveInfo

data DefragmentationPassInfo

VmaDefragmentationPassInfo

Parameters for incremental defragmentation steps.

To be used with function beginDefragmentationPass.

Constructors

DefragmentationPassInfo

Fields

• moveCount :: Word32
• moves :: Ptr DefragmentationPassMoveInfo

Instances

Eq DefragmentationPassInfo

Defined in VulkanMemoryAllocator

Methods

(==) :: DefragmentationPassInfo -> DefragmentationPassInfo -> Bool

(/=) :: DefragmentationPassInfo -> DefragmentationPassInfo -> Bool

Show DefragmentationPassInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationPassInfo -> ShowS

show :: DefragmentationPassInfo -> String

showList :: [DefragmentationPassInfo] -> ShowS

Storable DefragmentationPassInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DefragmentationPassInfo -> Int

alignment :: DefragmentationPassInfo -> Int

peekElemOff :: Ptr DefragmentationPassInfo -> Int -> IO DefragmentationPassInfo

pokeElemOff :: Ptr DefragmentationPassInfo -> Int -> DefragmentationPassInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO DefragmentationPassInfo

pokeByteOff :: Ptr b -> Int -> DefragmentationPassInfo -> IO ()

peek :: Ptr DefragmentationPassInfo -> IO DefragmentationPassInfo

poke :: Ptr DefragmentationPassInfo -> DefragmentationPassInfo -> IO ()

Zero DefragmentationPassInfo

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationPassInfo

ToCStruct DefragmentationPassInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: DefragmentationPassInfo -> (Ptr DefragmentationPassInfo -> IO b) -> IO b

pokeCStruct :: Ptr DefragmentationPassInfo -> DefragmentationPassInfo -> IO b -> IO b

withZeroCStruct :: (Ptr DefragmentationPassInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr DefragmentationPassInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DefragmentationPassInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr DefragmentationPassInfo -> IO DefragmentationPassInfo

data DefragmentationInfo

VmaDefragmentationInfo

Deprecated. Optional configuration parameters to be passed to function defragment.

Deprecated

This is a part of the old interface. It is recommended to use structure DefragmentationInfo2 and function defragmentationBegin instead.

Constructors

DefragmentationInfo

Fields

• maxBytesToMove :: DeviceSize

  Maximum total numbers of bytes that can be copied while moving allocations to different places.

  Default is VK_WHOLE_SIZE, which means no limit.

• maxAllocationsToMove :: Word32

  Maximum number of allocations that can be moved to different place.

  Default is UINT32_MAX, which means no limit.

Instances

Eq DefragmentationInfo

Defined in VulkanMemoryAllocator

Methods

(==) :: DefragmentationInfo -> DefragmentationInfo -> Bool

(/=) :: DefragmentationInfo -> DefragmentationInfo -> Bool

Show DefragmentationInfo

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationInfo -> ShowS

show :: DefragmentationInfo -> String

showList :: [DefragmentationInfo] -> ShowS

Storable DefragmentationInfo

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DefragmentationInfo -> Int

alignment :: DefragmentationInfo -> Int

peekElemOff :: Ptr DefragmentationInfo -> Int -> IO DefragmentationInfo

pokeElemOff :: Ptr DefragmentationInfo -> Int -> DefragmentationInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO DefragmentationInfo

pokeByteOff :: Ptr b -> Int -> DefragmentationInfo -> IO ()

peek :: Ptr DefragmentationInfo -> IO DefragmentationInfo

poke :: Ptr DefragmentationInfo -> DefragmentationInfo -> IO ()

Zero DefragmentationInfo

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationInfo

ToCStruct DefragmentationInfo

Defined in VulkanMemoryAllocator

Methods

withCStruct :: DefragmentationInfo -> (Ptr DefragmentationInfo -> IO b) -> IO b

pokeCStruct :: Ptr DefragmentationInfo -> DefragmentationInfo -> IO b -> IO b

withZeroCStruct :: (Ptr DefragmentationInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr DefragmentationInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DefragmentationInfo

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr DefragmentationInfo -> IO DefragmentationInfo

data DefragmentationStats

VmaDefragmentationStats

Statistics returned by function defragment.

Constructors

DefragmentationStats

Fields

• bytesMoved :: DeviceSize

  Total number of bytes that have been copied while moving allocations to different places.

• bytesFreed :: DeviceSize

  Total number of bytes that have been released to the system by freeing empty VkDeviceMemory objects.

• allocationsMoved :: Word32

  Number of allocations that have been moved to different places.

• deviceMemoryBlocksFreed :: Word32

  Number of empty VkDeviceMemory objects that have been released to the system.

Instances

Eq DefragmentationStats

Defined in VulkanMemoryAllocator

Methods

(==) :: DefragmentationStats -> DefragmentationStats -> Bool

(/=) :: DefragmentationStats -> DefragmentationStats -> Bool

Show DefragmentationStats

Defined in VulkanMemoryAllocator

Methods

showsPrec :: Int -> DefragmentationStats -> ShowS

show :: DefragmentationStats -> String

showList :: [DefragmentationStats] -> ShowS

Storable DefragmentationStats

Defined in VulkanMemoryAllocator

Methods

sizeOf :: DefragmentationStats -> Int

alignment :: DefragmentationStats -> Int

peekElemOff :: Ptr DefragmentationStats -> Int -> IO DefragmentationStats

pokeElemOff :: Ptr DefragmentationStats -> Int -> DefragmentationStats -> IO ()

peekByteOff :: Ptr b -> Int -> IO DefragmentationStats

pokeByteOff :: Ptr b -> Int -> DefragmentationStats -> IO ()

peek :: Ptr DefragmentationStats -> IO DefragmentationStats

poke :: Ptr DefragmentationStats -> DefragmentationStats -> IO ()

Zero DefragmentationStats

Defined in VulkanMemoryAllocator

Methods

zero :: DefragmentationStats

ToCStruct DefragmentationStats

Defined in VulkanMemoryAllocator

Methods

withCStruct :: DefragmentationStats -> (Ptr DefragmentationStats -> IO b) -> IO b

pokeCStruct :: Ptr DefragmentationStats -> DefragmentationStats -> IO b -> IO b

withZeroCStruct :: (Ptr DefragmentationStats -> IO b) -> IO b

pokeZeroCStruct :: Ptr DefragmentationStats -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DefragmentationStats

Defined in VulkanMemoryAllocator

Methods

peekCStruct :: Ptr DefragmentationStats -> IO DefragmentationStats