| 1 |
# 2.3.0 (2019-12-04) |
| 2 |
|
| 3 |
Major release after a year of development in "master" branch and feature branches. Notable new features: supporting Vulkan 1.1, supporting query for memory budget. |
| 4 |
|
| 5 |
Major changes: |
| 6 |
|
| 7 |
- Added support for Vulkan 1.1. |
| 8 |
- Added member `VmaAllocatorCreateInfo::vulkanApiVersion`. |
| 9 |
- When Vulkan 1.1 is used, there is no need to enable VK_KHR_dedicated_allocation or VK_KHR_bind_memory2 extensions, as they are promoted to Vulkan itself. |
| 10 |
- Added support for query for memory budget and staying within the budget. |
| 11 |
- Added function `vmaGetBudget`, structure `VmaBudget`. This can also serve as simple statistics, more efficient than `vmaCalculateStats`. |
| 12 |
- By default the budget it is estimated based on memory heap sizes. It may be queried from the system using VK_EXT_memory_budget extension if you use `VMA_ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT` flag and `VmaAllocatorCreateInfo::instance` member. |
| 13 |
- Added flag `VMA_ALLOCATION_CREATE_WITHIN_BUDGET_BIT` that fails an allocation if it would exceed the budget. |
| 14 |
- Added new memory usage options: |
| 15 |
- `VMA_MEMORY_USAGE_CPU_COPY` for memory that is preferably not `DEVICE_LOCAL` but not guaranteed to be `HOST_VISIBLE`. |
| 16 |
- `VMA_MEMORY_USAGE_GPU_LAZILY_ALLOCATED` for memory that is `LAZILY_ALLOCATED`. |
| 17 |
- Added support for VK_KHR_bind_memory2 extension: |
| 18 |
- Added `VMA_ALLOCATION_CREATE_DONT_BIND_BIT` flag that lets you create both buffer/image and allocation, but don't bind them together. |
| 19 |
- Added flag `VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT`, functions `vmaBindBufferMemory2`, `vmaBindImageMemory2` that let you specify additional local offset and `pNext` pointer while binding. |
| 20 |
- Added functions `vmaSetPoolName`, `vmaGetPoolName` that let you assign string names to custom pools. JSON dump file format and VmaDumpVis tool is updated to show these names. |
| 21 |
- Defragmentation is legal only on buffers and images in `VK_IMAGE_TILING_LINEAR`. This is due to the way it is currently implemented in the library and the restrictions of the Vulkan specification. Clarified documentation in this regard. See discussion in #59. |
| 22 |
|
| 23 |
Minor changes: |
| 24 |
|
| 25 |
- Made `vmaResizeAllocation` function deprecated, always returning failure. |
| 26 |
- Made changes in the internal algorithm for the choice of memory type. Be careful! You may now get a type that is not `HOST_VISIBLE` or `HOST_COHERENT` if it's not stated as always ensured by some `VMA_MEMORY_USAGE_*` flag. |
| 27 |
- Extended VmaReplay application with more detailed statistics printed at the end. |
| 28 |
- Added macros `VMA_CALL_PRE`, `VMA_CALL_POST` that let you decorate declarations of all library functions if you want to e.g. export/import them as dynamically linked library. |
| 29 |
- Optimized `VmaAllocation` objects to be allocated out of an internal free-list allocator. This makes allocation and deallocation causing 0 dynamic CPU heap allocations on average. |
| 30 |
- Updated recording CSV file format version to 1.8, to support new functions. |
| 31 |
- Many additions and fixes in documentation. Many compatibility fixes for various compilers and platforms. Other internal bugfixes, optimizations, updates, refactoring... |
| 32 |
|
| 33 |
# 2.2.0 (2018-12-13) |
| 34 |
|
| 35 |
Major release after many months of development in "master" branch and feature branches. Notable new features: defragmentation of GPU memory, buddy algorithm, convenience functions for sparse binding. |
| 36 |
|
| 37 |
Major changes: |
| 38 |
|
| 39 |
- New, more powerful defragmentation: |
| 40 |
- Added structure `VmaDefragmentationInfo2`, functions `vmaDefragmentationBegin`, `vmaDefragmentationEnd`. |
| 41 |
- Added support for defragmentation of GPU memory. |
| 42 |
- Defragmentation of CPU memory now uses `memmove`, so it can move data to overlapping regions. |
| 43 |
- Defragmentation of CPU memory is now available for memory types that are `HOST_VISIBLE` but not `HOST_COHERENT`. |
| 44 |
- Added structure member `VmaVulkanFunctions::vkCmdCopyBuffer`. |
| 45 |
- Major internal changes in defragmentation algorithm. |
| 46 |
- VmaReplay: added parameters: `--DefragmentAfterLine`, `--DefragmentationFlags`. |
| 47 |
- Old interface (structure `VmaDefragmentationInfo`, function `vmaDefragment`) is now deprecated. |
| 48 |
- Added buddy algorithm, available for custom pools - flag `VMA_POOL_CREATE_BUDDY_ALGORITHM_BIT`. |
| 49 |
- Added convenience functions for multiple allocations and deallocations at once, intended for sparse binding resources - functions `vmaAllocateMemoryPages`, `vmaFreeMemoryPages`. |
| 50 |
- Added function that tries to resize existing allocation in place: `vmaResizeAllocation`. |
| 51 |
- Added flags for allocation strategy: `VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT`, `VMA_ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT`, `VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT`, and their aliases: `VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT`, `VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT`, `VMA_ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT`. |
| 52 |
|
| 53 |
Minor changes: |
| 54 |
|
| 55 |
- Changed behavior of allocation functions to return `VK_ERROR_VALIDATION_FAILED_EXT` when trying to allocate memory of size 0, create buffer with size 0, or image with one of the dimensions 0. |
| 56 |
- VmaReplay: Added support for Windows end of lines. |
| 57 |
- Updated recording CSV file format version to 1.5, to support new functions. |
| 58 |
- Internal optimization: using read-write mutex on some platforms. |
| 59 |
- Many additions and fixes in documentation. Many compatibility fixes for various compilers. Other internal bugfixes, optimizations, refactoring, added more internal validation... |
| 60 |
|
| 61 |
# 2.1.0 (2018-09-10) |
| 62 |
|
| 63 |
Minor bugfixes. |
| 64 |
|
| 65 |
# 2.1.0-beta.1 (2018-08-27) |
| 66 |
|
| 67 |
Major release after many months of development in "development" branch and features branches. Many new features added, some bugs fixed. API stays backward-compatible. |
| 68 |
|
| 69 |
Major changes: |
| 70 |
|
| 71 |
- Added linear allocation algorithm, accessible for custom pools, that can be used as free-at-once, stack, double stack, or ring buffer. See "Linear allocation algorithm" documentation chapter. |
| 72 |
- Added `VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT`, `VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT`. |
| 73 |
- Added feature to record sequence of calls to the library to a file and replay it using dedicated application. See documentation chapter "Record and replay". |
| 74 |
- Recording: added `VmaAllocatorCreateInfo::pRecordSettings`. |
| 75 |
- Replaying: added VmaReplay project. |
| 76 |
- Recording file format: added document "docs/Recording file format.md". |
| 77 |
- Improved support for non-coherent memory. |
| 78 |
- Added functions: `vmaFlushAllocation`, `vmaInvalidateAllocation`. |
| 79 |
- `nonCoherentAtomSize` is now respected automatically. |
| 80 |
- Added `VmaVulkanFunctions::vkFlushMappedMemoryRanges`, `vkInvalidateMappedMemoryRanges`. |
| 81 |
- Improved debug features related to detecting incorrect mapped memory usage. See documentation chapter "Debugging incorrect memory usage". |
| 82 |
- Added debug macro `VMA_DEBUG_DETECT_CORRUPTION`, functions `vmaCheckCorruption`, `vmaCheckPoolCorruption`. |
| 83 |
- Added debug macro `VMA_DEBUG_INITIALIZE_ALLOCATIONS` to initialize contents of allocations with a bit pattern. |
| 84 |
- Changed behavior of `VMA_DEBUG_MARGIN` macro - it now adds margin also before first and after last allocation in a block. |
| 85 |
- Changed format of JSON dump returned by `vmaBuildStatsString` (not backward compatible!). |
| 86 |
- Custom pools and memory blocks now have IDs that don't change after sorting. |
| 87 |
- Added properties: "CreationFrameIndex", "LastUseFrameIndex", "Usage". |
| 88 |
- Changed VmaDumpVis tool to use these new properties for better coloring. |
| 89 |
- Changed behavior of `vmaGetAllocationInfo` and `vmaTouchAllocation` to update `allocation.lastUseFrameIndex` even if allocation cannot become lost. |
| 90 |
|
| 91 |
Minor changes: |
| 92 |
|
| 93 |
- Changes in custom pools: |
| 94 |
- Added new structure member `VmaPoolStats::blockCount`. |
| 95 |
- Changed behavior of `VmaPoolCreateInfo::blockSize` = 0 (default) - it now means that pool may use variable block sizes, just like default pools do. |
| 96 |
- Improved logic of `vmaFindMemoryTypeIndex` for some cases, especially integrated GPUs. |
| 97 |
- VulkanSample application: Removed dependency on external library MathFu. Added own vector and matrix structures. |
| 98 |
- Changes that improve compatibility with various platforms, including: Visual Studio 2012, 32-bit code, C compilers. |
| 99 |
- Changed usage of "VK_KHR_dedicated_allocation" extension in the code to be optional, driven by macro `VMA_DEDICATED_ALLOCATION`, for compatibility with Android. |
| 100 |
- Many additions and fixes in documentation, including description of new features, as well as "Validation layer warnings". |
| 101 |
- Other bugfixes. |
| 102 |
|
| 103 |
# 2.0.0 (2018-03-19) |
| 104 |
|
| 105 |
A major release with many compatibility-breaking changes. |
| 106 |
|
| 107 |
Notable new features: |
| 108 |
|
| 109 |
- Introduction of `VmaAllocation` handle that you must retrieve from allocation functions and pass to deallocation functions next to normal `VkBuffer` and `VkImage`. |
| 110 |
- Introduction of `VmaAllocationInfo` structure that you can retrieve from `VmaAllocation` handle to access parameters of the allocation (like `VkDeviceMemory` and offset) instead of retrieving them directly from allocation functions. |
| 111 |
- Support for reference-counted mapping and persistently mapped allocations - see `vmaMapMemory`, `VMA_ALLOCATION_CREATE_MAPPED_BIT`. |
| 112 |
- Support for custom memory pools - see `VmaPool` handle, `VmaPoolCreateInfo` structure, `vmaCreatePool` function. |
| 113 |
- Support for defragmentation (compaction) of allocations - see function `vmaDefragment` and related structures. |
| 114 |
- Support for "lost allocations" - see appropriate chapter on documentation Main Page. |
| 115 |
|
| 116 |
# 1.0.1 (2017-07-04) |
| 117 |
|
| 118 |
- Fixes for Linux GCC compilation. |
| 119 |
- Changed "CONFIGURATION SECTION" to contain #ifndef so you can define these macros before including this header, not necessarily change them in the file. |
| 120 |
|
| 121 |
# 1.0.0 (2017-06-16) |
| 122 |
|
| 123 |
First public release. |