<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Set of callbacks that the library will call for <code>vkAllocateMemory</code> and <code>vkFreeMemory</code>. <ahref="struct_vma_device_memory_callbacks.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Pointers to some Vulkan functions - a subset used by the library. <ahref="struct_vma_vulkan_functions.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters for recording calls to VMA functions. To be used in <aclass="el"href="struct_vma_allocator_create_info.html#ace2aa4877b16a42b0b7673d4e26000ee"title="Parameters for recording of VMA calls. Can be null.">VmaAllocatorCreateInfo::pRecordSettings</a>. <ahref="struct_vma_record_settings.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Description of a Allocator to be created. <ahref="struct_vma_allocator_create_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Information about existing <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object. <ahref="struct_vma_allocator_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calculated statistics of memory usage in entire allocator. <ahref="struct_vma_stat_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">General statistics from current state of Allocator. <ahref="struct_vma_stats.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics of current memory usage and available budget, in bytes, for specific memory heap. <ahref="struct_vma_budget.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Describes parameter of created <aclass="el"href="struct_vma_pool.html"title="Represents custom memory pool.">VmaPool</a>. <ahref="struct_vma_pool_create_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of <aclass="el"href="struct_vma_allocation.html"title="Represents single memory allocation.">VmaAllocation</a> objects, that can be retrieved using function <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>. <ahref="struct_vma_allocation_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters for defragmentation. <ahref="struct_vma_defragmentation_info2.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Deprecated. Optional configuration parameters to be passed to function <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. <ahref="struct_vma_defragmentation_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics returned by function <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. <ahref="struct_vma_defragmentation_stats.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of created <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> object to be passed to <aclass="el"href="vk__mem__alloc_8h.html#ab585754076877265fdae33e5c40ef13b"title="Creates new VmaVirtualBlock object.">vmaCreateVirtualBlock()</a>. <ahref="struct_vma_virtual_block_create_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of created virtual allocation to be passed to <aclass="el"href="vk__mem__alloc_8h.html#a1c15925e6745dacee0cfc877fffecec2"title="Allocates new virtual allocation inside given VmaVirtualBlock.">vmaVirtualAllocate()</a>. <ahref="struct_vma_virtual_allocation_create_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of an existing virtual allocation, returned by <aclass="el"href="vk__mem__alloc_8h.html#ab5fcb961ffea69023e7e0ea100bdad8e"title="Returns information about a specific virtual allocation within a virtual block, like its size and pUs...">vmaGetVirtualAllocationInfo()</a>. <ahref="struct_vma_virtual_allocation_info.html#details">More...</a><br/></td></tr>
<trclass="memdesc:a7e1ed85f7799600b03ad51a77acc21f3"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Callback function called after successful vkAllocateMemory. <ahref="vk__mem__alloc_8h.html#a7e1ed85f7799600b03ad51a77acc21f3">More...</a><br/></td></tr>
<trclass="memdesc:a154ccaaf53dc2c36378f80f0c4f3679b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Callback function called before vkFreeMemory. <ahref="vk__mem__alloc_8h.html#a154ccaaf53dc2c36378f80f0c4f3679b">More...</a><br/></td></tr>
<trclass="memdesc:a77692d3c8770ea8882d573206bd27b2b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Set of callbacks that the library will call for <code>vkAllocateMemory</code> and <code>vkFreeMemory</code>. <ahref="vk__mem__alloc_8h.html#a77692d3c8770ea8882d573206bd27b2b">More...</a><br/></td></tr>
<trclass="memdesc:afd73b95e737ee7e76f827cb5472f559f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags for created <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a>. <ahref="vk__mem__alloc_8h.html#afd73b95e737ee7e76f827cb5472f559f">More...</a><br/></td></tr>
<trclass="memdesc:abb0a8e3b5040d847571cca6c7f9a8074"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Pointers to some Vulkan functions - a subset used by the library. <ahref="vk__mem__alloc_8h.html#abb0a8e3b5040d847571cca6c7f9a8074">More...</a><br/></td></tr>
<trclass="memdesc:acd24d5eb58abff7e1f43cb32a1ba1413"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be used in <aclass="el"href="struct_vma_record_settings.html#ad8fdcc92119ae7a8c08c1a564c01d63a"title="Flags for recording. Use VmaRecordFlagBits enum.">VmaRecordSettings::flags</a>. <ahref="vk__mem__alloc_8h.html#acd24d5eb58abff7e1f43cb32a1ba1413">More...</a><br/></td></tr>
<trclass="memdesc:a16e21c877101493fce582664cd8754fc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters for recording calls to VMA functions. To be used in <aclass="el"href="struct_vma_allocator_create_info.html#ace2aa4877b16a42b0b7673d4e26000ee"title="Parameters for recording of VMA calls. Can be null.">VmaAllocatorCreateInfo::pRecordSettings</a>. <ahref="vk__mem__alloc_8h.html#a16e21c877101493fce582664cd8754fc">More...</a><br/></td></tr>
<trclass="memdesc:aad9652301d33759b83e52d4f3605a14a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Description of a Allocator to be created. <ahref="vk__mem__alloc_8h.html#aad9652301d33759b83e52d4f3605a14a">More...</a><br/></td></tr>
<trclass="memdesc:a1988031b0223fdbd564250fa1edd942c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Information about existing <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object. <ahref="vk__mem__alloc_8h.html#a1988031b0223fdbd564250fa1edd942c">More...</a><br/></td></tr>
<trclass="memdesc:aec5b57e29c97b5d69c6d5654d60df878"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calculated statistics of memory usage in entire allocator. <ahref="vk__mem__alloc_8h.html#aec5b57e29c97b5d69c6d5654d60df878">More...</a><br/></td></tr>
<trclass="memdesc:a21813b2efdf3836767a9058cd8a94034"><tdclass="mdescLeft"> </td><tdclass="mdescRight">General statistics from current state of Allocator. <ahref="vk__mem__alloc_8h.html#a21813b2efdf3836767a9058cd8a94034">More...</a><br/></td></tr>
<trclass="memdesc:aa078667e71b1ef24e87a6a30d128381d"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics of current memory usage and available budget, in bytes, for specific memory heap. <ahref="vk__mem__alloc_8h.html#aa078667e71b1ef24e87a6a30d128381d">More...</a><br/></td></tr>
<trclass="memdesc:a4fceecc301f4064dc808d3cd6c038941"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a4fceecc301f4064dc808d3cd6c038941">More...</a><br/></td></tr>
<trclass="memdesc:a4d4f2efc2509157a9e4ecd4fd7942303"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446"title="Use combination of VmaPoolCreateFlagBits.">VmaPoolCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a4d4f2efc2509157a9e4ecd4fd7942303">More...</a><br/></td></tr>
<trclass="memdesc:a2770e325ea42e087c1b91fdf46d0292a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446"title="Use combination of VmaPoolCreateFlagBits.">VmaPoolCreateInfo::flags</a>. See <aclass="el"href="vk__mem__alloc_8h.html#a9a7c45f9c863695d98c83fa5ac940fe7"title="Flags to be passed as VmaPoolCreateInfo::flags.">VmaPoolCreateFlagBits</a>. <ahref="vk__mem__alloc_8h.html#a2770e325ea42e087c1b91fdf46d0292a">More...</a><br/></td></tr>
<trclass="memdesc:a1017aa83489c0eee8d2163d2bf253f67"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Describes parameter of created <aclass="el"href="struct_vma_pool.html"title="Represents custom memory pool.">VmaPool</a>. <ahref="vk__mem__alloc_8h.html#a1017aa83489c0eee8d2163d2bf253f67">More...</a><br/></td></tr>
<trclass="memdesc:a1cf7774606721026a68aabe3af2e5b50"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of <aclass="el"href="struct_vma_allocation.html"title="Represents single memory allocation.">VmaAllocation</a> objects, that can be retrieved using function <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>. <ahref="vk__mem__alloc_8h.html#a1cf7774606721026a68aabe3af2e5b50">More...</a><br/></td></tr>
<trclass="memdesc:a13415cc0b443353a7b5abda300b833fc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be used in <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. None at the moment. Reserved for future use. <ahref="vk__mem__alloc_8h.html#a13415cc0b443353a7b5abda300b833fc">More...</a><br/></td></tr>
<trclass="memdesc:ad6daeffaa670ce6d11a203a6224c9937"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters for defragmentation. <ahref="vk__mem__alloc_8h.html#ad6daeffaa670ce6d11a203a6224c9937">More...</a><br/></td></tr>
<trclass="memdesc:a2bf47f96bf92bed2a49461bd9af3acfa"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Deprecated. Optional configuration parameters to be passed to function <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. <ahref="vk__mem__alloc_8h.html#a2bf47f96bf92bed2a49461bd9af3acfa">More...</a><br/></td></tr>
<trclass="memdesc:ad94034192259c2e34a4d1c5e27810403"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics returned by function <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. <ahref="vk__mem__alloc_8h.html#ad94034192259c2e34a4d1c5e27810403">More...</a><br/></td></tr>
<trclass="memdesc:a0860ba1c0a67178fae4aecb63a78573e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#a5838b15c053a0370420e4e1d82d09c09"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a0860ba1c0a67178fae4aecb63a78573e">More...</a><br/></td></tr>
<trclass="memdesc:a4e49c2f0ab7f6b4868833e5bac78d91e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#a5838b15c053a0370420e4e1d82d09c09"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. See <aclass="el"href="vk__mem__alloc_8h.html#a88bcf8c1cd3bb1610ff7343811c65bca"title="Flags to be passed as VmaVirtualBlockCreateInfo::flags.">VmaVirtualBlockCreateFlagBits</a>. <ahref="vk__mem__alloc_8h.html#a4e49c2f0ab7f6b4868833e5bac78d91e">More...</a><br/></td></tr>
<trclass="memdesc:a936815e64946a6b6d812d08d10184c23"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_allocation_create_info.html#ab10e16956cc4bf20ced9de77d1129ea4"title="Use combination of VmaVirtualAllocationCreateFlagBits.">VmaVirtualAllocationCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a936815e64946a6b6d812d08d10184c23">More...</a><br/></td></tr>
<trclass="memdesc:ae96ffc099bf898257fb19e9410ed08a7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_allocation_create_info.html#ab10e16956cc4bf20ced9de77d1129ea4"title="Use combination of VmaVirtualAllocationCreateFlagBits.">VmaVirtualAllocationCreateInfo::flags</a>. See <aclass="el"href="vk__mem__alloc_8h.html#a2e9c64d405b14156fea7e10c4ad06cb6"title="Flags to be passed as VmaVirtualAllocationCreateInfo::flags.">VmaVirtualAllocationCreateFlagBits</a>. <ahref="vk__mem__alloc_8h.html#ae96ffc099bf898257fb19e9410ed08a7">More...</a><br/></td></tr>
<trclass="memdesc:a4f87c9100d154a65a4ad495f7763cf7c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags for created <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a>. <ahref="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7c">More...</a><br/></td></tr>
<trclass="memdesc:a4dd2c44642312a147a4e93373a6e64d2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be used in <aclass="el"href="struct_vma_record_settings.html#ad8fdcc92119ae7a8c08c1a564c01d63a"title="Flags for recording. Use VmaRecordFlagBits enum.">VmaRecordSettings::flags</a>. <ahref="vk__mem__alloc_8h.html#a4dd2c44642312a147a4e93373a6e64d2">More...</a><br/></td></tr>
<trclass="memdesc:ad9889c10c798b040d59c92f257cae597"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597">More...</a><br/></td></tr>
<trclass="memdesc:a9a7c45f9c863695d98c83fa5ac940fe7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446"title="Use combination of VmaPoolCreateFlagBits.">VmaPoolCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a9a7c45f9c863695d98c83fa5ac940fe7">More...</a><br/></td></tr>
<trclass="memdesc:a6552a65b71d16f378c6994b3ceaef50c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be used in <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. None at the moment. Reserved for future use. <ahref="vk__mem__alloc_8h.html#a6552a65b71d16f378c6994b3ceaef50c">More...</a><br/></td></tr>
<trclass="memdesc:a88bcf8c1cd3bb1610ff7343811c65bca"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#a5838b15c053a0370420e4e1d82d09c09"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a88bcf8c1cd3bb1610ff7343811c65bca">More...</a><br/></td></tr>
<trclass="memdesc:a2e9c64d405b14156fea7e10c4ad06cb6"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_allocation_create_info.html#ab10e16956cc4bf20ced9de77d1129ea4"title="Use combination of VmaVirtualAllocationCreateFlagBits.">VmaVirtualAllocationCreateInfo::flags</a>. <ahref="vk__mem__alloc_8h.html#a2e9c64d405b14156fea7e10c4ad06cb6">More...</a><br/></td></tr>
<trclass="memdesc:afa02231a791b37255720d566a52683e7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns information about existing <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object - handle to Vulkan device etc. <ahref="vk__mem__alloc_8h.html#afa02231a791b37255720d566a52683e7">More...</a><br/></td></tr>
<trclass="memdesc:a8701444752eb5de4464adb5a2b514bca"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Given Memory Type Index, returns Property Flags of this memory type. <ahref="vk__mem__alloc_8h.html#a8701444752eb5de4464adb5a2b514bca">More...</a><br/></td></tr>
<trclass="memdesc:ade56bf8dc9f5a5eaddf5f119ed525236"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets index of the current frame. <ahref="vk__mem__alloc_8h.html#ade56bf8dc9f5a5eaddf5f119ed525236">More...</a><br/></td></tr>
<trclass="memdesc:a333b61c1788cb23559177531e6a93ca3"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves statistics from current state of the Allocator. <ahref="vk__mem__alloc_8h.html#a333b61c1788cb23559177531e6a93ca3">More...</a><br/></td></tr>
<trclass="memdesc:aec0ed24ebea2d0099eed5f801daaefba"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves information about current memory budget for all memory heaps. <ahref="vk__mem__alloc_8h.html#aec0ed24ebea2d0099eed5f801daaefba">More...</a><br/></td></tr>
<trclass="memdesc:aa4fee7eb5253377599ef4fd38c93c2a0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Builds and returns statistics as a null-terminated string in JSON format. <ahref="vk__mem__alloc_8h.html#aa4fee7eb5253377599ef4fd38c93c2a0">More...</a><br/></td></tr>
<trclass="memdesc:aef15a94b58fbcb0fe706d5720e84a74a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helps to find memoryTypeIndex, given memoryTypeBits and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. <ahref="vk__mem__alloc_8h.html#aef15a94b58fbcb0fe706d5720e84a74a">More...</a><br/></td></tr>
<trclass="memdesc:ae790ab9ffaf7667fb8f62523e6897888"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helps to find memoryTypeIndex, given VkBufferCreateInfo and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. <ahref="vk__mem__alloc_8h.html#ae790ab9ffaf7667fb8f62523e6897888">More...</a><br/></td></tr>
<trclass="memdesc:a088da83d8eaf3ce9056d9ea0b981d472"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helps to find memoryTypeIndex, given VkImageCreateInfo and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. <ahref="vk__mem__alloc_8h.html#a088da83d8eaf3ce9056d9ea0b981d472">More...</a><br/></td></tr>
<trclass="memitem:a736bd6cbda886f36c891727e73bd4024"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="vk__mem__alloc_8h.html#a736bd6cbda886f36c891727e73bd4024">vmaMakePoolAllocationsLost</a> (<aclass="el"href="struct_vma_allocator.html">VmaAllocator</a> allocator, <aclass="el"href="struct_vma_pool.html">VmaPool</a> pool, size_t *pLostAllocationCount)</td></tr>
<trclass="memdesc:a736bd6cbda886f36c891727e73bd4024"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Marks all allocations in given pool as lost if they are not used in current frame or <aclass="el"href="struct_vma_pool_create_info.html#a9437e43ffbb644dbbf7fc4e50cfad6aa"title="Maximum number of additional frames that are in use at the same time as current frame.">VmaPoolCreateInfo::frameInUseCount</a> back from now. <ahref="vk__mem__alloc_8h.html#a736bd6cbda886f36c891727e73bd4024">More...</a><br/></td></tr>
<trclass="memdesc:ad535935619c7a549bf837e1bb0068f89"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Checks magic number in margins around all allocations in given memory pool in search for corruptions. <ahref="vk__mem__alloc_8h.html#ad535935619c7a549bf837e1bb0068f89">More...</a><br/></td></tr>
<trclass="memitem:af09b4e4eafdbee812e8d73ddf960f030"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="vk__mem__alloc_8h.html#af09b4e4eafdbee812e8d73ddf960f030">vmaGetPoolName</a> (<aclass="el"href="struct_vma_allocator.html">VmaAllocator</a> allocator, <aclass="el"href="struct_vma_pool.html">VmaPool</a> pool, const char **ppName)</td></tr>
<trclass="memdesc:af09b4e4eafdbee812e8d73ddf960f030"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves name of a custom pool. <ahref="vk__mem__alloc_8h.html#af09b4e4eafdbee812e8d73ddf960f030">More...</a><br/></td></tr>
<trclass="memitem:adbae3a0b4ab078024462fc85c37f3b58"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="vk__mem__alloc_8h.html#adbae3a0b4ab078024462fc85c37f3b58">vmaSetPoolName</a> (<aclass="el"href="struct_vma_allocator.html">VmaAllocator</a> allocator, <aclass="el"href="struct_vma_pool.html">VmaPool</a> pool, const char *pName)</td></tr>
<trclass="memdesc:adbae3a0b4ab078024462fc85c37f3b58"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets name of a custom pool. <ahref="vk__mem__alloc_8h.html#adbae3a0b4ab078024462fc85c37f3b58">More...</a><br/></td></tr>
<trclass="memdesc:a0faa3f9e5fb233d29d1e00390650febb"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Function similar to <aclass="el"href="vk__mem__alloc_8h.html#a7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>. <ahref="vk__mem__alloc_8h.html#a0faa3f9e5fb233d29d1e00390650febb">More...</a><br/></td></tr>
<trclass="memdesc:a5fea5518972ae9094b1526cbcb19b05f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Frees memory previously allocated using <aclass="el"href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, or <aclass="el"href="vk__mem__alloc_8h.html#a0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a>. <ahref="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f">More...</a><br/></td></tr>
<trclass="memdesc:a86dd08aba8633bfa4ad0df2e76481d8b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns current information about specified allocation and atomically marks it as used in current frame. <ahref="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b">More...</a><br/></td></tr>
<trclass="memdesc:a43d8ba9673c846f049089a5029d5c73a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns <code>VK_TRUE</code> if allocation is not lost and atomically marks it as used in current frame. <ahref="vk__mem__alloc_8h.html#a43d8ba9673c846f049089a5029d5c73a">More...</a><br/></td></tr>
<trclass="memdesc:af9147d31ffc11d62fc187bde283ed14f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets pUserData in given allocation to new value. <ahref="vk__mem__alloc_8h.html#af9147d31ffc11d62fc187bde283ed14f">More...</a><br/></td></tr>
<trclass="memdesc:ae5c9657d9e94756269145b01c05d16f1"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Creates new allocation that is in lost state from the beginning. <ahref="vk__mem__alloc_8h.html#ae5c9657d9e94756269145b01c05d16f1">More...</a><br/></td></tr>
<trclass="memdesc:ad5bd1243512d099706de88168992f069"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Maps memory represented by given allocation and returns pointer to it. <ahref="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069">More...</a><br/></td></tr>
<trclass="memdesc:a9bc268595cb33f6ec4d519cfce81ff45"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Unmaps memory represented by given allocation, mapped previously using <aclass="el"href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>. <ahref="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45">More...</a><br/></td></tr>
<trclass="memdesc:a30c37c1eec6025f397be41644f48490f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flushes memory of given allocation. <ahref="vk__mem__alloc_8h.html#a30c37c1eec6025f397be41644f48490f">More...</a><br/></td></tr>
<trclass="memdesc:aaa8412919139ef413a4215ac6a290fae"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Invalidates memory of given allocation. <ahref="vk__mem__alloc_8h.html#aaa8412919139ef413a4215ac6a290fae">More...</a><br/></td></tr>
<trclass="memdesc:ac3dd00da721875ed99fa8a881922bdfc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flushes memory of given set of allocations. <ahref="vk__mem__alloc_8h.html#ac3dd00da721875ed99fa8a881922bdfc">More...</a><br/></td></tr>
<trclass="memdesc:ab25b558d75f7378ec944a1522fdcc3c5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Invalidates memory of given set of allocations. <ahref="vk__mem__alloc_8h.html#ab25b558d75f7378ec944a1522fdcc3c5">More...</a><br/></td></tr>
<trclass="memdesc:a49329a7f030dafcf82f7b73334c22e98"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Checks magic number in margins around all allocations in given memory types (in both default and custom pools) in search for corruptions. <ahref="vk__mem__alloc_8h.html#a49329a7f030dafcf82f7b73334c22e98">More...</a><br/></td></tr>
<trclass="memdesc:a6b0929b914b60cf2d45cac4bf3547470"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds buffer to allocation. <ahref="vk__mem__alloc_8h.html#a6b0929b914b60cf2d45cac4bf3547470">More...</a><br/></td></tr>
<trclass="memdesc:a927c944f45e0f2941182abb6f608e64a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds buffer to allocation with additional parameters. <ahref="vk__mem__alloc_8h.html#a927c944f45e0f2941182abb6f608e64a">More...</a><br/></td></tr>
<trclass="memdesc:a3d3ca45799923aa5d138e9e5f9eb2da5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds image to allocation. <ahref="vk__mem__alloc_8h.html#a3d3ca45799923aa5d138e9e5f9eb2da5">More...</a><br/></td></tr>
<trclass="memdesc:aa8251ee81b0045a443e35b8e8aa021bc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds image to allocation with additional parameters. <ahref="vk__mem__alloc_8h.html#aa8251ee81b0045a443e35b8e8aa021bc">More...</a><br/></td></tr>
<trclass="memdesc:aa06a690013a0d01e60894ac378083834"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Creates a buffer with additional minimum alignment. <ahref="vk__mem__alloc_8h.html#aa06a690013a0d01e60894ac378083834">More...</a><br/></td></tr>
<trclass="memdesc:a02a94f25679275851a53e82eacbcfc73"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Function similar to <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>. <ahref="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73">More...</a><br/></td></tr>
<trclass="memdesc:ab585754076877265fdae33e5c40ef13b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Creates new <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> object. <ahref="vk__mem__alloc_8h.html#ab585754076877265fdae33e5c40ef13b">More...</a><br/></td></tr>
<trclass="memdesc:a3795f7783ae2c182cede067d656f66a5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> object. <ahref="vk__mem__alloc_8h.html#a3795f7783ae2c182cede067d656f66a5">More...</a><br/></td></tr>
<trclass="memdesc:acd53b5b1d23f8fcbad692ccfdc1811f1"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns true of the <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> is empty - contains 0 virtual allocations and has all its space available for new allocations. <ahref="vk__mem__alloc_8h.html#acd53b5b1d23f8fcbad692ccfdc1811f1">More...</a><br/></td></tr>
<trclass="memdesc:ab5fcb961ffea69023e7e0ea100bdad8e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns information about a specific virtual allocation within a virtual block, like its size and <code>pUserData</code> pointer. <ahref="vk__mem__alloc_8h.html#ab5fcb961ffea69023e7e0ea100bdad8e">More...</a><br/></td></tr>
<trclass="memdesc:a1c15925e6745dacee0cfc877fffecec2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Allocates new virtual allocation inside given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. <ahref="vk__mem__alloc_8h.html#a1c15925e6745dacee0cfc877fffecec2">More...</a><br/></td></tr>
<trclass="memdesc:a13f01c44b3c1a06e695f1f5d24b80639"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Frees virtual allocation inside given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. <ahref="vk__mem__alloc_8h.html#a13f01c44b3c1a06e695f1f5d24b80639">More...</a><br/></td></tr>
<trclass="memdesc:a5eda6f55919fb05bd2f56a112590c571"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Frees all virtual allocations inside given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. <ahref="vk__mem__alloc_8h.html#a5eda6f55919fb05bd2f56a112590c571">More...</a><br/></td></tr>
<trclass="memdesc:a4b96f835d38686df937e097a0c7db5e9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Changes custom pointer associated with given virtual allocation. <ahref="vk__mem__alloc_8h.html#a4b96f835d38686df937e097a0c7db5e9">More...</a><br/></td></tr>
<trclass="memdesc:a95169b4730e94757897470086ec2768a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calculates and returns statistics about virtual allocations and memory usage in given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. <ahref="vk__mem__alloc_8h.html#a95169b4730e94757897470086ec2768a">More...</a><br/></td></tr>
<trclass="memdesc:a52d810e1222c592e5d80556ad005f1e6"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Builds and returns a null-terminated string in JSON format with information about given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. <ahref="vk__mem__alloc_8h.html#a52d810e1222c592e5d80556ad005f1e6">More...</a><br/></td></tr>
<trclass="memdesc:a47fb8d8aa69df4a7c23a9719b4080623"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Frees a string returned by <aclass="el"href="vk__mem__alloc_8h.html#a52d810e1222c592e5d80556ad005f1e6"title="Builds and returns a null-terminated string in JSON format with information about given VmaVirtualBlo...">vmaBuildVirtualBlockStatsString()</a>. <ahref="vk__mem__alloc_8h.html#a47fb8d8aa69df4a7c23a9719b4080623">More...</a><br/></td></tr>
<p>Flags to be passed as <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>. </p>
<p>Parameters of <aclass="el"href="struct_vma_allocation.html"title="Represents single memory allocation.">VmaAllocation</a> objects, that can be retrieved using function <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>. </p>
<p>Information about existing <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object. </p>
<p>Flags to be used in <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. None at the moment. Reserved for future use. </p>
<p>Deprecated. Optional configuration parameters to be passed to function <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. </p>
<dlclass="deprecated"><dt><b><aclass="el"href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>This is a part of the old interface. It is recommended to use structure <aclass="el"href="struct_vma_defragmentation_info2.html"title="Parameters for defragmentation.">VmaDefragmentationInfo2</a> and function <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a> instead. </dd></dl>
<p>To be used with function <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. </p>
<p>Statistics returned by function <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. </p>
<p>Provided for informative purpose, e.g. to gather statistics about number of allocations or total amount of memory allocated in Vulkan.</p>
<p>Used in <aclass="el"href="struct_vma_allocator_create_info.html#af1380969b5e1ea4c3184a877892d260e"title="Informative callbacks for vkAllocateMemory, vkFreeMemory. Optional.">VmaAllocatorCreateInfo::pDeviceMemoryCallbacks</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446"title="Use combination of VmaPoolCreateFlagBits.">VmaPoolCreateInfo::flags</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446"title="Use combination of VmaPoolCreateFlagBits.">VmaPoolCreateInfo::flags</a>. See <aclass="el"href="vk__mem__alloc_8h.html#a9a7c45f9c863695d98c83fa5ac940fe7"title="Flags to be passed as VmaPoolCreateInfo::flags.">VmaPoolCreateFlagBits</a>. </p>
<p>Flags to be used in <aclass="el"href="struct_vma_record_settings.html#ad8fdcc92119ae7a8c08c1a564c01d63a"title="Flags for recording. Use VmaRecordFlagBits enum.">VmaRecordSettings::flags</a>. </p>
<p>Parameters for recording calls to VMA functions. To be used in <aclass="el"href="struct_vma_allocator_create_info.html#ace2aa4877b16a42b0b7673d4e26000ee"title="Parameters for recording of VMA calls. Can be null.">VmaAllocatorCreateInfo::pRecordSettings</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_allocation_create_info.html#ab10e16956cc4bf20ced9de77d1129ea4"title="Use combination of VmaVirtualAllocationCreateFlagBits.">VmaVirtualAllocationCreateInfo::flags</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_allocation_create_info.html#ab10e16956cc4bf20ced9de77d1129ea4"title="Use combination of VmaVirtualAllocationCreateFlagBits.">VmaVirtualAllocationCreateInfo::flags</a>. See <aclass="el"href="vk__mem__alloc_8h.html#a2e9c64d405b14156fea7e10c4ad06cb6"title="Flags to be passed as VmaVirtualAllocationCreateInfo::flags.">VmaVirtualAllocationCreateFlagBits</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#a5838b15c053a0370420e4e1d82d09c09"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#a5838b15c053a0370420e4e1d82d09c09"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. See <aclass="el"href="vk__mem__alloc_8h.html#a88bcf8c1cd3bb1610ff7343811c65bca"title="Flags to be passed as VmaVirtualBlockCreateInfo::flags.">VmaVirtualBlockCreateFlagBits</a>. </p>
<p>Used in <aclass="el"href="struct_vma_allocator_create_info.html#a3dc197be3227da7338b1643f70db36bd"title="Pointers to Vulkan functions. Can be null.">VmaAllocatorCreateInfo::pVulkanFunctions</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>. </p>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"name="ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"></a>VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT </td><tdclass="fielddoc"><p>Set this flag if the allocation should have its own memory block. </p>
<p>Use it for special, big resources, like fullscreen images used as attachments.</p>
<p>You should not use this flag if <aclass="el"href="struct_vma_allocation_create_info.html#a6272c0555cfd1fe28bff1afeb6190150"title="Pool that this allocation should be created in.">VmaAllocationCreateInfo::pool</a> is not null. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"name="ad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"></a>VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT </td><tdclass="fielddoc"><p>Set this flag to only try to allocate from existing <code>VkDeviceMemory</code> blocks and never create new such block. </p>
<p>If new allocation cannot be placed in any of the existing blocks, allocation fails with <code>VK_ERROR_OUT_OF_DEVICE_MEMORY</code> error.</p>
<p>You should not use <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a> and <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"title="Set this flag to only try to allocate from existing VkDeviceMemory blocks and never create new such b...">VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT</a> at the same time. It makes no sense.</p>
<p>If <aclass="el"href="struct_vma_allocation_create_info.html#a6272c0555cfd1fe28bff1afeb6190150"title="Pool that this allocation should be created in.">VmaAllocationCreateInfo::pool</a> is not null, this flag is implied and ignored. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"name="ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"></a>VMA_ALLOCATION_CREATE_MAPPED_BIT </td><tdclass="fielddoc"><p>Set this flag to use a memory that will be persistently mapped and retrieve pointer to it. </p>
<p>Pointer to mapped memory will be returned through <aclass="el"href="struct_vma_allocation_info.html#a5eeffbe2d2f30f53370ff14aefbadbe2"title="Pointer to the beginning of this allocation as mapped data.">VmaAllocationInfo::pMappedData</a>.</p>
<p>It is valid to use this flag for allocation made from memory type that is not <code>HOST_VISIBLE</code>. 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 (<code>DEVICE_LOCAL</code>) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).</p>
<p>You should not use this flag together with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a>. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2"name="ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2"></a>VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT </td><tdclass="fielddoc"><p>Allocation created with this flag can become lost as a result of another allocation with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a68686d0ce9beb0d4d1b9f2b8b1389a7e">VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT</a> flag, so you must check it before use.</p>
<p>To check if allocation is not lost, call <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a> and check if <aclass="el"href="struct_vma_allocation_info.html#ae0bfb7dfdf79a76ffefc9a94677a2f67"title="Handle to Vulkan memory object.">VmaAllocationInfo::deviceMemory</a> is not <code>VK_NULL_HANDLE</code>.</p>
<p>For details about supporting lost allocations, see Lost Allocations chapter of User Guide on Main Page.</p>
<p>You should not use this flag together with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a>. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a68686d0ce9beb0d4d1b9f2b8b1389a7e"name="ad9889c10c798b040d59c92f257cae597a68686d0ce9beb0d4d1b9f2b8b1389a7e"></a>VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT </td><tdclass="fielddoc"><p>While creating allocation using this flag, other allocations that were created with flag <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a> can become lost.</p>
<p>For details about supporting lost allocations, see Lost Allocations chapter of User Guide on Main Page. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597aa6f24f821cd6a7c5e4a443f7bf59c520"name="ad9889c10c798b040d59c92f257cae597aa6f24f821cd6a7c5e4a443f7bf59c520"></a>VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT </td><tdclass="fielddoc"><p>Set this flag to treat <aclass="el"href="struct_vma_allocation_create_info.html#a8259e85c272683434f4abb4ddddffe19"title="Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...">VmaAllocationCreateInfo::pUserData</a> 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 <code>pUserData</code>. The string is automatically freed together with the allocation. It is also used in <aclass="el"href="vk__mem__alloc_8h.html#aa4fee7eb5253377599ef4fd38c93c2a0"title="Builds and returns statistics as a null-terminated string in JSON format.">vmaBuildStatsString()</a>. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a42ba3a2d2c7117953210b7c3ef8da0df"name="ad9889c10c798b040d59c92f257cae597a42ba3a2d2c7117953210b7c3ef8da0df"></a>VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT </td><tdclass="fielddoc"><p>Allocation will be created from upper stack in a double stack pool.</p>
<p>This flag is only allowed for custom pools created with <aclass="el"href="vk__mem__alloc_8h.html#a9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"title="Enables alternative, linear allocation algorithm in this pool.">VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT</a> flag. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a2310568c62208af432724305fe29ccea"name="ad9889c10c798b040d59c92f257cae597a2310568c62208af432724305fe29ccea"></a>VMA_ALLOCATION_CREATE_DONT_BIND_BIT </td><tdclass="fielddoc"><p>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: <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>. Otherwise it is ignored. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597ab8b1764f3e9022368e440c057783b92d"name="ad9889c10c798b040d59c92f257cae597ab8b1764f3e9022368e440c057783b92d"></a>VMA_ALLOCATION_CREATE_WITHIN_BUDGET_BIT </td><tdclass="fielddoc"><p>Create allocation only if additional device memory required for it, if any, won't exceed memory budget. Otherwise return <code>VK_ERROR_OUT_OF_DEVICE_MEMORY</code>. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a839826775c62319466441f86496f036d"name="ad9889c10c798b040d59c92f257cae597a839826775c62319466441f86496f036d"></a>VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT </td><tdclass="fielddoc"><p>Allocation strategy that chooses smallest possible free range for the allocation. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597ad242a04f802e25fef0b880afe8bb0a62"name="ad9889c10c798b040d59c92f257cae597ad242a04f802e25fef0b880afe8bb0a62"></a>VMA_ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT </td><tdclass="fielddoc"><p>Allocation strategy that chooses biggest possible free range for the allocation. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a33eb2052674f3ad92386c714a65fb777"name="ad9889c10c798b040d59c92f257cae597a33eb2052674f3ad92386c714a65fb777"></a>VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT </td><tdclass="fielddoc"><p>Allocation strategy that chooses first suitable free range for the allocation.</p>
<p>"First" doesn't necessarily means the one with smallest offset in memory, but rather the one that is easiest and fastest to find. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a8af1210cf591784afa026d94998f735d"name="ad9889c10c798b040d59c92f257cae597a8af1210cf591784afa026d94998f735d"></a>VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize memory usage. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a0729e932b7ea170e3a128cad96c5cf6d"name="ad9889c10c798b040d59c92f257cae597a0729e932b7ea170e3a128cad96c5cf6d"></a>VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize allocation time. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a621b704103eb3360230c860acf36e706"name="ad9889c10c798b040d59c92f257cae597a621b704103eb3360230c860acf36e706"></a>VMA_ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize memory fragmentation. </p>
<tr><tdclass="fieldname"><aid="ad9889c10c798b040d59c92f257cae597a8e16845d81ae3d27c47106d4770d5c7e"name="ad9889c10c798b040d59c92f257cae597a8e16845d81ae3d27c47106d4770d5c7e"></a>VMA_ALLOCATION_CREATE_STRATEGY_MASK </td><tdclass="fielddoc"><p>A bit mask to extract only <code>STRATEGY</code> bits from entire set of flags. </p>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7ca4816ddaed324ba110172ca608a20f29d"name="a4f87c9100d154a65a4ad495f7763cf7ca4816ddaed324ba110172ca608a20f29d"></a>VMA_ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT </td><tdclass="fielddoc"><p>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. </p>
<p>Using this flag may increase performance because internal mutexes are not used. </p>
<tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878"name="a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878"></a>VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT </td><tdclass="fielddoc"><p>Enables usage of VK_KHR_dedicated_allocation extension. </p>
<p>The flag works only if <aclass="el"href="struct_vma_allocator_create_info.html#ae0ffc55139b54520a6bb704b29ffc285"title="Optional. The highest version of Vulkan that the application is designed to use.">VmaAllocatorCreateInfo::vulkanApiVersion</a><code>== VK_API_VERSION_1_0</code>. When it is <code>VK_API_VERSION_1_1</code>, the flag is ignored because the extension has been promoted to Vulkan 1.1.</p>
<p>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 <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a> flag) when it is recommended by the driver. It may improve performance on some GPUs.</p>
<p>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 <aclass="el"href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500"title="Vulkan device.">VmaAllocatorCreateInfo::device</a>, and you want them to be used internally by this library:</p>
<tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7ca8fb75bf07cd184ab903596295e863dee"name="a4f87c9100d154a65a4ad495f7763cf7ca8fb75bf07cd184ab903596295e863dee"></a>VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT </td><tdclass="fielddoc"><p>Enables usage of VK_KHR_bind_memory2 extension.</p>
<p>The flag works only if <aclass="el"href="struct_vma_allocator_create_info.html#ae0ffc55139b54520a6bb704b29ffc285"title="Optional. The highest version of Vulkan that the application is designed to use.">VmaAllocatorCreateInfo::vulkanApiVersion</a><code>== VK_API_VERSION_1_0</code>. When it is <code>VK_API_VERSION_1_1</code>, the flag is ignored because the extension has been promoted to Vulkan 1.1.</p>
<p>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 <aclass="el"href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500"title="Vulkan device.">VmaAllocatorCreateInfo::device</a>, and you want it to be used internally by this library.</p>
<p>The extension provides functions <code>vkBindBufferMemory2KHR</code> and <code>vkBindImageMemory2KHR</code>, which allow to pass a chain of <code>pNext</code> structures while binding. This flag is required if you use <code>pNext</code> parameter in <aclass="el"href="vk__mem__alloc_8h.html#a927c944f45e0f2941182abb6f608e64a"title="Binds buffer to allocation with additional parameters.">vmaBindBufferMemory2()</a> or <aclass="el"href="vk__mem__alloc_8h.html#aa8251ee81b0045a443e35b8e8aa021bc"title="Binds image to allocation with additional parameters.">vmaBindImageMemory2()</a>. </p>
<tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7ca4d4687863f7bd4b418c6006dc04400b0"name="a4f87c9100d154a65a4ad495f7763cf7ca4d4687863f7bd4b418c6006dc04400b0"></a>VMA_ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT </td><tdclass="fielddoc"><p>Enables usage of VK_EXT_memory_budget extension.</p>
<p>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 <aclass="el"href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500"title="Vulkan device.">VmaAllocatorCreateInfo::device</a>, 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).</p>
<p>The extension provides query for current memory usage and budget, which will probably be more accurate than an estimation used by the library otherwise. </p>
<tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7ca2acce4886d8078552efa38878413970f"name="a4f87c9100d154a65a4ad495f7763cf7ca2acce4886d8078552efa38878413970f"></a>VMA_ALLOCATOR_CREATE_AMD_DEVICE_COHERENT_MEMORY_BIT </td><tdclass="fielddoc"><p>Enables usage of VK_AMD_device_coherent_memory extension.</p>
<li>found out that this device extension is supported and enabled it while creating Vulkan device passed as <aclass="el"href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500"title="Vulkan device.">VmaAllocatorCreateInfo::device</a>,</li>
<li>checked that <code>VkPhysicalDeviceCoherentMemoryFeaturesAMD::deviceCoherentMemory</code> is true and set it while creating the Vulkan device,</li>
<li>want it to be used internally by this library.</li>
<p>The extension and accompanying device feature provide access to memory types with <code>VK_MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD</code> and <code>VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD</code> flags. They are useful mostly for writing breadcrumb markers - a common method for debugging GPU crash/hang/TDR.</p>
<p>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 <code>VK_ERROR_FEATURE_NOT_PRESENT</code>. </p>
<tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7ca5f1b28b0414319d1687e1f2b30ab0089"name="a4f87c9100d154a65a4ad495f7763cf7ca5f1b28b0414319d1687e1f2b30ab0089"></a>VMA_ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT </td><tdclass="fielddoc"><p>Enables usage of "buffer device address" feature, which allows you to use function <code>vkGetBufferDeviceAddress*</code> to get raw GPU pointer to a buffer and pass it for usage inside a shader.</p>
<li>(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.</li>
<p>When this flag is set, you can create buffers with <code>VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT</code> using VMA. The library automatically adds <code>VK_MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT</code> to allocated memory blocks wherever it might be needed.</p>
<p>For more information, see documentation chapter <aclass="el"href="enabling_buffer_device_address.html">Enabling buffer device address</a>. </p>
<tr><tdclass="fieldname"><aid="a4f87c9100d154a65a4ad495f7763cf7caffdd7a5169be3dbd7cbf6b3619e4f78a"name="a4f87c9100d154a65a4ad495f7763cf7caffdd7a5169be3dbd7cbf6b3619e4f78a"></a>VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT </td><tdclass="fielddoc"><p>Enables usage of VK_EXT_memory_priority extension in the library.</p>
<p>You may set this flag only if you found available and enabled this device extension, along with <code>VkPhysicalDeviceMemoryPriorityFeaturesEXT::memoryPriority == VK_TRUE</code>, while creating Vulkan device passed as <aclass="el"href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500"title="Vulkan device.">VmaAllocatorCreateInfo::device</a>.</p>
<p>When this flag is used, <aclass="el"href="struct_vma_allocation_create_info.html#a983d39e1a2e63649d78a960aa2fdd0f7"title="A floating-point value between 0 and 1, indicating the priority of the allocation relative to other m...">VmaAllocationCreateInfo::priority</a> and <aclass="el"href="struct_vma_pool_create_info.html#a16e686c688f6725f119ebf6e24ab5274"title="A floating-point value between 0 and 1, indicating the priority of the allocations in this pool relat...">VmaPoolCreateInfo::priority</a> are used to set priorities of allocated Vulkan memory. Without it, these variables are ignored.</p>
<p>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 <code>vkAllocateMemory</code> done by the library using structure <code>VkMemoryPriorityAllocateInfoEXT</code>. The value to be used for default priority is 0.5. For more details, see the documentation of the VK_EXT_memory_priority extension. </p>
<p>Flags to be used in <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. None at the moment. Reserved for future use. </p>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305ccaf50d27e34e0925cf3a63db8c839121dd"name="aa5846affa1e9da3800e3e78fae2305ccaf50d27e34e0925cf3a63db8c839121dd"></a>VMA_MEMORY_USAGE_UNKNOWN </td><tdclass="fielddoc"><p>No intended memory usage specified. Use other members of <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a> to specify your requirements. </p>
<tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305ccac6b5dc1432d88647aa4cd456246eadf7"name="aa5846affa1e9da3800e3e78fae2305ccac6b5dc1432d88647aa4cd456246eadf7"></a>VMA_MEMORY_USAGE_GPU_ONLY </td><tdclass="fielddoc"><p>Memory will be used on device only, so fast access from the device is preferred. It usually means device-local GPU (video) memory. No need to be mappable on host. It is roughly equivalent of <code>D3D12_HEAP_TYPE_DEFAULT</code>.</p>
<li>Resources transferred from host once (immutable) or infrequently and read by device multiple times, e.g. textures to be sampled, vertex buffers, uniform (constant) buffers, and majority of other types of resources used on GPU.</li>
<p>Allocation may still end up in <code>HOST_VISIBLE</code> memory on some implementations. In such case, you are free to map it. You can use <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a> with this usage type. </p>
<tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305cca40bdf4cddeffeb12f43d45ca1286e0a5"name="aa5846affa1e9da3800e3e78fae2305cca40bdf4cddeffeb12f43d45ca1286e0a5"></a>VMA_MEMORY_USAGE_CPU_ONLY </td><tdclass="fielddoc"><p>Memory will be mappable on host. It usually means CPU (system) memory. Guarantees to be <code>HOST_VISIBLE</code> and <code>HOST_COHERENT</code>. CPU access is typically uncached. Writes may be write-combined. Resources created in this pool may still be accessible to the device, but access to them can be slow. It is roughly equivalent of <code>D3D12_HEAP_TYPE_UPLOAD</code>.</p>
<p>Usage: Staging copy of resources used as transfer source. </p>
<tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305cca9066b52c5a7079bb74a69aaf8b92ff67"name="aa5846affa1e9da3800e3e78fae2305cca9066b52c5a7079bb74a69aaf8b92ff67"></a>VMA_MEMORY_USAGE_CPU_TO_GPU </td><tdclass="fielddoc"><p>Memory that is both mappable on host (guarantees to be <code>HOST_VISIBLE</code>) and preferably fast to access by GPU. CPU access is typically uncached. Writes may be write-combined.</p>
<p>Usage: Resources written frequently by host (dynamic), read by device. E.g. textures (with LINEAR layout), vertex buffers, uniform buffers updated every frame or every draw call. </p>
<tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305cca7b586d2fdaf82a463b58f581ed72be27"name="aa5846affa1e9da3800e3e78fae2305cca7b586d2fdaf82a463b58f581ed72be27"></a>VMA_MEMORY_USAGE_GPU_TO_CPU </td><tdclass="fielddoc"><p>Memory mappable on host (guarantees to be <code>HOST_VISIBLE</code>) and cached. It is roughly equivalent of <code>D3D12_HEAP_TYPE_READBACK</code>.</p>
<li>Any resources read or accessed randomly on host, e.g. CPU-side copy of vertex buffer used as source of transfer, but also used for collision detection. </li>
<tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305cca416a444d4d0fc20067c3f76f32ff2500"name="aa5846affa1e9da3800e3e78fae2305cca416a444d4d0fc20067c3f76f32ff2500"></a>VMA_MEMORY_USAGE_CPU_COPY </td><tdclass="fielddoc"><p>CPU memory - memory that is preferably not <code>DEVICE_LOCAL</code>, but also not guaranteed to be <code>HOST_VISIBLE</code>.</p>
<p>Usage: Staging copy of resources moved from GPU memory to CPU memory as part of custom paging/residency mechanism, to be moved back to GPU memory when needed. </p>
<tr><tdclass="fieldname"><aid="aa5846affa1e9da3800e3e78fae2305cca835333d9072db63a653818030e17614d"name="aa5846affa1e9da3800e3e78fae2305cca835333d9072db63a653818030e17614d"></a>VMA_MEMORY_USAGE_GPU_LAZILY_ALLOCATED </td><tdclass="fielddoc"><p>Lazily allocated GPU memory having <code>VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT</code>. Exists mostly on mobile platforms. Using it on desktop PC or other GPUs with no such memory type present will fail the allocation.</p>
<p>Usage: Memory for transient attachment images (color attachments, depth attachments etc.), created with <code>VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT</code>.</p>
<p>Allocations with this usage are always created as dedicated - it implies <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446"title="Use combination of VmaPoolCreateFlagBits.">VmaPoolCreateInfo::flags</a>. </p>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a9a7c45f9c863695d98c83fa5ac940fe7a9f1a499508a8edb4e8ba40aa0290a3d2"name="a9a7c45f9c863695d98c83fa5ac940fe7a9f1a499508a8edb4e8ba40aa0290a3d2"></a>VMA_POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT </td><tdclass="fielddoc"><p>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. </p>
<p>This is an optional optimization flag.</p>
<p>If you always allocate using <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, 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.</p>
<p>If you also allocate using <aclass="el"href="vk__mem__alloc_8h.html#a0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a> or <aclass="el"href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, 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. </p>
<tr><tdclass="fieldname"><aid="a9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"name="a9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"></a>VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT </td><tdclass="fielddoc"><p>Enables alternative, linear allocation algorithm in this pool. </p>
<p>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.</p>
<p>By using this flag, you can achieve behavior of free-at-once, stack, ring buffer, and double stack. For details, see documentation chapter <aclass="el"href="custom_memory_pools.html#linear_algorithm">Linear allocation algorithm</a>.</p>
<p>When using this flag, you must specify <aclass="el"href="struct_vma_pool_create_info.html#ae41142f2834fcdc82baa4883c187b75c"title="Maximum number of blocks that can be allocated in this pool. Optional.">VmaPoolCreateInfo::maxBlockCount</a> == 1 (or 0 for default). </p>
<tr><tdclass="fieldname"><aid="a9a7c45f9c863695d98c83fa5ac940fe7a97a0dc38e5161b780594d998d313d35e"name="a9a7c45f9c863695d98c83fa5ac940fe7a97a0dc38e5161b780594d998d313d35e"></a>VMA_POOL_CREATE_BUDDY_ALGORITHM_BIT </td><tdclass="fielddoc"><p>Enables alternative, buddy allocation algorithm in this pool. </p>
<p>It operates on a tree of blocks, each having size that is a power of two and a half of its parent's size. Comparing to default algorithm, this one provides faster allocation and deallocation and decreased external fragmentation, at the expense of more memory wasted (internal fragmentation). For details, see documentation chapter <aclass="el"href="custom_memory_pools.html#buddy_algorithm">Buddy allocation algorithm</a>. </p>
<tr><tdclass="fieldname"><aid="a9a7c45f9c863695d98c83fa5ac940fe7af4d270f8f42517a0f70037ceb6ac1d9c"name="a9a7c45f9c863695d98c83fa5ac940fe7af4d270f8f42517a0f70037ceb6ac1d9c"></a>VMA_POOL_CREATE_ALGORITHM_MASK </td><tdclass="fielddoc"><p>Bit mask to extract only <code>ALGORITHM</code> bits from entire set of flags. </p>
<p>Flags to be used in <aclass="el"href="struct_vma_record_settings.html#ad8fdcc92119ae7a8c08c1a564c01d63a"title="Flags for recording. Use VmaRecordFlagBits enum.">VmaRecordSettings::flags</a>. </p>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a4dd2c44642312a147a4e93373a6e64d2a8e7ab322e8732654be627c4ea8f36cc7"name="a4dd2c44642312a147a4e93373a6e64d2a8e7ab322e8732654be627c4ea8f36cc7"></a>VMA_RECORD_FLUSH_AFTER_CALL_BIT </td><tdclass="fielddoc"><p>Enables flush after recording every function call. </p>
<p>Enable it if you expect your application to crash, which may leave recording file truncated. It may degrade performance though. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_allocation_create_info.html#ab10e16956cc4bf20ced9de77d1129ea4"title="Use combination of VmaVirtualAllocationCreateFlagBits.">VmaVirtualAllocationCreateInfo::flags</a>. </p>
<tableclass="fieldtable">
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a2e9c64d405b14156fea7e10c4ad06cb6a9524a329a55b5ec390d57d90b67ad78e"name="a2e9c64d405b14156fea7e10c4ad06cb6a9524a329a55b5ec390d57d90b67ad78e"></a>VMA_VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT </td><tdclass="fielddoc"><p>Allocation will be created from upper stack in a double stack pool. </p>
<p>This flag is only allowed for virtual blocks created with <aclass="el"href="vk__mem__alloc_8h.html#a88bcf8c1cd3bb1610ff7343811c65bcaae6423e2fa2f3c9211b21c819e3f10f96"title="Enables alternative, linear allocation algorithm in this virtual block.">VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT</a> flag. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a2e9c64d405b14156fea7e10c4ad06cb6ae2a9591a62b5e3b1bdcbc81c6188a1bf"name="a2e9c64d405b14156fea7e10c4ad06cb6ae2a9591a62b5e3b1bdcbc81c6188a1bf"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize memory usage. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a2e9c64d405b14156fea7e10c4ad06cb6a562d10a46012719d33167d3dc5dbbf9b"name="a2e9c64d405b14156fea7e10c4ad06cb6a562d10a46012719d33167d3dc5dbbf9b"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize allocation time. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a2e9c64d405b14156fea7e10c4ad06cb6a9aa0c32667ba2deaa9cdeac6149ec47a"name="a2e9c64d405b14156fea7e10c4ad06cb6a9aa0c32667ba2deaa9cdeac6149ec47a"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize memory fragmentation. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a2e9c64d405b14156fea7e10c4ad06cb6ac5b5e45c335368d18df59c9f27df17e3"name="a2e9c64d405b14156fea7e10c4ad06cb6ac5b5e45c335368d18df59c9f27df17e3"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK </td><tdclass="fielddoc"><p>A bit mask to extract only <code>STRATEGY</code> bits from entire set of flags. </p>
<p>These stategy flags are binary compatible with equivalent flags in <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597"title="Flags to be passed as VmaAllocationCreateInfo::flags.">VmaAllocationCreateFlagBits</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#a5838b15c053a0370420e4e1d82d09c09"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. </p>
<tableclass="fieldtable">
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a88bcf8c1cd3bb1610ff7343811c65bcaae6423e2fa2f3c9211b21c819e3f10f96"name="a88bcf8c1cd3bb1610ff7343811c65bcaae6423e2fa2f3c9211b21c819e3f10f96"></a>VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT </td><tdclass="fielddoc"><p>Enables alternative, linear allocation algorithm in this virtual block. </p>
<p>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.</p>
<p>By using this flag, you can achieve behavior of free-at-once, stack, ring buffer, and double stack. For details, see documentation chapter <aclass="el"href="custom_memory_pools.html#linear_algorithm">Linear allocation algorithm</a>. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a88bcf8c1cd3bb1610ff7343811c65bcaa923116612509e26bf84982b9baf25c63"name="a88bcf8c1cd3bb1610ff7343811c65bcaa923116612509e26bf84982b9baf25c63"></a>VMA_VIRTUAL_BLOCK_CREATE_BUDDY_ALGORITHM_BIT </td><tdclass="fielddoc"><p>Enables alternative, buddy allocation algorithm in this virtual block. </p>
<p>It operates on a tree of blocks, each having size that is a power of two and a half of its parent's size. Comparing to default algorithm, this one provides faster allocation and deallocation and decreased external fragmentation, at the expense of more memory wasted (internal fragmentation). For details, see documentation chapter <aclass="el"href="custom_memory_pools.html#buddy_algorithm">Buddy allocation algorithm</a>. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a88bcf8c1cd3bb1610ff7343811c65bcaaf9487467136e1a9e371894dc3a7c4844"name="a88bcf8c1cd3bb1610ff7343811c65bcaaf9487467136e1a9e371894dc3a7c4844"></a>VMA_VIRTUAL_BLOCK_CREATE_ALGORITHM_MASK </td><tdclass="fielddoc"><p>Bit mask to extract only <code>ALGORITHM</code> bits from entire set of flags. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocationInfo</td><td>Optional. Information about allocated memory. It can be later fetched using function <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>.</td></tr>
<p>You should free the memory using <aclass="el"href="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a> or <aclass="el"href="vk__mem__alloc_8h.html#a834b1e4aef395c0a1d56a28e69a4a17e"title="Frees memory and destroys multiple allocations.">vmaFreeMemoryPages()</a>.</p>
<p>It is recommended to use <aclass="el"href="vk__mem__alloc_8h.html#a7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a>, <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a> instead whenever possible. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocationInfo</td><td>Optional. Information about allocated memory. It can be later fetched using function <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>.</td></tr>
<p>You should free the memory using <aclass="el"href="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a>. </p>
<tr><tdclass="paramdir"></td><tdclass="paramname">pVkMemoryRequirements</td><td>Memory requirements for each allocation. </td></tr>
<tr><tdclass="paramdir"></td><tdclass="paramname">pCreateInfo</td><td>Creation parameters for each alloction. </td></tr>
<tr><tdclass="paramdir"></td><tdclass="paramname">allocationCount</td><td>Number of allocations to make. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocations</td><td>Pointer to array that will be filled with handles to created allocations. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocationInfo</td><td>Optional. Pointer to array that will be filled with parameters of created allocations.</td></tr>
<p>You should free the memory using <aclass="el"href="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a> or <aclass="el"href="vk__mem__alloc_8h.html#a834b1e4aef395c0a1d56a28e69a4a17e"title="Frees memory and destroys multiple allocations.">vmaFreeMemoryPages()</a>.</p>
<p>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 <aclass="el"href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a><code>allocationCount</code> times.</p>
<p>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 <code>VK_SUCCESS</code>, <code>pAllocation</code> array is always entirely filled with <code>VK_NULL_HANDLE</code>. </p>
<p>Binds specified buffer to region of memory represented by specified allocation. Gets <code>VkDeviceMemory</code> 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 <code>vkBindBufferMemory()</code>, because it ensures proper synchronization so that when a <code>VkDeviceMemory</code> object is used by multiple allocations, calls to <code>vkBind*Memory()</code> or <code>vkMapMemory()</code> won't happen from multiple threads simultaneously (which is illegal in Vulkan).</p>
<p>It is recommended to use function <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a> instead of this one. </p>
<tr><tdclass="paramname">allocationLocalOffset</td><td>Additional offset to be added while binding, relative to the beginning of the <code>allocation</code>. Normally it should be 0. </td></tr>
<tr><tdclass="paramname">pNext</td><td>A chain of structures to be attached to <code>VkBindBufferMemoryInfoKHR</code> structure used internally. Normally it should be null.</td></tr>
<p>This function is similar to <aclass="el"href="vk__mem__alloc_8h.html#a6b0929b914b60cf2d45cac4bf3547470"title="Binds buffer to allocation.">vmaBindBufferMemory()</a>, but it provides additional parameters.</p>
<p>If <code>pNext</code> is not null, <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object must have been created with <aclass="el"href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7ca8fb75bf07cd184ab903596295e863dee">VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT</a> flag or with <aclass="el"href="struct_vma_allocator_create_info.html#ae0ffc55139b54520a6bb704b29ffc285"title="Optional. The highest version of Vulkan that the application is designed to use.">VmaAllocatorCreateInfo::vulkanApiVersion</a><code>>= VK_API_VERSION_1_1</code>. Otherwise the call fails. </p>
<p>Binds specified image to region of memory represented by specified allocation. Gets <code>VkDeviceMemory</code> 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 <code>vkBindImageMemory()</code>, because it ensures proper synchronization so that when a <code>VkDeviceMemory</code> object is used by multiple allocations, calls to <code>vkBind*Memory()</code> or <code>vkMapMemory()</code> won't happen from multiple threads simultaneously (which is illegal in Vulkan).</p>
<p>It is recommended to use function <aclass="el"href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a> instead of this one. </p>
<tr><tdclass="paramname">allocationLocalOffset</td><td>Additional offset to be added while binding, relative to the beginning of the <code>allocation</code>. Normally it should be 0. </td></tr>
<tr><tdclass="paramname">pNext</td><td>A chain of structures to be attached to <code>VkBindImageMemoryInfoKHR</code> structure used internally. Normally it should be null.</td></tr>
<p>This function is similar to <aclass="el"href="vk__mem__alloc_8h.html#a3d3ca45799923aa5d138e9e5f9eb2da5"title="Binds image to allocation.">vmaBindImageMemory()</a>, but it provides additional parameters.</p>
<p>If <code>pNext</code> is not null, <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object must have been created with <aclass="el"href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7ca8fb75bf07cd184ab903596295e863dee">VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT</a> flag or with <aclass="el"href="struct_vma_allocator_create_info.html#ae0ffc55139b54520a6bb704b29ffc285"title="Optional. The highest version of Vulkan that the application is designed to use.">VmaAllocatorCreateInfo::vulkanApiVersion</a><code>>= VK_API_VERSION_1_1</code>. Otherwise the call fails. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">ppStatsString</td><td>Must be freed using <aclass="el"href="vk__mem__alloc_8h.html#a3104eb30d8122c84dd8541063f145288">vmaFreeStatsString()</a> function. </td></tr>
<p>Builds and returns a null-terminated string in JSON format with information about given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. </p>
<tr><tdclass="paramdir"></td><tdclass="paramname">detailedMap</td><td>Pass <code>VK_FALSE</code> to also list statistics as returned by <aclass="el"href="vk__mem__alloc_8h.html#a95169b4730e94757897470086ec2768a"title="Calculates and returns statistics about virtual allocations and memory usage in given VmaVirtualBlock...">vmaCalculateVirtualBlockStats()</a>. Pass <code>VK_TRUE</code> to also obtain full list of allocations and free spaces.</td></tr>
</table>
</dd>
</dl>
<p>Returned string must be freed using <aclass="el"href="vk__mem__alloc_8h.html#a47fb8d8aa69df4a7c23a9719b4080623"title="Frees a string returned by vmaBuildVirtualBlockStatsString().">vmaFreeVirtualBlockStatsString()</a>. </p>
<p>This function is called "calculate" not "get" because it has to traverse all internal data structures, so it may be quite slow. For faster but more brief statistics suitable to be called every frame or every allocation, use <aclass="el"href="vk__mem__alloc_8h.html#aec0ed24ebea2d0099eed5f801daaefba"title="Retrieves information about current memory budget for all memory heaps.">vmaGetBudget()</a>.</p>
<p>Note that when using allocator from multiple threads, returned information may immediately become outdated. </p>
<p>Calculates and returns statistics about virtual allocations and memory usage in given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. </p>
<p>Corruption detection is enabled only when <code>VMA_DEBUG_DETECT_CORRUPTION</code> macro is defined to nonzero, <code>VMA_DEBUG_MARGIN</code> is defined to nonzero and only for memory types that are <code>HOST_VISIBLE</code> and <code>HOST_COHERENT</code>. For more information, see <aclass="el"href="debugging_memory_usage.html#debugging_memory_usage_corruption_detection">Corruption detection</a>.</p>
<li><code>VK_ERROR_UNKNOWN</code> - corruption detection has been performed and found memory corruptions around one of the allocations. <code>VMA_ASSERT</code> is also fired in that case.</li>
<p>Corruption detection is enabled only when <code>VMA_DEBUG_DETECT_CORRUPTION</code> macro is defined to nonzero, <code>VMA_DEBUG_MARGIN</code> is defined to nonzero and the pool is created in memory type that is <code>HOST_VISIBLE</code> and <code>HOST_COHERENT</code>. For more information, see <aclass="el"href="debugging_memory_usage.html#debugging_memory_usage_corruption_detection">Corruption detection</a>.</p>
<li><code>VK_ERROR_UNKNOWN</code> - corruption detection has been performed and found memory corruptions around one of the allocations. <code>VMA_ASSERT</code> is also fired in that case.</li>
<p>Frees all virtual allocations inside given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. </p>
<p>You must either call this function or free each virtual allocation individually with <aclass="el"href="vk__mem__alloc_8h.html#a13f01c44b3c1a06e695f1f5d24b80639"title="Frees virtual allocation inside given VmaVirtualBlock.">vmaVirtualFree()</a> before destroying a virtual block. Otherwise, an assert is called.</p>
<p>If you keep pointer to some additional metadata associated with your virtual allocation in its <code>pUserData</code>, don't forget to free it as well. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocationInfo</td><td>Optional. Information about allocated memory. It can be later fetched using function <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>.</td></tr>
<p>If any of these operations fail, buffer and allocation are not created, returned value is negative error code, *pBuffer and *pAllocation are null.</p>
<p>If the function succeeded, you must destroy both buffer and allocation when you no longer need them using either convenience function <aclass="el"href="vk__mem__alloc_8h.html#a0d9f4e4ba5bf9aab1f1c746387753d77"title="Destroys Vulkan buffer and frees allocated memory.">vmaDestroyBuffer()</a> or separately, using <code>vkDestroyBuffer()</code> and <aclass="el"href="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a>.</p>
<p>If <aclass="el"href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878"title="Enables usage of VK_KHR_dedicated_allocation extension.">VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT</a> 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 (<aclass="el"href="struct_vma_allocation_create_info.html#a6272c0555cfd1fe28bff1afeb6190150"title="Pool that this allocation should be created in.">VmaAllocationCreateInfo::pool</a> is null and <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"title="Set this flag to only try to allocate from existing VkDeviceMemory blocks and never create new such b...">VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT</a> is not used), it creates dedicated allocation for this buffer, just like when using <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a>.</p>
<dlclass="section note"><dt>Note</dt><dd>This function creates a new <code>VkBuffer</code>. 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. </dd></dl>
<p>Similar to <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a> but provides additional parameter <code>minAlignment</code> 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. </p>
<p>It can be useful if you need a dummy, non-null allocation.</p>
<p>You still need to destroy created object using <aclass="el"href="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a>.</p>
<p>Returned allocation is not tied to any specific memory pool or memory type and not bound to any image or buffer. It has size = 0. It cannot be turned into a real, non-empty allocation. </p>
<p>Creates new <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> object. </p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir"></td><tdclass="paramname">pCreateInfo</td><td>Parameters for creation. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pVirtualBlock</td><td>Returned virtual block object or <code>VMA_NULL</code> if creation failed. </td></tr>
<tr><tdclass="paramdir"></td><tdclass="paramname">pAllocations</td><td>Array of allocations that can be moved during this compation. </td></tr>
<tr><tdclass="paramdir"></td><tdclass="paramname">allocationCount</td><td>Number of elements in pAllocations and pAllocationsChanged arrays. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocationsChanged</td><td>Array of boolean values that will indicate whether matching allocation in pAllocations array has been moved. This parameter is optional. Pass null if you don't need this information. </td></tr>
<tr><tdclass="paramdir"></td><tdclass="paramname">pDefragmentationInfo</td><td>Configuration parameters. Optional - pass null to use default values. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pDefragmentationStats</td><td>Statistics returned by the function. Optional - pass null if you don't need this information. </td></tr>
<dlclass="deprecated"><dt><b><aclass="el"href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>This is a part of the old interface. It is recommended to use structure <aclass="el"href="struct_vma_defragmentation_info2.html"title="Parameters for defragmentation.">VmaDefragmentationInfo2</a> and function <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a> instead.</dd></dl>
<p>This function works by moving allocations to different places (different <code>VkDeviceMemory</code> objects and/or different offsets) in order to optimize memory usage. Only allocations that are in <code>pAllocations</code> array can be moved. All other allocations are considered nonmovable in this call. Basic rules:</p>
<li>Only allocations made in memory types that have <code>VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT</code> and <code>VK_MEMORY_PROPERTY_HOST_COHERENT_BIT</code> flags can be compacted. You may pass other allocations but it makes no sense - these will never be moved.</li>
<li>Custom pools created with <aclass="el"href="vk__mem__alloc_8h.html#a9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"title="Enables alternative, linear allocation algorithm in this pool.">VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT</a> or <aclass="el"href="vk__mem__alloc_8h.html#a9a7c45f9c863695d98c83fa5ac940fe7a97a0dc38e5161b780594d998d313d35e"title="Enables alternative, buddy allocation algorithm in this pool.">VMA_POOL_CREATE_BUDDY_ALGORITHM_BIT</a> flag are not defragmented. Allocations passed to this function that come from such pools are ignored.</li>
<li>Allocations created with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a> or created as dedicated allocations for any other reason are also ignored.</li>
<li>Both allocations made with or without <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a> flag can be compacted. If not persistently mapped, memory will be mapped temporarily inside this function if needed.</li>
<li>You must not pass same <aclass="el"href="struct_vma_allocation.html"title="Represents single memory allocation.">VmaAllocation</a> object multiple times in <code>pAllocations</code> array.</li>
<p>The function also frees empty <code>VkDeviceMemory</code> blocks.</p>
<p>Warning: This function may be time-consuming, so you shouldn't call it too often (like after every resource creation/destruction). You can call it on special occasions (like when reloading a game level or when you just destroyed a lot of objects). Calling it every frame may be OK, but you should measure that on your platform.</p>
<p>For more information, see <aclass="el"href="defragmentation.html">Defragmentation</a> chapter. </p>
<tr><tdclass="paramdir"></td><tdclass="paramname">pInfo</td><td>Structure filled with parameters of defragmentation. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pStats</td><td>Optional. Statistics of defragmentation. You can pass null if you are not interested in this information. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pContext</td><td>Context object that must be passed to <aclass="el"href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a> to finish defragmentation. </td></tr>
<dlclass="section return"><dt>Returns</dt><dd><code>VK_SUCCESS</code> and <code>*pContext == null</code> if defragmentation finished within this function call. <code>VK_NOT_READY</code> and <code>*pContext != null</code> if defragmentation has been started and you need to call <aclass="el"href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a> to finish it. Negative value in case of error.</dd></dl>
<p>Use this function instead of old, deprecated <aclass="el"href="vk__mem__alloc_8h.html#a9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>.</p>
<p>Warning! Between the call to <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a> and <aclass="el"href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a>:</p>
<li>You should not use any of allocations passed as <code>pInfo->pAllocations</code> or any allocations that belong to pools passed as <code>pInfo->pPools</code>, including calling <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a43d8ba9673c846f049089a5029d5c73a"title="Returns VK_TRUE if allocation is not lost and atomically marks it as used in current frame.">vmaTouchAllocation()</a>, or access their data.</li>
<li>Some mutexes protecting internal data structures may be locked, so trying to make or free any allocations, bind buffers or images, map memory, or launch another simultaneous defragmentation in between may cause stall (when done on another thread) or deadlock (when done on the same thread), unless you are 100% sure that defragmented allocations are in different pools.</li>
<li>Information returned via <code>pStats</code> and <code>pInfo->pAllocationsChanged</code> are undefined. They become valid after call to <aclass="el"href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a>.</li>
<li>If <code>pInfo->commandBuffer</code> is not null, you must submit that command buffer and make sure it finished execution before calling <aclass="el"href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a>.</li>
<p>For more information and important limitations regarding defragmentation, see documentation chapter: <aclass="el"href="defragmentation.html">Defragmentation</a>. </p>
<p>Use this function to finish defragmentation started by <aclass="el"href="vk__mem__alloc_8h.html#a36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. It is safe to pass <code>context == null</code>. The function then does nothing. </p>
<p>Destroys <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> object. </p>
<p>Please note that you should consciously handle virtual allocations that could remain unfreed in the block. You should either free them individually using <aclass="el"href="vk__mem__alloc_8h.html#a13f01c44b3c1a06e695f1f5d24b80639"title="Frees virtual allocation inside given VmaVirtualBlock.">vmaVirtualFree()</a> or call <aclass="el"href="vk__mem__alloc_8h.html#a5eda6f55919fb05bd2f56a112590c571"title="Frees all virtual allocations inside given VmaVirtualBlock.">vmaClearVirtualBlock()</a> if you are sure this is what you want. If you do neither, an assert is called.</p>
<p>If you keep pointers to some additional metadata associated with your virtual allocations in their <code>pUserData</code>, don't forget to free them. </p>
<li>Contains all the flags from pAllocationCreateInfo->requiredFlags.</li>
<li>Matches intended usage.</li>
<li>Has as many flags from pAllocationCreateInfo->preferredFlags as possible.</li>
</ul>
<dlclass="section return"><dt>Returns</dt><dd>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. </dd></dl>
<p>Helps to find memoryTypeIndex, given VkBufferCreateInfo and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. </p>
<p>It can be useful e.g. to determine value to be used as <aclass="el"href="struct_vma_pool_create_info.html#a596fa76b685d3f1f688f84a709a5b319"title="Vulkan memory type index to allocate this pool from.">VmaPoolCreateInfo::memoryTypeIndex</a>. It internally creates a temporary, dummy buffer that never has memory bound. It is just a convenience function, equivalent to calling:</p>
<p>Helps to find memoryTypeIndex, given VkImageCreateInfo and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. </p>
<p>It can be useful e.g. to determine value to be used as <aclass="el"href="struct_vma_pool_create_info.html#a596fa76b685d3f1f688f84a709a5b319"title="Vulkan memory type index to allocate this pool from.">VmaPoolCreateInfo::memoryTypeIndex</a>. It internally creates a temporary, dummy image that never has memory bound. It is just a convenience function, equivalent to calling:</p>
<p>Calls <code>vkFlushMappedMemoryRanges()</code> 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 <code>HOST_COHERENT</code>. Unmap operation doesn't do that automatically.</p>
<li><code>offset</code> must be relative to the beginning of allocation.</li>
<li><code>size</code> can be <code>VK_WHOLE_SIZE</code>. It means all memory from <code>offset</code> the the end of given allocation.</li>
<li><code>offset</code> and <code>size</code> don't have to be aligned. They are internally rounded down/up to multiply of <code>nonCoherentAtomSize</code>.</li>
<li>If <code>size</code> is 0, this call is ignored.</li>
<li>If memory type that the <code>allocation</code> belongs to is not <code>HOST_VISIBLE</code> or it is <code>HOST_COHERENT</code>, this call is ignored.</li>
<p>Warning! <code>offset</code> and <code>size</code> are relative to the contents of given <code>allocation</code>. If you mean whole allocation, you can pass 0 and <code>VK_WHOLE_SIZE</code>, respectively. Do not pass allocation's offset as <code>offset</code>!!!</p>
<p>This function returns the <code>VkResult</code> from <code>vkFlushMappedMemoryRanges</code> if it is called, otherwise <code>VK_SUCCESS</code>. </p>
<p>Calls <code>vkFlushMappedMemoryRanges()</code> for memory associated with given ranges of given allocations. For more information, see documentation of <aclass="el"href="vk__mem__alloc_8h.html#a30c37c1eec6025f397be41644f48490f"title="Flushes memory of given allocation.">vmaFlushAllocation()</a>.</p>
<tr><tdclass="paramname">offsets</td><td>If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero. </td></tr>
<tr><tdclass="paramname">sizes</td><td>If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means <code>VK_WHOLE_SIZE</code> for all allocations.</td></tr>
</table>
</dd>
</dl>
<p>This function returns the <code>VkResult</code> from <code>vkFlushMappedMemoryRanges</code> if it is called, otherwise <code>VK_SUCCESS</code>. </p>
<p>Frees memory previously allocated using <aclass="el"href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, or <aclass="el"href="vk__mem__alloc_8h.html#a0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a>. </p>
<p>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. <aclass="el"href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, <aclass="el"href="vk__mem__alloc_8h.html#ad37e82e492b3de38fc3f4cffd9ad0ae1"title="General purpose memory allocation for multiple allocation objects at once.">vmaAllocateMemoryPages()</a> and other functions. It may be internally optimized to be more efficient than calling <aclass="el"href="vk__mem__alloc_8h.html#a5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a><code>allocationCount</code> times.</p>
<p>Allocations in <code>pAllocations</code> array can come from any memory pools and types. Passing <code>VK_NULL_HANDLE</code> as elements of <code>pAllocations</code> array is valid. Such entries are just skipped. </p>
<p>Frees a string returned by <aclass="el"href="vk__mem__alloc_8h.html#a52d810e1222c592e5d80556ad005f1e6"title="Builds and returns a null-terminated string in JSON format with information about given VmaVirtualBlo...">vmaBuildVirtualBlockStatsString()</a>. </p>
<p>Current paramteres of given allocation are returned in <code>pAllocationInfo</code>.</p>
<p>This function also atomically "touches" allocation - marks it as used in current frame, just like <aclass="el"href="vk__mem__alloc_8h.html#a43d8ba9673c846f049089a5029d5c73a"title="Returns VK_TRUE if allocation is not lost and atomically marks it as used in current frame.">vmaTouchAllocation()</a>. If the allocation is in lost state, <code>pAllocationInfo->deviceMemory == VK_NULL_HANDLE</code>.</p>
<p>Although this function uses atomics and doesn't lock any mutex, so it should be quite efficient, you can avoid calling it too often.</p>
<li>You can retrieve same <aclass="el"href="struct_vma_allocation_info.html"title="Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().">VmaAllocationInfo</a> structure while creating your resource, from function <aclass="el"href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>. You can remember it if you are sure parameters don't change (e.g. due to defragmentation or allocation becoming lost).</li>
<li>If you just want to check if allocation is not lost, <aclass="el"href="vk__mem__alloc_8h.html#a43d8ba9673c846f049089a5029d5c73a"title="Returns VK_TRUE if allocation is not lost and atomically marks it as used in current frame.">vmaTouchAllocation()</a> will work faster. </li>
<p>Returns information about existing <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> object - handle to Vulkan device etc. </p>
<p>It might be useful if you want to keep just the <aclass="el"href="struct_vma_allocator.html"title="Represents main object of this library initialized.">VmaAllocator</a> handle and fetch other required handles to <code>VkPhysicalDevice</code>, <code>VkDevice</code> etc. every time using this function. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pBudget</td><td>Must point to array with number of elements at least equal to number of memory heaps in physical device used.</td></tr>
<p>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 <aclass="el"href="vk__mem__alloc_8h.html#a333b61c1788cb23559177531e6a93ca3"title="Retrieves statistics from current state of the Allocator.">vmaCalculateStats()</a>.</p>
<p>PhysicalDeviceMemoryProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own. </p>
<p>This is just a convenience function. Same information can be obtained using <aclass="el"href="vk__mem__alloc_8h.html#ab88db292a17974f911182543fda52d19">vmaGetMemoryProperties()</a>. </p>
<p>After the call <code>ppName</code> 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 <aclass="el"href="vk__mem__alloc_8h.html#adbae3a0b4ab078024462fc85c37f3b58"title="Sets name of a custom pool.">vmaSetPoolName()</a>. </p>
<p>Calls <code>vkInvalidateMappedMemoryRanges()</code> 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 <code>HOST_COHERENT</code>. Map operation doesn't do that automatically.</p>
<li><code>offset</code> must be relative to the beginning of allocation.</li>
<li><code>size</code> can be <code>VK_WHOLE_SIZE</code>. It means all memory from <code>offset</code> the the end of given allocation.</li>
<li><code>offset</code> and <code>size</code> don't have to be aligned. They are internally rounded down/up to multiply of <code>nonCoherentAtomSize</code>.</li>
<li>If <code>size</code> is 0, this call is ignored.</li>
<li>If memory type that the <code>allocation</code> belongs to is not <code>HOST_VISIBLE</code> or it is <code>HOST_COHERENT</code>, this call is ignored.</li>
<p>Warning! <code>offset</code> and <code>size</code> are relative to the contents of given <code>allocation</code>. If you mean whole allocation, you can pass 0 and <code>VK_WHOLE_SIZE</code>, respectively. Do not pass allocation's offset as <code>offset</code>!!!</p>
<p>This function returns the <code>VkResult</code> from <code>vkInvalidateMappedMemoryRanges</code> if it is called, otherwise <code>VK_SUCCESS</code>. </p>
<p>Calls <code>vkInvalidateMappedMemoryRanges()</code> for memory associated with given ranges of given allocations. For more information, see documentation of <aclass="el"href="vk__mem__alloc_8h.html#aaa8412919139ef413a4215ac6a290fae"title="Invalidates memory of given allocation.">vmaInvalidateAllocation()</a>.</p>
<tr><tdclass="paramname">offsets</td><td>If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero. </td></tr>
<tr><tdclass="paramname">sizes</td><td>If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means <code>VK_WHOLE_SIZE</code> for all allocations.</td></tr>
</table>
</dd>
</dl>
<p>This function returns the <code>VkResult</code> from <code>vkInvalidateMappedMemoryRanges</code> if it is called, otherwise <code>VK_SUCCESS</code>. </p>
<p>Returns true of the <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a> is empty - contains 0 virtual allocations and has all its space available for new allocations. </p>
<p>Marks all allocations in given pool as lost if they are not used in current frame or <aclass="el"href="struct_vma_pool_create_info.html#a9437e43ffbb644dbbf7fc4e50cfad6aa"title="Maximum number of additional frames that are in use at the same time as current frame.">VmaPoolCreateInfo::frameInUseCount</a> back from now. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pLostAllocationCount</td><td>Number of allocations marked as lost. Optional - pass null if you don't need this information. </td></tr>
<p>Maps memory represented by given allocation to make it accessible to CPU code. When succeeded, <code>*ppData</code> contains pointer to first byte of this memory. If the allocation is part of bigger <code>VkDeviceMemory</code> block, the pointer is correctly offsetted to the beginning of region assigned to this particular allocation.</p>
<p>Mapping is internally reference-counted and synchronized, so despite raw Vulkan function <code>vkMapMemory()</code> cannot be used to map same block of <code>VkDeviceMemory</code> 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.</p>
<p>If the function succeeded, you must call <aclass="el"href="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45"title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a> to unmap the allocation when mapping is no longer needed or before freeing the allocation, at the latest.</p>
<p>It also safe to call this function multiple times on the same allocation. You must call <aclass="el"href="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45"title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a> same number of times as you called <aclass="el"href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>.</p>
<p>It is also safe to call this function on allocation created with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a> flag. Its memory stays mapped all the time. You must still call <aclass="el"href="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45"title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a> same number of times as you called <aclass="el"href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>. You must not call <aclass="el"href="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45"title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a> additional time to free the "0-th" mapping made automatically due to <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a> flag.</p>
<p>This function fails when used on allocation made in memory type that is not <code>HOST_VISIBLE</code>.</p>
<p>This function always fails when called for allocation that was created with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a> flag. Such allocations cannot be mapped.</p>
<p>This function doesn't automatically flush or invalidate caches. If the allocation is made from a memory types that is not <code>HOST_COHERENT</code>, you also need to use <aclass="el"href="vk__mem__alloc_8h.html#aaa8412919139ef413a4215ac6a290fae"title="Invalidates memory of given allocation.">vmaInvalidateAllocation()</a> / <aclass="el"href="vk__mem__alloc_8h.html#a30c37c1eec6025f397be41644f48490f"title="Flushes memory of given allocation.">vmaFlushAllocation()</a>, as required by Vulkan specification. </p>
<p>If the allocation was created with VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT, pUserData must be either null, or pointer to a null-terminated string. The function makes local copy of the string and sets it as allocation's <code>pUserData</code>. String passed as pUserData doesn't need to be valid for whole lifetime of the allocation - you can free it after this call. String previously pointed by allocation's pUserData is freed from memory.</p>
<p>If the flag was not used, the value of pointer <code>pUserData</code> is just copied to allocation's <code>pUserData</code>. 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. </p>
<p>This function must be used if you make allocations with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a> and <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a68686d0ce9beb0d4d1b9f2b8b1389a7e">VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT</a> flags to inform the allocator when a new frame begins. Allocations queried using <aclass="el"href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a> cannot become lost in the current frame. </p>
<p><code>pName</code> 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. </p>
<p>If the allocation has been created with <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a> flag, this function returns <code>VK_TRUE</code> if it is not in lost state, so it can still be used. It then also atomically "touches" the allocation - marks it as used in current frame, so that you can be sure it won't become lost in current frame or next <code>frameInUseCount</code> frames.</p>
<p>If the allocation is in lost state, the function returns <code>VK_FALSE</code>. Memory of such allocation, as well as buffer or image bound to it, should not be used. Lost allocation and the buffer/image still need to be destroyed.</p>
<p>If the allocation has been created without <aclass="el"href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a> flag, this function always returns <code>VK_TRUE</code>. </p>
<p>Unmaps memory represented by given allocation, mapped previously using <aclass="el"href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>. </p>
<p>For details, see description of <aclass="el"href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>.</p>
<p>This function doesn't automatically flush or invalidate caches. If the allocation is made from a memory types that is not <code>HOST_COHERENT</code>, you also need to use <aclass="el"href="vk__mem__alloc_8h.html#aaa8412919139ef413a4215ac6a290fae"title="Invalidates memory of given allocation.">vmaInvalidateAllocation()</a> / <aclass="el"href="vk__mem__alloc_8h.html#a30c37c1eec6025f397be41644f48490f"title="Flushes memory of given allocation.">vmaFlushAllocation()</a>, as required by Vulkan specification. </p>
<p>Allocates new virtual allocation inside given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. </p>
<p>There is no handle type for a virtual allocation. Virtual allocations within a specific virtual block are uniquely identified by their offsets.</p>
<p>If the allocation fails due to not enough free space available, <code>VK_ERROR_OUT_OF_DEVICE_MEMORY</code> is returned, despite the function doesn't ever allocate actual GPU memory. </p>
<p>Frees virtual allocation inside given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. </p>
