Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 102

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: CS::Memory::AllocatorHeapBase&lt; HeapAccess &gt; Class Template Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1Memory.html">Memory</a>::<a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html">AllocatorHeapBase</a></div>
<h1>CS::Memory::AllocatorHeapBase&lt; HeapAccess &gt; Class Template Reference</h1><!-- doxytag: class="CS::Memory::AllocatorHeapBase" -->A memory allocator that allocates from a heap.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="memheap_8h-source.html">csutil/memheap.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for CS::Memory::AllocatorHeapBase&lt; HeapAccess &gt;:</div>
<div class="dynsection">
<p><center><img src="classCS_1_1Memory_1_1AllocatorHeapBase__inherit__graph.png" border="0" usemap="#CS_1_1Memory_1_1AllocatorHeapBase_3_01HeapAccess_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="CS_1_1Memory_1_1AllocatorHeapBase_3_01HeapAccess_01_4__inherit__map">
<area shape="rect" href="classCS_1_1Memory_1_1AllocatorHeap.html" title="A memory allocator that allocates from a heap." alt="" coords="5,84,533,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classCS_1_1Memory_1_1AllocatorHeapBase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html#8c3a33074fec52234ae2edd4d6f0e2a7">Alloc</a> (const size_t n)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a block of memory of size <code>n</code>.  <a href="#8c3a33074fec52234ae2edd4d6f0e2a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="928ab003fcc315bd1d43f77213e0fd44"></a><!-- doxytag: member="CS::Memory::AllocatorHeapBase::AllocatorHeapBase" ref="928ab003fcc315bd1d43f77213e0fd44" args="(const HeapAccess &amp;heap)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html#928ab003fcc315bd1d43f77213e0fd44">AllocatorHeapBase</a> (const HeapAccess &amp;heap)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b617631fe3f1530fcd32cdb1e24952e3"></a><!-- doxytag: member="CS::Memory::AllocatorHeapBase::AllocatorHeapBase" ref="b617631fe3f1530fcd32cdb1e24952e3" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html#b617631fe3f1530fcd32cdb1e24952e3">AllocatorHeapBase</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html#bb570cf6349ed2de0c24034c0a7d97b7">Free</a> (void *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Free the block <code>p</code>.  <a href="#bb570cf6349ed2de0c24034c0a7d97b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html#4bef794b1fe6b684af91b18687707074">Realloc</a> (void *p, size_t newSize)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resize the allocated block <code>p</code> to size <code>newSize</code>.  <a href="#4bef794b1fe6b684af91b18687707074"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html#b0c98707372ec37938f584843c2561ba">SetMemTrackerInfo</a> (const char *info)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the information used for memory tracking.  <a href="#b0c98707372ec37938f584843c2561ba"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class HeapAccess&gt;<br>
 class CS::Memory::AllocatorHeapBase&lt; HeapAccess &gt;</h3>

A memory allocator that allocates from a heap. 
<p>
The <code>HeapAccess</code> template argument must behave like the <a class="el" href="classCS_1_1Memory_1_1Heap.html" title="A separate heap from which memory can be allocated.">Heap</a> class. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structCS_1_1Memory_1_1HeapAccessPointer.html" title="Heap accessor for AllocatorHeapBase.">HeapAccessPointer</a> </dd></dl>

<p>Definition at line <a class="el" href="memheap_8h-source.html#l00084">84</a> of file <a class="el" href="memheap_8h-source.html">memheap.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8c3a33074fec52234ae2edd4d6f0e2a7"></a><!-- doxytag: member="CS::Memory::AllocatorHeapBase::Alloc" ref="8c3a33074fec52234ae2edd4d6f0e2a7" args="(const size_t n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class HeapAccess&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html">CS::Memory::AllocatorHeapBase</a>&lt; HeapAccess &gt;::Alloc           </td>
          <td>(</td>
          <td class="paramtype">const size_t&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allocate a block of memory of size <code>n</code>. 
<p>

<p>Definition at line <a class="el" href="memheap_8h-source.html#l00098">98</a> of file <a class="el" href="memheap_8h-source.html">memheap.h</a>.</p>

<p>Referenced by <a class="el" href="memheap_8h-source.html#l00131">CS::Memory::AllocatorHeapBase&lt; CS::Memory::HeapAccessPointer&lt; HeapPtr &gt; &gt;::Realloc()</a>.</p>

</div>
</div><p>
<a class="anchor" name="bb570cf6349ed2de0c24034c0a7d97b7"></a><!-- doxytag: member="CS::Memory::AllocatorHeapBase::Free" ref="bb570cf6349ed2de0c24034c0a7d97b7" args="(void *p)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class HeapAccess&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html">CS::Memory::AllocatorHeapBase</a>&lt; HeapAccess &gt;::Free           </td>
          <td>(</td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>p</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Free the block <code>p</code>. 
<p>

<p>Definition at line <a class="el" href="memheap_8h-source.html#l00118">118</a> of file <a class="el" href="memheap_8h-source.html">memheap.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="4bef794b1fe6b684af91b18687707074"></a><!-- doxytag: member="CS::Memory::AllocatorHeapBase::Realloc" ref="4bef794b1fe6b684af91b18687707074" args="(void *p, size_t newSize)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class HeapAccess&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html">CS::Memory::AllocatorHeapBase</a>&lt; HeapAccess &gt;::Realloc           </td>
          <td>(</td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>newSize</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Resize the allocated block <code>p</code> to size <code>newSize</code>. 
<p>

<p>Definition at line <a class="el" href="memheap_8h-source.html#l00131">131</a> of file <a class="el" href="memheap_8h-source.html">memheap.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b0c98707372ec37938f584843c2561ba"></a><!-- doxytag: member="CS::Memory::AllocatorHeapBase::SetMemTrackerInfo" ref="b0c98707372ec37938f584843c2561ba" args="(const char *info)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class HeapAccess&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html">CS::Memory::AllocatorHeapBase</a>&lt; HeapAccess &gt;::SetMemTrackerInfo           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>info</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the information used for memory tracking. 
<p>

<p>Definition at line <a class="el" href="memheap_8h-source.html#l00149">149</a> of file <a class="el" href="memheap_8h-source.html">memheap.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="memheap_8h-source.html">memheap.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>