cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
							<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: FixedSizeFreeList&lt; Object &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.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="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_fixed_size_free_list.html',''); initResizable(true); });
/* @license-end */
</script>
<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 class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_fixed_size_free_list-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">FixedSizeFreeList&lt; Object &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_fixed_size_free_list_8h_source.html">FixedSizeFreeList.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FixedSizeFreeList&lt; Object &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_fixed_size_free_list.png" usemap="#FixedSizeFreeList_3C_20Object_20_3E_map" alt=""/>
  <map id="FixedSizeFreeList_3C_20Object_20_3E_map" name="FixedSizeFreeList_3C_20Object_20_3E_map">
<area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,174,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_fixed_size_free_list_1_1_batch.html">Batch</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A batch of objects that can be destructed.  <a href="struct_fixed_size_free_list_1_1_batch.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a71571a26f9bc002d714f0178e46177ba" id="r_a71571a26f9bc002d714f0178e46177ba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a71571a26f9bc002d714f0178e46177ba">~FixedSizeFreeList</a> ()</td></tr>
<tr class="memdesc:a71571a26f9bc002d714f0178e46177ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:a71571a26f9bc002d714f0178e46177ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a083084370fcf7fde019f6d4d8b99378e" id="r_a083084370fcf7fde019f6d4d8b99378e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a083084370fcf7fde019f6d4d8b99378e">Init</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxObjects, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inPageSize)</td></tr>
<tr class="memdesc:a083084370fcf7fde019f6d4d8b99378e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the free list, up to inMaxObjects can be allocated.  <br /></td></tr>
<tr class="separator:a083084370fcf7fde019f6d4d8b99378e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54bb676ae1632d32f3f07dea3e5b4ba8" id="r_a54bb676ae1632d32f3f07dea3e5b4ba8"><td class="memTemplParams" colspan="2">template&lt;typename... Parameters&gt; </td></tr>
<tr class="memitem:a54bb676ae1632d32f3f07dea3e5b4ba8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a54bb676ae1632d32f3f07dea3e5b4ba8">ConstructObject</a> (Parameters &amp;&amp;... inParameters)</td></tr>
<tr class="memdesc:a54bb676ae1632d32f3f07dea3e5b4ba8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lockless construct a new object, inParameters are passed on to the constructor.  <br /></td></tr>
<tr class="separator:a54bb676ae1632d32f3f07dea3e5b4ba8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7446e6f32dac053462c14dfefcb467a0" id="r_a7446e6f32dac053462c14dfefcb467a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7446e6f32dac053462c14dfefcb467a0">DestructObject</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inObjectIndex)</td></tr>
<tr class="memdesc:a7446e6f32dac053462c14dfefcb467a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lockless destruct an object and return it to the free pool.  <br /></td></tr>
<tr class="separator:a7446e6f32dac053462c14dfefcb467a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80ff23d54800cfa02da08d6e77171397" id="r_a80ff23d54800cfa02da08d6e77171397"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a80ff23d54800cfa02da08d6e77171397">DestructObject</a> (<a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> *inObject)</td></tr>
<tr class="memdesc:a80ff23d54800cfa02da08d6e77171397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lockless destruct an object and return it to the free pool.  <br /></td></tr>
<tr class="separator:a80ff23d54800cfa02da08d6e77171397"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afed6e2529117da02be0ddbcc41a509a9" id="r_afed6e2529117da02be0ddbcc41a509a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afed6e2529117da02be0ddbcc41a509a9">AddObjectToBatch</a> (<a class="el" href="struct_fixed_size_free_list_1_1_batch.html">Batch</a> &amp;ioBatch, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inObjectIndex)</td></tr>
<tr class="separator:afed6e2529117da02be0ddbcc41a509a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bf25bd9e2c35e584e0bc14d40054bc2" id="r_a0bf25bd9e2c35e584e0bc14d40054bc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bf25bd9e2c35e584e0bc14d40054bc2">DestructObjectBatch</a> (<a class="el" href="struct_fixed_size_free_list_1_1_batch.html">Batch</a> &amp;ioBatch)</td></tr>
<tr class="memdesc:a0bf25bd9e2c35e584e0bc14d40054bc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lockless destruct batch of objects.  <br /></td></tr>
<tr class="separator:a0bf25bd9e2c35e584e0bc14d40054bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accd9130a85781885d0d5f669ce0a86f1" id="r_accd9130a85781885d0d5f669ce0a86f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#accd9130a85781885d0d5f669ce0a86f1">Get</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inObjectIndex)</td></tr>
<tr class="memdesc:accd9130a85781885d0d5f669ce0a86f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access an object by index.  <br /></td></tr>
<tr class="separator:accd9130a85781885d0d5f669ce0a86f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcfce9ec76b8df6291beac70ab699080" id="r_afcfce9ec76b8df6291beac70ab699080"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afcfce9ec76b8df6291beac70ab699080">Get</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inObjectIndex) const</td></tr>
<tr class="memdesc:afcfce9ec76b8df6291beac70ab699080"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access an object by index.  <br /></td></tr>
<tr class="separator:afcfce9ec76b8df6291beac70ab699080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
<tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
<tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aa52c28cff499eeeb733b9b2f421a6f80" id="r_aa52c28cff499eeeb733b9b2f421a6f80"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa52c28cff499eeeb733b9b2f421a6f80">cInvalidObjectIndex</a> = 0xffffffff</td></tr>
<tr class="memdesc:aa52c28cff499eeeb733b9b2f421a6f80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid index.  <br /></td></tr>
<tr class="separator:aa52c28cff499eeeb733b9b2f421a6f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a574046ef3a420bee3408d5a1930f0952" id="r_a574046ef3a420bee3408d5a1930f0952"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a574046ef3a420bee3408d5a1930f0952">ObjectStorageSize</a> = sizeof(ObjectStorage)</td></tr>
<tr class="memdesc:a574046ef3a420bee3408d5a1930f0952"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of an object + bookkeeping for the freelist.  <br /></td></tr>
<tr class="separator:a574046ef3a420bee3408d5a1930f0952"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a>&gt;<br />
class FixedSizeFreeList&lt; Object &gt;</div><p>Class that allows lock free creation / destruction of objects (unless a new page of objects needs to be allocated) It contains a fixed pool of objects and also allows batching up a lot of objects to be destroyed and doing the actual free in a single atomic operation </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a71571a26f9bc002d714f0178e46177ba" name="a71571a26f9bc002d714f0178e46177ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71571a26f9bc002d714f0178e46177ba">&#9670;&#160;</a></span>~FixedSizeFreeList()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::~<a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a> </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afed6e2529117da02be0ddbcc41a509a9" name="afed6e2529117da02be0ddbcc41a509a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afed6e2529117da02be0ddbcc41a509a9">&#9670;&#160;</a></span>AddObjectToBatch()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::AddObjectToBatch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_fixed_size_free_list_1_1_batch.html">Batch</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>ioBatch</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>          <td class="paramname"><span class="paramname"><em>inObjectIndex</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Add a object to an existing batch to be destructed. Adding objects to a batch does not destroy or modify the objects, this will merely link them so that the entire batch can be returned to the free list in a single atomic operation </p>

