mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-26 08:34:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
48b8a33869
VulkanMemoryAllocator/docs/html/struct_vma_allocation_info.html

218 lines
14 KiB
HTML
Raw Normal View History

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">
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<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=9"/>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<meta name="generator" content="Doxygen 1.8.16"/>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: VmaAllocationInfo 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 and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<!-- Generated by Doxygen 1.8.16 -->
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<script type="text/javascript">
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 magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
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 */
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
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 magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
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 */</script>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +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">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_vma_allocation_info-members.html">List of all members</a> </div>
<div class="headertitle">
Reorganized Doxygen documentation into more separate pages.
2017-10-17 09:27:14 +00:00
<div class="title">VmaAllocationInfo Struct Reference</div> </div>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div><!--header-->
<div class="contents">
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<p>Parameters of <a class="el" href="struct_vma_allocation.html" title="Represents single memory allocation.">VmaAllocation</a> objects, that can be retrieved using function <a class="el" href="vk__mem__alloc_8h.html#ae10b53588f197141c6e88a1f5ec34789" title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>.
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<a href="struct_vma_allocation_info.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vk__mem__alloc_8h_source.html">vk_mem_alloc.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7f6b0aa58c135e488e6b40a388dad9d5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_allocation_info.html#a7f6b0aa58c135e488e6b40a388dad9d5">memoryType</a></td></tr>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<tr class="memdesc:a7f6b0aa58c135e488e6b40a388dad9d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory type index that this allocation was allocated from. <a href="struct_vma_allocation_info.html#a7f6b0aa58c135e488e6b40a388dad9d5">More...</a><br /></td></tr>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<tr class="separator:a7f6b0aa58c135e488e6b40a388dad9d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0bfb7dfdf79a76ffefc9a94677a2f67"><td class="memItemLeft" align="right" valign="top">VkDeviceMemory&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_allocation_info.html#ae0bfb7dfdf79a76ffefc9a94677a2f67">deviceMemory</a></td></tr>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<tr class="memdesc:ae0bfb7dfdf79a76ffefc9a94677a2f67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle to Vulkan memory object. <a href="struct_vma_allocation_info.html#ae0bfb7dfdf79a76ffefc9a94677a2f67">More...</a><br /></td></tr>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<tr class="separator:ae0bfb7dfdf79a76ffefc9a94677a2f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a3c732388dbdc7a23f9365b00825268"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_allocation_info.html#a4a3c732388dbdc7a23f9365b00825268">offset</a></td></tr>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<tr class="memdesc:a4a3c732388dbdc7a23f9365b00825268"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset into deviceMemory object to the beginning of this allocation, in bytes. (deviceMemory, offset) pair is unique to this allocation. <a href="struct_vma_allocation_info.html#a4a3c732388dbdc7a23f9365b00825268">More...</a><br /></td></tr>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<tr class="separator:a4a3c732388dbdc7a23f9365b00825268"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac76d113a6a5ccbb09fea00fb25fd18f"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_allocation_info.html#aac76d113a6a5ccbb09fea00fb25fd18f">size</a></td></tr>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<tr class="memdesc:aac76d113a6a5ccbb09fea00fb25fd18f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of this allocation, in bytes. <a href="struct_vma_allocation_info.html#aac76d113a6a5ccbb09fea00fb25fd18f">More...</a><br /></td></tr>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<tr class="separator:aac76d113a6a5ccbb09fea00fb25fd18f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5eeffbe2d2f30f53370ff14aefbadbe2"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_allocation_info.html#a5eeffbe2d2f30f53370ff14aefbadbe2">pMappedData</a></td></tr>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<tr class="memdesc:a5eeffbe2d2f30f53370ff14aefbadbe2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the beginning of this allocation as mapped data. <a href="struct_vma_allocation_info.html#a5eeffbe2d2f30f53370ff14aefbadbe2">More...</a><br /></td></tr>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<tr class="separator:a5eeffbe2d2f30f53370ff14aefbadbe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc507656149c04de7ed95d0042ba2a13"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_allocation_info.html#adc507656149c04de7ed95d0042ba2a13">pUserData</a></td></tr>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<tr class="memdesc:adc507656149c04de7ed95d0042ba2a13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom general-purpose pointer that was passed as <a class="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> or set using <a class="el" href="vk__mem__alloc_8h.html#a402558851f800ecd733800962c227f6a" title="Sets pUserData in given allocation to new value.">vmaSetAllocationUserData()</a>. <a href="struct_vma_allocation_info.html#adc507656149c04de7ed95d0042ba2a13">More...</a><br /></td></tr>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<tr class="separator:adc507656149c04de7ed95d0042ba2a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<div class="textblock"><p>Parameters of <a class="el" href="struct_vma_allocation.html" title="Represents single memory allocation.">VmaAllocation</a> objects, that can be retrieved using function <a class="el" href="vk__mem__alloc_8h.html#ae10b53588f197141c6e88a1f5ec34789" title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a>. </p>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0bfb7dfdf79a76ffefc9a94677a2f67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0bfb7dfdf79a76ffefc9a94677a2f67">&#9670;&nbsp;</a></span>deviceMemory</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceMemory VmaAllocationInfo::deviceMemory</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle to Vulkan memory object. </p>
<p>Same memory object can be shared by multiple allocations.</p>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<p>It can change after call to <a class="el" href="vk__mem__alloc_8h.html#a2c33b164a2597db181db3ca8e5812e4c" title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a> if this allocation is passed to the function, or if allocation is lost.</p>
Version 2.0.0-alpha.3 - major update.
2017-09-12 18:45:14 +00:00
<p>If the allocation is lost, it is equal to <code>VK_NULL_HANDLE</code>. </p>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div>
</div>
<a id="a7f6b0aa58c135e488e6b40a388dad9d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f6b0aa58c135e488e6b40a388dad9d5">&#9670;&nbsp;</a></span>memoryType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaAllocationInfo::memoryType</td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory type index that this allocation was allocated from. </p>
<p>It never changes. </p>
</div>
</div>
<a id="a4a3c732388dbdc7a23f9365b00825268"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a3c732388dbdc7a23f9365b00825268">&#9670;&nbsp;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaAllocationInfo::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Offset into deviceMemory object to the beginning of this allocation, in bytes. (deviceMemory, offset) pair is unique to this allocation. </p>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<p>It can change after call to <a class="el" href="vk__mem__alloc_8h.html#a2c33b164a2597db181db3ca8e5812e4c" title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a> if this allocation is passed to the function, or if allocation is lost. </p>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div>
</div>
<a id="a5eeffbe2d2f30f53370ff14aefbadbe2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5eeffbe2d2f30f53370ff14aefbadbe2">&#9670;&nbsp;</a></span>pMappedData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* VmaAllocationInfo::pMappedData</td>
</tr>
</table>
</div><div class="memdoc">
Version 2.0.0-alpha.5. Major change in memory mapping - now it's internally reference-counted. Renamed flag VMA_ALLOCATION_CREATE_PERSISTENT_MAP_BIT to VMA_ALLOCATION_CREATE_MAPPED_BIT. See documentation of vmaMapMemory().
2017-11-08 11:52:05 +00:00
<p>Pointer to the beginning of this allocation as mapped data. </p>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<p>If the allocation hasn't been mapped using <a class="el" href="vk__mem__alloc_8h.html#ae98119383e8e5754b6c09679386677d3" title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a> and hasn't been created with <a class="el" href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f" title="Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.">VMA_ALLOCATION_CREATE_MAPPED_BIT</a> flag, this value null.</p>
<p>It can change after call to <a class="el" href="vk__mem__alloc_8h.html#ae98119383e8e5754b6c09679386677d3" title="Maps memory represented by given allocation and returns pointer to it.">vmaMapMemory()</a>, <a class="el" href="vk__mem__alloc_8h.html#a3128786cae5f317f51307074a487c278" title="Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().">vmaUnmapMemory()</a>. It can also change after call to <a class="el" href="vk__mem__alloc_8h.html#a2c33b164a2597db181db3ca8e5812e4c" title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a> if this allocation is passed to the function. </p>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div>
</div>
<a id="adc507656149c04de7ed95d0042ba2a13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc507656149c04de7ed95d0042ba2a13">&#9670;&nbsp;</a></span>pUserData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* VmaAllocationInfo::pUserData</td>
</tr>
</table>
</div><div class="memdoc">
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<p>Custom general-purpose pointer that was passed as <a class="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> or set using <a class="el" href="vk__mem__alloc_8h.html#a402558851f800ecd733800962c227f6a" title="Sets pUserData in given allocation to new value.">vmaSetAllocationUserData()</a>. </p>
<p>It can change after call to <a class="el" href="vk__mem__alloc_8h.html#a402558851f800ecd733800962c227f6a" title="Sets pUserData in given allocation to new value.">vmaSetAllocationUserData()</a> for this allocation. </p>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div>
</div>
<a id="aac76d113a6a5ccbb09fea00fb25fd18f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac76d113a6a5ccbb09fea00fb25fd18f">&#9670;&nbsp;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaAllocationInfo::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of this allocation, in bytes. </p>
Version 2.0.0-alpha.3 - major update.
2017-09-12 18:45:14 +00:00
<p>It never changes, unless allocation is lost. </p>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="vk__mem__alloc_8h_source.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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
</a> 1.8.16
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink