1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.17"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>Vulkan Memory Allocator: Vulkan Memory Allocator</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="search/search.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="search/searchdata.js"></script> 14<script type="text/javascript" src="search/search.js"></script> 15<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16</head> 17<body> 18<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19<div id="titlearea"> 20<table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectalign" style="padding-left: 0.5em;"> 24 <div id="projectname">Vulkan Memory Allocator 25 </div> 26 </td> 27 </tr> 28 </tbody> 29</table> 30</div> 31<!-- end header part --> 32<!-- Generated by Doxygen 1.8.17 --> 33<script type="text/javascript"> 34/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 35var searchBox = new SearchBox("searchBox", "search",false,'Search'); 36/* @license-end */ 37</script> 38<script type="text/javascript" src="menudata.js"></script> 39<script type="text/javascript" src="menu.js"></script> 40<script type="text/javascript"> 41/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 42$(function() { 43 initMenu('',true,false,'search.php','Search'); 44 $(document).ready(function() { init_search(); }); 45}); 46/* @license-end */</script> 47<div id="main-nav"></div> 48</div><!-- top --> 49<!-- window showing the filter options --> 50<div id="MSearchSelectWindow" 51 onmouseover="return searchBox.OnSearchSelectShow()" 52 onmouseout="return searchBox.OnSearchSelectHide()" 53 onkeydown="return searchBox.OnSearchSelectKey(event)"> 54</div> 55 56<!-- iframe showing the search results (closed by default) --> 57<div id="MSearchResultsWindow"> 58<iframe src="javascript:void(0)" frameborder="0" 59 name="MSearchResults" id="MSearchResults"> 60</iframe> 61</div> 62 63<div class="PageDoc"><div class="header"> 64 <div class="headertitle"> 65<div class="title">Vulkan Memory Allocator </div> </div> 66</div><!--header--> 67<div class="contents"> 68<div class="textblock"><p><b>Version 3.0.0-development</b> (2020-03-23)</p> 69<p>Copyright (c) 2017-2020 Advanced Micro Devices, Inc. All rights reserved. <br /> 70License: MIT</p> 71<p>Documentation of all members: <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></p> 72<h1><a class="anchor" id="main_table_of_contents"></a> 73Table of contents</h1> 74<ul> 75<li><b>User guide</b><ul> 76<li><a class="el" href="quick_start.html">Quick start</a><ul> 77<li><a class="el" href="quick_start.html#quick_start_project_setup">Project setup</a></li> 78<li><a class="el" href="quick_start.html#quick_start_initialization">Initialization</a></li> 79<li><a class="el" href="quick_start.html#quick_start_resource_allocation">Resource allocation</a></li> 80</ul> 81</li> 82<li><a class="el" href="choosing_memory_type.html">Choosing memory type</a><ul> 83<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_usage">Usage</a></li> 84<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_required_preferred_flags">Required and preferred flags</a></li> 85<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_explicit_memory_types">Explicit memory types</a></li> 86<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_custom_memory_pools">Custom memory pools</a></li> 87<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_dedicated_allocations">Dedicated allocations</a></li> 88</ul> 89</li> 90<li><a class="el" href="memory_mapping.html">Memory mapping</a><ul> 91<li><a class="el" href="memory_mapping.html#memory_mapping_mapping_functions">Mapping functions</a></li> 92<li><a class="el" href="memory_mapping.html#memory_mapping_persistently_mapped_memory">Persistently mapped memory</a></li> 93<li><a class="el" href="memory_mapping.html#memory_mapping_cache_control">Cache flush and invalidate</a></li> 94<li><a class="el" href="memory_mapping.html#memory_mapping_finding_if_memory_mappable">Finding out if memory is mappable</a></li> 95</ul> 96</li> 97<li><a class="el" href="staying_within_budget.html">Staying within budget</a><ul> 98<li><a class="el" href="staying_within_budget.html#staying_within_budget_querying_for_budget">Querying for budget</a></li> 99<li><a class="el" href="staying_within_budget.html#staying_within_budget_controlling_memory_usage">Controlling memory usage</a></li> 100</ul> 101</li> 102<li><a class="el" href="custom_memory_pools.html">Custom memory pools</a><ul> 103<li><a class="el" href="custom_memory_pools.html#custom_memory_pools_MemTypeIndex">Choosing memory type index</a></li> 104<li><a class="el" href="custom_memory_pools.html#linear_algorithm">Linear allocation algorithm</a><ul> 105<li><a class="el" href="custom_memory_pools.html#linear_algorithm_free_at_once">Free-at-once</a></li> 106<li><a class="el" href="custom_memory_pools.html#linear_algorithm_stack">Stack</a></li> 107<li><a class="el" href="custom_memory_pools.html#linear_algorithm_double_stack">Double stack</a></li> 108<li><a class="el" href="custom_memory_pools.html#linear_algorithm_ring_buffer">Ring buffer</a></li> 109</ul> 110</li> 111<li><a class="el" href="custom_memory_pools.html#buddy_algorithm">Buddy allocation algorithm</a></li> 112</ul> 113</li> 114<li><a class="el" href="defragmentation.html">Defragmentation</a><ul> 115<li><a class="el" href="defragmentation.html#defragmentation_cpu">Defragmenting CPU memory</a></li> 116<li><a class="el" href="defragmentation.html#defragmentation_gpu">Defragmenting GPU memory</a></li> 117<li><a class="el" href="defragmentation.html#defragmentation_additional_notes">Additional notes</a></li> 118<li><a class="el" href="defragmentation.html#defragmentation_custom_algorithm">Writing custom allocation algorithm</a></li> 119</ul> 120</li> 121<li><a class="el" href="lost_allocations.html">Lost allocations</a></li> 122<li><a class="el" href="statistics.html">Statistics</a><ul> 123<li><a class="el" href="statistics.html#statistics_numeric_statistics">Numeric statistics</a></li> 124<li><a class="el" href="statistics.html#statistics_json_dump">JSON dump</a></li> 125</ul> 126</li> 127<li><a class="el" href="allocation_annotation.html">Allocation names and user data</a><ul> 128<li><a class="el" href="allocation_annotation.html#allocation_user_data">Allocation user data</a></li> 129<li><a class="el" href="allocation_annotation.html#allocation_names">Allocation names</a></li> 130</ul> 131</li> 132<li><a class="el" href="debugging_memory_usage.html">Debugging incorrect memory usage</a><ul> 133<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_initialization">Memory initialization</a></li> 134<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_margins">Margins</a></li> 135<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_corruption_detection">Corruption detection</a></li> 136</ul> 137</li> 138<li><a class="el" href="record_and_replay.html">Record and replay</a></li> 139</ul> 140</li> 141<li><a class="el" href="usage_patterns.html">Recommended usage patterns</a><ul> 142<li><a class="el" href="usage_patterns.html#usage_patterns_common_mistakes">Common mistakes</a></li> 143<li><a class="el" href="usage_patterns.html#usage_patterns_simple">Simple patterns</a></li> 144<li><a class="el" href="usage_patterns.html#usage_patterns_advanced">Advanced patterns</a></li> 145</ul> 146</li> 147<li><a class="el" href="configuration.html">Configuration</a><ul> 148<li><a class="el" href="configuration.html#config_Vulkan_functions">Pointers to Vulkan functions</a></li> 149<li><a class="el" href="configuration.html#custom_memory_allocator">Custom host memory allocator</a></li> 150<li><a class="el" href="configuration.html#allocation_callbacks">Device memory allocation callbacks</a></li> 151<li><a class="el" href="configuration.html#heap_memory_limit">Device heap memory limit</a></li> 152<li><a class="el" href="vk_khr_dedicated_allocation.html">VK_KHR_dedicated_allocation</a></li> 153<li><a class="el" href="enabling_buffer_device_address.html">Enabling buffer device address</a></li> 154<li><a class="el" href="vk_amd_device_coherent_memory.html">VK_AMD_device_coherent_memory</a></li> 155</ul> 156</li> 157<li><a class="el" href="general_considerations.html">General considerations</a><ul> 158<li><a class="el" href="general_considerations.html#general_considerations_thread_safety">Thread safety</a></li> 159<li><a class="el" href="general_considerations.html#general_considerations_validation_layer_warnings">Validation layer warnings</a></li> 160<li><a class="el" href="general_considerations.html#general_considerations_allocation_algorithm">Allocation algorithm</a></li> 161<li><a class="el" href="general_considerations.html#general_considerations_features_not_supported">Features not supported</a></li> 162</ul> 163</li> 164</ul> 165<h1><a class="anchor" id="main_see_also"></a> 166See also</h1> 167<ul> 168<li><a href="https://gpuopen.com/gaming-product/vulkan-memory-allocator/">Product page on GPUOpen</a></li> 169<li><a href="https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator">Source repository on GitHub</a> </li> 170</ul> 171</div></div><!-- PageDoc --> 172</div><!-- contents --> 173<!-- start footer part --> 174<hr class="footer"/><address class="footer"><small> 175Generated by  <a href="http://www.doxygen.org/index.html"> 176<img class="footer" src="doxygen.png" alt="doxygen"/> 177</a> 1.8.17 178</small></address> 179</body> 180</html> 181
