TorqueEngine
/
Torque2D
cermin dari https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
							<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: FrameAllocator Class 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>
<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" />
<link href="t2d-stylesheet-extra.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">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_frame_allocator-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">FrameAllocator Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;frameAllocator.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a8204766ccfda2a862770bce2c027b964" id="r_a8204766ccfda2a862770bce2c027b964"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_allocator.html#a8204766ccfda2a862770bce2c027b964">init</a> (const U32 frameSize)</td></tr>
<tr class="separator:a8204766ccfda2a862770bce2c027b964"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a80b6032f86a56bec74609034b3246f" id="r_a3a80b6032f86a56bec74609034b3246f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_allocator.html#a3a80b6032f86a56bec74609034b3246f">destroy</a> ()</td></tr>
<tr class="separator:a3a80b6032f86a56bec74609034b3246f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef6ef5307ac1d9321035892014354bd0" id="r_aef6ef5307ac1d9321035892014354bd0"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_allocator.html#aef6ef5307ac1d9321035892014354bd0">alloc</a> (const U32 allocSize)</td></tr>
<tr class="separator:aef6ef5307ac1d9321035892014354bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0b2e19e087a5e08ee2729f5a2d24c29" id="r_af0b2e19e087a5e08ee2729f5a2d24c29"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_allocator.html#af0b2e19e087a5e08ee2729f5a2d24c29">setWaterMark</a> (const U32)</td></tr>
<tr class="separator:af0b2e19e087a5e08ee2729f5a2d24c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a39eaeb8ec75881dfd4f39a64f71f4f" id="r_a8a39eaeb8ec75881dfd4f39a64f71f4f"><td class="memItemLeft" align="right" valign="top">static U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_allocator.html#a8a39eaeb8ec75881dfd4f39a64f71f4f">getWaterMark</a> ()</td></tr>
<tr class="separator:a8a39eaeb8ec75881dfd4f39a64f71f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae69ba4a6f5ddaa5c3e7db7a41b217c8e" id="r_ae69ba4a6f5ddaa5c3e7db7a41b217c8e"><td class="memItemLeft" align="right" valign="top">static U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_allocator.html#ae69ba4a6f5ddaa5c3e7db7a41b217c8e">getHighWaterMark</a> ()</td></tr>
<tr class="separator:ae69ba4a6f5ddaa5c3e7db7a41b217c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Temporary memory pool for per-frame allocations.</p>
<p>In the course of rendering a frame, it is often necessary to allocate many small chunks of memory, then free them all in a batch. For instance, say we're allocating storage for some vertex calculations:</p>
<div class="fragment"><div class="line"><span class="comment">// Get FrameAllocator memory...</span></div>
<div class="line">U32 waterMark = <a class="code hl_function" href="class_frame_allocator.html#a8a39eaeb8ec75881dfd4f39a64f71f4f">FrameAllocator::getWaterMark</a>();</div>
<div class="line">F32 * ptr = (F32*)<a class="code hl_function" href="class_frame_allocator.html#aef6ef5307ac1d9321035892014354bd0">FrameAllocator::alloc</a>(<span class="keyword">sizeof</span>(F32)*2*targetMesh-&gt;vertsPerFrame);</div>
<div class="line"> </div>
<div class="line">... calculations ...</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Free frameAllocator memory</span></div>
<div class="line">FrameAllocator::setWaterMark(waterMark);</div>
<div class="ttc" id="aclass_frame_allocator_html_a8a39eaeb8ec75881dfd4f39a64f71f4f"><div class="ttname"><a href="class_frame_allocator.html#a8a39eaeb8ec75881dfd4f39a64f71f4f">FrameAllocator::getWaterMark</a></div><div class="ttdeci">static U32 getWaterMark()</div><div class="ttdef"><b>Definition</b> frameAllocator.h:141</div></div>
<div class="ttc" id="aclass_frame_allocator_html_aef6ef5307ac1d9321035892014354bd0"><div class="ttname"><a href="class_frame_allocator.html#aef6ef5307ac1d9321035892014354bd0">FrameAllocator::alloc</a></div><div class="ttdeci">static void * alloc(const U32 allocSize)</div><div class="ttdef"><b>Definition</b> frameAllocator.h:95</div></div>
</div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aef6ef5307ac1d9321035892014354bd0" name="aef6ef5307ac1d9321035892014354bd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef6ef5307ac1d9321035892014354bd0">&#9670;&#160;</a></span>alloc()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void * alloc </td>
          <td>(</td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>allocSize</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void destroy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">U32 getHighWaterMark </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">U32 getWaterMark </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void init </td>
          <td>(</td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>frameSize</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void setWaterMark </td>
          <td>(</td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>waterMark</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>memory/<b>frameAllocator.h</b></li>
</ul>
</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.9.8
</small></address>
</body>
</html>