[−][src]Module vk_mem::ffi
Structs
| VkAllocationCallbacks | |
| VkBindBufferMemoryInfo | |
| VkBindImageMemoryInfo | |
| VkBufferCopy | |
| VkBufferCreateInfo | |
| VkBufferMemoryRequirementsInfo2 | |
| VkBuffer_T | |
| VkCommandBuffer_T | |
| VkDeviceMemory_T | |
| VkDevice_T | |
| VkExtent3D | |
| VkImageCreateInfo | |
| VkImageMemoryRequirementsInfo2 | |
| VkImage_T | |
| VkInstance_T | |
| VkMappedMemoryRange | |
| VkMemoryAllocateInfo | |
| VkMemoryHeap | |
| VkMemoryRequirements | |
| VkMemoryRequirements2 | |
| VkMemoryType | |
| VkPhysicalDeviceLimits | |
| VkPhysicalDeviceMemoryProperties | |
| VkPhysicalDeviceMemoryProperties2 | |
| VkPhysicalDeviceProperties | |
| VkPhysicalDeviceSparseProperties | |
| VkPhysicalDevice_T | |
| VmaAllocationCreateInfo | |
| VmaAllocationInfo | \brief Parameters of #VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo(). |
| VmaAllocation_T | |
| VmaAllocatorCreateInfo | Description of a Allocator to be created. |
| VmaAllocatorInfo | \brief Information about existing #VmaAllocator object. |
| VmaAllocator_T | |
| VmaBudget | \brief Statistics of current memory usage and available budget, in bytes, for specific memory heap. |
| VmaDefragmentationContext_T | |
| VmaDefragmentationInfo | \brief Deprecated. Optional configuration parameters to be passed to function vmaDefragment(). |
| VmaDefragmentationInfo2 | \brief Parameters for defragmentation. |
| VmaDefragmentationPassInfo | \brief Parameters for incremental defragmentation steps. |
| VmaDefragmentationPassMoveInfo | |
| VmaDefragmentationStats | \brief Statistics returned by function vmaDefragment(). |
| VmaDeviceMemoryCallbacks | \brief Set of callbacks that the library will call for |
| VmaPoolCreateInfo | \brief Describes parameter of created #VmaPool. |
| VmaPoolStats | \brief Describes parameter of existing #VmaPool. |
| VmaPool_T | |
| VmaRecordSettings | Parameters for recording calls to VMA functions. To be used in VmaAllocatorCreateInfo::pRecordSettings. |
| VmaStatInfo | \brief Calculated statistics of memory usage in entire allocator. |
| VmaStats | General statistics from current state of Allocator. |
| VmaVulkanFunctions | \brief Pointers to some Vulkan functions - a subset used by the library. |
Constants
Functions
| vmaAllocateMemory⚠ | \brief General purpose memory allocation. |
| vmaAllocateMemoryForBuffer⚠ | @param[out] pAllocation Handle to allocated memory. @param[out] pAllocationInfo Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo(). |
| vmaAllocateMemoryForImage⚠ | Function similar to vmaAllocateMemoryForBuffer(). |
| vmaAllocateMemoryPages⚠ | \brief General purpose memory allocation for multiple allocation objects at once. |
| vmaBeginDefragmentationPass⚠ | |
| vmaBindBufferMemory⚠ | \brief Binds buffer to allocation. |
| vmaBindBufferMemory2⚠ | \brief Binds buffer to allocation with additional parameters. |
| vmaBindImageMemory⚠ | \brief Binds image to allocation. |
| vmaBindImageMemory2⚠ | \brief Binds image to allocation with additional parameters. |
| vmaBuildStatsString⚠ | Builds and returns statistics as string in JSON format. ** @param[out] ppStatsString Must be freed using vmaFreeStatsString() function. */ |
| vmaCalculateStats⚠ | \brief Retrieves statistics from current state of the Allocator. |
| vmaCheckCorruption⚠ | \brief Checks magic number in margins around all allocations in given memory types (in both default and custom pools) in search for corruptions. |
| vmaCheckPoolCorruption⚠ | \brief Checks magic number in margins around all allocations in given memory pool in search for corruptions. |
| vmaCreateAllocator⚠ | Creates Allocator object. |
| vmaCreateBuffer⚠ | @param[out] pBuffer Buffer that was created. @param[out] pAllocation Allocation that was created. @param[out] pAllocationInfo Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo(). |
| vmaCreateImage⚠ | Function similar to vmaCreateBuffer(). |
| vmaCreateLostAllocation⚠ | \brief Creates new allocation that is in lost state from the beginning. |
| vmaCreatePool⚠ | \brief Allocates Vulkan device memory and creates #VmaPool object. |
| vmaDefragment⚠ | \brief Deprecated. Compacts memory by moving allocations. |
| vmaDefragmentationBegin⚠ | \brief Begins defragmentation process. |
| vmaDefragmentationEnd⚠ | \brief Ends defragmentation process. |
| vmaDestroyAllocator⚠ | Destroys allocator object. |
| vmaDestroyBuffer⚠ | \brief Destroys Vulkan buffer and frees allocated memory. |
| vmaDestroyImage⚠ | \brief Destroys Vulkan image and frees allocated memory. |
| vmaDestroyPool⚠ | \brief Destroys #VmaPool object and frees Vulkan device memory. |
| vmaEndDefragmentationPass⚠ | |
| vmaFindMemoryTypeIndex⚠ | \brief Helps to find memoryTypeIndex, given memoryTypeBits and VmaAllocationCreateInfo. |
| vmaFindMemoryTypeIndexForBufferInfo⚠ | \brief Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo. |
| vmaFindMemoryTypeIndexForImageInfo⚠ | \brief Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo. |
| vmaFlushAllocation⚠ | \brief Flushes memory of given allocation. |
| vmaFreeMemory⚠ | \brief Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(), or vmaAllocateMemoryForImage(). |
| vmaFreeMemoryPages⚠ | \brief Frees memory and destroys multiple allocations. |
| vmaFreeStatsString⚠ | |
| vmaGetAllocationInfo⚠ | \brief Returns current information about specified allocation and atomically marks it as used in current frame. |
| vmaGetAllocatorInfo⚠ | \brief Returns information about existing #VmaAllocator object - handle to Vulkan device etc. |
| vmaGetBudget⚠ | \brief Retrieves information about current memory budget for all memory heaps. |
| vmaGetMemoryProperties⚠ | PhysicalDeviceMemoryProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own. |
| vmaGetMemoryTypeProperties⚠ | \brief Given Memory Type Index, returns Property Flags of this memory type. |
| vmaGetPhysicalDeviceProperties⚠ | PhysicalDeviceProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own. |
| vmaGetPoolName⚠ | \brief Retrieves name of a custom pool. |
| vmaGetPoolStats⚠ | \brief Retrieves statistics of existing #VmaPool object. |
| vmaInvalidateAllocation⚠ | \brief Invalidates memory of given allocation. |
| vmaMakePoolAllocationsLost⚠ | \brief Marks all allocations in given pool as lost if they are not used in current frame or VmaPoolCreateInfo::frameInUseCount back from now. |
| vmaMapMemory⚠ | \brief Maps memory represented by given allocation and returns pointer to it. |
| vmaResizeAllocation⚠ | \brief Deprecated. |
| vmaSetAllocationUserData⚠ | \brief Sets pUserData in given allocation to new value. |
| vmaSetCurrentFrameIndex⚠ | \brief Sets index of the current frame. |
| vmaSetPoolName⚠ | \brief Sets name of a custom pool. |
| vmaTouchAllocation⚠ | \brief Returns |
| vmaUnmapMemory⚠ | \brief Unmaps memory represented by given allocation, mapped previously using vmaMapMemory(). |