| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830 |
- <!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: FrameTemp< T > 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>
- <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&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&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-methods">Public Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="class_frame_temp-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">FrameTemp< T > Class Template Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <frameAllocator.h></code></p>
- <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:a2b6ae6938cea05fbe6237f3385814b3e" id="r_a2b6ae6938cea05fbe6237f3385814b3e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a2b6ae6938cea05fbe6237f3385814b3e">FrameTemp</a> (const U32 count=1)</td></tr>
- <tr class="separator:a2b6ae6938cea05fbe6237f3385814b3e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2ac9be21e7bf97c192c02e5d0ed0b74b" id="r_a2ac9be21e7bf97c192c02e5d0ed0b74b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a2ac9be21e7bf97c192c02e5d0ed0b74b">~FrameTemp</a> ()</td></tr>
- <tr class="memdesc:a2ac9be21e7bf97c192c02e5d0ed0b74b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor restores the watermark. <br /></td></tr>
- <tr class="separator:a2ac9be21e7bf97c192c02e5d0ed0b74b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7bb441796dac4fb5289226692afb6b64" id="r_a7bb441796dac4fb5289226692afb6b64"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a7bb441796dac4fb5289226692afb6b64">getObjectCount</a> (void) const</td></tr>
- <tr class="separator:a7bb441796dac4fb5289226692afb6b64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ff4ebf9110c679d84f776e8a9d7f60c" id="r_a5ff4ebf9110c679d84f776e8a9d7f60c"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a5ff4ebf9110c679d84f776e8a9d7f60c">operator~</a> ()</td></tr>
- <tr class="memdesc:a5ff4ebf9110c679d84f776e8a9d7f60c"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This will return the memory, NOT perform a ones-complement. <br /></td></tr>
- <tr class="separator:a5ff4ebf9110c679d84f776e8a9d7f60c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5efeb6c9c446101e493779189b1da3a0" id="r_a5efeb6c9c446101e493779189b1da3a0"><td class="memItemLeft" align="right" valign="top">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a5efeb6c9c446101e493779189b1da3a0">operator~</a> () const</td></tr>
- <tr class="memdesc:a5efeb6c9c446101e493779189b1da3a0"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This will return the memory, NOT perform a ones-complement. <br /></td></tr>
- <tr class="separator:a5efeb6c9c446101e493779189b1da3a0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af314652148c0545b268b465f72a6dcf9" id="r_af314652148c0545b268b465f72a6dcf9"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#af314652148c0545b268b465f72a6dcf9">operator+</a> ()</td></tr>
- <tr class="memdesc:af314652148c0545b268b465f72a6dcf9"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This will dereference the memory, NOT do standard unary plus behavior. <br /></td></tr>
- <tr class="separator:af314652148c0545b268b465f72a6dcf9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea1dc42d994e6a81b8ac895d354fb905" id="r_aea1dc42d994e6a81b8ac895d354fb905"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#aea1dc42d994e6a81b8ac895d354fb905">operator+</a> () const</td></tr>
- <tr class="memdesc:aea1dc42d994e6a81b8ac895d354fb905"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This will dereference the memory, NOT do standard unary plus behavior. <br /></td></tr>
- <tr class="separator:aea1dc42d994e6a81b8ac895d354fb905"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f534efce0b043d603eb8f5653268e7d" id="r_a3f534efce0b043d603eb8f5653268e7d"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a3f534efce0b043d603eb8f5653268e7d">operator*</a> ()</td></tr>
- <tr class="separator:a3f534efce0b043d603eb8f5653268e7d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a241c04e3ce86e1fd5a946eb2aa8b1f22" id="r_a241c04e3ce86e1fd5a946eb2aa8b1f22"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a241c04e3ce86e1fd5a946eb2aa8b1f22">operator*</a> () const</td></tr>
- <tr class="separator:a241c04e3ce86e1fd5a946eb2aa8b1f22"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acdc7401fc36927f956eacaaa55d8cef6" id="r_acdc7401fc36927f956eacaaa55d8cef6"><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#acdc7401fc36927f956eacaaa55d8cef6">operator&</a> ()</td></tr>
- <tr class="separator:acdc7401fc36927f956eacaaa55d8cef6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0be2730b030f587e0e7351f6bd4ff318" id="r_a0be2730b030f587e0e7351f6bd4ff318"><td class="memItemLeft" align="right" valign="top">const T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a0be2730b030f587e0e7351f6bd4ff318">operator&</a> () const</td></tr>
- <tr class="separator:a0be2730b030f587e0e7351f6bd4ff318"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adec4d6e4697fff19761dfb957ab203f2" id="r_adec4d6e4697fff19761dfb957ab203f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#adec4d6e4697fff19761dfb957ab203f2">operator T*</a> ()</td></tr>
- <tr class="separator:adec4d6e4697fff19761dfb957ab203f2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac9ca720e14833f50c05bee6f3de9185c" id="r_ac9ca720e14833f50c05bee6f3de9185c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#ac9ca720e14833f50c05bee6f3de9185c">operator const T *</a> () const</td></tr>
- <tr class="separator:ac9ca720e14833f50c05bee6f3de9185c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b758965ffe566b5d38d4cd81fca2831" id="r_a3b758965ffe566b5d38d4cd81fca2831"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a3b758965ffe566b5d38d4cd81fca2831">operator T&</a> ()</td></tr>
- <tr class="separator:a3b758965ffe566b5d38d4cd81fca2831"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a619905eb6bcfb8d0424234c5e2e65954" id="r_a619905eb6bcfb8d0424234c5e2e65954"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a619905eb6bcfb8d0424234c5e2e65954">operator const T &</a> () const</td></tr>
- <tr class="separator:a619905eb6bcfb8d0424234c5e2e65954"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4b15b6419d4ff99730ee9df795b90f61" id="r_a4b15b6419d4ff99730ee9df795b90f61"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a4b15b6419d4ff99730ee9df795b90f61">operator T</a> ()</td></tr>
- <tr class="separator:a4b15b6419d4ff99730ee9df795b90f61"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aba96e70985a068343ea666d4a59060f2" id="r_aba96e70985a068343ea666d4a59060f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#aba96e70985a068343ea666d4a59060f2">operator const T</a> () const</td></tr>
- <tr class="separator:aba96e70985a068343ea666d4a59060f2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a27264a03025326c7d9c8a6daab08d48e" id="r_a27264a03025326c7d9c8a6daab08d48e"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a27264a03025326c7d9c8a6daab08d48e">operator[]</a> (const U32 idx)</td></tr>
- <tr class="separator:a27264a03025326c7d9c8a6daab08d48e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4d249a26374c26b95af7191c09e10ff" id="r_ab4d249a26374c26b95af7191c09e10ff"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#ab4d249a26374c26b95af7191c09e10ff">operator[]</a> (const U32 idx) const</td></tr>
- <tr class="separator:ab4d249a26374c26b95af7191c09e10ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a52ea6108495c27cc799f6c90e9c5f523" id="r_a52ea6108495c27cc799f6c90e9c5f523"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a52ea6108495c27cc799f6c90e9c5f523">operator[]</a> (const S32 idx)</td></tr>
- <tr class="separator:a52ea6108495c27cc799f6c90e9c5f523"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af72bc2e80236827ce19cffdd98972a2e" id="r_af72bc2e80236827ce19cffdd98972a2e"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#af72bc2e80236827ce19cffdd98972a2e">operator[]</a> (const S32 idx) const</td></tr>
- <tr class="separator:af72bc2e80236827ce19cffdd98972a2e"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:a8089a82a7059ace407e14c9e710227e5" id="r_a8089a82a7059ace407e14c9e710227e5"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#a8089a82a7059ace407e14c9e710227e5">mWaterMark</a></td></tr>
- <tr class="separator:a8089a82a7059ace407e14c9e710227e5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ade3bf084e0874644a6a10ce9efb12f75" id="r_ade3bf084e0874644a6a10ce9efb12f75"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#ade3bf084e0874644a6a10ce9efb12f75">mMemory</a></td></tr>
- <tr class="separator:ade3bf084e0874644a6a10ce9efb12f75"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6a35e8d606bb0bc1998020aaa3bd2d3" id="r_aa6a35e8d606bb0bc1998020aaa3bd2d3"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_temp.html#aa6a35e8d606bb0bc1998020aaa3bd2d3">mNumObjectsInMemory</a></td></tr>
- <tr class="separator:aa6a35e8d606bb0bc1998020aaa3bd2d3"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><div class="compoundTemplParams">template<class T><br />
- class FrameTemp< T ></div><p>Class for temporary variables that you want to allocate easily using the <a class="el" href="class_frame_allocator.html">FrameAllocator</a>. For example: </p><div class="fragment"><div class="line"><a class="code hl_class" href="class_frame_temp.html">FrameTemp<char></a> tempStr(32); <span class="comment">// NOTE! This parameter is NOT THE SIZE IN BYTES. See constructor docs.</span></div>
- <div class="line">dStrcat( tempStr, SomeOtherString );</div>
- <div class="line">tempStr[2] = <span class="charliteral">'l'</span>;</div>
- <div class="line"><a class="code hl_function" href="namespace_con.html#a0aff7311d684a0e0ef33125616a73385">Con::printf</a>( tempStr );</div>
- <div class="line"><a class="code hl_function" href="namespace_con.html#a0aff7311d684a0e0ef33125616a73385">Con::printf</a>( <span class="stringliteral">"Foo: %s"</span>, ~tempStr );</div>
- <div class="ttc" id="aclass_frame_temp_html"><div class="ttname"><a href="class_frame_temp.html">FrameTemp</a></div><div class="ttdef"><b>Definition</b> frameAllocator.h:215</div></div>
- <div class="ttc" id="anamespace_con_html_a0aff7311d684a0e0ef33125616a73385"><div class="ttname"><a href="namespace_con.html#a0aff7311d684a0e0ef33125616a73385">Con::printf</a></div><div class="ttdeci">void printf(const char *fmt,...)</div><div class="ttdef"><b>Definition</b> console.cc:636</div></div>
- </div><!-- fragment --><p>This will automatically handle getting and restoring the watermark of the <a class="el" href="class_frame_allocator.html">FrameAllocator</a> when it goes out of scope. You should notice the strange operator infront of tempStr on the printf call. This is normally a unary operator for ones-complement, but in this class it will simply return the memory of the allocation. It's the same as doing (const char *)tempStr in the above case. The reason why it is necessary for the second printf and not the first is because the second one is taking a variable arg list and so it isn't getting the cast so that it's cast operator can properly return the memory instead of the <a class="el" href="class_frame_temp.html">FrameTemp</a> object itself.</p>
- <dl class="section note"><dt>Note</dt><dd>It is important to note that this object is designed to just be a temporary array of a dynamic size. Some wierdness may occur if you try do perform crazy pointer stuff with it using regular operators on it. I implemented what I thought were the most common operators that it would be used for. If strange things happen, you will need to debug them yourself. </dd></dl>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a2b6ae6938cea05fbe6237f3385814b3e" name="a2b6ae6938cea05fbe6237f3385814b3e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2b6ae6938cea05fbe6237f3385814b3e">◆ </a></span>FrameTemp()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_frame_temp.html">FrameTemp</a> </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>count</em> = <code>1</code></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>Constructor will store the <a class="el" href="class_frame_allocator.html">FrameAllocator</a> watermark and allocate the memory off of the <a class="el" href="class_frame_allocator.html">FrameAllocator</a>.</p>
- <dl class="section note"><dt>Note</dt><dd>It is important to note that, unlike the <a class="el" href="class_frame_allocator_marker.html">FrameAllocatorMarker</a> and the <a class="el" href="class_frame_allocator.html">FrameAllocator</a> itself, the argument to allocate is NOT the size in bytes, doing: <div class="fragment"><div class="line"><a class="code hl_class" href="class_frame_temp.html">FrameTemp<F64></a> f64s(5);</div>
- </div><!-- fragment --> Is the same as <div class="fragment"><div class="line">F64 *f64s = <span class="keyword">new</span> F64[5];</div>
- </div><!-- fragment --></dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">count</td><td>The number of objects to allocate </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a2ac9be21e7bf97c192c02e5d0ed0b74b" name="a2ac9be21e7bf97c192c02e5d0ed0b74b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2ac9be21e7bf97c192c02e5d0ed0b74b">◆ </a></span>~FrameTemp()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_frame_temp.html">FrameTemp</a> </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destructor restores the watermark. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a7bb441796dac4fb5289226692afb6b64" name="a7bb441796dac4fb5289226692afb6b64"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7bb441796dac4fb5289226692afb6b64">◆ </a></span>getObjectCount()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 getObjectCount </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="aba96e70985a068343ea666d4a59060f2" name="aba96e70985a068343ea666d4a59060f2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aba96e70985a068343ea666d4a59060f2">◆ </a></span>operator const T()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator const T </td>
- <td>(</td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="a619905eb6bcfb8d0424234c5e2e65954" name="a619905eb6bcfb8d0424234c5e2e65954"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a619905eb6bcfb8d0424234c5e2e65954">◆ </a></span>operator const T &()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator const T & </td>
- <td>(</td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="ac9ca720e14833f50c05bee6f3de9185c" name="ac9ca720e14833f50c05bee6f3de9185c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac9ca720e14833f50c05bee6f3de9185c">◆ </a></span>operator const T *()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator const T * </td>
- <td>(</td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="a4b15b6419d4ff99730ee9df795b90f61" name="a4b15b6419d4ff99730ee9df795b90f61"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4b15b6419d4ff99730ee9df795b90f61">◆ </a></span>operator T()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator T </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a3b758965ffe566b5d38d4cd81fca2831" name="a3b758965ffe566b5d38d4cd81fca2831"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3b758965ffe566b5d38d4cd81fca2831">◆ </a></span>operator T&()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator T& </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="adec4d6e4697fff19761dfb957ab203f2" name="adec4d6e4697fff19761dfb957ab203f2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adec4d6e4697fff19761dfb957ab203f2">◆ </a></span>operator T*()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator T* </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="acdc7401fc36927f956eacaaa55d8cef6" name="acdc7401fc36927f956eacaaa55d8cef6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acdc7401fc36927f956eacaaa55d8cef6">◆ </a></span>operator&() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T ** operator& </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0be2730b030f587e0e7351f6bd4ff318" name="a0be2730b030f587e0e7351f6bd4ff318"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0be2730b030f587e0e7351f6bd4ff318">◆ </a></span>operator&() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T ** operator& </td>
- <td>(</td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="a3f534efce0b043d603eb8f5653268e7d" name="a3f534efce0b043d603eb8f5653268e7d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3f534efce0b043d603eb8f5653268e7d">◆ </a></span>operator*() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T & operator* </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a241c04e3ce86e1fd5a946eb2aa8b1f22" name="a241c04e3ce86e1fd5a946eb2aa8b1f22"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a241c04e3ce86e1fd5a946eb2aa8b1f22">◆ </a></span>operator*() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T & operator* </td>
- <td>(</td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="af314652148c0545b268b465f72a6dcf9" name="af314652148c0545b268b465f72a6dcf9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af314652148c0545b268b465f72a6dcf9">◆ </a></span>operator+() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T & operator+ </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>NOTE: This will dereference the memory, NOT do standard unary plus behavior. </p>
- </div>
- </div>
- <a id="aea1dc42d994e6a81b8ac895d354fb905" name="aea1dc42d994e6a81b8ac895d354fb905"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea1dc42d994e6a81b8ac895d354fb905">◆ </a></span>operator+() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T & operator+ </td>
- <td>(</td>
- <td class="paramname"></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>NOTE: This will dereference the memory, NOT do standard unary plus behavior. </p>
- </div>
- </div>
- <a id="a52ea6108495c27cc799f6c90e9c5f523" name="a52ea6108495c27cc799f6c90e9c5f523"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a52ea6108495c27cc799f6c90e9c5f523">◆ </a></span>operator[]() <span class="overload">[1/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T & operator[] </td>
- <td>(</td>
- <td class="paramtype">const S32 </td>
- <td class="paramname"><em>idx</em></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">
- </div>
- </div>
- <a id="af72bc2e80236827ce19cffdd98972a2e" name="af72bc2e80236827ce19cffdd98972a2e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af72bc2e80236827ce19cffdd98972a2e">◆ </a></span>operator[]() <span class="overload">[2/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T & operator[] </td>
- <td>(</td>
- <td class="paramtype">const S32 </td>
- <td class="paramname"><em>idx</em></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">
- </div>
- </div>
- <a id="a27264a03025326c7d9c8a6daab08d48e" name="a27264a03025326c7d9c8a6daab08d48e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a27264a03025326c7d9c8a6daab08d48e">◆ </a></span>operator[]() <span class="overload">[3/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T & operator[] </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>idx</em></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">
- </div>
- </div>
- <a id="ab4d249a26374c26b95af7191c09e10ff" name="ab4d249a26374c26b95af7191c09e10ff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab4d249a26374c26b95af7191c09e10ff">◆ </a></span>operator[]() <span class="overload">[4/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T & operator[] </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>idx</em></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">
- </div>
- </div>
- <a id="a5ff4ebf9110c679d84f776e8a9d7f60c" name="a5ff4ebf9110c679d84f776e8a9d7f60c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5ff4ebf9110c679d84f776e8a9d7f60c">◆ </a></span>operator~() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T * operator~ </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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>NOTE: This will return the memory, NOT perform a ones-complement. </p>
- </div>
- </div>
- <a id="a5efeb6c9c446101e493779189b1da3a0" name="a5efeb6c9c446101e493779189b1da3a0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5efeb6c9c446101e493779189b1da3a0">◆ </a></span>operator~() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T * operator~ </td>
- <td>(</td>
- <td class="paramname"></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>NOTE: This will return the memory, NOT perform a ones-complement. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="ade3bf084e0874644a6a10ce9efb12f75" name="ade3bf084e0874644a6a10ce9efb12f75"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ade3bf084e0874644a6a10ce9efb12f75">◆ </a></span>mMemory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T* mMemory</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa6a35e8d606bb0bc1998020aaa3bd2d3" name="aa6a35e8d606bb0bc1998020aaa3bd2d3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa6a35e8d606bb0bc1998020aaa3bd2d3">◆ </a></span>mNumObjectsInMemory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 mNumObjectsInMemory</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8089a82a7059ace407e14c9e710227e5" name="a8089a82a7059ace407e14c9e710227e5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8089a82a7059ace407e14c9e710227e5">◆ </a></span>mWaterMark</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 mWaterMark</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</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 <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>
|