</div>
</div>
<a id="a54bb676ae1632d32f3f07dea3e5b4ba8" name="a54bb676ae1632d32f3f07dea3e5b4ba8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54bb676ae1632d32f3f07dea3e5b4ba8">&#9670;&#160;</a></span>ConstructObject()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<div class="memtemplate">
template&lt;typename... Parameters&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::ConstructObject </td>
          <td>(</td>
          <td class="paramtype">Parameters &amp;&amp;...</td>          <td class="paramname"><span class="paramname"><em>inParameters</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Lockless construct a new object, inParameters are passed on to the constructor. </p>

</div>
</div>
<a id="a80ff23d54800cfa02da08d6e77171397" name="a80ff23d54800cfa02da08d6e77171397"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80ff23d54800cfa02da08d6e77171397">&#9670;&#160;</a></span>DestructObject() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::DestructObject </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> *</td>          <td class="paramname"><span class="paramname"><em>inObject</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Lockless destruct an object and return it to the free pool. </p>

</div>
</div>
<a id="a7446e6f32dac053462c14dfefcb467a0" name="a7446e6f32dac053462c14dfefcb467a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7446e6f32dac053462c14dfefcb467a0">&#9670;&#160;</a></span>DestructObject() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::DestructObject </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>          <td class="paramname"><span class="paramname"><em>inObjectIndex</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Lockless destruct an object and return it to the free pool. </p>

</div>
</div>
<a id="a0bf25bd9e2c35e584e0bc14d40054bc2" name="a0bf25bd9e2c35e584e0bc14d40054bc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bf25bd9e2c35e584e0bc14d40054bc2">&#9670;&#160;</a></span>DestructObjectBatch()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::DestructObjectBatch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_fixed_size_free_list_1_1_batch.html">Batch</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>ioBatch</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Lockless destruct batch of objects. </p>

</div>
</div>
<a id="accd9130a85781885d0d5f669ce0a86f1" name="accd9130a85781885d0d5f669ce0a86f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accd9130a85781885d0d5f669ce0a86f1">&#9670;&#160;</a></span>Get() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &amp; <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::Get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>          <td class="paramname"><span class="paramname"><em>inObjectIndex</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Access an object by index. </p>

</div>
</div>
<a id="afcfce9ec76b8df6291beac70ab699080" name="afcfce9ec76b8df6291beac70ab699080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcfce9ec76b8df6291beac70ab699080">&#9670;&#160;</a></span>Get() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &amp; <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::Get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>          <td class="paramname"><span class="paramname"><em>inObjectIndex</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Access an object by index. </p>

</div>
</div>
<a id="a083084370fcf7fde019f6d4d8b99378e" name="a083084370fcf7fde019f6d4d8b99378e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a083084370fcf7fde019f6d4d8b99378e">&#9670;&#160;</a></span>Init()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inMaxObjects</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inPageSize</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initialize the free list, up to inMaxObjects can be allocated. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa52c28cff499eeeb733b9b2f421a6f80" name="aa52c28cff499eeeb733b9b2f421a6f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa52c28cff499eeeb733b9b2f421a6f80">&#9670;&#160;</a></span>cInvalidObjectIndex</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::cInvalidObjectIndex = 0xffffffff</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Invalid index. </p>

</div>
</div>
<a id="a574046ef3a420bee3408d5a1930f0952" name="a574046ef3a420bee3408d5a1930f0952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a574046ef3a420bee3408d5a1930f0952">&#9670;&#160;</a></span>ObjectStorageSize</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt; <a class="el" href="_serializable_attribute_8h.html#a1c4e088742cfa4700da8d88eacf5974aa497031794414a552435f90151ac3b54b">Object</a> &gt;::ObjectStorageSize = sizeof(ObjectStorage)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Size of an object + bookkeeping for the freelist. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Core/<a class="el" href="_fixed_size_free_list_8h_source.html">FixedSizeFreeList.h</a></li>
<li>Jolt/Core/<a class="el" href="_fixed_size_free_list_8inl_source.html">FixedSizeFreeList.inl</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  </ul>
</div>
</body>
</html>