Sophie

Sophie

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

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 Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><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="namespaces.html"><span>Namespace List</span></a></li>
    <li><a href="namespacemembers.html"><span>Namespace&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></div>
<h1>CS::Memory Namespace Reference</h1><a class="el" href="namespaceCS_1_1Memory.html" title="Memory allocation.">Memory</a> allocation.  
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorAlign.html">AllocatorAlign</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This class implements an allocator policy which aligns the first element on given byte boundary.  <a href="classCS_1_1Memory_1_1AllocatorAlign.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeap.html">AllocatorHeap</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A memory allocator that allocates from a heap.  <a href="classCS_1_1Memory_1_1AllocatorHeap.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html">AllocatorHeapBase</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A memory allocator that allocates from a heap.  <a href="classCS_1_1Memory_1_1AllocatorHeapBase.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorMalloc.html">AllocatorMalloc</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A default memory allocator that allocates with <a class="el" href="cssysdef_8h.html#bcc451ff5f6451f8b8bcbe91c762bcf0">cs_malloc()</a>.  <a href="classCS_1_1Memory_1_1AllocatorMalloc.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorNew.html">AllocatorNew</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A default memory allocator that allocates using new T[].  <a href="classCS_1_1Memory_1_1AllocatorNew.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1AllocatorNewChar.html">AllocatorNewChar</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A default memory allocator that allocates using new char[].  <a href="classCS_1_1Memory_1_1AllocatorNewChar.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html">AllocatorPointerWrapper</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to store a pointer that is allocated from Allocator, to eliminate overhead from a possibly empty Allocator.  <a href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1CustomAllocated.html">CustomAllocated</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class that overrides operator new/operator delete/etc.  <a href="classCS_1_1Memory_1_1CustomAllocated.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1Heap.html">Heap</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A separate heap from which memory can be allocated.  <a href="classCS_1_1Memory_1_1Heap.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCS_1_1Memory_1_1HeapAccessPointer.html">HeapAccessPointer</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classCS_1_1Memory_1_1Heap.html" title="A separate heap from which memory can be allocated.">Heap</a> accessor for <a class="el" href="classCS_1_1Memory_1_1AllocatorHeapBase.html" title="A memory allocator that allocates from a heap.">AllocatorHeapBase</a>.  <a href="structCS_1_1Memory_1_1HeapAccessPointer.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Memory_1_1LocalBufferAllocator.html">LocalBufferAllocator</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An allocator with a small local buffer.  <a href="classCS_1_1Memory_1_1LocalBufferAllocator.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>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="namespaceCS_1_1Memory.html#24e1a01a11f8cd839a625bfe10c4b984">AlignedFree</a> (void *ptr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Free a block of memory allocated with AlignedMalloc.  <a href="#24e1a01a11f8cd839a625bfe10c4b984"></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="namespaceCS_1_1Memory.html#c840bbf3f092cb8d7cacb3b886930444">AlignedMalloc</a> (size_t size, size_t align)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a block of memory, with the start address being aligned to a multiple of <code>align</code> bytes.  <a href="#c840bbf3f092cb8d7cacb3b886930444"></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="namespaceCS_1_1Memory.html#80bd77b1f5274e7cda7c95f26fff0d10">AlignedRealloc</a> (void *ptr, size_t size, size_t align)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reallocate a block of memory with a new size, with the start address being aligned to a multiple of <code>align</code> bytes.  <a href="#80bd77b1f5274e7cda7c95f26fff0d10"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="namespaceCS_1_1Memory.html" title="Memory allocation.">Memory</a> allocation. <hr><h2>Function Documentation</h2>
<a class="anchor" name="24e1a01a11f8cd839a625bfe10c4b984"></a><!-- doxytag: member="CS::Memory::AlignedFree" ref="24e1a01a11f8cd839a625bfe10c4b984" args="(void *ptr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CS::Memory::AlignedFree           </td>
          <td>(</td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>ptr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Free a block of memory allocated with AlignedMalloc. 
<p>

<p>Referenced by <a class="el" href="allocator_8h-source.html#l00215">CS::Memory::AllocatorAlign&lt; A &gt;::Free()</a>.</p>

</div>
</div><p>
<a class="anchor" name="c840bbf3f092cb8d7cacb3b886930444"></a><!-- doxytag: member="CS::Memory::AlignedMalloc" ref="c840bbf3f092cb8d7cacb3b886930444" args="(size_t size, size_t align)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* CS::Memory::AlignedMalloc           </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>align</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allocate a block of memory, with the start address being aligned to a multiple of <code>align</code> bytes. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The returned block of memory must be freed with AlignedFree. </dd></dl>

<p>Referenced by <a class="el" href="allocator_8h-source.html#l00206">CS::Memory::AllocatorAlign&lt; A &gt;::Alloc()</a>.</p>

</div>
</div><p>
<a class="anchor" name="80bd77b1f5274e7cda7c95f26fff0d10"></a><!-- doxytag: member="CS::Memory::AlignedRealloc" ref="80bd77b1f5274e7cda7c95f26fff0d10" args="(void *ptr, size_t size, size_t align)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* CS::Memory::AlignedRealloc           </td>
          <td>(</td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>align</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reallocate a block of memory with a new size, with the start address being aligned to a multiple of <code>align</code> bytes. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The returned block of memory must be freed with AlignedFree. </dd></dl>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>The alignment must be the same as initially passed to AlignedMalloc. </dd></dl>

<p>Referenced by <a class="el" href="allocator_8h-source.html#l00220">CS::Memory::AllocatorAlign&lt; A &gt;::Realloc()</a>.</p>

</div>
</div><p>
<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>