<p>API elements related to the mechanism of <aclass="el"href="virtual_allocator.html">Virtual allocator</a> - using the core allocation algorithm for user-defined purpose without allocating any real GPU memory.
<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="#gab585754076877265fdae33e5c40ef13b"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="#ga6b7cdcc1c3e5103c323fedc4e1319e01"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="#ga8ee14ceb1fe033ec84d8aa29e1f75afa"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:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Represents single memory allocation done inside <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="struct_vma_virtual_allocation.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory. <ahref="struct_vma_virtual_block.html#details">More...</a><br/></td></tr>
<trclass="memdesc:ga0860ba1c0a67178fae4aecb63a78573e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#aaab9bf7e2d228c02ab6d90a72a6e6912"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. <br/></td></tr>
<trclass="memdesc:ga4e49c2f0ab7f6b4868833e5bac78d91e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#aaab9bf7e2d228c02ab6d90a72a6e6912"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. See <aclass="el"href="#ga88bcf8c1cd3bb1610ff7343811c65bca"title="Flags to be passed as VmaVirtualBlockCreateInfo::flags.">VmaVirtualBlockCreateFlagBits</a>. <br/></td></tr>
<trclass="memdesc:ga936815e64946a6b6d812d08d10184c23"><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>. <br/></td></tr>
<trclass="memdesc:gae96ffc099bf898257fb19e9410ed08a7"><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="#ga2e9c64d405b14156fea7e10c4ad06cb6"title="Flags to be passed as VmaVirtualAllocationCreateInfo::flags.">VmaVirtualAllocationCreateFlagBits</a>. <br/></td></tr>
<trclass="memdesc:ga4753d42d40217a3a652a3cdf253ad773"><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="#gab585754076877265fdae33e5c40ef13b"title="Creates new VmaVirtualBlock object.">vmaCreateVirtualBlock()</a>. <br/></td></tr>
<trclass="memdesc:gac3c90d80bedc6847a41b82d0e2158c9e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of created virtual allocation to be passed to <aclass="el"href="#ga6b7cdcc1c3e5103c323fedc4e1319e01"title="Allocates new virtual allocation inside given VmaVirtualBlock.">vmaVirtualAllocate()</a>. <br/></td></tr>
<trclass="memdesc:ga75bc33ff7cf18c98e101f570dc2a5ebc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parameters of an existing virtual allocation, returned by <aclass="el"href="#ga8ee14ceb1fe033ec84d8aa29e1f75afa"title="Returns information about a specific virtual allocation within a virtual block, like its size and pUs...">vmaGetVirtualAllocationInfo()</a>. <br/></td></tr>
<trclass="memdesc:ga88bcf8c1cd3bb1610ff7343811c65bca"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#aaab9bf7e2d228c02ab6d90a72a6e6912"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. <ahref="#ga88bcf8c1cd3bb1610ff7343811c65bca">More...</a><br/></td></tr>
<trclass="memdesc:ga2e9c64d405b14156fea7e10c4ad06cb6"><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="#ga2e9c64d405b14156fea7e10c4ad06cb6">More...</a><br/></td></tr>
<trclass="memdesc:gab585754076877265fdae33e5c40ef13b"><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. <br/></td></tr>
<trclass="memdesc:ga3795f7783ae2c182cede067d656f66a5"><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. <br/></td></tr>
<trclass="memdesc:gacd53b5b1d23f8fcbad692ccfdc1811f1"><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. <br/></td></tr>
<trclass="memdesc:ga8ee14ceb1fe033ec84d8aa29e1f75afa"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns information about a specific virtual allocation within a virtual block, like its size and <code>pUserData</code> pointer. <br/></td></tr>
<trclass="memdesc:ga6b7cdcc1c3e5103c323fedc4e1319e01"><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>. <br/></td></tr>
<trclass="memdesc:ga09fc688c0c3653ff23723b037e5d5033"><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>. <br/></td></tr>
<trclass="memdesc:ga5eda6f55919fb05bd2f56a112590c571"><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>. <br/></td></tr>
<trclass="memdesc:ga001ea1850458a4062b829e09c303fca2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Changes custom pointer associated with given virtual allocation. <br/></td></tr>
<trclass="memdesc:ga2902aa3130866afcc64bb5f984113db3"><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>. <br/></td></tr>
<trclass="memdesc:ga93c5741bca44b43e5b849cacbd616098"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calculates and returns detailed 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>. <br/></td></tr>
<p>API elements related to the mechanism of <aclass="el"href="virtual_allocator.html">Virtual allocator</a> - using the core allocation algorithm for user-defined purpose without allocating any real GPU memory. </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="#ga2e9c64d405b14156fea7e10c4ad06cb6"title="Flags to be passed as VmaVirtualAllocationCreateInfo::flags.">VmaVirtualAllocationCreateFlagBits</a>. </p>
<p>Parameters of created virtual allocation to be passed to <aclass="el"href="#ga6b7cdcc1c3e5103c323fedc4e1319e01"title="Allocates new virtual allocation inside given VmaVirtualBlock.">vmaVirtualAllocate()</a>. </p>
<p>Parameters of an existing virtual allocation, returned by <aclass="el"href="#ga8ee14ceb1fe033ec84d8aa29e1f75afa"title="Returns information about a specific virtual allocation within a virtual block, like its size and pUs...">vmaGetVirtualAllocationInfo()</a>. </p>
<p>Flags to be passed as <aclass="el"href="struct_vma_virtual_block_create_info.html#aaab9bf7e2d228c02ab6d90a72a6e6912"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#aaab9bf7e2d228c02ab6d90a72a6e6912"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. See <aclass="el"href="#ga88bcf8c1cd3bb1610ff7343811c65bca"title="Flags to be passed as VmaVirtualBlockCreateInfo::flags.">VmaVirtualBlockCreateFlagBits</a>. </p>
<p>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="#gab585754076877265fdae33e5c40ef13b"title="Creates new VmaVirtualBlock object.">vmaCreateVirtualBlock()</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>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="gga2e9c64d405b14156fea7e10c4ad06cb6a9524a329a55b5ec390d57d90b67ad78e"name="gga2e9c64d405b14156fea7e10c4ad06cb6a9524a329a55b5ec390d57d90b67ad78e"></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="#gga88bcf8c1cd3bb1610ff7343811c65bcaae6423e2fa2f3c9211b21c819e3f10f96"title="Enables alternative, linear allocation algorithm in this virtual block.">VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT</a> flag. </p>
<tr><tdclass="fieldname"><aid="gga2e9c64d405b14156fea7e10c4ad06cb6ae2a9591a62b5e3b1bdcbc81c6188a1bf"name="gga2e9c64d405b14156fea7e10c4ad06cb6ae2a9591a62b5e3b1bdcbc81c6188a1bf"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize memory usage. </p>
<tr><tdclass="fieldname"><aid="gga2e9c64d405b14156fea7e10c4ad06cb6a562d10a46012719d33167d3dc5dbbf9b"name="gga2e9c64d405b14156fea7e10c4ad06cb6a562d10a46012719d33167d3dc5dbbf9b"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT </td><tdclass="fielddoc"><p>Allocation strategy that tries to minimize allocation time. </p>
<tr><tdclass="fieldname"><aid="gga2e9c64d405b14156fea7e10c4ad06cb6a3bb82d2aedd587a64846a1d7778852e6"name="gga2e9c64d405b14156fea7e10c4ad06cb6a3bb82d2aedd587a64846a1d7778852e6"></a>VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT </td><tdclass="fielddoc"><p>Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data. </p>
<tr><tdclass="fieldname"><aid="gga2e9c64d405b14156fea7e10c4ad06cb6ac5b5e45c335368d18df59c9f27df17e3"name="gga2e9c64d405b14156fea7e10c4ad06cb6ac5b5e45c335368d18df59c9f27df17e3"></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 strategy flags are binary compatible with equivalent flags in <aclass="el"href="group__group__alloc.html#gad9889c10c798b040d59c92f257cae597"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#aaab9bf7e2d228c02ab6d90a72a6e6912"title="Use combination of VmaVirtualBlockCreateFlagBits.">VmaVirtualBlockCreateInfo::flags</a>. </p>
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="gga88bcf8c1cd3bb1610ff7343811c65bcaae6423e2fa2f3c9211b21c819e3f10f96"name="gga88bcf8c1cd3bb1610ff7343811c65bcaae6423e2fa2f3c9211b21c819e3f10f96"></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>
<tr><tdclass="fieldname"><aid="gga88bcf8c1cd3bb1610ff7343811c65bcaaf9487467136e1a9e371894dc3a7c4844"name="gga88bcf8c1cd3bb1610ff7343811c65bcaaf9487467136e1a9e371894dc3a7c4844"></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>
<p>Calculates and returns detailed 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>This function is slow to call. Use for debugging purposes. For less detailed statistics, see <aclass="el"href="#ga2902aa3130866afcc64bb5f984113db3"title="Calculates and returns statistics about virtual allocations and memory usage in given VmaVirtualBlock...">vmaGetVirtualBlockStatistics()</a>. </p>
<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="#ga09fc688c0c3653ff23723b037e5d5033"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>
<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>
<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="#ga09fc688c0c3653ff23723b037e5d5033"title="Frees virtual allocation inside given VmaVirtualBlock.">vmaVirtualFree()</a> or call <aclass="el"href="#ga5eda6f55919fb05bd2f56a112590c571"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>
<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>This function is fast to call. For more detailed statistics, see <aclass="el"href="#ga93c5741bca44b43e5b849cacbd616098"title="Calculates and returns detailed statistics about virtual allocations and memory usage in given VmaVir...">vmaCalculateVirtualBlockStatistics()</a>. </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>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>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). <code>pAllocation</code> is then set to <code>VK_NULL_HANDLE</code> and <code>pOffset</code>, if not null, it set to <code>UINT64_MAX</code>.</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>