<p>API elements related to the allocation, deallocation, and management of Vulkan memory, buffers, images. Most basic ones being: <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>.
<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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">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="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"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="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"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">Represents custom memory pool. <ahref="struct_vma_pool.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Represents single memory allocation. <ahref="struct_vma_allocation.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Represents Opaque object that represents started defragmentation process. <ahref="struct_vma_defragmentation_context.html#details">More...</a><br/></td></tr>
<trclass="memdesc:ga806e8499dde802e59eb72a1dc811c35f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Intended usage of the allocated memory. <ahref="group__group__alloc.html#ga806e8499dde802e59eb72a1dc811c35f">More...</a><br/></td></tr>
<trclass="memdesc:ga4fceecc301f4064dc808d3cd6c038941"><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="group__group__alloc.html#ga4fceecc301f4064dc808d3cd6c038941">More...</a><br/></td></tr>
<trclass="memdesc:ga4d4f2efc2509157a9e4ecd4fd7942303"><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="group__group__alloc.html#ga4d4f2efc2509157a9e4ecd4fd7942303">More...</a><br/></td></tr>
<trclass="memdesc:ga2770e325ea42e087c1b91fdf46d0292a"><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="group__group__alloc.html#ga9a7c45f9c863695d98c83fa5ac940fe7"title="Flags to be passed as VmaPoolCreateInfo::flags.">VmaPoolCreateFlagBits</a>. <ahref="group__group__alloc.html#ga2770e325ea42e087c1b91fdf46d0292a">More...</a><br/></td></tr>
<trclass="memdesc:ga13415cc0b443353a7b5abda300b833fc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be used in <aclass="el"href="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. None at the moment. Reserved for future use. <ahref="group__group__alloc.html#ga13415cc0b443353a7b5abda300b833fc">More...</a><br/></td></tr>
<trclass="memdesc:ga1017aa83489c0eee8d2163d2bf253f67"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Describes parameter of created <aclass="el"href="struct_vma_pool.html"title="Represents custom memory pool.">VmaPool</a>. <ahref="group__group__alloc.html#ga1017aa83489c0eee8d2163d2bf253f67">More...</a><br/></td></tr>
<trclass="memdesc:ga1cf7774606721026a68aabe3af2e5b50"><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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a>. <ahref="group__group__alloc.html#ga1cf7774606721026a68aabe3af2e5b50">More...</a><br/></td></tr>
<trclass="memdesc:gad6daeffaa670ce6d11a203a6224c9937"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters for defragmentation. <ahref="group__group__alloc.html#gad6daeffaa670ce6d11a203a6224c9937">More...</a><br/></td></tr>
<trclass="memdesc:ga2bf47f96bf92bed2a49461bd9af3acfa"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Deprecated. Optional configuration parameters to be passed to function <aclass="el"href="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. <ahref="group__group__alloc.html#ga2bf47f96bf92bed2a49461bd9af3acfa">More...</a><br/></td></tr>
<trclass="memdesc:gad94034192259c2e34a4d1c5e27810403"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics returned by function <aclass="el"href="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>. <ahref="group__group__alloc.html#gad94034192259c2e34a4d1c5e27810403">More...</a><br/></td></tr>
<trclass="memdesc:gaa5846affa1e9da3800e3e78fae2305cc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Intended usage of the allocated memory. <ahref="group__group__alloc.html#gaa5846affa1e9da3800e3e78fae2305cc">More...</a><br/></td></tr>
<trclass="memdesc:gad9889c10c798b040d59c92f257cae597"><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="group__group__alloc.html#gad9889c10c798b040d59c92f257cae597">More...</a><br/></td></tr>
<trclass="memdesc:ga9a7c45f9c863695d98c83fa5ac940fe7"><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="group__group__alloc.html#ga9a7c45f9c863695d98c83fa5ac940fe7">More...</a><br/></td></tr>
<trclass="memdesc:ga6552a65b71d16f378c6994b3ceaef50c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be used in <aclass="el"href="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. None at the moment. Reserved for future use. <ahref="group__group__alloc.html#ga6552a65b71d16f378c6994b3ceaef50c">More...</a><br/></td></tr>
<trclass="memdesc:gaef15a94b58fbcb0fe706d5720e84a74a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helps to find memoryTypeIndex, given memoryTypeBits and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. <ahref="group__group__alloc.html#gaef15a94b58fbcb0fe706d5720e84a74a">More...</a><br/></td></tr>
<trclass="memdesc:gae790ab9ffaf7667fb8f62523e6897888"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helps to find memoryTypeIndex, given VkBufferCreateInfo and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. <ahref="group__group__alloc.html#gae790ab9ffaf7667fb8f62523e6897888">More...</a><br/></td></tr>
<trclass="memdesc:ga088da83d8eaf3ce9056d9ea0b981d472"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helps to find memoryTypeIndex, given VkImageCreateInfo and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. <ahref="group__group__alloc.html#ga088da83d8eaf3ce9056d9ea0b981d472">More...</a><br/></td></tr>
<trclass="memdesc:gad535935619c7a549bf837e1bb0068f89"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Checks magic number in margins around all allocations in given memory pool in search for corruptions. <ahref="group__group__alloc.html#gad535935619c7a549bf837e1bb0068f89">More...</a><br/></td></tr>
<trclass="memitem:gaf09b4e4eafdbee812e8d73ddf960f030"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="group__group__alloc.html#gaf09b4e4eafdbee812e8d73ddf960f030">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:gaf09b4e4eafdbee812e8d73ddf960f030"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves name of a custom pool. <ahref="group__group__alloc.html#gaf09b4e4eafdbee812e8d73ddf960f030">More...</a><br/></td></tr>
<trclass="memitem:gadbae3a0b4ab078024462fc85c37f3b58"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="group__group__alloc.html#gadbae3a0b4ab078024462fc85c37f3b58">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:gadbae3a0b4ab078024462fc85c37f3b58"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets name of a custom pool. <ahref="group__group__alloc.html#gadbae3a0b4ab078024462fc85c37f3b58">More...</a><br/></td></tr>
<trclass="memdesc:ga0faa3f9e5fb233d29d1e00390650febb"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Function similar to <aclass="el"href="group__group__alloc.html#ga7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>. <ahref="group__group__alloc.html#ga0faa3f9e5fb233d29d1e00390650febb">More...</a><br/></td></tr>
<trclass="memdesc:ga5fea5518972ae9094b1526cbcb19b05f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Frees memory previously allocated using <aclass="el"href="group__group__alloc.html#gabf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, <aclass="el"href="group__group__alloc.html#ga7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, or <aclass="el"href="group__group__alloc.html#ga0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a>. <ahref="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f">More...</a><br/></td></tr>
<trclass="memdesc:ga86dd08aba8633bfa4ad0df2e76481d8b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns current information about specified allocation. <ahref="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b">More...</a><br/></td></tr>
<trclass="memdesc:gaf9147d31ffc11d62fc187bde283ed14f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets pUserData in given allocation to new value. <ahref="group__group__alloc.html#gaf9147d31ffc11d62fc187bde283ed14f">More...</a><br/></td></tr>
<trclass="memdesc:ga571e87dd38e552249b56b1b0b982fad1"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Given an allocation, returns Property Flags of its memory type. <ahref="group__group__alloc.html#ga571e87dd38e552249b56b1b0b982fad1">More...</a><br/></td></tr>
<trclass="memdesc:gad5bd1243512d099706de88168992f069"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Maps memory represented by given allocation and returns pointer to it. <ahref="group__group__alloc.html#gad5bd1243512d099706de88168992f069">More...</a><br/></td></tr>
<trclass="memdesc:ga9bc268595cb33f6ec4d519cfce81ff45"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Unmaps memory represented by given allocation, mapped previously using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>. <ahref="group__group__alloc.html#ga9bc268595cb33f6ec4d519cfce81ff45">More...</a><br/></td></tr>
<trclass="memdesc:ga30c37c1eec6025f397be41644f48490f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flushes memory of given allocation. <ahref="group__group__alloc.html#ga30c37c1eec6025f397be41644f48490f">More...</a><br/></td></tr>
<trclass="memdesc:gaaa8412919139ef413a4215ac6a290fae"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Invalidates memory of given allocation. <ahref="group__group__alloc.html#gaaa8412919139ef413a4215ac6a290fae">More...</a><br/></td></tr>
<trclass="memdesc:gac3dd00da721875ed99fa8a881922bdfc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flushes memory of given set of allocations. <ahref="group__group__alloc.html#gac3dd00da721875ed99fa8a881922bdfc">More...</a><br/></td></tr>
<trclass="memdesc:gab25b558d75f7378ec944a1522fdcc3c5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Invalidates memory of given set of allocations. <ahref="group__group__alloc.html#gab25b558d75f7378ec944a1522fdcc3c5">More...</a><br/></td></tr>
<trclass="memdesc:ga49329a7f030dafcf82f7b73334c22e98"><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="group__group__alloc.html#ga49329a7f030dafcf82f7b73334c22e98">More...</a><br/></td></tr>
<trclass="memdesc:ga6b0929b914b60cf2d45cac4bf3547470"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds buffer to allocation. <ahref="group__group__alloc.html#ga6b0929b914b60cf2d45cac4bf3547470">More...</a><br/></td></tr>
<trclass="memdesc:ga927c944f45e0f2941182abb6f608e64a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds buffer to allocation with additional parameters. <ahref="group__group__alloc.html#ga927c944f45e0f2941182abb6f608e64a">More...</a><br/></td></tr>
<trclass="memdesc:ga3d3ca45799923aa5d138e9e5f9eb2da5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds image to allocation. <ahref="group__group__alloc.html#ga3d3ca45799923aa5d138e9e5f9eb2da5">More...</a><br/></td></tr>
<trclass="memdesc:gaa8251ee81b0045a443e35b8e8aa021bc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Binds image to allocation with additional parameters. <ahref="group__group__alloc.html#gaa8251ee81b0045a443e35b8e8aa021bc">More...</a><br/></td></tr>
<trclass="memdesc:gaa06a690013a0d01e60894ac378083834"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Creates a buffer with additional minimum alignment. <ahref="group__group__alloc.html#gaa06a690013a0d01e60894ac378083834">More...</a><br/></td></tr>
<trclass="memdesc:ga02a94f25679275851a53e82eacbcfc73"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Function similar to <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>. <ahref="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73">More...</a><br/></td></tr>
<p>API elements related to the allocation, deallocation, and management of Vulkan memory, buffers, images. Most basic ones being: <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</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>
<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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a>. </p>
<p>Flags to be used in <aclass="el"href="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"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="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"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="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a> instead. </dd></dl>
<p>To be used with function <aclass="el"href="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. </p>
<p>Statistics returned by function <aclass="el"href="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</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="group__group__alloc.html#ga9a7c45f9c863695d98c83fa5ac940fe7"title="Flags to be passed as VmaPoolCreateInfo::flags.">VmaPoolCreateFlagBits</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>
<tableclass="fieldtable">
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"name="ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"></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>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"name="ggad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"></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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a> and <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"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>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"name="ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"></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>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597ad7e8035e8edecd8dfa1f32a194bdf103"name="ggad9889c10c798b040d59c92f257cae597ad7e8035e8edecd8dfa1f32a194bdf103"></a>VMA_ALLOCATION_CREATE_RESERVED_1_BIT </td><tdclass="fielddoc"><dlclass="deprecated"><dt><b><aclass="el"href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Removed. Do not use. </dd></dl>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597ae9290dbcf5817e7616d5802e2aa251e7"name="ggad9889c10c798b040d59c92f257cae597ae9290dbcf5817e7616d5802e2aa251e7"></a>VMA_ALLOCATION_CREATE_RESERVED_2_BIT </td><tdclass="fielddoc"><dlclass="deprecated"><dt><b><aclass="el"href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Removed. Do not use. </dd></dl>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597aa6f24f821cd6a7c5e4a443f7bf59c520"name="ggad9889c10c798b040d59c92f257cae597aa6f24f821cd6a7c5e4a443f7bf59c520"></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="group__group__stats.html#gaa4fee7eb5253377599ef4fd38c93c2a0"title="Builds and returns statistics as a null-terminated string in JSON format.">vmaBuildStatsString()</a>. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a42ba3a2d2c7117953210b7c3ef8da0df"name="ggad9889c10c798b040d59c92f257cae597a42ba3a2d2c7117953210b7c3ef8da0df"></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="group__group__alloc.html#gga9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"title="Enables alternative, linear allocation algorithm in this pool.">VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT</a> flag. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a2310568c62208af432724305fe29ccea"name="ggad9889c10c798b040d59c92f257cae597a2310568c62208af432724305fe29ccea"></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="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>. Otherwise it is ignored. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597ab8b1764f3e9022368e440c057783b92d"name="ggad9889c10c798b040d59c92f257cae597ab8b1764f3e9022368e440c057783b92d"></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>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597afb0ee060cd733aaa5e249704ff589ad6"name="ggad9889c10c798b040d59c92f257cae597afb0ee060cd733aaa5e249704ff589ad6"></a>VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT </td><tdclass="fielddoc"><p>Set this flag if the allocated memory will have aliasing resources. </p>
<p>Usage of this flag prevents supplying <code>VkMemoryDedicatedAllocateInfoKHR</code> when <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a> is specified. Otherwise created dedicated memory will not be suitable for aliasing resources, resulting in Vulkan Validation Layer errors. </p>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a9be224df3bfc1cfa06203aed689a30c5"name="ggad9889c10c798b040d59c92f257cae597a9be224df3bfc1cfa06203aed689a30c5"></a>VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT </td><tdclass="fielddoc"><p>Requests possibility to map the allocation (using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"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>
<ul>
<li>If you use <aclass="el"href="group__group__alloc.html#ggaa5846affa1e9da3800e3e78fae2305cca27cde9026a84d34d525777baa41fce6e">VMA_MEMORY_USAGE_AUTO</a> or other <code>VMA_MEMORY_USAGE_AUTO*</code> value, you must use this flag to be able to map the allocation. Otherwise, mapping is incorrect.</li>
<li>If you use other value of <aclass="el"href="group__group__alloc.html#gaa5846affa1e9da3800e3e78fae2305cc"title="Intended usage of the allocated memory.">VmaMemoryUsage</a>, this flag is ignored and mapping is always possible in memory types that are <code>HOST_VISIBLE</code>. This includes allocations created in <aclass="el"href="custom_memory_pools.html">Custom memory pools</a>.</li>
</ul>
<p>Declares that mapped memory will only be written sequentially, e.g. using <code>memcpy()</code> or a loop writing number-by-number, never read or accessed randomly, so a memory type can be selected that is uncached and write-combined.</p>
<dlclass="section warning"><dt>Warning</dt><dd>Violating this declaration may work correctly, but will likely be very slow. Watch out for implicit reads introduces by doing e.g. <code>pMappedData[i] += x;</code> Better prepare your data in a local variable and <code>memcpy()</code> it to the mapped pointer all at once. </dd></dl>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597add61238d98e20917b9a06c617763f492"name="ggad9889c10c798b040d59c92f257cae597add61238d98e20917b9a06c617763f492"></a>VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT </td><tdclass="fielddoc"><p>Requests possibility to map the allocation (using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"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>
<ul>
<li>If you use <aclass="el"href="group__group__alloc.html#ggaa5846affa1e9da3800e3e78fae2305cca27cde9026a84d34d525777baa41fce6e">VMA_MEMORY_USAGE_AUTO</a> or other <code>VMA_MEMORY_USAGE_AUTO*</code> value, you must use this flag to be able to map the allocation. Otherwise, mapping is incorrect.</li>
<li>If you use other value of <aclass="el"href="group__group__alloc.html#gaa5846affa1e9da3800e3e78fae2305cc"title="Intended usage of the allocated memory.">VmaMemoryUsage</a>, this flag is ignored and mapping is always possible in memory types that are <code>HOST_VISIBLE</code>. This includes allocations created in <aclass="el"href="custom_memory_pools.html">Custom memory pools</a>.</li>
</ul>
<p>Declares that mapped memory can be read, written, and accessed in random order, so a <code>HOST_CACHED</code> memory type is preferred. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a11337f96eacf34c1016c339eac165cad"name="ggad9889c10c798b040d59c92f257cae597a11337f96eacf34c1016c339eac165cad"></a>VMA_ALLOCATION_CREATE_HOST_ACCESS_ALLOW_TRANSFER_INSTEAD_BIT </td><tdclass="fielddoc"><p>Together with <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a9be224df3bfc1cfa06203aed689a30c5">VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597add61238d98e20917b9a06c617763f492">VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT</a>, it says that despite request for host access, a not-<code>HOST_VISIBLE</code> memory type can be selected if it may improve performance.</p>
<p>By using this flag, you declare that you will check if the allocation ended up in a <code>HOST_VISIBLE</code> memory type (e.g. using <aclass="el"href="group__group__alloc.html#ga571e87dd38e552249b56b1b0b982fad1"title="Given an allocation, returns Property Flags of its memory type.">vmaGetAllocationMemoryProperties()</a>) and if not, you will create some "staging" buffer and issue an explicit transfer to write/read your data. To prepare for this possibility, don't forget to add appropriate flags like <code>VK_BUFFER_USAGE_TRANSFER_DST_BIT</code>, <code>VK_BUFFER_USAGE_TRANSFER_SRC_BIT</code> to the parameters of created buffer or image. </p>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a8af1210cf591784afa026d94998f735d"name="ggad9889c10c798b040d59c92f257cae597a8af1210cf591784afa026d94998f735d"></a>VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT </td><tdclass="fielddoc"><p>Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time. </p>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a0729e932b7ea170e3a128cad96c5cf6d"name="ggad9889c10c798b040d59c92f257cae597a0729e932b7ea170e3a128cad96c5cf6d"></a>VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT </td><tdclass="fielddoc"><p>Allocation strategy that chooses first suitable free range for the allocation - not necessarily in terms of the smallest offset but the one that is easiest and fastest to find to minimize allocation time, possibly at the expense of allocation quality. </p>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a839826775c62319466441f86496f036d"name="ggad9889c10c798b040d59c92f257cae597a839826775c62319466441f86496f036d"></a>VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT </td><tdclass="fielddoc"><p>Alias to <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a8af1210cf591784afa026d94998f735d">VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT</a>. </p>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a33eb2052674f3ad92386c714a65fb777"name="ggad9889c10c798b040d59c92f257cae597a33eb2052674f3ad92386c714a65fb777"></a>VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT </td><tdclass="fielddoc"><p>Alias to <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a0729e932b7ea170e3a128cad96c5cf6d">VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT</a>. </p>
<tr><tdclass="fieldname"><aid="ggad9889c10c798b040d59c92f257cae597a8e16845d81ae3d27c47106d4770d5c7e"name="ggad9889c10c798b040d59c92f257cae597a8e16845d81ae3d27c47106d4770d5c7e"></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>
<p>Flags to be used in <aclass="el"href="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"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="ggaa5846affa1e9da3800e3e78fae2305ccaf50d27e34e0925cf3a63db8c839121dd"name="ggaa5846affa1e9da3800e3e78fae2305ccaf50d27e34e0925cf3a63db8c839121dd"></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="ggaa5846affa1e9da3800e3e78fae2305cca40bdf4cddeffeb12f43d45ca1286e0a5"name="ggaa5846affa1e9da3800e3e78fae2305cca40bdf4cddeffeb12f43d45ca1286e0a5"></a>VMA_MEMORY_USAGE_CPU_ONLY </td><tdclass="fielddoc"><dlclass="deprecated"><dt><b><aclass="el"href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Obsolete, preserved for backward compatibility. Guarantees <code>VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT</code> and <code>VK_MEMORY_PROPERTY_HOST_COHERENT_BIT</code>. </dd></dl>
<tr><tdclass="fieldname"><aid="ggaa5846affa1e9da3800e3e78fae2305cca416a444d4d0fc20067c3f76f32ff2500"name="ggaa5846affa1e9da3800e3e78fae2305cca416a444d4d0fc20067c3f76f32ff2500"></a>VMA_MEMORY_USAGE_CPU_COPY </td><tdclass="fielddoc"><dlclass="deprecated"><dt><b><aclass="el"href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>Obsolete, preserved for backward compatibility. Prefers not <code>VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT</code>. </dd></dl>
<tr><tdclass="fieldname"><aid="ggaa5846affa1e9da3800e3e78fae2305cca835333d9072db63a653818030e17614d"name="ggaa5846affa1e9da3800e3e78fae2305cca835333d9072db63a653818030e17614d"></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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"title="Set this flag if the allocation should have its own memory block.">VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT</a>. </p>
<tr><tdclass="fieldname"><aid="ggaa5846affa1e9da3800e3e78fae2305cca27cde9026a84d34d525777baa41fce6e"name="ggaa5846affa1e9da3800e3e78fae2305cca27cde9026a84d34d525777baa41fce6e"></a>VMA_MEMORY_USAGE_AUTO </td><tdclass="fielddoc"><p>Selects best memory type automatically. This flag is recommended for most common use cases.</p>
<p>When using this flag, if you want to map the allocation (using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a>), you must pass one of the flags: <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a9be224df3bfc1cfa06203aed689a30c5">VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597add61238d98e20917b9a06c617763f492">VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT</a> in <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>.</p>
<p>It can be used only with functions that let the library know <code>VkBufferCreateInfo</code> or <code>VkImageCreateInfo</code>, e.g. <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>, <aclass="el"href="group__group__alloc.html#gae790ab9ffaf7667fb8f62523e6897888"title="Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.">vmaFindMemoryTypeIndexForBufferInfo()</a>, <aclass="el"href="group__group__alloc.html#ga088da83d8eaf3ce9056d9ea0b981d472"title="Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo.">vmaFindMemoryTypeIndexForImageInfo()</a> and not with generic memory allocation functions. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="ggaa5846affa1e9da3800e3e78fae2305ccae2adb696d6a73c18bb20c23666661327"name="ggaa5846affa1e9da3800e3e78fae2305ccae2adb696d6a73c18bb20c23666661327"></a>VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE </td><tdclass="fielddoc"><p>Selects best memory type automatically with preference for GPU (device) memory.</p>
<p>When using this flag, if you want to map the allocation (using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a>), you must pass one of the flags: <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a9be224df3bfc1cfa06203aed689a30c5">VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597add61238d98e20917b9a06c617763f492">VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT</a> in <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>.</p>
<p>It can be used only with functions that let the library know <code>VkBufferCreateInfo</code> or <code>VkImageCreateInfo</code>, e.g. <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>, <aclass="el"href="group__group__alloc.html#gae790ab9ffaf7667fb8f62523e6897888"title="Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.">vmaFindMemoryTypeIndexForBufferInfo()</a>, <aclass="el"href="group__group__alloc.html#ga088da83d8eaf3ce9056d9ea0b981d472"title="Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo.">vmaFindMemoryTypeIndexForImageInfo()</a> and not with generic memory allocation functions. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="ggaa5846affa1e9da3800e3e78fae2305cca9b422585242160b8ed3418310ee6664d"name="ggaa5846affa1e9da3800e3e78fae2305cca9b422585242160b8ed3418310ee6664d"></a>VMA_MEMORY_USAGE_AUTO_PREFER_HOST </td><tdclass="fielddoc"><p>Selects best memory type automatically with preference for CPU (host) memory.</p>
<p>When using this flag, if you want to map the allocation (using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a>), you must pass one of the flags: <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a9be224df3bfc1cfa06203aed689a30c5">VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT</a> or <aclass="el"href="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597add61238d98e20917b9a06c617763f492">VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT</a> in <aclass="el"href="struct_vma_allocation_create_info.html#add09658ac14fe290ace25470ddd6d41b"title="Use VmaAllocationCreateFlagBits enum.">VmaAllocationCreateInfo::flags</a>.</p>
<p>It can be used only with functions that let the library know <code>VkBufferCreateInfo</code> or <code>VkImageCreateInfo</code>, e.g. <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>, <aclass="el"href="group__group__alloc.html#gae790ab9ffaf7667fb8f62523e6897888"title="Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.">vmaFindMemoryTypeIndexForBufferInfo()</a>, <aclass="el"href="group__group__alloc.html#ga088da83d8eaf3ce9056d9ea0b981d472"title="Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo.">vmaFindMemoryTypeIndexForImageInfo()</a> and not with generic memory allocation functions. </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>
<tableclass="fieldtable">
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="gga9a7c45f9c863695d98c83fa5ac940fe7a9f1a499508a8edb4e8ba40aa0290a3d2"name="gga9a7c45f9c863695d98c83fa5ac940fe7a9f1a499508a8edb4e8ba40aa0290a3d2"></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="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>, <aclass="el"href="group__group__alloc.html#ga7fdf64415b6c3d83c454f28d2c53df7b">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="group__group__alloc.html#ga0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a> or <aclass="el"href="group__group__alloc.html#gabf28077dbf82d0908b8acbe8ee8dd9b8"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>
</td></tr>
<tr><tdclass="fieldname"><aid="gga9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"name="gga9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"></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>
<tr><tdclass="fieldname"><aid="gga9a7c45f9c863695d98c83fa5ac940fe7a97a0dc38e5161b780594d998d313d35e"name="gga9a7c45f9c863695d98c83fa5ac940fe7a97a0dc38e5161b780594d998d313d35e"></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>
</td></tr>
<tr><tdclass="fieldname"><aid="gga9a7c45f9c863695d98c83fa5ac940fe7a855ee6e02e46d835ee28c8cd596b7e32"name="gga9a7c45f9c863695d98c83fa5ac940fe7a855ee6e02e46d835ee28c8cd596b7e32"></a>VMA_POOL_CREATE_TLSF_ALGORITHM_BIT </td><tdclass="fielddoc"><p>Enables alternative, Two-Level Segregated Fit (TLSF) allocation algorithm in this pool. </p>
<p>This algorithm is based on 2-level lists dividing address space into smaller chunks. The first level is aligned to power of two which serves as buckets for requested memory to fall into, and the second level is lineary subdivided into lists of free memory. This algorithm aims to achieve bounded response time even in the worst case scenario. Allocation time can be sometimes slightly longer than compared to other algorithms but in return the application can avoid stalls in case of fragmentation, giving predictable results, suitable for real-time use cases. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="gga9a7c45f9c863695d98c83fa5ac940fe7af4d270f8f42517a0f70037ceb6ac1d9c"name="gga9a7c45f9c863695d98c83fa5ac940fe7af4d270f8f42517a0f70037ceb6ac1d9c"></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>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocation</td><td>Handle to allocated memory. </td></tr>
<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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a>.</td></tr>
</table>
</dd>
</dl>
<p>You should free the memory using <aclass="el"href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a> or <aclass="el"href="group__group__alloc.html#ga834b1e4aef395c0a1d56a28e69a4a17e"title="Frees memory and destroys multiple allocations.">vmaFreeMemoryPages()</a>.</p>
<p>It is recommended to use <aclass="el"href="group__group__alloc.html#ga7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a>, <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a> instead whenever possible. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocation</td><td>Handle to allocated memory. </td></tr>
<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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a>.</td></tr>
</table>
</dd>
</dl>
<p>You should free the memory using <aclass="el"href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f"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 allocation. </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>
</table>
</dd>
</dl>
<p>You should free the memory using <aclass="el"href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a> or <aclass="el"href="group__group__alloc.html#ga834b1e4aef395c0a1d56a28e69a4a17e"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="group__group__alloc.html#gabf28077dbf82d0908b8acbe8ee8dd9b8"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="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">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>
</table>
</dd>
</dl>
<p>This function is similar to <aclass="el"href="group__group__alloc.html#ga6b0929b914b60cf2d45cac4bf3547470"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="group__group__init.html#gga4f87c9100d154a65a4ad495f7763cf7ca8fb75bf07cd184ab903596295e863dee">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="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"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">image</td><td></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>
</table>
</dd>
</dl>
<p>This function is similar to <aclass="el"href="group__group__alloc.html#ga3d3ca45799923aa5d138e9e5f9eb2da5"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="group__group__init.html#gga4f87c9100d154a65a4ad495f7763cf7ca8fb75bf07cd184ab903596295e863dee">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="paramname">memoryTypeBits</td><td>Bit mask, where each bit set means that a memory type with that index should be checked.</td></tr>
</table>
</dd>
</dl>
<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>
<p>Possible return values:</p>
<ul>
<li><code>VK_ERROR_FEATURE_NOT_PRESENT</code> - corruption detection is not enabled for any of specified memory types.</li>
<li><code>VK_SUCCESS</code> - corruption detection has been performed and succeeded.</li>
<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>
<li>Other value: Error returned by Vulkan, e.g. memory mapping failure. </li>
<p>Checks magic number in margins around all allocations in given memory pool in search for corruptions. </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 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>
<p>Possible return values:</p>
<ul>
<li><code>VK_ERROR_FEATURE_NOT_PRESENT</code> - corruption detection is not enabled for specified pool.</li>
<li><code>VK_SUCCESS</code> - corruption detection has been performed and succeeded.</li>
<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>
<li>Other value: Error returned by Vulkan, e.g. memory mapping failure. </li>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pBuffer</td><td>Buffer that was created. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pAllocation</td><td>Allocation that was created. </td></tr>
<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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a>.</td></tr>
</table>
</dd>
</dl>
<p>This function automatically:</p>
<oltype="1">
<li>Creates buffer.</li>
<li>Allocates appropriate memory for it.</li>
<li>Binds the buffer with the memory.</li>
</ol>
<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="group__group__alloc.html#ga0d9f4e4ba5bf9aab1f1c746387753d77"title="Destroys Vulkan buffer and frees allocated memory.">vmaDestroyBuffer()</a> or separately, using <code>vkDestroyBuffer()</code> and <aclass="el"href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f"title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a>.</p>
<p>If <aclass="el"href="group__group__init.html#gga4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878"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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a89759603401014eb325eb22a3839f2ff"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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"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>Creates a buffer with additional minimum alignment. </p>
<p>Similar to <aclass="el"href="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">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>
<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>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd><code>VK_SUCCESS</code> if completed, negative error code in case of error.</dd></dl>
<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="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"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>
<ul>
<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="group__group__alloc.html#gga9a7c45f9c863695d98c83fa5ac940fe7a13c8a444197c67866be9cb05599fc726"title="Enables alternative, linear allocation algorithm in this pool.">VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT</a> or <aclass="el"href="group__group__alloc.html#gga9a7c45f9c863695d98c83fa5ac940fe7a97a0dc38e5161b780594d998d313d35e"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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a3fc311d855c2ff53f1090ef5c722b38f"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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"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>
</ul>
<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="group__group__alloc.html#ga8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a> to finish defragmentation. </td></tr>
</table>
</dd>
</dl>
<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="group__group__alloc.html#ga8774e20e91e245aae959ba63efa15dd2"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="group__group__alloc.html#ga9f0f8f56db5f7f57fe4454f465142dac"title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a>.</p>
<p>Warning! Between the call to <aclass="el"href="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a> and <aclass="el"href="group__group__alloc.html#ga8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a>:</p>
<ul>
<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="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</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="group__group__alloc.html#ga8774e20e91e245aae959ba63efa15dd2"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="group__group__alloc.html#ga8774e20e91e245aae959ba63efa15dd2"title="Ends defragmentation process.">vmaDefragmentationEnd()</a>.</li>
</ul>
<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="group__group__alloc.html#ga36ba776fd7fd5cb1e9359fdc0d8e6e8a"title="Begins defragmentation process.">vmaDefragmentationBegin()</a>. It is safe to pass <code>context == null</code>. The function then does nothing. </p>
<p>Helps to find memoryTypeIndex, given memoryTypeBits and <aclass="el"href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>. </p>
<p>This algorithm tries to find a memory type that:</p>
<ul>
<li>Is allowed by memoryTypeBits.</li>
<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. </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. </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>
<ul>
<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>
</ul>
<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>Flushes memory of given set of allocations. </p>
<p>Calls <code>vkFlushMappedMemoryRanges()</code> for memory associated with given ranges of given allocations. For more information, see documentation of <aclass="el"href="group__group__alloc.html#ga30c37c1eec6025f397be41644f48490f"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="group__group__alloc.html#gabf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, <aclass="el"href="group__group__alloc.html#ga7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, or <aclass="el"href="group__group__alloc.html#ga0faa3f9e5fb233d29d1e00390650febb"title="Function similar to vmaAllocateMemoryForBuffer().">vmaAllocateMemoryForImage()</a>. </p>
<p>Passing <code>VK_NULL_HANDLE</code> as <code>allocation</code> is valid. Such function call is just skipped. </p>
<p>Frees memory and destroys multiple allocations. </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="group__group__alloc.html#gabf28077dbf82d0908b8acbe8ee8dd9b8"title="General purpose memory allocation.">vmaAllocateMemory()</a>, <aclass="el"href="group__group__alloc.html#gad37e82e492b3de38fc3f4cffd9ad0ae1"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="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f"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>Returns current information about specified allocation. </p>
<p>Current paramteres of given allocation are returned in <code>pAllocationInfo</code>.</p>
<p>Although this function doesn't lock any mutex, so it should be quite efficient, you should avoid calling it too often. You can retrieve same <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="group__group__alloc.html#gac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <aclass="el"href="group__group__alloc.html#ga02a94f25679275851a53e82eacbcfc73"title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>. You can remember it if you are sure parameters don't change (e.g. due to defragmentation). </p>
<p>Given an allocation, returns Property Flags of its memory type. </p>
<p>This is just a convenience function. Same information can be obtained using <aclass="el"href="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b"title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a> + <aclass="el"href="group__group__init.html#gab88db292a17974f911182543fda52d19">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="group__group__alloc.html#gadbae3a0b4ab078024462fc85c37f3b58"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>
<ul>
<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>
</ul>
<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>Invalidates memory of given set of allocations. </p>
<p>Calls <code>vkInvalidateMappedMemoryRanges()</code> for memory associated with given ranges of given allocations. For more information, see documentation of <aclass="el"href="group__group__alloc.html#gaaa8412919139ef413a4215ac6a290fae"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>Maps memory represented by given allocation and returns pointer to it. </p>
<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.</p>
<dlclass="section warning"><dt>Warning</dt><dd>If the allocation is part of a bigger <code>VkDeviceMemory</code> block, returned pointer is correctly offsetted to the beginning of region assigned to this particular allocation. Unlike the result of <code>vkMapMemory</code>, it points to the allocation, not to the beginning of the whole block. You should not add <aclass="el"href="struct_vma_allocation_info.html#a4a3c732388dbdc7a23f9365b00825268"title="Offset in VkDeviceMemory object to the beginning of this allocation, in bytes. (deviceMemory,...">VmaAllocationInfo::offset</a> to it!</dd></dl>
<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="group__group__alloc.html#ga9bc268595cb33f6ec4d519cfce81ff45"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="group__group__alloc.html#ga9bc268595cb33f6ec4d519cfce81ff45"title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a> same number of times as you called <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"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="group__group__alloc.html#ga9bc268595cb33f6ec4d519cfce81ff45"title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a> same number of times as you called <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>. You must not call <aclass="el"href="group__group__alloc.html#ga9bc268595cb33f6ec4d519cfce81ff45"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="group__group__alloc.html#ggad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"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 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="group__group__alloc.html#gaaa8412919139ef413a4215ac6a290fae"title="Invalidates memory of given allocation.">vmaInvalidateAllocation()</a> / <aclass="el"href="group__group__alloc.html#ga30c37c1eec6025f397be41644f48490f"title="Flushes memory of given allocation.">vmaFlushAllocation()</a>, as required by Vulkan specification. </p>
<p>Sets pUserData in given allocation to new value. </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><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>Unmaps memory represented by given allocation, mapped previously using <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>. </p>
<p>For details, see description of <aclass="el"href="group__group__alloc.html#gad5bd1243512d099706de88168992f069"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="group__group__alloc.html#gaaa8412919139ef413a4215ac6a290fae"title="Invalidates memory of given allocation.">vmaInvalidateAllocation()</a> / <aclass="el"href="group__group__alloc.html#ga30c37c1eec6025f397be41644f48490f"title="Flushes memory of given allocation.">vmaFlushAllocation()</a>, as required by Vulkan specification. </p>
