VulkanMemoryAllocator/docs/html/thread_safety.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: Thread safety</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.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</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');
  $(document).ready(function() { init_search(); });
});
</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Thread safety </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><ul>
<li>The library has no global state, so separate <code>VmaAllocator</code> objects can be used independently. There should be no need to create multiple such objects though - one per <code>VkDevice</code> is enough.</li>
<li>By default, all calls to functions that take <code>VmaAllocator</code> as first parameter are safe to call from multiple threads simultaneously because they are synchronized internally when needed.</li>
<li>When the allocator is created with <a class="el" href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7ca4816ddaed324ba110172ca608a20f29d" title="Allocator and all objects created from it will not be synchronized internally, so you must guarantee ...">VMA_ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT</a> flag, calls to functions that take such <code>VmaAllocator</code> object must be synchronized externally.</li>
<li>Access to a <code>VmaAllocation</code> object must be externally synchronized. For example, you must not call <a class="el" href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b" title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a> and <a class="el" href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069" title="Maps memory represented by given allocation and returns pointer to it. ">vmaMapMemory()</a> from different threads at the same time if you pass the same <code>VmaAllocation</code> object to these functions. </li>
</ul>
</div></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"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reorganized Doxygen documentation into more separate pages. 2017-10-17 09:27:14 +00:00			`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>`
			`<meta name="generator" content="Doxygen 1.8.13"/>`
			`<meta name="viewport" content="width=device-width, initial-scale=1"/>`
			`<title>Vulkan Memory Allocator: Thread safety</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.8.13 -->`
			`<script type="text/javascript">`
			`var searchBox = new SearchBox("searchBox", "search",false,'Search');`
			`</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');`
			`$(document).ready(function() { init_search(); });`
			`});`
			`</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 id="nav-path" class="navpath">`
			`<ul>`
			`<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li> </ul>`
			`</div>`
			`</div><!-- top -->`
			`<div class="header">`
			`<div class="headertitle">`
			`<div class="title">Thread safety </div> </div>`
			`</div><!--header-->`
			`<div class="contents">`
			`<div class="textblock"><ul>`
Many minor formatting tweaks in documentation. 2018-03-09 16:35:48 +00:00			`<li>The library has no global state, so separate <code>VmaAllocator</code> objects can be used independently. There should be no need to create multiple such objects though - one per <code>VkDevice</code> is enough.</li>`
Reorganized Doxygen documentation into more separate pages. 2017-10-17 09:27:14 +00:00			`<li>By default, all calls to functions that take <code>VmaAllocator</code> as first parameter are safe to call from multiple threads simultaneously because they are synchronized internally when needed.</li>`
Many minor formatting tweaks in documentation. 2018-03-09 16:35:48 +00:00			`<li>When the allocator is created with <a class="el" href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7ca4816ddaed324ba110172ca608a20f29d" title="Allocator and all objects created from it will not be synchronized internally, so you must guarantee ...">VMA_ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT</a> flag, calls to functions that take such <code>VmaAllocator</code> object must be synchronized externally.</li>`
Written more documentation - about lost allocations. 2018-03-09 17:18:34 +00:00			<li>Access to a <code>VmaAllocation</code> object must be externally synchronized. For example, you must not call <a class="el" href="vk__mem__alloc_8h.html#a86dd08aba8633bfa4ad0df2e76481d8b" title="Returns current information about specified allocation and atomically marks it as used in current fra...">vmaGetAllocationInfo()</a> and <a class="el" href="vk__mem__alloc_8h.html#ad5bd1243512d099706de88168992f069" title="Maps memory represented by given allocation and returns pointer to it. ">vmaMapMemory()</a> from different threads at the same time if you pass the same <code>VmaAllocation</code> object to these functions. </li>
Reorganized Doxygen documentation into more separate pages. 2017-10-17 09:27:14 +00:00			`</ul>`
			`</div></div><!-- contents -->`
			`<!-- start footer part -->`
			`<hr class="footer"/><address class="footer"><small>`
			`Generated by  <a href="http://www.doxygen.org/index.html">`
			`<img class="footer" src="doxygen.png" alt="doxygen"/>`
			`</a> 1.8.13`
			`</small></address>`
			`</body>`
			`</html>`