docs/html/index.html - external/github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator - Git at Google

 <!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.17.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>D3D12 Memory Allocator: D3D12 Memory Allocator</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="codefolding.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>
 <script type="module">
 import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
 const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';
 mermaid.initialize({ startOnLoad: true, theme: theme });
 </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">D3D12 Memory Allocator
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.17.0 -->
 <script type="text/javascript">
 let searchBox = new SearchBox("searchBox", "search/",'.html');
 </script>
 <script type="text/javascript">
 document.addEventListener('DOMContentLoaded', codefold.init);
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 document.addEventListener('DOMContentLoaded', () => {
   initMenu('',false);
   init_search();
 });
 </script>
 <div id="main-nav-mobile">
 <div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
 <label class="main-menu-btn" for="main-menu-state">
 <span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
 <span id="searchBoxPos1" style="position:absolute;right:8px;top:8px;height:36px;"></span>
 </div>
 </div><!-- main-nav-mobile -->
 <div id="main-nav">
   <ul class="sm sm-dox" id="main-menu">
     <li id="searchBoxPos2" style="float:right">
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
           <span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
                onfocus="searchBox.OnSearchFieldFocus(true)"
                onblur="searchBox.OnSearchFieldFocus(false)"
                onkeyup="searchBox.OnSearchFieldChange(event)"/>
           </span><span class="right">
             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
           </span>
         </div>
     </li>
   </ul>
 </div><!-- main-nav -->
 </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">D3D12 Memory Allocator </div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><p><b>Version 3.2.0</b> (2026-06-05)</p>
 <p>Copyright (c) 2019-2026 Advanced Micro Devices, Inc. All rights reserved. <br  />
 License: MIT</p>
 <p>Documentation of all members: <a class="el" href="_d3_d12_mem_alloc_8h.html">D3D12MemAlloc.h</a></p>
 <h1 class="doxsection"><a class="anchor" id="main_table_of_contents"></a>
 Table of contents</h1>
 <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 and initialization">Project setup</a></li>
 <li><a class="el" href="quick_start.html#quick_start_creating_resources" title="Creating resources">Creating resources</a></li>
 <li><a class="el" href="quick_start.html#quick_start_resource_reference_counting" title="Resource reference counting">Resource reference counting</a></li>
 <li><a class="el" href="quick_start.html#quick_start_mapping_memory" title="Mapping memory">Mapping memory</a></li>
 <li><a class="el" href="quick_start.html#quick_start_helper_structures" title="Helper structures">Helper structures</a></li>
 </ul>
 </li>
 <li><a class="el" href="custom_pools.html" title="Custom memory pools">Custom memory pools</a></li>
 <li><a class="el" href="optimal_allocation.html" title="Optimal resource allocation">Optimal resource allocation</a><ul>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory" title="Avoiding running out of memory">Avoiding running out of memory</a></li>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_allocation_Performance" title="Allocation performance">Allocation performance</a></li>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_suballocating_buffers" title="Sub-allocating buffers">Sub-allocating buffers</a></li>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_residency_priority" title="Residency priority">Residency priority</a></li>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_gpu_upload_heap" title="GPU upload heap">GPU upload heap</a></li>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_committed_vs_placed" title="Committed versus placed resources">Committed versus placed resources</a></li>
 <li><a class="el" href="optimal_allocation.html#optimal_allocation_resource_alignment" title="Resource alignment">Resource alignment</a></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></li>
 <li><a class="el" href="resource_aliasing.html" title="Resource aliasing (overlap)">Resource aliasing (overlap)</a></li>
 <li><a class="el" href="linear_algorithm.html" title="Linear allocation algorithm">Linear allocation algorithm</a></li>
 <li><a class="el" href="virtual_allocator.html" title="Virtual allocator">Virtual allocator</a></li>
 <li><a class="el" href="configuration.html" title="Configuration">Configuration</a><ul>
 <li><a class="el" href="configuration.html#custom_memory_allocator" title="Custom CPU memory allocator">Custom CPU memory allocator</a></li>
 <li><a class="el" href="configuration.html#debug_margins" title="Debug margins">Debug margins</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_features_not_supported" title="Features not supported">Features not supported</a></li>
 </ul>
 </li>
 </ul>
 <h1 class="doxsection"><a class="anchor" id="main_see_also"></a>
 Web links</h1>
 <ul>
 <li><a href="https://gpuopen.com/d3d12-memory-allocator/">Direct3D 12 Memory Allocator at GPUOpen.com</a> - product page</li>
 <li><a href="https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator">GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com</a> - source code repository </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.17.0
 </small></address>
 </div><!-- doc-content -->
 </body>
 </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.17.0"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>D3D12 Memory Allocator: D3D12 Memory Allocator</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="codefolding.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>
	<script type="module">
	import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
	const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';
	mermaid.initialize({ startOnLoad: true, theme: theme });
	</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">D3D12 Memory Allocator
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.17.0 -->
	<script type="text/javascript">
	let searchBox = new SearchBox("searchBox", "search/",'.html');
	</script>
	<script type="text/javascript">
	document.addEventListener('DOMContentLoaded', codefold.init);
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	document.addEventListener('DOMContentLoaded', () => {
	initMenu('',false);
	init_search();
	});
	</script>
	<div id="main-nav-mobile">
	<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
	<label class="main-menu-btn" for="main-menu-state">
	<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
	<span id="searchBoxPos1" style="position:absolute;right:8px;top:8px;height:36px;"></span>
	</div>
	</div><!-- main-nav-mobile -->
	<div id="main-nav">
	<ul class="sm sm-dox" id="main-menu">
	<li id="searchBoxPos2" style="float:right">
	<div id="MSearchBox" class="MSearchBoxInactive">
	<span class="left">
	<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
	<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
	onfocus="searchBox.OnSearchFieldFocus(true)"
	onblur="searchBox.OnSearchFieldFocus(false)"
	onkeyup="searchBox.OnSearchFieldChange(event)"/>
	</span><span class="right">
	<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
	</span>
	</div>
	</li>
	</ul>
	</div><!-- main-nav -->
	</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">D3D12 Memory Allocator </div></div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><p><b>Version 3.2.0</b> (2026-06-05)</p>
	<p>Copyright (c) 2019-2026 Advanced Micro Devices, Inc. All rights reserved. <br />
	License: MIT</p>
	<p>Documentation of all members: <a class="el" href="_d3_d12_mem_alloc_8h.html">D3D12MemAlloc.h</a></p>
	<h1 class="doxsection"><a class="anchor" id="main_table_of_contents"></a>
	Table of contents</h1>
	<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 and initialization">Project setup</a></li>
	<li><a class="el" href="quick_start.html#quick_start_creating_resources" title="Creating resources">Creating resources</a></li>
	<li><a class="el" href="quick_start.html#quick_start_resource_reference_counting" title="Resource reference counting">Resource reference counting</a></li>
	<li><a class="el" href="quick_start.html#quick_start_mapping_memory" title="Mapping memory">Mapping memory</a></li>
	<li><a class="el" href="quick_start.html#quick_start_helper_structures" title="Helper structures">Helper structures</a></li>
	</ul>
	</li>
	<li><a class="el" href="custom_pools.html" title="Custom memory pools">Custom memory pools</a></li>
	<li><a class="el" href="optimal_allocation.html" title="Optimal resource allocation">Optimal resource allocation</a><ul>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory" title="Avoiding running out of memory">Avoiding running out of memory</a></li>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_allocation_Performance" title="Allocation performance">Allocation performance</a></li>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_suballocating_buffers" title="Sub-allocating buffers">Sub-allocating buffers</a></li>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_residency_priority" title="Residency priority">Residency priority</a></li>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_gpu_upload_heap" title="GPU upload heap">GPU upload heap</a></li>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_committed_vs_placed" title="Committed versus placed resources">Committed versus placed resources</a></li>
	<li><a class="el" href="optimal_allocation.html#optimal_allocation_resource_alignment" title="Resource alignment">Resource alignment</a></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></li>
	<li><a class="el" href="resource_aliasing.html" title="Resource aliasing (overlap)">Resource aliasing (overlap)</a></li>
	<li><a class="el" href="linear_algorithm.html" title="Linear allocation algorithm">Linear allocation algorithm</a></li>
	<li><a class="el" href="virtual_allocator.html" title="Virtual allocator">Virtual allocator</a></li>
	<li><a class="el" href="configuration.html" title="Configuration">Configuration</a><ul>
	<li><a class="el" href="configuration.html#custom_memory_allocator" title="Custom CPU memory allocator">Custom CPU memory allocator</a></li>
	<li><a class="el" href="configuration.html#debug_margins" title="Debug margins">Debug margins</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_features_not_supported" title="Features not supported">Features not supported</a></li>
	</ul>
	</li>
	</ul>
	<h1 class="doxsection"><a class="anchor" id="main_see_also"></a>
	Web links</h1>
	<ul>
	<li><a href="https://gpuopen.com/d3d12-memory-allocator/">Direct3D 12 Memory Allocator at GPUOpen.com</a> - product page</li>
	<li><a href="https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator">GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com</a> - source code repository </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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.17.0
	</small></address>
	</div><!-- doc-content -->
	</body>
	</html>