Sophie

Sophie

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

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: csShaderVarBlockAlloc&lt; ObjectDispose &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>
<h1>csShaderVarBlockAlloc&lt; ObjectDispose &gt; Class Template Reference</h1><!-- doxytag: class="csShaderVarBlockAlloc" -->A block allocator for shader variables.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="shadervarblockalloc_8h-source.html">csgfx/shadervarblockalloc.h</a>&gt;</code>
<p>

<p>
<a href="classcsShaderVarBlockAlloc-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"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="classcsShaderVariable.html">csShaderVariable</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderVarBlockAlloc.html#2d71edec2ba49e791b3177fb624420bc">Alloc</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a new shader variable.  <a href="#2d71edec2ba49e791b3177fb624420bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderVarBlockAlloc.html#44595605e0609d143f2df18d43474c36">csShaderVarBlockAlloc</a> (size_t nelem=32)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a new allocator.  <a href="#44595605e0609d143f2df18d43474c36"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7438b758b50f6e369cac218e4d953370"></a><!-- doxytag: member="csShaderVarBlockAlloc::BlockAllocatedSV" ref="7438b758b50f6e369cac218e4d953370" args="" -->
struct&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderVarBlockAlloc.html#7438b758b50f6e369cac218e4d953370">BlockAllocatedSV</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ObjectDispose = csBlockAllocatorDisposeDelete&lt;csShaderVariable&gt;&gt;<br>
 class csShaderVarBlockAlloc&lt; ObjectDispose &gt;</h3>

A block allocator for shader variables. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Check the <a class="el" href="classcsBlockAllocator.html" title="This class implements a memory allocator which can efficiently allocate objects that...">csBlockAllocator</a> documentation for information on general block allocators. </dd></dl>

<p>Definition at line <a class="el" href="shadervarblockalloc_8h-source.html#l00039">39</a> of file <a class="el" href="shadervarblockalloc_8h-source.html">shadervarblockalloc.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="44595605e0609d143f2df18d43474c36"></a><!-- doxytag: member="csShaderVarBlockAlloc::csShaderVarBlockAlloc" ref="44595605e0609d143f2df18d43474c36" args="(size_t nelem=32)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectDispose = csBlockAllocatorDisposeDelete&lt;csShaderVariable&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsShaderVarBlockAlloc.html">csShaderVarBlockAlloc</a>&lt; ObjectDispose &gt;::<a class="el" href="classcsShaderVarBlockAlloc.html">csShaderVarBlockAlloc</a>           </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>nelem</em> = <code>32</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct a new allocator. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The parameters are the same as to <a class="el" href="classcsBlockAllocator.html#d8f422778b7c2fa33ee76c77f409b0c3" title="Construct a new block allocator.">csBlockAllocator&lt;T&gt;::csBlockAllocator()</a>. </dd></dl>

<p>Definition at line <a class="el" href="shadervarblockalloc_8h-source.html#l00056">56</a> of file <a class="el" href="shadervarblockalloc_8h-source.html">shadervarblockalloc.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2d71edec2ba49e791b3177fb624420bc"></a><!-- doxytag: member="csShaderVarBlockAlloc::Alloc" ref="2d71edec2ba49e791b3177fb624420bc" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectDispose = csBlockAllocatorDisposeDelete&lt;csShaderVariable&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsRef.html">csRef</a>&lt;<a class="el" href="classcsShaderVariable.html">csShaderVariable</a>&gt; <a class="el" href="classcsShaderVarBlockAlloc.html">csShaderVarBlockAlloc</a>&lt; ObjectDispose &gt;::Alloc           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allocate a new shader variable. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Returned object freed when all references are released, but when the allocating block allocator is freed. Make sure no references are kept to objects created by an allocator past its lifetime. </dd></dl>

<p>Definition at line <a class="el" href="shadervarblockalloc_8h-source.html#l00064">64</a> of file <a class="el" href="shadervarblockalloc_8h-source.html">shadervarblockalloc.h</a>.</p>

<p>References <a class="el" href="shadervarblockalloc_8h-source.html#l00046">csShaderVarBlockAlloc&lt; ObjectDispose &gt;::BlockAllocatedSV</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgfx/<a class="el" href="shadervarblockalloc_8h-source.html">shadervarblockalloc.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>