-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Bindings to the VulkanMemoryAllocator library
--
-- Bindings to the VulkanMemoryAllocator library
@package VulkanMemoryAllocator
@version 0.10
module VulkanMemoryAllocator
-- | Creates Allocator object.
createAllocator :: forall io. MonadIO io => AllocatorCreateInfo -> io Allocator
-- | 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.
withAllocator :: forall io r. MonadIO io => AllocatorCreateInfo -> (io Allocator -> (Allocator -> io ()) -> r) -> r
-- | Destroys allocator object.
destroyAllocator :: forall io. MonadIO io => Allocator -> io ()
-- | 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.
getAllocatorInfo :: forall io. MonadIO io => Allocator -> io AllocatorInfo
-- | PhysicalDeviceProperties are fetched from physicalDevice by the
-- allocator. You can access it here, without fetching it again on your
-- own.
getPhysicalDeviceProperties :: forall io. MonadIO io => Allocator -> io (Ptr PhysicalDeviceProperties)
-- | PhysicalDeviceMemoryProperties 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)
-- | Given Memory Type Index, returns Property Flags of this memory type.
--
-- This is just a convenience function. Same information can be obtained
-- using getMemoryProperties.
getMemoryTypeProperties :: forall io. MonadIO io => Allocator -> ("memoryTypeIndex" ::: Word32) -> io MemoryPropertyFlags
-- | Sets index of the current frame.
setCurrentFrameIndex :: forall io. MonadIO io => Allocator -> ("frameIndex" ::: Word32) -> io ()
-- | 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. Use it
-- for debugging purposes. For faster but more brief statistics suitable
-- to be called every frame or every allocation, use
-- getHeapBudgets.
--
-- Note that when using allocator from multiple threads, returned
-- information may immediately become outdated.
calculateStatistics :: forall io. MonadIO io => Allocator -> io ("stats" ::: TotalStatistics)
-- | Retrieves information about current memory usage and budget for all
-- memory heaps.
--
-- Parameters
--
-- TODO: table
--
-- 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 calculateStatistics.
--
-- Note that when using allocator from multiple threads, returned
-- information may immediately become outdated.
getHeapBudgets :: forall io. MonadIO io => Allocator -> ("budgets" ::: Ptr Budget) -> io ()
-- | 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.
findMemoryTypeIndex :: forall io. MonadIO io => Allocator -> ("memoryTypeBits" ::: Word32) -> 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.
findMemoryTypeIndexForBufferInfo :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo 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.
findMemoryTypeIndexForImageInfo :: forall a io. (Extendss ImageCreateInfo a, PokeChain a, MonadIO io) => Allocator -> ImageCreateInfo a -> AllocationCreateInfo -> io ("memoryTypeIndex" ::: Word32)
-- | Allocates Vulkan device memory and creates Pool object.
--
-- Parameters
--
-- TODO: table
createPool :: forall io. MonadIO io => Allocator -> PoolCreateInfo -> io Pool
-- | 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.
withPool :: forall io r. MonadIO io => Allocator -> PoolCreateInfo -> (io Pool -> (Pool -> io ()) -> r) -> r
-- | Destroys Pool object and frees Vulkan device memory.
destroyPool :: forall io. MonadIO io => Allocator -> Pool -> io ()
-- | Retrieves statistics of existing Pool object.
--
-- Parameters
--
-- TODO: table
getPoolStatistics :: forall io. MonadIO io => Allocator -> Pool -> io ("poolStats" ::: Statistics)
-- | Retrieves detailed statistics of existing Pool object.
--
-- Parameters
--
-- TODO: table
calculatePoolStatistics :: forall io. MonadIO io => Allocator -> Pool -> io ("poolStats" ::: DetailedStatistics)
-- | 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_UNKNOWN - 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.
--
checkPoolCorruption :: forall io. MonadIO io => Allocator -> Pool -> io ()
-- | 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.
getPoolName :: forall io. MonadIO io => Allocator -> Pool -> io ("name" ::: Ptr CChar)
-- | 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.
setPoolName :: forall io. MonadIO io => Allocator -> Pool -> ("name" ::: Maybe ByteString) -> io ()
-- | General purpose memory allocation.
--
-- Parameters
--
-- TODO: table
--
-- You should free the memory using freeMemory or
-- freeMemoryPages.
--
-- It is recommended to use allocateMemoryForBuffer,
-- allocateMemoryForImage, createBuffer, createImage
-- instead whenever possible.
allocateMemory :: forall io. MonadIO io => Allocator -> ("vkMemoryRequirements" ::: MemoryRequirements) -> AllocationCreateInfo -> io (Allocation, AllocationInfo)
-- | 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.
withMemory :: forall io r. MonadIO io => Allocator -> MemoryRequirements -> AllocationCreateInfo -> (io (Allocation, AllocationInfo) -> ((Allocation, AllocationInfo) -> io ()) -> r) -> r
-- | General purpose memory allocation for multiple allocation objects at
-- once.
--
-- Parameters
--
-- TODO: table
--
-- 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.
allocateMemoryPages :: forall io. MonadIO io => Allocator -> ("vkMemoryRequirements" ::: Vector MemoryRequirements) -> ("createInfo" ::: Vector AllocationCreateInfo) -> io ("allocations" ::: Vector Allocation, "allocationInfo" ::: Vector AllocationInfo)
-- | 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.
withMemoryPages :: forall io r. MonadIO io => Allocator -> Vector MemoryRequirements -> Vector AllocationCreateInfo -> (io (Vector Allocation, Vector AllocationInfo) -> ((Vector Allocation, Vector AllocationInfo) -> io ()) -> r) -> r
-- | Allocates memory suitable for given VkBuffer.
--
-- Parameters
--
-- TODO: table
--
-- It only creates Allocation. To bind the memory to the buffer,
-- use bindBufferMemory.
--
-- This is a special-purpose function. In most cases you should use
-- createBuffer.
--
-- You must free the allocation using freeMemory when no longer
-- needed.
allocateMemoryForBuffer :: forall io. MonadIO io => Allocator -> Buffer -> AllocationCreateInfo -> io (Allocation, AllocationInfo)
-- | 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.
withMemoryForBuffer :: forall io r. MonadIO io => Allocator -> Buffer -> AllocationCreateInfo -> (io (Allocation, AllocationInfo) -> ((Allocation, AllocationInfo) -> io ()) -> r) -> r
-- | Allocates memory suitable for given VkImage.
--
-- Parameters
--
-- TODO: table
--
-- It only creates Allocation. To bind the memory to the buffer,
-- use bindImageMemory.
--
-- This is a special-purpose function. In most cases you should use
-- createImage.
--
-- You must free the allocation using freeMemory when no longer
-- needed.
allocateMemoryForImage :: forall io. MonadIO io => Allocator -> Image -> AllocationCreateInfo -> io (Allocation, AllocationInfo)
-- | 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.
withMemoryForImage :: forall io r. MonadIO io => Allocator -> Image -> AllocationCreateInfo -> (io (Allocation, AllocationInfo) -> ((Allocation, AllocationInfo) -> io ()) -> r) -> r
-- | Frees memory previously allocated using allocateMemory,
-- allocateMemoryForBuffer, or allocateMemoryForImage.
--
-- Passing VK_NULL_HANDLE as allocation is valid. Such
-- function call is just skipped.
freeMemory :: forall io. MonadIO io => Allocator -> 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.
freeMemoryPages :: forall io. MonadIO io => Allocator -> ("allocations" ::: Vector Allocation) -> io ()
-- | Returns current information about specified allocation.
--
-- Current paramteres of given allocation are returned in
-- pAllocationInfo.
--
-- Although this function doesn't lock any mutex, so it should be quite
-- efficient, you should 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).
getAllocationInfo :: forall io. MonadIO io => Allocator -> Allocation -> io AllocationInfo
-- | Sets pUserData in given allocation to new value.
--
-- The value of pointer pUserData is 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.
setAllocationUserData :: forall io. MonadIO io => Allocator -> Allocation -> ("userData" ::: Ptr ()) -> io ()
-- | Sets pName in given allocation to new value.
--
-- pName 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 pName. String passed as pName 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 pName is
-- freed from memory.
setAllocationName :: forall io. MonadIO io => Allocator -> Allocation -> ("name" ::: Maybe ByteString) -> io ()
-- | Given an allocation, returns Property Flags of its memory type.
--
-- This is just a convenience function. Same information can be obtained
-- using getAllocationInfo + getMemoryProperties.
getAllocationMemoryProperties :: forall io. MonadIO io => Allocator -> Allocation -> io MemoryPropertyFlags
-- | 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.
--
-- Warning
--
-- If the allocation is part of a bigger VkDeviceMemory block,
-- returned pointer is correctly offsetted to the beginning of region
-- assigned to this particular allocation. Unlike the result of
-- vkMapMemory, it points to the allocation, not to the
-- beginning of the whole block. You should not add
-- VmaAllocationInfo::offset to it!
--
-- 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 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.
mapMemory :: forall io. MonadIO io => Allocator -> Allocation -> io ("data" ::: Ptr ())
-- | 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.
withMappedMemory :: forall io r. MonadIO io => Allocator -> Allocation -> (io (Ptr ()) -> (Ptr () -> io ()) -> r) -> r
-- | 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.
unmapMemory :: forall io. MonadIO io => Allocator -> Allocation -> 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.
flushAllocation :: 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.
invalidateAllocation :: forall io. MonadIO io => Allocator -> Allocation -> ("offset" ::: DeviceSize) -> 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
--
-- TODO: table
--
-- This function returns the VkResult from
-- vkFlushMappedMemoryRanges if it is called, otherwise
-- VK_SUCCESS.
flushAllocations :: 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
--
-- TODO: table
--
-- This function returns the VkResult from
-- vkInvalidateMappedMemoryRanges if it is called, otherwise
-- VK_SUCCESS.
invalidateAllocations :: forall io. MonadIO io => Allocator -> ("allocations" ::: Vector Allocation) -> ("offsets" ::: Vector DeviceSize) -> ("sizes" ::: Vector DeviceSize) -> io ()
-- | Checks magic number in margins around all allocations in given memory
-- types (in both default and custom pools) in search for corruptions.
--
-- Parameters
--
-- TODO: table
--
-- 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_UNKNOWN - 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.
--
checkCorruption :: forall io. MonadIO io => Allocator -> ("memoryTypeBits" ::: Word32) -> io ()
-- | Begins defragmentation process.
--
-- Parameters
--
-- TODO: table
--
-- Returns
--
--
-- - VK_SUCCESS if defragmentation can begin.
-- - VK_ERROR_FEATURE_NOT_PRESENT if defragmentation is not
-- supported.
--
--
-- For more information about defragmentation, see documentation chapter:
-- Defragmentation.
beginDefragmentation :: forall io. MonadIO io => Allocator -> DefragmentationInfo -> io DefragmentationContext
-- | A convenience wrapper to make a compatible pair of calls to
-- beginDefragmentation and endDefragmentation
--
-- To ensure that endDefragmentation 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.
withDefragmentation :: forall io r. MonadIO io => Allocator -> DefragmentationInfo -> (io DefragmentationContext -> (DefragmentationContext -> io DefragmentationStats) -> r) -> r
-- | Ends defragmentation process.
--
-- Parameters
--
-- TODO: table
--
-- Use this function to finish defragmentation started by
-- beginDefragmentation.
endDefragmentation :: forall io. MonadIO io => Allocator -> DefragmentationContext -> io DefragmentationStats
-- | Starts single defragmentation pass.
--
-- Parameters
--
-- TODO: table
--
-- Returns
--
--
beginDefragmentationPass :: forall io. MonadIO io => Allocator -> DefragmentationContext -> io ("passInfo" ::: DefragmentationPassMoveInfo)
-- | 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.
useDefragmentationPass :: forall io r. MonadIO io => Allocator -> DefragmentationContext -> (DefragmentationPassMoveInfo -> io r) -> io ("passInfo" ::: DefragmentationPassMoveInfo, r)
-- | Ends single defragmentation pass.
--
-- Parameters
--
-- TODO: table
--
-- Returns VK_SUCCESS if no more moves are possible or
-- VK_INCOMPLETE if more defragmentations are possible.
--
-- Ends incremental defragmentation pass and commits all defragmentation
-- moves from pPassInfo. After this call:
--
--
--
-- If no more moves are possible you can end whole defragmentation.
endDefragmentationPass :: forall io. MonadIO io => Allocator -> DefragmentationContext -> io ("passInfo" ::: DefragmentationPassMoveInfo)
-- | 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.
bindBufferMemory :: forall io. MonadIO io => Allocator -> Allocation -> Buffer -> io ()
-- | Binds buffer to allocation with additional parameters.
--
-- Parameters
--
-- TODO: table
--
-- 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.
bindBufferMemory2 :: forall io. MonadIO io => Allocator -> Allocation -> ("allocationLocalOffset" ::: DeviceSize) -> Buffer -> ("next" ::: Ptr ()) -> 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.
bindImageMemory :: forall io. MonadIO io => Allocator -> Allocation -> Image -> io ()
-- | Binds image to allocation with additional parameters.
--
-- Parameters
--
-- TODO: table
--
-- 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.
bindImageMemory2 :: forall io. MonadIO io => Allocator -> Allocation -> ("allocationLocalOffset" ::: DeviceSize) -> Image -> ("next" ::: Ptr ()) -> io ()
-- | Creates a new VkBuffer, allocates and binds memory for it.
--
-- Parameters
--
-- TODO: table
--
-- This function automatically:
--
--
-- - Creates buffer.
-- - Allocates appropriate memory for it.
-- - 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
-- (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.
createBuffer :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo a -> AllocationCreateInfo -> io (Buffer, Allocation, AllocationInfo)
-- | 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.
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
-- | 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.
createBufferWithAlignment :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> BufferCreateInfo a -> AllocationCreateInfo -> ("minAlignment" ::: DeviceSize) -> io (Buffer, Allocation, AllocationInfo)
-- | Creates a new VkBuffer, binds already created memory for it.
--
-- Parameters
--
-- TODO: table
--
-- This function automatically:
--
--
-- - Creates buffer.
-- - Binds the buffer with the supplied memory.
--
--
-- If any of these operations fail, buffer is not created, returned value
-- is negative error code and *pBuffer is null.
--
-- If the function succeeded, you must destroy the buffer when you no
-- longer need it using vkDestroyBuffer(). If you want to also
-- destroy the corresponding allocation you can use convenience function
-- destroyBuffer.
createAliasingBuffer :: forall a io. (Extendss BufferCreateInfo a, PokeChain a, MonadIO io) => Allocator -> Allocation -> BufferCreateInfo a -> io Buffer
-- | 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.
destroyBuffer :: forall io. MonadIO io => Allocator -> Buffer -> Allocation -> io ()
-- | Function similar to createBuffer.
createImage :: forall a io. (Extendss ImageCreateInfo a, PokeChain a, MonadIO io) => Allocator -> ImageCreateInfo a -> AllocationCreateInfo -> io (Image, Allocation, AllocationInfo)
-- | 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.
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
-- | Function similar to createAliasingBuffer.
createAliasingImage :: forall a io. (Extendss ImageCreateInfo a, PokeChain a, MonadIO io) => Allocator -> Allocation -> ImageCreateInfo a -> io Image
-- | 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.
destroyImage :: forall io. MonadIO io => Allocator -> Image -> Allocation -> io ()
-- | Creates new VirtualBlock object.
--
-- Parameters
--
-- TODO: table
createVirtualBlock :: forall io. MonadIO io => VirtualBlockCreateInfo -> io VirtualBlock
-- | A convenience wrapper to make a compatible pair of calls to
-- createVirtualBlock and destroyVirtualBlock
--
-- To ensure that destroyVirtualBlock 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.
withVirtualBlock :: forall io r. MonadIO io => VirtualBlockCreateInfo -> (io VirtualBlock -> (VirtualBlock -> io ()) -> r) -> r
-- | Destroys VirtualBlock object.
--
-- Please note that you should consciously handle virtual allocations
-- that could remain unfreed in the block. You should either free them
-- individually using virtualFree or call clearVirtualBlock
-- if you are sure this is what you want. If you do neither, an assert is
-- called.
--
-- If you keep pointers to some additional metadata associated with your
-- virtual allocations in their pUserData, don't forget to free
-- them.
destroyVirtualBlock :: forall io. MonadIO io => VirtualBlock -> io ()
-- | Returns true of the VirtualBlock is empty - contains 0 virtual
-- allocations and has all its space available for new allocations.
isVirtualBlockEmpty :: forall io. MonadIO io => VirtualBlock -> io Bool
-- | Returns information about a specific virtual allocation within a
-- virtual block, like its size and pUserData pointer.
getVirtualAllocationInfo :: forall io. MonadIO io => VirtualBlock -> VirtualAllocation -> io ("virtualAllocInfo" ::: VirtualAllocationInfo)
-- | Allocates new virtual allocation inside given VirtualBlock.
--
-- If the allocation fails due to not enough free space available,
-- VK_ERROR_OUT_OF_DEVICE_MEMORY is returned (despite the
-- function doesn't ever allocate actual GPU memory).
-- pAllocation is then set to VK_NULL_HANDLE and
-- pOffset, if not null, it set to UINT64_MAX.
--
-- Parameters
--
-- TODO: table
virtualAllocate :: forall io. MonadIO io => VirtualBlock -> VirtualAllocationCreateInfo -> io (VirtualAllocation, "offset" ::: DeviceSize)
-- | A convenience wrapper to make a compatible pair of calls to
-- virtualAllocate and virtualFree
--
-- To ensure that virtualFree 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.
withVirtualAllocation :: forall io r. MonadIO io => VirtualBlock -> VirtualAllocationCreateInfo -> (io (VirtualAllocation, DeviceSize) -> ((VirtualAllocation, DeviceSize) -> io ()) -> r) -> r
-- | Frees virtual allocation inside given VirtualBlock.
--
-- It is correct to call this function with allocation ==
-- VK_NULL_HANDLE - it does nothing.
virtualFree :: forall io. MonadIO io => VirtualBlock -> VirtualAllocation -> io ()
-- | Frees all virtual allocations inside given VirtualBlock.
--
-- You must either call this function or free each virtual allocation
-- individually with virtualFree before destroying a virtual
-- block. Otherwise, an assert is called.
--
-- If you keep pointer to some additional metadata associated with your
-- virtual allocation in its pUserData, don't forget to free it
-- as well.
clearVirtualBlock :: forall io. MonadIO io => VirtualBlock -> io ()
-- | Changes custom pointer associated with given virtual allocation.
setVirtualAllocationUserData :: forall io. MonadIO io => VirtualBlock -> VirtualAllocation -> ("userData" ::: Ptr ()) -> io ()
-- | Calculates and returns statistics about virtual allocations and memory
-- usage in given VirtualBlock.
--
-- This function is fast to call. For more detailed statistics, see
-- calculateVirtualBlockStatistics.
getVirtualBlockStatistics :: forall io. MonadIO io => VirtualBlock -> io ("stats" ::: Statistics)
-- | Calculates and returns detailed statistics about virtual allocations
-- and memory usage in given VirtualBlock.
--
-- This function is slow to call. Use for debugging purposes. For less
-- detailed statistics, see getVirtualBlockStatistics.
calculateVirtualBlockStatistics :: forall io. MonadIO io => VirtualBlock -> io ("stats" ::: DetailedStatistics)
-- | Builds and returns a null-terminated string in JSON format with
-- information about given VirtualBlock.
--
-- Parameters
--
-- TODO: table
--
-- Returned string must be freed using
-- freeVirtualBlockStatsString.
buildVirtualBlockStatsString :: forall io. MonadIO io => VirtualBlock -> ("detailedMap" ::: Bool) -> io ("statsString" ::: Ptr CChar)
-- | Frees a string returned by buildVirtualBlockStatsString.
freeVirtualBlockStatsString :: forall io. MonadIO io => VirtualBlock -> ("statsString" ::: Ptr CChar) -> io ()
-- | Builds and returns statistics as a null-terminated string in JSON
-- format.
--
-- Parameters
--
-- TODO: table
buildStatsString :: forall io. MonadIO io => Allocator -> ("detailedMap" ::: Bool) -> io ("statsString" ::: Ptr CChar)
freeStatsString :: forall io. MonadIO io => Allocator -> ("statsString" ::: Ptr CChar) -> io ()
type AllocatorCreateFlags = AllocatorCreateFlagBits
-- | Flags for created Allocator.
newtype AllocatorCreateFlagBits
AllocatorCreateFlagBits :: Flags -> 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_EXTERNALLY_SYNCHRONIZED_BIT :: AllocatorCreateFlagBits
-- | Enables usage of VK_KHR_dedicated_allocation extension.
--
-- The flag works only if VmaAllocatorCreateInfo::vulkanApiVersion
-- == VK_API_VERSION_1_0. When it is
-- 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_DEDICATED_ALLOCATION_BIT :: AllocatorCreateFlagBits
-- | Enables usage of VK_KHR_bind_memory2 extension.
--
-- The flag works only if VmaAllocatorCreateInfo::vulkanApiVersion
-- == VK_API_VERSION_1_0. When it is
-- 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_KHR_BIND_MEMORY2_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_EXT_MEMORY_BUDGET_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_AMD_DEVICE_COHERENT_MEMORY_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:
--
--
-- - (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.
-- - 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_BUFFER_DEVICE_ADDRESS_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.
pattern ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT :: AllocatorCreateFlagBits
-- | Intended usage of the allocated memory.
newtype MemoryUsage
MemoryUsage :: Int32 -> MemoryUsage
-- | No intended memory usage specified. Use other members of
-- AllocationCreateInfo to specify your requirements.
pattern MEMORY_USAGE_UNKNOWN :: MemoryUsage
-- | Deprecated
--
-- Obsolete, preserved for backward compatibility. Prefers
-- VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT.
pattern MEMORY_USAGE_GPU_ONLY :: MemoryUsage
-- | Deprecated
--
-- Obsolete, preserved for backward compatibility. Guarantees
-- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT and
-- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT.
pattern MEMORY_USAGE_CPU_ONLY :: MemoryUsage
-- | Deprecated
--
-- Obsolete, preserved for backward compatibility. Guarantees
-- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, prefers
-- VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT.
pattern MEMORY_USAGE_CPU_TO_GPU :: MemoryUsage
-- | Deprecated
--
-- Obsolete, preserved for backward compatibility. Guarantees
-- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, prefers
-- VK_MEMORY_PROPERTY_HOST_CACHED_BIT.
pattern MEMORY_USAGE_GPU_TO_CPU :: MemoryUsage
-- | Deprecated
--
-- Obsolete, preserved for backward compatibility. Prefers not
-- VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT.
pattern MEMORY_USAGE_CPU_COPY :: 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.
pattern MEMORY_USAGE_GPU_LAZILY_ALLOCATED :: MemoryUsage
-- | Selects best memory type automatically. This flag is recommended for
-- most common use cases.
--
-- When using this flag, if you want to map the allocation (using
-- mapMemory or ALLOCATION_CREATE_MAPPED_BIT), you must
-- pass one of the flags:
-- ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or
-- ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT in
-- VmaAllocationCreateInfo::flags.
--
-- It can be used only with functions that let the library know
-- VkBufferCreateInfo or VkImageCreateInfo, e.g.
-- createBuffer, createImage,
-- findMemoryTypeIndexForBufferInfo,
-- findMemoryTypeIndexForImageInfo and not with generic memory
-- allocation functions.
pattern MEMORY_USAGE_AUTO :: MemoryUsage
-- | Selects best memory type automatically with preference for GPU
-- (device) memory.
--
-- When using this flag, if you want to map the allocation (using
-- mapMemory or ALLOCATION_CREATE_MAPPED_BIT), you must
-- pass one of the flags:
-- ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or
-- ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT in
-- VmaAllocationCreateInfo::flags.
--
-- It can be used only with functions that let the library know
-- VkBufferCreateInfo or VkImageCreateInfo, e.g.
-- createBuffer, createImage,
-- findMemoryTypeIndexForBufferInfo,
-- findMemoryTypeIndexForImageInfo and not with generic memory
-- allocation functions.
pattern MEMORY_USAGE_AUTO_PREFER_DEVICE :: MemoryUsage
-- | Selects best memory type automatically with preference for CPU (host)
-- memory.
--
-- When using this flag, if you want to map the allocation (using
-- mapMemory or ALLOCATION_CREATE_MAPPED_BIT), you must
-- pass one of the flags:
-- ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or
-- ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT in
-- VmaAllocationCreateInfo::flags.
--
-- It can be used only with functions that let the library know
-- VkBufferCreateInfo or VkImageCreateInfo, e.g.
-- createBuffer, createImage,
-- findMemoryTypeIndexForBufferInfo,
-- findMemoryTypeIndexForImageInfo and not with generic memory
-- allocation functions.
pattern MEMORY_USAGE_AUTO_PREFER_HOST :: MemoryUsage
type AllocationCreateFlags = AllocationCreateFlagBits
-- | Flags to be passed as VmaAllocationCreateInfo::flags.
newtype AllocationCreateFlagBits
AllocationCreateFlagBits :: Flags -> 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.
pattern ALLOCATION_CREATE_DEDICATED_MEMORY_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.
pattern ALLOCATION_CREATE_NEVER_ALLOCATE_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).
pattern ALLOCATION_CREATE_MAPPED_BIT :: AllocationCreateFlagBits
-- | Deprecated
--
-- Preserved for backward compatibility. Consider using
-- setAllocationName instead.
--
-- 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
-- pName. The string is automatically freed together with the
-- allocation. It is also used in buildStatsString.
pattern ALLOCATION_CREATE_USER_DATA_COPY_STRING_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_UPPER_ADDRESS_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.
--
-- If you want to make sure the new buffer/image is not tied to the new
-- memory allocation through VkMemoryDedicatedAllocateInfoKHR
-- structure in case the allocation ends up in its own memory block, use
-- also flag ALLOCATION_CREATE_CAN_ALIAS_BIT.
pattern ALLOCATION_CREATE_DONT_BIND_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_WITHIN_BUDGET_BIT :: AllocationCreateFlagBits
-- | Set this flag if the allocated memory will have aliasing resources.
--
-- Usage of this flag prevents supplying
-- VkMemoryDedicatedAllocateInfoKHR when
-- ALLOCATION_CREATE_DEDICATED_MEMORY_BIT is specified. Otherwise
-- created dedicated memory will not be suitable for aliasing resources,
-- resulting in Vulkan Validation Layer errors.
pattern ALLOCATION_CREATE_CAN_ALIAS_BIT :: AllocationCreateFlagBits
-- | Requests possibility to map the allocation (using mapMemory or
-- ALLOCATION_CREATE_MAPPED_BIT).
--
--
-- - If you use MEMORY_USAGE_AUTO or other
-- VMA_MEMORY_USAGE_AUTO* value, you must use this flag to be
-- able to map the allocation. Otherwise, mapping is incorrect.
-- - If you use other value of MemoryUsage, this flag is ignored
-- and mapping is always possible in memory types that are
-- HOST_VISIBLE. This includes allocations created in Custom
-- memory pools.
--
--
-- Declares that mapped memory will only be written sequentially, e.g.
-- using memcpy() or a loop writing number-by-number, never read
-- or accessed randomly, so a memory type can be selected that is
-- uncached and write-combined.
--
-- Warning
--
-- Violating this declaration may work correctly, but will likely be very
-- slow. Watch out for implicit reads introduced by doing e.g.
-- pMappedData[i] += x; Better prepare your data in a local
-- variable and memcpy() it to the mapped pointer all at once.
pattern ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT :: AllocationCreateFlagBits
-- | Requests possibility to map the allocation (using mapMemory or
-- ALLOCATION_CREATE_MAPPED_BIT).
--
--
-- - If you use MEMORY_USAGE_AUTO or other
-- VMA_MEMORY_USAGE_AUTO* value, you must use this flag to be
-- able to map the allocation. Otherwise, mapping is incorrect.
-- - If you use other value of MemoryUsage, this flag is ignored
-- and mapping is always possible in memory types that are
-- HOST_VISIBLE. This includes allocations created in Custom
-- memory pools.
--
--
-- Declares that mapped memory can be read, written, and accessed in
-- random order, so a HOST_CACHED memory type is required.
pattern ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT :: AllocationCreateFlagBits
-- | Together with
-- ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or
-- ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT, it says that despite
-- request for host access, a not-HOST_VISIBLE memory type can
-- be selected if it may improve performance.
--
-- By using this flag, you declare that you will check if the allocation
-- ended up in a HOST_VISIBLE memory type (e.g. using
-- getAllocationMemoryProperties) and if not, you will create some
-- "staging" buffer and issue an explicit transfer to write/read your
-- data. To prepare for this possibility, don't forget to add appropriate
-- flags like VK_BUFFER_USAGE_TRANSFER_DST_BIT,
-- VK_BUFFER_USAGE_TRANSFER_SRC_BIT to the parameters of created
-- buffer or image.
pattern ALLOCATION_CREATE_HOST_ACCESS_ALLOW_TRANSFER_INSTEAD_BIT :: AllocationCreateFlagBits
-- | Allocation strategy that chooses smallest possible free range for the
-- allocation to minimize memory usage and fragmentation, possibly at the
-- expense of allocation time.
pattern ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT :: AllocationCreateFlagBits
-- | Allocation strategy that chooses first suitable free range for the
-- allocation - not necessarily in terms of the smallest offset but the
-- one that is easiest and fastest to find to minimize allocation time,
-- possibly at the expense of allocation quality.
pattern ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT :: AllocationCreateFlagBits
-- | Allocation strategy that chooses always the lowest offset in available
-- space. This is not the most efficient strategy but achieves highly
-- packed data. Used internally by defragmentation, not recomended in
-- typical usage.
pattern ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT :: AllocationCreateFlagBits
-- | Alias to ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT.
pattern ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT :: AllocationCreateFlagBits
-- | Alias to ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT.
pattern ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT :: AllocationCreateFlagBits
-- | A bit mask to extract only STRATEGY bits from entire set of
-- flags.
pattern ALLOCATION_CREATE_STRATEGY_MASK :: AllocationCreateFlagBits
type PoolCreateFlags = PoolCreateFlagBits
-- | Flags to be passed as VmaPoolCreateInfo::flags.
newtype PoolCreateFlagBits
PoolCreateFlagBits :: Flags -> 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_IGNORE_BUFFER_IMAGE_GRANULARITY_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.
pattern POOL_CREATE_LINEAR_ALGORITHM_BIT :: PoolCreateFlagBits
-- | Bit mask to extract only ALGORITHM bits from entire set of
-- flags.
pattern POOL_CREATE_ALGORITHM_MASK :: PoolCreateFlagBits
type DefragmentationFlags = DefragmentationFlagBits
-- | Flags to be passed as VmaDefragmentationInfo::flags.
newtype DefragmentationFlagBits
DefragmentationFlagBits :: Flags -> DefragmentationFlagBits
pattern DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT :: DefragmentationFlagBits
pattern DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED_BIT :: DefragmentationFlagBits
pattern DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT :: DefragmentationFlagBits
-- | Use the most roboust algorithm at the cost of time to compute and
-- number of copies to make. Only available when bufferImageGranularity
-- is greater than 1, since it aims to reduce alignment issues between
-- different types of resources. Otherwise falls back to same behavior as
-- DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT.
pattern DEFRAGMENTATION_FLAG_ALGORITHM_EXTENSIVE_BIT :: DefragmentationFlagBits
-- | A bit mask to extract only ALGORITHM bits from entire set of
-- flags.
pattern DEFRAGMENTATION_FLAG_ALGORITHM_MASK :: DefragmentationFlagBits
-- | Operation performed on single defragmentation move. See structure
-- DefragmentationMove.
newtype DefragmentationMoveOperation
DefragmentationMoveOperation :: Int32 -> DefragmentationMoveOperation
-- | Buffer/image has been recreated at dstTmpAllocation, data has
-- been copied, old buffer/image has been destroyed.
-- srcAllocation should be changed to point to the new place.
-- This is the default value set by beginDefragmentationPass.
pattern DEFRAGMENTATION_MOVE_OPERATION_COPY :: DefragmentationMoveOperation
-- | Set this value if you cannot move the allocation. New place reserved
-- at dstTmpAllocation will be freed. srcAllocation
-- will remain unchanged.
pattern DEFRAGMENTATION_MOVE_OPERATION_IGNORE :: DefragmentationMoveOperation
-- | Set this value if you decide to abandon the allocation and you
-- destroyed the buffer/image. New place reserved at
-- dstTmpAllocation will be freed, along with
-- srcAllocation, which will be destroyed.
pattern DEFRAGMENTATION_MOVE_OPERATION_DESTROY :: DefragmentationMoveOperation
type VirtualBlockCreateFlags = VirtualBlockCreateFlagBits
-- | Flags to be passed as VmaVirtualBlockCreateInfo::flags.
newtype VirtualBlockCreateFlagBits
VirtualBlockCreateFlagBits :: Flags -> VirtualBlockCreateFlagBits
-- | Enables alternative, linear allocation algorithm in this virtual
-- block.
--
-- 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.
pattern VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT :: VirtualBlockCreateFlagBits
-- | Bit mask to extract only ALGORITHM bits from entire set of
-- flags.
pattern VIRTUAL_BLOCK_CREATE_ALGORITHM_MASK :: VirtualBlockCreateFlagBits
type VirtualAllocationCreateFlags = VirtualAllocationCreateFlagBits
-- | Flags to be passed as VmaVirtualAllocationCreateInfo::flags.
newtype VirtualAllocationCreateFlagBits
VirtualAllocationCreateFlagBits :: Flags -> VirtualAllocationCreateFlagBits
-- | Allocation will be created from upper stack in a double stack pool.
--
-- This flag is only allowed for virtual blocks created with
-- VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT flag.
pattern VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT :: VirtualAllocationCreateFlagBits
-- | Allocation strategy that tries to minimize memory usage.
pattern VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT :: VirtualAllocationCreateFlagBits
-- | Allocation strategy that tries to minimize allocation time.
pattern VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT :: VirtualAllocationCreateFlagBits
-- | Allocation strategy that chooses always the lowest offset in available
-- space. This is not the most efficient strategy but achieves highly
-- packed data.
pattern VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT :: VirtualAllocationCreateFlagBits
-- | A bit mask to extract only STRATEGY bits from entire set of
-- flags.
--
-- These strategy flags are binary compatible with equivalent flags in
-- AllocationCreateFlagBits.
pattern VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK :: VirtualAllocationCreateFlagBits
-- | 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.
newtype Allocator
Allocator :: Word64 -> Allocator
-- | 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.
newtype Pool
Pool :: Word64 -> Pool
-- | 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.
newtype Allocation
Allocation :: Word64 -> Allocation
-- | VmaDefragmentationContext
--
-- An opaque object that represents started defragmentation process.
--
-- Fill structure DefragmentationInfo and call function
-- beginDefragmentation to create it. Call function
-- endDefragmentation to destroy it.
newtype DefragmentationContext
DefragmentationContext :: Word64 -> DefragmentationContext
-- | VmaVirtualAllocation
--
-- Represents single memory allocation done inside VirtualBlock.
--
-- Use it as a unique identifier to virtual allocation within the single
-- block.
--
-- Use value VK_NULL_HANDLE to represent a null/invalid
-- allocation.
newtype VirtualAllocation
VirtualAllocation :: Word64 -> VirtualAllocation
-- | VmaVirtualBlock
--
-- Handle to a virtual block object that allows to use core allocation
-- algorithm without allocating any real GPU memory.
--
-- Fill in VirtualBlockCreateInfo structure and use
-- createVirtualBlock to create it. Use destroyVirtualBlock
-- to destroy it. For more information, see documentation chapter
-- Virtual allocator.
--
-- This object is not thread-safe - should not be used from multiple
-- threads simultaneously, must be synchronized externally.
newtype VirtualBlock
VirtualBlock :: Word64 -> VirtualBlock
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 ()
-- | 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.
data DeviceMemoryCallbacks
DeviceMemoryCallbacks :: PFN_vmaAllocateDeviceMemoryFunction -> PFN_vmaFreeDeviceMemoryFunction -> Ptr () -> DeviceMemoryCallbacks
-- | Optional, can be null.
[$sel:pfnAllocate:DeviceMemoryCallbacks] :: DeviceMemoryCallbacks -> PFN_vmaAllocateDeviceMemoryFunction
-- | Optional, can be null.
[$sel:pfnFree:DeviceMemoryCallbacks] :: DeviceMemoryCallbacks -> PFN_vmaFreeDeviceMemoryFunction
-- | Optional, can be null.
[$sel:userData:DeviceMemoryCallbacks] :: DeviceMemoryCallbacks -> Ptr ()
-- | VmaVulkanFunctions
--
-- Pointers to some Vulkan functions - a subset used by the library.
--
-- Used in VmaAllocatorCreateInfo::pVulkanFunctions.
data VulkanFunctions
VulkanFunctions :: PFN_vkGetInstanceProcAddr -> PFN_vkGetDeviceProcAddr -> PFN_vkGetPhysicalDeviceProperties -> PFN_vkGetPhysicalDeviceMemoryProperties -> PFN_vkAllocateMemory -> PFN_vkFreeMemory -> PFN_vkMapMemory -> PFN_vkUnmapMemory -> PFN_vkFlushMappedMemoryRanges -> PFN_vkInvalidateMappedMemoryRanges -> PFN_vkBindBufferMemory -> PFN_vkBindImageMemory -> PFN_vkGetBufferMemoryRequirements -> PFN_vkGetImageMemoryRequirements -> PFN_vkCreateBuffer -> PFN_vkDestroyBuffer -> PFN_vkCreateImage -> PFN_vkDestroyImage -> PFN_vkCmdCopyBuffer -> PFN_vkGetBufferMemoryRequirements2KHR -> PFN_vkGetImageMemoryRequirements2KHR -> PFN_vkBindBufferMemory2KHR -> PFN_vkBindImageMemory2KHR -> PFN_vkGetPhysicalDeviceMemoryProperties2KHR -> VulkanFunctions
-- | Required when using VMA_DYNAMIC_VULKAN_FUNCTIONS.
[$sel:vkGetInstanceProcAddr:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetInstanceProcAddr
-- | Required when using VMA_DYNAMIC_VULKAN_FUNCTIONS.
[$sel:vkGetDeviceProcAddr:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetDeviceProcAddr
[$sel:vkGetPhysicalDeviceProperties:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetPhysicalDeviceProperties
[$sel:vkGetPhysicalDeviceMemoryProperties:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetPhysicalDeviceMemoryProperties
[$sel:vkAllocateMemory:VulkanFunctions] :: VulkanFunctions -> PFN_vkAllocateMemory
[$sel:vkFreeMemory:VulkanFunctions] :: VulkanFunctions -> PFN_vkFreeMemory
[$sel:vkMapMemory:VulkanFunctions] :: VulkanFunctions -> PFN_vkMapMemory
[$sel:vkUnmapMemory:VulkanFunctions] :: VulkanFunctions -> PFN_vkUnmapMemory
[$sel:vkFlushMappedMemoryRanges:VulkanFunctions] :: VulkanFunctions -> PFN_vkFlushMappedMemoryRanges
[$sel:vkInvalidateMappedMemoryRanges:VulkanFunctions] :: VulkanFunctions -> PFN_vkInvalidateMappedMemoryRanges
[$sel:vkBindBufferMemory:VulkanFunctions] :: VulkanFunctions -> PFN_vkBindBufferMemory
[$sel:vkBindImageMemory:VulkanFunctions] :: VulkanFunctions -> PFN_vkBindImageMemory
[$sel:vkGetBufferMemoryRequirements:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetBufferMemoryRequirements
[$sel:vkGetImageMemoryRequirements:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetImageMemoryRequirements
[$sel:vkCreateBuffer:VulkanFunctions] :: VulkanFunctions -> PFN_vkCreateBuffer
[$sel:vkDestroyBuffer:VulkanFunctions] :: VulkanFunctions -> PFN_vkDestroyBuffer
[$sel:vkCreateImage:VulkanFunctions] :: VulkanFunctions -> PFN_vkCreateImage
[$sel:vkDestroyImage:VulkanFunctions] :: VulkanFunctions -> PFN_vkDestroyImage
[$sel:vkCmdCopyBuffer:VulkanFunctions] :: VulkanFunctions -> PFN_vkCmdCopyBuffer
-- | Fetch "vkGetBufferMemoryRequirements2" on Vulkan >= 1.1, fetch
-- "vkGetBufferMemoryRequirements2KHR" when using
-- VK_KHR_dedicated_allocation extension.
[$sel:vkGetBufferMemoryRequirements2KHR:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetBufferMemoryRequirements2KHR
-- | Fetch "vkGetImageMemoryRequirements 2" on Vulkan >= 1.1, fetch
-- "vkGetImageMemoryRequirements2KHR" when using
-- VK_KHR_dedicated_allocation extension.
[$sel:vkGetImageMemoryRequirements2KHR:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetImageMemoryRequirements2KHR
-- | Fetch "vkBindBufferMemory2" on Vulkan >= 1.1, fetch
-- "vkBindBufferMemory2KHR" when using VK_KHR_bind_memory2 extension.
[$sel:vkBindBufferMemory2KHR:VulkanFunctions] :: VulkanFunctions -> PFN_vkBindBufferMemory2KHR
-- | Fetch "vkBindImageMemory2" on Vulkan >= 1.1, fetch
-- "vkBindImageMemory2KHR" when using VK_KHR_bind_memory2 extension.
[$sel:vkBindImageMemory2KHR:VulkanFunctions] :: VulkanFunctions -> PFN_vkBindImageMemory2KHR
[$sel:vkGetPhysicalDeviceMemoryProperties2KHR:VulkanFunctions] :: VulkanFunctions -> PFN_vkGetPhysicalDeviceMemoryProperties2KHR
-- | VmaAllocatorCreateInfo
--
-- Description of a Allocator to be created.
data AllocatorCreateInfo
AllocatorCreateInfo :: AllocatorCreateFlags -> Ptr PhysicalDevice_T -> Ptr Device_T -> DeviceSize -> Maybe AllocationCallbacks -> Maybe DeviceMemoryCallbacks -> Ptr DeviceSize -> Maybe VulkanFunctions -> Ptr Instance_T -> Word32 -> Ptr ExternalMemoryHandleTypeFlagsKHR -> AllocatorCreateInfo
-- | Flags for created allocator. Use AllocatorCreateFlagBits enum.
[$sel:flags:AllocatorCreateInfo] :: AllocatorCreateInfo -> AllocatorCreateFlags
-- | Vulkan physical device.
--
-- It must be valid throughout whole lifetime of created allocator.
[$sel:physicalDevice:AllocatorCreateInfo] :: AllocatorCreateInfo -> Ptr PhysicalDevice_T
-- | Vulkan device.
--
-- It must be valid throughout whole lifetime of created allocator.
[$sel:device:AllocatorCreateInfo] :: AllocatorCreateInfo -> Ptr Device_T
-- | 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.
[$sel:preferredLargeHeapBlockSize:AllocatorCreateInfo] :: AllocatorCreateInfo -> DeviceSize
-- | Custom CPU memory allocation callbacks. Optional.
--
-- Optional, can be null. When specified, will also be used for all
-- CPU-side memory allocations.
[$sel:allocationCallbacks:AllocatorCreateInfo] :: AllocatorCreateInfo -> Maybe AllocationCallbacks
-- | Informative callbacks for vkAllocateMemory,
-- vkFreeMemory. Optional.
--
-- Optional, can be null.
[$sel:deviceMemoryCallbacks:AllocatorCreateInfo] :: AllocatorCreateInfo -> Maybe DeviceMemoryCallbacks
-- | 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.
[$sel:heapSizeLimit:AllocatorCreateInfo] :: AllocatorCreateInfo -> Ptr DeviceSize
-- | Pointers to Vulkan functions. Can be null.
--
-- For details see Pointers to Vulkan functions.
[$sel:vulkanFunctions:AllocatorCreateInfo] :: AllocatorCreateInfo -> Maybe VulkanFunctions
-- | Handle to Vulkan instance object.
--
-- Starting from version 3.0.0 this member is no longer optional, it must
-- be set!
[$sel:instance':AllocatorCreateInfo] :: AllocatorCreateInfo -> Ptr Instance_T
-- | 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,
-- 1.3 are supported by the current implementation. Leaving it
-- initialized to zero is equivalent to VK_API_VERSION_1_0.
[$sel:vulkanApiVersion:AllocatorCreateInfo] :: AllocatorCreateInfo -> Word32
-- | 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.
[$sel:typeExternalMemoryHandleTypes:AllocatorCreateInfo] :: AllocatorCreateInfo -> Ptr ExternalMemoryHandleTypeFlagsKHR
-- | VmaAllocatorInfo
--
-- Information about existing Allocator object.
data AllocatorInfo
AllocatorInfo :: Ptr Instance_T -> Ptr PhysicalDevice_T -> Ptr Device_T -> AllocatorInfo
-- | Handle to Vulkan instance object.
--
-- This is the same value as has been passed through
-- VmaAllocatorCreateInfo::instance.
[$sel:instance':AllocatorInfo] :: AllocatorInfo -> Ptr Instance_T
-- | Handle to Vulkan physical device object.
--
-- This is the same value as has been passed through
-- VmaAllocatorCreateInfo::physicalDevice.
[$sel:physicalDevice:AllocatorInfo] :: AllocatorInfo -> Ptr PhysicalDevice_T
-- | Handle to Vulkan device object.
--
-- This is the same value as has been passed through
-- VmaAllocatorCreateInfo::device.
[$sel:device:AllocatorInfo] :: AllocatorInfo -> Ptr Device_T
-- | VmaStatistics
--
-- Calculated statistics of memory usage e.g. in a specific memory type,
-- heap, custom pool, or total.
--
-- These are fast to calculate. See functions: getHeapBudgets,
-- getPoolStatistics.
data Statistics
Statistics :: Word32 -> Word32 -> DeviceSize -> DeviceSize -> Statistics
-- | Number of VkDeviceMemory objects - Vulkan memory blocks
-- allocated.
[$sel:blockCount:Statistics] :: Statistics -> Word32
-- | Number of Allocation objects allocated.
--
-- Dedicated allocations have their own blocks, so each one adds 1 to
-- allocationCount as well as blockCount.
[$sel:allocationCount:Statistics] :: Statistics -> Word32
-- | Number of bytes allocated in VkDeviceMemory blocks.
--
-- Note
--
-- To avoid confusion, please be aware that what Vulkan calls an
-- "allocation" - a whole VkDeviceMemory object (e.g. as in
-- VkPhysicalDeviceLimits::maxMemoryAllocationCount) is called a
-- "block" in VMA, while VMA calls "allocation" a Allocation
-- object that represents a memory region sub-allocated from such block,
-- usually for a single buffer or image.
[$sel:blockBytes:Statistics] :: Statistics -> DeviceSize
-- | Total number of bytes occupied by all Allocation objects.
--
-- Always less or equal than blockBytes. Difference
-- (blockBytes - allocationBytes) is the amount of memory
-- allocated from Vulkan but unused by any Allocation.
[$sel:allocationBytes:Statistics] :: Statistics -> DeviceSize
-- | VmaDetailedStatistics
--
-- More detailed statistics than Statistics.
--
-- These are slower to calculate. Use for debugging purposes. See
-- functions: calculateStatistics, calculatePoolStatistics.
--
-- Previous version of the statistics API provided averages, but they
-- have been removed because they can be easily calculated as:
--
--
-- VkDeviceSize allocationSizeAvg = detailedStats.statistics.allocationBytes / detailedStats.statistics.allocationCount;
-- VkDeviceSize unusedBytes = detailedStats.statistics.blockBytes - detailedStats.statistics.allocationBytes;
-- VkDeviceSize unusedRangeSizeAvg = unusedBytes / detailedStats.unusedRangeCount;
--
data DetailedStatistics
DetailedStatistics :: Statistics -> Word32 -> DeviceSize -> DeviceSize -> DeviceSize -> DeviceSize -> DetailedStatistics
-- | Basic statistics.
[$sel:statistics:DetailedStatistics] :: DetailedStatistics -> Statistics
-- | Number of free ranges of memory between allocations.
[$sel:unusedRangeCount:DetailedStatistics] :: DetailedStatistics -> Word32
-- | Smallest allocation size. VK_WHOLE_SIZE if there are 0
-- allocations.
[$sel:allocationSizeMin:DetailedStatistics] :: DetailedStatistics -> DeviceSize
-- | Largest allocation size. 0 if there are 0 allocations.
[$sel:allocationSizeMax:DetailedStatistics] :: DetailedStatistics -> DeviceSize
-- | Smallest empty range size. VK_WHOLE_SIZE if there are 0 empty
-- ranges.
[$sel:unusedRangeSizeMin:DetailedStatistics] :: DetailedStatistics -> DeviceSize
-- | Largest empty range size. 0 if there are 0 empty ranges.
[$sel:unusedRangeSizeMax:DetailedStatistics] :: DetailedStatistics -> DeviceSize
-- | VmaTotalStatistics
--
--
--
-- General statistics from current state of the Allocator - total memory
-- usage across all memory heaps and types.
--
-- These are slower to calculate. Use for debugging purposes. See
-- function calculateStatistics.
--
-- memoryHeap
--
-- memoryHeap VmaTotalStatistics VmaTotalStatistics memoryHeap
-- VmaDetailedStatistics
-- VmaTotalStatistics::memoryHeap[VK_MAX_MEMORY_HEAPS]
--
-- memoryType
--
-- memoryType VmaTotalStatistics VmaTotalStatistics memoryType
-- VmaDetailedStatistics
-- VmaTotalStatistics::memoryType[VK_MAX_MEMORY_TYPES]
data TotalStatistics
TotalStatistics :: Vector DetailedStatistics -> Vector DetailedStatistics -> DetailedStatistics -> TotalStatistics
[$sel:memoryType:TotalStatistics] :: TotalStatistics -> Vector DetailedStatistics
[$sel:memoryHeap:TotalStatistics] :: TotalStatistics -> Vector DetailedStatistics
[$sel:total:TotalStatistics] :: TotalStatistics -> DetailedStatistics
-- | VmaBudget
--
-- Statistics of current memory usage and available budget for a specific
-- memory heap.
--
-- These are fast to calculate. See function getHeapBudgets.
data Budget
Budget :: Statistics -> DeviceSize -> DeviceSize -> Budget
-- | Statistics fetched from the library.
[$sel:statistics:Budget] :: Budget -> Statistics
-- | 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 statistics.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.
[$sel:usage:Budget] :: 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, decided by the operating system. Difference budget -
-- usage is the amount of additional memory that can probably be
-- allocated without problems. Exceeding the budget may result in various
-- problems.
[$sel:budget:Budget] :: Budget -> DeviceSize
-- | VmaAllocationCreateInfo
--
-- Parameters of new Allocation.
--
-- To be used with functions like createBuffer,
-- createImage, and many others.
data AllocationCreateInfo
AllocationCreateInfo :: AllocationCreateFlags -> MemoryUsage -> MemoryPropertyFlags -> MemoryPropertyFlags -> Word32 -> Pool -> Ptr () -> Float -> AllocationCreateInfo
-- | Use AllocationCreateFlagBits enum.
[$sel:flags:AllocationCreateInfo] :: AllocationCreateInfo -> AllocationCreateFlags
-- | 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.
[$sel:usage:AllocationCreateInfo] :: AllocationCreateInfo -> MemoryUsage
-- | 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.
[$sel:requiredFlags:AllocationCreateInfo] :: AllocationCreateInfo -> 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.
[$sel:preferredFlags:AllocationCreateInfo] :: AllocationCreateInfo -> MemoryPropertyFlags
-- | 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.
[$sel:memoryTypeBits:AllocationCreateInfo] :: AllocationCreateInfo -> Word32
-- | 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.
[$sel:pool:AllocationCreateInfo] :: AllocationCreateInfo -> Pool
-- | 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.
[$sel:userData:AllocationCreateInfo] :: AllocationCreateInfo -> Ptr ()
-- | 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.
[$sel:priority:AllocationCreateInfo] :: AllocationCreateInfo -> Float
-- | VmaPoolCreateInfo
--
-- Describes parameter of created Pool.
data PoolCreateInfo
PoolCreateInfo :: Word32 -> PoolCreateFlags -> DeviceSize -> Word64 -> Word64 -> Float -> DeviceSize -> Ptr () -> PoolCreateInfo
-- | Vulkan memory type index to allocate this pool from.
[$sel:memoryTypeIndex:PoolCreateInfo] :: PoolCreateInfo -> Word32
-- | Use combination of PoolCreateFlagBits.
[$sel:flags:PoolCreateInfo] :: PoolCreateInfo -> PoolCreateFlags
-- | 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. In this case, the
-- pool will also support dedicated allocations.
[$sel:blockSize:PoolCreateInfo] :: PoolCreateInfo -> DeviceSize
-- | 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.
[$sel:minBlockCount:PoolCreateInfo] :: PoolCreateInfo -> 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.
[$sel:maxBlockCount:PoolCreateInfo] :: PoolCreateInfo -> Word64
-- | 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.
[$sel:priority:PoolCreateInfo] :: PoolCreateInfo -> Float
-- | 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.
[$sel:minAllocationAlignment:PoolCreateInfo] :: PoolCreateInfo -> DeviceSize
-- | 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.
[$sel:memoryAllocateNext:PoolCreateInfo] :: PoolCreateInfo -> Ptr ()
-- | VmaAllocationInfo
--
-- Parameters of Allocation objects, that can be retrieved using
-- function getAllocationInfo.
data AllocationInfo
AllocationInfo :: Word32 -> DeviceMemory -> DeviceSize -> DeviceSize -> Ptr () -> Ptr () -> Maybe ByteString -> AllocationInfo
-- | Memory type index that this allocation was allocated from.
--
-- It never changes.
[$sel:memoryType:AllocationInfo] :: AllocationInfo -> Word32
-- | Handle to Vulkan memory object.
--
-- Same memory object can be shared by multiple allocations.
--
-- It can change after the allocation is moved during
-- Defragmentation.
[$sel:deviceMemory:AllocationInfo] :: AllocationInfo -> DeviceMemory
-- | 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 the allocation is moved during
-- Defragmentation.
[$sel:offset:AllocationInfo] :: AllocationInfo -> DeviceSize
-- | Size of this allocation, in bytes.
--
-- It never changes.
--
-- 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.
[$sel:size:AllocationInfo] :: AllocationInfo -> DeviceSize
-- | 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 the allocation is moved during
-- Defragmentation.
[$sel:mappedData:AllocationInfo] :: AllocationInfo -> 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.
[$sel:userData:AllocationInfo] :: AllocationInfo -> Ptr ()
-- | Custom allocation name that was set with setAllocationName.
--
-- It can change after call to setAllocationName for this
-- allocation.
--
-- Another way to set custom name is to pass it in
-- VmaAllocationCreateInfo::pUserData with additional flag
-- ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT set [DEPRECATED].
[$sel:name:AllocationInfo] :: AllocationInfo -> Maybe ByteString
-- | VmaDefragmentationInfo
--
-- Parameters for defragmentation.
--
-- To be used with function beginDefragmentation.
data DefragmentationInfo
DefragmentationInfo :: DefragmentationFlags -> Pool -> DeviceSize -> Word32 -> DefragmentationInfo
-- | Use combination of DefragmentationFlagBits.
[$sel:flags:DefragmentationInfo] :: DefragmentationInfo -> DefragmentationFlags
-- | Custom pool to be defragmented.
--
-- If null then default pools will undergo defragmentation process.
[$sel:pool:DefragmentationInfo] :: DefragmentationInfo -> Pool
-- | Maximum numbers of bytes that can be copied during single pass, while
-- moving allocations to different places.
--
-- 0 means no limit.
[$sel:maxBytesPerPass:DefragmentationInfo] :: DefragmentationInfo -> DeviceSize
-- | Maximum number of allocations that can be moved during single pass to
-- a different place.
--
-- 0 means no limit.
[$sel:maxAllocationsPerPass:DefragmentationInfo] :: DefragmentationInfo -> Word32
-- | VmaDefragmentationMove
--
-- Single move of an allocation to be done for defragmentation.
data DefragmentationMove
DefragmentationMove :: DefragmentationMoveOperation -> Allocation -> Allocation -> DefragmentationMove
-- | Operation to be performed on the allocation by
-- endDefragmentationPass. Default value is
-- DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
[$sel:operation:DefragmentationMove] :: DefragmentationMove -> DefragmentationMoveOperation
-- | Allocation that should be moved.
[$sel:srcAllocation:DefragmentationMove] :: DefragmentationMove -> Allocation
-- | Temporary allocation pointing to destination memory that will replace
-- srcAllocation.
--
-- Warning
--
-- Do not store this allocation in your data structures! It exists only
-- temporarily, for the duration of the defragmentation pass, to be used
-- for binding new buffer/image to the destination memory using e.g.
-- bindBufferMemory. endDefragmentationPass will destroy it
-- and make srcAllocation point to this memory.
[$sel:dstTmpAllocation:DefragmentationMove] :: DefragmentationMove -> Allocation
-- | VmaDefragmentationPassMoveInfo
--
-- Parameters for incremental defragmentation steps.
--
-- To be used with function beginDefragmentationPass.
data DefragmentationPassMoveInfo
DefragmentationPassMoveInfo :: Word32 -> Ptr DefragmentationMove -> DefragmentationPassMoveInfo
-- | Number of elements in the pMoves array.
[$sel:moveCount:DefragmentationPassMoveInfo] :: DefragmentationPassMoveInfo -> Word32
-- | Array of moves to be performed by the user in the current
-- defragmentation pass.
--
-- Pointer to an array of moveCount elements, owned by VMA,
-- created in beginDefragmentationPass, destroyed in
-- endDefragmentationPass.
--
-- For each element, you should:
--
--
-- - Create a new buffer/image in the place pointed by
-- VmaDefragmentationMove::dstMemory +
-- VmaDefragmentationMove::dstOffset.
-- - Copy data from the VmaDefragmentationMove::srcAllocation
-- e.g. using vkCmdCopyBuffer, vkCmdCopyImage.
-- - Make sure these commands finished executing on the GPU.
-- - Destroy the old buffer/image.
--
--
-- Only then you can finish defragmentation pass by calling
-- endDefragmentationPass. After this call, the allocation will
-- point to the new place in memory.
--
-- Alternatively, if you cannot move specific allocation, you can set
-- VmaDefragmentationMove::operation to
-- DEFRAGMENTATION_MOVE_OPERATION_IGNORE.
--
-- Alternatively, if you decide you want to completely remove the
-- allocation:
--
--
-- - Destroy its buffer/image.
-- - Set VmaDefragmentationMove::operation to
-- DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
--
--
-- Then, after endDefragmentationPass the allocation will be
-- freed.
[$sel:moves:DefragmentationPassMoveInfo] :: DefragmentationPassMoveInfo -> Ptr DefragmentationMove
-- | VmaDefragmentationStats
--
-- Statistics returned for defragmentation process in function
-- endDefragmentation.
data DefragmentationStats
DefragmentationStats :: DeviceSize -> DeviceSize -> Word32 -> Word32 -> DefragmentationStats
-- | Total number of bytes that have been copied while moving allocations
-- to different places.
[$sel:bytesMoved:DefragmentationStats] :: DefragmentationStats -> DeviceSize
-- | Total number of bytes that have been released to the system by freeing
-- empty VkDeviceMemory objects.
[$sel:bytesFreed:DefragmentationStats] :: DefragmentationStats -> DeviceSize
-- | Number of allocations that have been moved to different places.
[$sel:allocationsMoved:DefragmentationStats] :: DefragmentationStats -> Word32
-- | Number of empty VkDeviceMemory objects that have been
-- released to the system.
[$sel:deviceMemoryBlocksFreed:DefragmentationStats] :: DefragmentationStats -> Word32
-- | VmaVirtualBlockCreateInfo
--
-- Parameters of created VirtualBlock object to be passed to
-- createVirtualBlock.
data VirtualBlockCreateInfo
VirtualBlockCreateInfo :: DeviceSize -> VirtualBlockCreateFlags -> Maybe AllocationCallbacks -> VirtualBlockCreateInfo
-- | Total size of the virtual block.
--
-- Sizes can be expressed in bytes or any units you want as long as you
-- are consistent in using them. For example, if you allocate from some
-- array of structures, 1 can mean single instance of entire structure.
[$sel:size:VirtualBlockCreateInfo] :: VirtualBlockCreateInfo -> DeviceSize
-- | Use combination of VirtualBlockCreateFlagBits.
[$sel:flags:VirtualBlockCreateInfo] :: VirtualBlockCreateInfo -> VirtualBlockCreateFlags
-- | Custom CPU memory allocation callbacks. Optional.
--
-- Optional, can be null. When specified, they will be used for all
-- CPU-side memory allocations.
[$sel:allocationCallbacks:VirtualBlockCreateInfo] :: VirtualBlockCreateInfo -> Maybe AllocationCallbacks
-- | VmaVirtualAllocationCreateInfo
--
-- Parameters of created virtual allocation to be passed to
-- virtualAllocate.
data VirtualAllocationCreateInfo
VirtualAllocationCreateInfo :: DeviceSize -> DeviceSize -> VirtualAllocationCreateFlags -> Ptr () -> VirtualAllocationCreateInfo
-- | Size of the allocation.
--
-- Cannot be zero.
[$sel:size:VirtualAllocationCreateInfo] :: VirtualAllocationCreateInfo -> DeviceSize
-- | Required alignment of the allocation. Optional.
--
-- Must be power of two. Special value 0 has the same meaning as 1 -
-- means no special alignment is required, so allocation can start at any
-- offset.
[$sel:alignment:VirtualAllocationCreateInfo] :: VirtualAllocationCreateInfo -> DeviceSize
-- | Use combination of VirtualAllocationCreateFlagBits.
[$sel:flags:VirtualAllocationCreateInfo] :: VirtualAllocationCreateInfo -> VirtualAllocationCreateFlags
-- | Custom pointer to be associated with the allocation. Optional.
--
-- It can be any value and can be used for user-defined purposes. It can
-- be fetched or changed later.
[$sel:userData:VirtualAllocationCreateInfo] :: VirtualAllocationCreateInfo -> Ptr ()
-- | VmaVirtualAllocationInfo
--
-- Parameters of an existing virtual allocation, returned by
-- getVirtualAllocationInfo.
data VirtualAllocationInfo
VirtualAllocationInfo :: DeviceSize -> DeviceSize -> Ptr () -> VirtualAllocationInfo
-- | Offset of the allocation.
--
-- Offset at which the allocation was made.
[$sel:offset:VirtualAllocationInfo] :: VirtualAllocationInfo -> DeviceSize
-- | Size of the allocation.
--
-- Same value as passed in VmaVirtualAllocationCreateInfo::size.
[$sel:size:VirtualAllocationInfo] :: VirtualAllocationInfo -> DeviceSize
-- | Custom pointer associated with the allocation.
--
-- Same value as passed in
-- VmaVirtualAllocationCreateInfo::pUserData or to
-- setVirtualAllocationUserData.
[$sel:userData:VirtualAllocationInfo] :: VirtualAllocationInfo -> Ptr ()
instance Data.Bits.FiniteBits VulkanMemoryAllocator.AllocatorCreateFlagBits
instance Data.Bits.Bits VulkanMemoryAllocator.AllocatorCreateFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.AllocatorCreateFlagBits
instance Foreign.Storable.Storable VulkanMemoryAllocator.AllocatorCreateFlagBits
instance GHC.Classes.Ord VulkanMemoryAllocator.AllocatorCreateFlagBits
instance GHC.Classes.Eq VulkanMemoryAllocator.AllocatorCreateFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.MemoryUsage
instance Foreign.Storable.Storable VulkanMemoryAllocator.MemoryUsage
instance GHC.Classes.Ord VulkanMemoryAllocator.MemoryUsage
instance GHC.Classes.Eq VulkanMemoryAllocator.MemoryUsage
instance Data.Bits.FiniteBits VulkanMemoryAllocator.AllocationCreateFlagBits
instance Data.Bits.Bits VulkanMemoryAllocator.AllocationCreateFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.AllocationCreateFlagBits
instance Foreign.Storable.Storable VulkanMemoryAllocator.AllocationCreateFlagBits
instance GHC.Classes.Ord VulkanMemoryAllocator.AllocationCreateFlagBits
instance GHC.Classes.Eq VulkanMemoryAllocator.AllocationCreateFlagBits
instance Data.Bits.FiniteBits VulkanMemoryAllocator.PoolCreateFlagBits
instance Data.Bits.Bits VulkanMemoryAllocator.PoolCreateFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.PoolCreateFlagBits
instance Foreign.Storable.Storable VulkanMemoryAllocator.PoolCreateFlagBits
instance GHC.Classes.Ord VulkanMemoryAllocator.PoolCreateFlagBits
instance GHC.Classes.Eq VulkanMemoryAllocator.PoolCreateFlagBits
instance Data.Bits.FiniteBits VulkanMemoryAllocator.DefragmentationFlagBits
instance Data.Bits.Bits VulkanMemoryAllocator.DefragmentationFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationFlagBits
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationFlagBits
instance GHC.Classes.Ord VulkanMemoryAllocator.DefragmentationFlagBits
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationMoveOperation
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationMoveOperation
instance GHC.Classes.Ord VulkanMemoryAllocator.DefragmentationMoveOperation
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationMoveOperation
instance Data.Bits.FiniteBits VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance Data.Bits.Bits VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance Foreign.Storable.Storable VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance GHC.Classes.Ord VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance GHC.Classes.Eq VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance Data.Bits.FiniteBits VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance Data.Bits.Bits VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance Foreign.Storable.Storable VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance GHC.Classes.Ord VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance GHC.Classes.Eq VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance Vulkan.Core10.APIConstants.IsHandle VulkanMemoryAllocator.Allocator
instance Vulkan.Zero.Zero VulkanMemoryAllocator.Allocator
instance Foreign.Storable.Storable VulkanMemoryAllocator.Allocator
instance GHC.Classes.Ord VulkanMemoryAllocator.Allocator
instance GHC.Classes.Eq VulkanMemoryAllocator.Allocator
instance Vulkan.Core10.APIConstants.IsHandle VulkanMemoryAllocator.Pool
instance Vulkan.Zero.Zero VulkanMemoryAllocator.Pool
instance Foreign.Storable.Storable VulkanMemoryAllocator.Pool
instance GHC.Classes.Ord VulkanMemoryAllocator.Pool
instance GHC.Classes.Eq VulkanMemoryAllocator.Pool
instance Vulkan.Core10.APIConstants.IsHandle VulkanMemoryAllocator.Allocation
instance Vulkan.Zero.Zero VulkanMemoryAllocator.Allocation
instance Foreign.Storable.Storable VulkanMemoryAllocator.Allocation
instance GHC.Classes.Ord VulkanMemoryAllocator.Allocation
instance GHC.Classes.Eq VulkanMemoryAllocator.Allocation
instance Vulkan.Core10.APIConstants.IsHandle VulkanMemoryAllocator.DefragmentationContext
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationContext
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationContext
instance GHC.Classes.Ord VulkanMemoryAllocator.DefragmentationContext
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationContext
instance Vulkan.Core10.APIConstants.IsHandle VulkanMemoryAllocator.VirtualAllocation
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualAllocation
instance Foreign.Storable.Storable VulkanMemoryAllocator.VirtualAllocation
instance GHC.Classes.Ord VulkanMemoryAllocator.VirtualAllocation
instance GHC.Classes.Eq VulkanMemoryAllocator.VirtualAllocation
instance Vulkan.Core10.APIConstants.IsHandle VulkanMemoryAllocator.VirtualBlock
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualBlock
instance Foreign.Storable.Storable VulkanMemoryAllocator.VirtualBlock
instance GHC.Classes.Ord VulkanMemoryAllocator.VirtualBlock
instance GHC.Classes.Eq VulkanMemoryAllocator.VirtualBlock
instance GHC.Classes.Eq VulkanMemoryAllocator.VulkanFunctions
instance GHC.Classes.Eq VulkanMemoryAllocator.AllocatorInfo
instance GHC.Classes.Eq VulkanMemoryAllocator.Statistics
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationInfo
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationMove
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationPassMoveInfo
instance GHC.Classes.Eq VulkanMemoryAllocator.DefragmentationStats
instance GHC.Show.Show VulkanMemoryAllocator.DeviceMemoryCallbacks
instance GHC.Show.Show VulkanMemoryAllocator.VulkanFunctions
instance GHC.Show.Show VulkanMemoryAllocator.AllocatorCreateInfo
instance GHC.Show.Show VulkanMemoryAllocator.AllocatorInfo
instance GHC.Show.Show VulkanMemoryAllocator.Statistics
instance GHC.Show.Show VulkanMemoryAllocator.DetailedStatistics
instance GHC.Show.Show VulkanMemoryAllocator.TotalStatistics
instance GHC.Show.Show VulkanMemoryAllocator.Budget
instance GHC.Show.Show VulkanMemoryAllocator.AllocationCreateInfo
instance GHC.Show.Show VulkanMemoryAllocator.PoolCreateInfo
instance GHC.Show.Show VulkanMemoryAllocator.AllocationInfo
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationInfo
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationMove
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationPassMoveInfo
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationStats
instance GHC.Show.Show VulkanMemoryAllocator.VirtualBlockCreateInfo
instance GHC.Show.Show VulkanMemoryAllocator.VirtualAllocationCreateInfo
instance GHC.Show.Show VulkanMemoryAllocator.VirtualAllocationInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.VirtualAllocationInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.VirtualAllocationInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.VirtualAllocationInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualAllocationInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.VirtualAllocationCreateInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.VirtualAllocationCreateInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.VirtualAllocationCreateInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualAllocationCreateInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.VirtualBlockCreateInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.VirtualBlockCreateInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VirtualBlockCreateInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.DefragmentationStats
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.DefragmentationStats
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationStats
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationStats
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.DefragmentationPassMoveInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.DefragmentationPassMoveInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationPassMoveInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationPassMoveInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.DefragmentationMove
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.DefragmentationMove
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationMove
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationMove
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.DefragmentationInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.DefragmentationInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.DefragmentationInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DefragmentationInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.AllocationInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.AllocationInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.AllocationInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.PoolCreateInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.PoolCreateInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.PoolCreateInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.PoolCreateInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.AllocationCreateInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.AllocationCreateInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.AllocationCreateInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.AllocationCreateInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.Budget
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.Budget
instance Foreign.Storable.Storable VulkanMemoryAllocator.Budget
instance Vulkan.Zero.Zero VulkanMemoryAllocator.Budget
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.TotalStatistics
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.TotalStatistics
instance Foreign.Storable.Storable VulkanMemoryAllocator.TotalStatistics
instance Vulkan.Zero.Zero VulkanMemoryAllocator.TotalStatistics
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.DetailedStatistics
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.DetailedStatistics
instance Foreign.Storable.Storable VulkanMemoryAllocator.DetailedStatistics
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DetailedStatistics
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.Statistics
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.Statistics
instance Foreign.Storable.Storable VulkanMemoryAllocator.Statistics
instance Vulkan.Zero.Zero VulkanMemoryAllocator.Statistics
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.AllocatorInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.AllocatorInfo
instance Foreign.Storable.Storable VulkanMemoryAllocator.AllocatorInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.AllocatorInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.AllocatorCreateInfo
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.AllocatorCreateInfo
instance Vulkan.Zero.Zero VulkanMemoryAllocator.AllocatorCreateInfo
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.VulkanFunctions
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.VulkanFunctions
instance Foreign.Storable.Storable VulkanMemoryAllocator.VulkanFunctions
instance Vulkan.Zero.Zero VulkanMemoryAllocator.VulkanFunctions
instance Vulkan.CStruct.ToCStruct VulkanMemoryAllocator.DeviceMemoryCallbacks
instance Vulkan.CStruct.FromCStruct VulkanMemoryAllocator.DeviceMemoryCallbacks
instance Foreign.Storable.Storable VulkanMemoryAllocator.DeviceMemoryCallbacks
instance Vulkan.Zero.Zero VulkanMemoryAllocator.DeviceMemoryCallbacks
instance GHC.Show.Show VulkanMemoryAllocator.VirtualBlock
instance GHC.Show.Show VulkanMemoryAllocator.VirtualAllocation
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationContext
instance GHC.Show.Show VulkanMemoryAllocator.Allocation
instance GHC.Show.Show VulkanMemoryAllocator.Pool
instance GHC.Show.Show VulkanMemoryAllocator.Allocator
instance GHC.Show.Show VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance GHC.Read.Read VulkanMemoryAllocator.VirtualAllocationCreateFlagBits
instance GHC.Show.Show VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance GHC.Read.Read VulkanMemoryAllocator.VirtualBlockCreateFlagBits
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationMoveOperation
instance GHC.Read.Read VulkanMemoryAllocator.DefragmentationMoveOperation
instance GHC.Show.Show VulkanMemoryAllocator.DefragmentationFlagBits
instance GHC.Read.Read VulkanMemoryAllocator.DefragmentationFlagBits
instance GHC.Show.Show VulkanMemoryAllocator.PoolCreateFlagBits
instance GHC.Read.Read VulkanMemoryAllocator.PoolCreateFlagBits
instance GHC.Show.Show VulkanMemoryAllocator.AllocationCreateFlagBits
instance GHC.Read.Read VulkanMemoryAllocator.AllocationCreateFlagBits
instance GHC.Show.Show VulkanMemoryAllocator.MemoryUsage
instance GHC.Read.Read VulkanMemoryAllocator.MemoryUsage
instance GHC.Show.Show VulkanMemoryAllocator.AllocatorCreateFlagBits
instance GHC.Read.Read VulkanMemoryAllocator.AllocatorCreateFlagBits