Sophie

Sophie

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

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: csRenderBufferHolder Class 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>csRenderBufferHolder Class Reference<br>
<small>
[<a class="el" href="group__gfx3d.html">3D</a>]</small>
</h1><!-- doxytag: class="csRenderBufferHolder" --><!-- doxytag: inherits="csRefCount" -->Holder of standard renderbuffers.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="rndbuf_8h-source.html">ivideo/rndbuf.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csRenderBufferHolder:</div>
<div class="dynsection">
<p><center><img src="classcsRenderBufferHolder__inherit__graph.png" border="0" usemap="#csRenderBufferHolder__inherit__map" alt="Inheritance graph"></center>
<map name="csRenderBufferHolder__inherit__map">
<area shape="rect" href="classcsRefCount.html" title="This is a class which provides basic reference&#45;counting semantics." alt="" coords="40,7,136,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsRenderBufferHolder-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#dea040f4f9618b6c1a5bf0e80537f655">csRenderBufferHolder</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">initialize  <a href="#dea040f4f9618b6c1a5bf0e80537f655"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiRenderBufferAccessor.html">iRenderBufferAccessor</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#20d436cee24d37f1f2a67250b878a947">GetAccessor</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the accessor.  <a href="#20d436cee24d37f1f2a67250b878a947"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#cd5b28a5b2863b2bd9848a6917432447">GetAccessorMask</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the accessor mask.  <a href="#cd5b28a5b2863b2bd9848a6917432447"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#2b48647eb884d40e34a7432e0c55c1c0">GetRenderBuffer</a> (<a class="el" href="group__gfx3d.html#g70013f7ff48bca5acf2c00bbb02eb6d6">csRenderBufferName</a> bufferName)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get buffer by name.  <a href="#2b48647eb884d40e34a7432e0c55c1c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#eed76d0fd4629ca905e0a96d4f03c406">GetRenderBufferNoAccessor</a> (<a class="el" href="group__gfx3d.html#g70013f7ff48bca5acf2c00bbb02eb6d6">csRenderBufferName</a> bufferName)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get buffer by name.  <a href="#eed76d0fd4629ca905e0a96d4f03c406"></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="classcsRenderBufferHolder.html#bd0fddfd94336a2fcb3ea153b695d3d4">SetAccessor</a> (<a class="el" href="structiRenderBufferAccessor.html">iRenderBufferAccessor</a> *a, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set accessor.  <a href="#bd0fddfd94336a2fcb3ea153b695d3d4"></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="classcsRenderBufferHolder.html#6e408bbd99b6d6d0bf133872d323752f">SetRenderBuffer</a> (<a class="el" href="group__gfx3d.html#g70013f7ff48bca5acf2c00bbb02eb6d6">csRenderBufferName</a> bufferName, <a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> *buffer)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set renderbuffer.  <a href="#6e408bbd99b6d6d0bf133872d323752f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="409ff459a2c0bca3b1e082028f36d641"></a><!-- doxytag: member="csRenderBufferHolder::accessor" ref="409ff459a2c0bca3b1e082028f36d641" args="" -->
<a class="el" href="classcsRef.html">csRef</a><br>
&lt; <a class="el" href="structiRenderBufferAccessor.html">iRenderBufferAccessor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#409ff459a2c0bca3b1e082028f36d641">accessor</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6196098e88920cc6b5912d5a1ca86937"></a><!-- doxytag: member="csRenderBufferHolder::accessorMask" ref="6196098e88920cc6b5912d5a1ca86937" args="" -->
<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#6196098e88920cc6b5912d5a1ca86937">accessorMask</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7cc87654c677022782e2d34fb719f384"></a><!-- doxytag: member="csRenderBufferHolder::buffers" ref="7cc87654c677022782e2d34fb719f384" args="[CS_BUFFER_COUNT]" -->
<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBufferHolder.html#7cc87654c677022782e2d34fb719f384">buffers</a> [CS_BUFFER_COUNT]</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Holder of standard renderbuffers. 
<p>
@DOC MORE 
<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00336">336</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="dea040f4f9618b6c1a5bf0e80537f655"></a><!-- doxytag: member="csRenderBufferHolder::csRenderBufferHolder" ref="dea040f4f9618b6c1a5bf0e80537f655" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csRenderBufferHolder::csRenderBufferHolder           </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>
initialize 
<p>

