VulkanMemoryAllocator/docs/html/struct_vma_allocation.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: VmaAllocation Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Vulkan Memory Allocator
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">VmaAllocation Struct Reference<div class="ingroups"><a class="el" href="group__group__alloc.html">Memory allocation</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Represents single memory allocation.  
 <a href="struct_vma_allocation.html#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents single memory allocation. </p>
<p>It may be either dedicated block of <code>VkDeviceMemory</code> or a specific region of a bigger block of this type plus unique offset.</p>
<p>There are multiple ways to create such object. You need to fill structure <a class="el" href="struct_vma_allocation_create_info.html" title="Parameters of new VmaAllocation.">VmaAllocationCreateInfo</a>. For more information see <a class="el" href="choosing_memory_type.html">Choosing memory type</a>.</p>
<p>Although the library provides convenience functions that create Vulkan buffer or image, allocate memory for it and bind them together, binding of the allocation to a buffer or an image is out of scope of the allocation itself. Allocation object can exist without buffer/image bound, binding can be done manually by the user, and destruction of it can be done independently of destruction of the allocation.</p>
<p>The object also remembers its size and some other information. To retrieve this information, use function <a class="el" href="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b" title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a> and inspect returned structure <a class="el" href="struct_vma_allocation_info.html" title="Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().">VmaAllocationInfo</a>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>D:/PROJECTS/Vulkan Memory Allocator/REPO/include/<a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Updated documentation - added information about VK_AMD_memory_allocation_behavior extension. Regenerated documentation, using new Doxygen version. 2019-01-15 10:45:58 +00:00			`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">`
Minor fix in documentation Regenerated the documentation using Doxygen 1.9.5. 2022-11-04 16:02:24 +00:00			`<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<head>`
			`<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`<meta http-equiv="X-UA-Compatible" content="IE=11"/>`
Updated Doxyfile for Doxygen 1.9.6 Regenerated documentation. Fixes #335 2023-05-02 10:44:06 +00:00			`<meta name="generator" content="Doxygen 1.9.6"/>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<meta name="viewport" content="width=device-width, initial-scale=1"/>`
			`<title>Vulkan Memory Allocator: VmaAllocation Struct Reference</title>`
			`<link href="tabs.css" rel="stylesheet" type="text/css"/>`
			`<script type="text/javascript" src="jquery.js"></script>`
			`<script type="text/javascript" src="dynsections.js"></script>`
			`<link href="search/search.css" rel="stylesheet" type="text/css"/>`
			`<script type="text/javascript" src="search/searchdata.js"></script>`
			`<script type="text/javascript" src="search/search.js"></script>`
			`<link href="doxygen.css" rel="stylesheet" type="text/css" />`
			`</head>`
			`<body>`
			`<div id="top"><!-- do not remove this div, it is closed by doxygen! -->`
			`<div id="titlearea">`
			`<table cellspacing="0" cellpadding="0">`
			`<tbody>`
Small but important fix in the documentation 2022-03-14 17:05:55 +00:00			`<tr id="projectrow">`
			`<td id="projectalign">`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<div id="projectname">Vulkan Memory Allocator`
			`</div>`
			`</td>`
			`</tr>`
			`</tbody>`
			`</table>`
			`</div>`
			`<!-- end header part -->`
