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">
<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.2"/>
<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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Vulkan Memory Allocator
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">VmaAllocation Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Represents single memory allocation.  
 <a href="struct_vma_allocation.html#details">More...</a></p>

<p><code>#include &lt;vk_mem_alloc.h&gt;</code></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">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="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b" 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.2
</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">`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<html xmlns="http://www.w3.org/1999/xhtml">`
			`<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"/>`
			`<meta name="generator" content="Doxygen 1.9.2"/>`
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>`
			`<tr style="height: 56px;">`
			`<td id="projectalign" style="padding-left: 0.5em;">`
			`<div id="projectname">Vulkan Memory Allocator`
			`</div>`
			`</td>`
			`</tr>`
			`</tbody>`
			`</table>`
			`</div>`
			`<!-- end header part -->`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`<!-- Generated by Doxygen 1.9.2 -->`
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 */`
			`var searchBox = new SearchBox("searchBox", "search",'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">`
			`<iframe src="javascript:void(0)" frameborder="0"`
			`name="MSearchResults" id="MSearchResults">`
			`</iframe>`
			`</div>`

			`</div><!-- top -->`
			`<div class="header">`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +00:00			`<div class="headertitle"><div class="title">VmaAllocation Struct Reference</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>`

Moved main documentation text from the beginning to the end of file Disabled VERBATIM_HEADERS in Doxyfile. Regenerated the docs. 2021-07-28 12:57:39 +00:00			`<p><code>#include <vk_mem_alloc.h></code></p>`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +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">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>`
Deleted the whole Record&Replay feature. COMPATIBILITY BREAKING! Removed from the API: VmaAllocatorCreateInfo::pRecordSettings, VmaRecordSettings, VmaRecordFlagBits, VmaRecordFlags. Regenerated documentation. Updated README. 2022-01-10 17:11:09 +00:00			`<p >The object also remembers its size and some other information. To retrieve this information, use function <a class="el" href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b" 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>`
Fixes in comments Regenerated documentation. 2021-10-18 15:32:40 +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.2`
Documented VmaAllocator, VmaAllocation, VmaPool. 2018-03-12 15:33:53 +00:00			`</small></address>`
			`</body>`
			`</html>`