docs/html/index.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.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: Vulkan Memory Allocator</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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search',false);
  $(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<!-- 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><div class="header">
  <div class="headertitle"><div class="title">Vulkan Memory Allocator </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><b>Version 3.4.0-development</b></p>
<p>Copyright (c) 2017-2026 Advanced Micro Devices, Inc. All rights reserved. <br  />
License: MIT <br  />
See also: <a href="https://gpuopen.com/vulkan-memory-allocator/">product page on GPUOpen</a>, <a href="https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator">repository on GitHub</a></p>
<p><b>API documentation divided into groups:</b> <a href="topics.html">Topics</a></p>
<p><b>General documentation chapters:</b></p>
<ul>
<li><a class="el" href="faq.html" title="Frequently asked questions">Frequently asked questions</a></li>
<li><a class="el" href="quick_start.html" title="Quick start">Quick start</a><ul>
<li><a class="el" href="quick_start.html#quick_start_project_setup" title="Project setup">Project setup</a></li>
<li><a class="el" href="quick_start.html#quick_start_initialization" title="Initialization">Initialization</a></li>
<li><a class="el" href="quick_start.html#quick_start_resource_allocation" title="Resource allocation">Resource allocation</a></li>
</ul>
</li>
<li><a class="el" href="choosing_memory_type.html" title="Choosing memory type">Choosing memory type</a><ul>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_usage" title="Usage">Usage</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_required_preferred_flags" title="Required and preferred flags">Required and preferred flags</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_explicit_memory_types" title="Explicit memory types">Explicit memory types</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_custom_memory_pools" title="Custom memory pools">Custom memory pools</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_dedicated_allocations" title="Dedicated allocations">Dedicated allocations</a></li>
</ul>
</li>
<li><a class="el" href="memory_mapping.html" title="Memory mapping">Memory mapping</a><ul>
<li><a class="el" href="memory_mapping.html#memory_mapping_copy_functions" title="Copy functions">Copy functions</a></li>
<li><a class="el" href="memory_mapping.html#memory_mapping_mapping_functions" title="Mapping functions">Mapping functions</a></li>
<li><a class="el" href="memory_mapping.html#memory_mapping_persistently_mapped_memory" title="Persistently mapped memory">Persistently mapped memory</a></li>
<li><a class="el" href="memory_mapping.html#memory_mapping_cache_control" title="Cache flush and invalidate">Cache flush and invalidate</a></li>
</ul>
</li>
<li><a class="el" href="staying_within_budget.html" title="Staying within budget">Staying within budget</a><ul>
<li><a class="el" href="staying_within_budget.html#staying_within_budget_querying_for_budget" title="Querying for budget">Querying for budget</a></li>
<li><a class="el" href="staying_within_budget.html#staying_within_budget_controlling_memory_usage" title="Controlling memory usage">Controlling memory usage</a></li>
</ul>
</li>
<li><a class="el" href="resource_aliasing.html" title="Resource aliasing (overlap)">Resource aliasing (overlap)</a></li>
<li><a class="el" href="custom_memory_pools.html" title="Custom memory pools">Custom memory pools</a><ul>
<li><a class="el" href="custom_memory_pools.html#custom_memory_pools_MemTypeIndex" title="Choosing memory type index">Choosing memory type index</a></li>
<li><a class="el" href="custom_memory_pools.html#custom_memory_pools_when_not_use" title="When not to use custom pools">When not to use custom pools</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm" title="Linear allocation algorithm">Linear allocation algorithm</a><ul>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_free_at_once" title="Free-at-once">Free-at-once</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_stack" title="Stack">Stack</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_double_stack" title="Double stack">Double stack</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_ring_buffer" title="Ring buffer">Ring buffer</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="el" href="defragmentation.html" title="Defragmentation">Defragmentation</a></li>
<li><a class="el" href="statistics.html" title="Statistics">Statistics</a><ul>
<li><a class="el" href="statistics.html#statistics_numeric_statistics" title="Numeric statistics">Numeric statistics</a></li>
<li><a class="el" href="statistics.html#statistics_json_dump" title="JSON dump">JSON dump</a></li>
</ul>
</li>
<li><a class="el" href="allocation_annotation.html" title="Allocation names and user data">Allocation names and user data</a><ul>
<li><a class="el" href="allocation_annotation.html#allocation_user_data" title="Allocation user data">Allocation user data</a></li>
<li><a class="el" href="allocation_annotation.html#allocation_names" title="Allocation names">Allocation names</a></li>
</ul>
</li>
<li><a class="el" href="virtual_allocator.html" title="Virtual allocator">Virtual allocator</a></li>
<li><a class="el" href="debugging_memory_usage.html" title="Debugging incorrect memory usage">Debugging incorrect memory usage</a><ul>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_initialization" title="Memory initialization">Memory initialization</a></li>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_margins" title="Margins">Margins</a></li>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_corruption_detection" title="Corruption detection">Corruption detection</a></li>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_leak_detection" title="Leak detection features">Leak detection features</a></li>
</ul>
</li>
<li><a class="el" href="other_api_interop.html" title="Interop with other graphics APIs">Interop with other graphics APIs</a><ul>
<li><a class="el" href="other_api_interop.html#other_api_interop_exporting_memory" title="Exporting memory">Exporting memory</a></li>
<li><a class="el" href="other_api_interop.html#other_api_interop_importing_memory" title="Importing memory">Importing memory</a></li>
</ul>
</li>
<li><a class="el" href="usage_patterns.html" title="Recommended usage patterns">Recommended usage patterns</a><ul>
<li><a class="el" href="usage_patterns.html#usage_patterns_gpu_only" title="GPU-only resource">GPU-only resource</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_staging_copy_upload" title="Staging copy for upload">Staging copy for upload</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_readback" title="Readback">Readback</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_advanced_data_uploading" title="Advanced data uploading">Advanced data uploading</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_other_use_cases" title="Other use cases">Other use cases</a></li>
</ul>
</li>
<li><a class="el" href="configuration.html" title="Configuration">Configuration</a><ul>
<li><a class="el" href="configuration.html#config_Vulkan_functions" title="Pointers to Vulkan functions">Pointers to Vulkan functions</a></li>
<li><a class="el" href="configuration.html#custom_memory_allocator" title="Custom host memory allocator">Custom host memory allocator</a></li>
<li><a class="el" href="configuration.html#allocation_callbacks" title="Device memory allocation callbacks">Device memory allocation callbacks</a></li>
<li><a class="el" href="configuration.html#heap_memory_limit" title="Device heap memory limit">Device heap memory limit</a></li>
</ul>
</li>
<li><b>Extension support</b><ul>
<li><a class="el" href="vk_khr_dedicated_allocation.html" title="VK_KHR_dedicated_allocation">VK_KHR_dedicated_allocation</a></li>
<li><a class="el" href="enabling_buffer_device_address.html" title="Enabling buffer device address">Enabling buffer device address</a></li>
<li><a class="el" href="vk_ext_memory_priority.html" title="VK_EXT_memory_priority">VK_EXT_memory_priority</a></li>
<li><a class="el" href="vk_amd_device_coherent_memory.html" title="VK_AMD_device_coherent_memory">VK_AMD_device_coherent_memory</a></li>
</ul>
</li>
<li><a class="el" href="general_considerations.html" title="General considerations">General considerations</a><ul>
<li><a class="el" href="general_considerations.html#general_considerations_thread_safety" title="Thread safety">Thread safety</a></li>
<li><a class="el" href="general_considerations.html#general_considerations_versioning_and_compatibility" title="Versioning and compatibility">Versioning and compatibility</a></li>
<li><a class="el" href="general_considerations.html#general_considerations_validation_layer_warnings" title="Validation layer warnings">Validation layer warnings</a></li>
<li><a class="el" href="general_considerations.html#general_considerations_allocation_algorithm" title="Allocation algorithm">Allocation algorithm</a></li>
<li><a class="el" href="general_considerations.html#general_considerations_features_not_supported" title="Features not supported">Features not supported</a> </li>
</ul>
</li>
</ul>
</div></div><!-- PageDoc -->
<a href="doxygen_crawl.html"></a>
</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.16.1
</small></address>
</div><!-- doc-content -->
</body>
</html>