Updated Doxyfile for Doxygen 1.9.6 Regenerated documentation. Fixes #335 2023-05-02 10:44:06 +00:00			`<!-- Generated by Doxygen 1.9.6 -->`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<script type="text/javascript">`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */`
Minor fix in documentation Regenerated the documentation using Doxygen 1.9.5. 2022-11-04 16:02:24 +00:00			`var searchBox = new SearchBox("searchBox", "search/",'.html');`
Prepared version 2.1.0 final. Rebuilt binaries. Updated CHANGELOG.md. Rebuilt Doxygen dovcumentation (with new Doxygen version). 2018-09-10 09:14:05 +00:00			`/* @license-end */`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</script>`
			`<script type="text/javascript" src="menudata.js"></script>`
			`<script type="text/javascript" src="menu.js"></script>`
			`<script type="text/javascript">`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`$(function() {`
			`initMenu('',true,false,'search.php','Search');`
			`$(document).ready(function() { init_search(); });`
			`});`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`/* @license-end */`
			`</script>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<div id="main-nav"></div>`
			`<!-- window showing the filter options -->`
			`<div id="MSearchSelectWindow"`
			`onmouseover="return searchBox.OnSearchSelectShow()"`
			`onmouseout="return searchBox.OnSearchSelectHide()"`
			`onkeydown="return searchBox.OnSearchSelectKey(event)">`
			`</div>`

			`<!-- iframe showing the search results (closed by default) -->`
			`<div id="MSearchResultsWindow">`
Minor fix in documentation Regenerated the documentation using Doxygen 1.9.5. 2022-11-04 16:02:24 +00:00			`<div id="MSearchResults">`
			`<div class="SRPage">`
			`<div id="SRIndex">`
			`<div id="SRResults"></div>`
			`<div class="SRStatus" id="Loading">Loading...</div>`
			`<div class="SRStatus" id="Searching">Searching...</div>`
			`<div class="SRStatus" id="NoMatches">No Matches</div>`
			`</div>`
			`</div>`
			`</div>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</div>`

			`</div><!-- top -->`
			`<div class="header">`
Refactored virtual allocator. (COMPATIBILITY BREAKING!) Added TLSF algoritym. Refactored virtual allocator: Added type VmaVirtualAllocation, member VmaVirtualAllocationInfo::offset, changed parameters of vmaVirtualAllocate, vmaVirtualFree, vmaSetVirtualAllocationUserData, vmaGetVirtualAllocationInfo. Added TLSF algorithm: Added VMA_POOL_CREATE_TLSF_ALGORITHM_BIT, VMA_VIRTUAL_BLOCK_CREATE_TLSF_ALGORITHM_BIT. Some internal refactoring. Improved documentation: Grouped API elements into Doxygen modules. Code mostly by @medranSolus. 2022-01-20 16:00:33 +00:00			`<div class="headertitle"><div class="title">VmaAllocation Struct Reference<div class="ingroups"><a class="el" href="group__group__alloc.html">Memory allocation</a></div></div></div>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</div><!--header-->`
			`<div class="contents">`

			`<p>Represents single memory allocation.`
			`<a href="struct_vma_allocation.html#details">More...</a></p>`
			`<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>`
Updated Doxyfile for Doxygen 1.9.6 Regenerated documentation. Fixes #335 2023-05-02 10:44:06 +00:00			`<div class="textblock"><p>Represents single memory allocation. </p>`
			`<p>It may be either dedicated block of <code>VkDeviceMemory</code> or a specific region of a bigger block of this type plus unique offset.</p>`
			`<p>There are multiple ways to create such object. You need to fill structure <a class="el" href="struct_vma_allocation_create_info.html" title="Parameters of new VmaAllocation.">VmaAllocationCreateInfo</a>. For more information see <a class="el" href="choosing_memory_type.html">Choosing memory type</a>.</p>`
			`<p>Although the library provides convenience functions that create Vulkan buffer or image, allocate memory for it and bind them together, binding of the allocation to a buffer or an image is out of scope of the allocation itself. Allocation object can exist without buffer/image bound, binding can be done manually by the user, and destruction of it can be done independently of destruction of the allocation.</p>`
			`<p>The object also remembers its size and some other information. To retrieve this information, use function <a class="el" href="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b" title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a> and inspect returned structure <a class="el" href="struct_vma_allocation_info.html" title="Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().">VmaAllocationInfo</a>. </p>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</div><hr/>The documentation for this struct was generated from the following file:<ul>`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`<li>D:/PROJECTS/Vulkan Memory Allocator/REPO/include/<a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></li>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</ul>`
			`</div><!-- contents -->`
			`<!-- start footer part -->`
			`<hr class="footer"/><address class="footer"><small>`
Updated Doxyfile for Doxygen 1.9.6 Regenerated documentation. Fixes #335 2023-05-02 10:44:06 +00:00			`Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</small></address>`
			`</body>`
			`</html>`