<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00340">340</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00389">accessorMask</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="20d436cee24d37f1f2a67250b878a947"></a><!-- doxytag: member="csRenderBufferHolder::GetAccessor" ref="20d436cee24d37f1f2a67250b878a947" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiRenderBufferAccessor.html">iRenderBufferAccessor</a>* csRenderBufferHolder::GetAccessor           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Query the accessor. 
<p>

<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00387">387</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00390">accessor</a>.</p>

</div>
</div><p>
<a class="anchor" name="cd5b28a5b2863b2bd9848a6917432447"></a><!-- doxytag: member="csRenderBufferHolder::GetAccessorMask" ref="cd5b28a5b2863b2bd9848a6917432447" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> csRenderBufferHolder::GetAccessorMask           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Query the accessor mask. 
<p>

<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00385">385</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00389">accessorMask</a>.</p>

</div>
</div><p>
<a class="anchor" name="2b48647eb884d40e34a7432e0c55c1c0"></a><!-- doxytag: member="csRenderBufferHolder::GetRenderBuffer" ref="2b48647eb884d40e34a7432e0c55c1c0" args="(csRenderBufferName bufferName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiRenderBuffer.html">iRenderBuffer</a>* csRenderBufferHolder::GetRenderBuffer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__gfx3d.html#g70013f7ff48bca5acf2c00bbb02eb6d6">csRenderBufferName</a>&nbsp;</td>
          <td class="paramname"> <em>bufferName</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get buffer by name. 
<p>
If an accessor is set, it will first be called, after that the buffer will be fetched. 
<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00346">346</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00390">accessor</a>, <a class="el" href="rndbuf_8h-source.html#l00389">accessorMask</a>, <a class="el" href="rndbuf_8h-source.html#l00391">buffers</a>, <a class="el" href="rndbuf_8h-source.html#l00238">CS_BUFFER_INDEX</a>, and <a class="el" href="rndbuf_8h-source.html#l00277">CS_BUFFER_MAKE_MASKABLE</a>.</p>

</div>
</div><p>
<a class="anchor" name="eed76d0fd4629ca905e0a96d4f03c406"></a><!-- doxytag: member="csRenderBufferHolder::GetRenderBufferNoAccessor" ref="eed76d0fd4629ca905e0a96d4f03c406" args="(csRenderBufferName bufferName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiRenderBuffer.html">iRenderBuffer</a>* csRenderBufferHolder::GetRenderBufferNoAccessor           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__gfx3d.html#g70013f7ff48bca5acf2c00bbb02eb6d6">csRenderBufferName</a>&nbsp;</td>
          <td class="paramname"> <em>bufferName</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get buffer by name. 
<p>
This version won't call accessor 
<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00360">360</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00391">buffers</a>, and <a class="el" href="rndbuf_8h-source.html#l00238">CS_BUFFER_INDEX</a>.</p>

</div>
</div><p>
<a class="anchor" name="bd0fddfd94336a2fcb3ea153b695d3d4"></a><!-- doxytag: member="csRenderBufferHolder::SetAccessor" ref="bd0fddfd94336a2fcb3ea153b695d3d4" args="(iRenderBufferAccessor *a, uint32 mask)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csRenderBufferHolder::SetAccessor           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiRenderBufferAccessor.html">iRenderBufferAccessor</a> *&nbsp;</td>
          <td class="paramname"> <em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td>
          <td class="paramname"> <em>mask</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>
Set accessor. 
<p>

<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00379">379</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00390">accessor</a>, and <a class="el" href="rndbuf_8h-source.html#l00389">accessorMask</a>.</p>

</div>
</div><p>
<a class="anchor" name="6e408bbd99b6d6d0bf133872d323752f"></a><!-- doxytag: member="csRenderBufferHolder::SetRenderBuffer" ref="6e408bbd99b6d6d0bf133872d323752f" args="(csRenderBufferName bufferName, iRenderBuffer *buffer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csRenderBufferHolder::SetRenderBuffer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__gfx3d.html#g70013f7ff48bca5acf2c00bbb02eb6d6">csRenderBufferName</a>&nbsp;</td>
          <td class="paramname"> <em>bufferName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>buffer</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>
Set renderbuffer. 
<p>

<p>Definition at line <a class="el" href="rndbuf_8h-source.html#l00370">370</a> of file <a class="el" href="rndbuf_8h-source.html">rndbuf.h</a>.</p>

<p>References <a class="el" href="rndbuf_8h-source.html#l00391">buffers</a>, <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="rndbuf_8h-source.html#l00274">CS_BUFFER_COUNT</a>.</p>

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