Sophie

Sophie

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

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: iGenericRenderStep Struct 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>iGenericRenderStep Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__rloop.html">Renderloops &amp; Rendersteps</a>]</small>
</h1><!-- doxytag: class="iGenericRenderStep" --><!-- doxytag: inherits="iBase" -->A generic render step.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="igeneric_8h-source.html">iengine/rendersteps/igeneric.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iGenericRenderStep:</div>
<div class="dynsection">
<p><center><img src="structiGenericRenderStep__inherit__graph.png" border="0" usemap="#iGenericRenderStep__inherit__map" alt="Inheritance graph"></center>
<map name="iGenericRenderStep__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="52,7,108,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiGenericRenderStep-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#456c0332d07a5c0d933bba832fe778ec">AddDisableDefaultTriggerType</a> (const char *type)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a shader type that, when present on a material, prevents the "use default shader" logic to not kick in.  <a href="#456c0332d07a5c0d933bba832fe778ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShader.html">iShader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#46d66bd841526f239cd2d78bb9a1157b">GetDefaultShader</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the default shader.  <a href="#46d66bd841526f239cd2d78bb9a1157b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#bd21998917a1ca47ddd73b25a919adb7">GetPortalTraversal</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get portal traversal flag.  <a href="#bd21998917a1ca47ddd73b25a919adb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#f5e3d4200d1f54a27437bb60d82db5ec">GetShaderType</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get shader type.  <a href="#f5e3d4200d1f54a27437bb60d82db5ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__gfx3d.html#g79fdaed7abd7a72af33d0f0c5dc99055">csZBufMode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#06e515b9d5c50266945a42822ffff552">GetZBufMode</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get Z buffer mode.  <a href="#06e515b9d5c50266945a42822ffff552"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#1b5d84da433270b9add75b09d4b040da">GetZOffset</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get Z offset flag.  <a href="#1b5d84da433270b9add75b09d4b040da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#aeea3ea03d886d286a5d97467ef0c4a5">RemoveDisableDefaultTriggerType</a> (const char *type)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a shader type that prevents default shader usage.  <a href="#aeea3ea03d886d286a5d97467ef0c4a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#08656fe1d3c7858ab40c724747ac38b9">SetDefaultShader</a> (<a class="el" href="structiShader.html">iShader</a> *shader)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the default shader that is used if a material doesn't provide one for the shader type of this step.  <a href="#08656fe1d3c7858ab40c724747ac38b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#4a5f8c8088ae3da5113fc3e6284c77a9">SetPortalTraversal</a> (bool p)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable/disable portal traversal for this renderstep.  <a href="#4a5f8c8088ae3da5113fc3e6284c77a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#0093599b21e35fa1befe7c5831ea8069">SetShaderType</a> (const char *type)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set shader type.  <a href="#0093599b21e35fa1befe7c5831ea8069"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#99df0190ac612e7c6cefea025f8d3d67">SetZBufMode</a> (<a class="el" href="group__gfx3d.html#g79fdaed7abd7a72af33d0f0c5dc99055">csZBufMode</a> zmode)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set Z buffer mode.  <a href="#99df0190ac612e7c6cefea025f8d3d67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiGenericRenderStep.html#6dff39603684aad6b655cc5919be5a6c">SetZOffset</a> (bool zOffset)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set Z offset flag.  <a href="#6dff39603684aad6b655cc5919be5a6c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A generic render step. 
<p>Definition at line <a class="el" href="igeneric_8h-source.html#l00039">39</a> of file <a class="el" href="igeneric_8h-source.html">igeneric.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="456c0332d07a5c0d933bba832fe778ec"></a><!-- doxytag: member="iGenericRenderStep::AddDisableDefaultTriggerType" ref="456c0332d07a5c0d933bba832fe778ec" args="(const char *type)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::AddDisableDefaultTriggerType           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a shader type that, when present on a material, prevents the "use default shader" logic to not kick in. 
<p>

</div>
</div><p>
<a class="anchor" name="46d66bd841526f239cd2d78bb9a1157b"></a><!-- doxytag: member="iGenericRenderStep::GetDefaultShader" ref="46d66bd841526f239cd2d78bb9a1157b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiShader.html">iShader</a>* iGenericRenderStep::GetDefaultShader           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the default shader. 
<p>

</div>
</div><p>
<a class="anchor" name="bd21998917a1ca47ddd73b25a919adb7"></a><!-- doxytag: member="iGenericRenderStep::GetPortalTraversal" ref="bd21998917a1ca47ddd73b25a919adb7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iGenericRenderStep::GetPortalTraversal           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get portal traversal flag. 
<p>

</div>
</div><p>
<a class="anchor" name="f5e3d4200d1f54a27437bb60d82db5ec"></a><!-- doxytag: member="iGenericRenderStep::GetShaderType" ref="f5e3d4200d1f54a27437bb60d82db5ec" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* iGenericRenderStep::GetShaderType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get shader type. 
<p>

</div>
</div><p>
<a class="anchor" name="06e515b9d5c50266945a42822ffff552"></a><!-- doxytag: member="iGenericRenderStep::GetZBufMode" ref="06e515b9d5c50266945a42822ffff552" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__gfx3d.html#g79fdaed7abd7a72af33d0f0c5dc99055">csZBufMode</a> iGenericRenderStep::GetZBufMode           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get Z buffer mode. 
<p>

</div>
</div><p>
<a class="anchor" name="1b5d84da433270b9add75b09d4b040da"></a><!-- doxytag: member="iGenericRenderStep::GetZOffset" ref="1b5d84da433270b9add75b09d4b040da" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iGenericRenderStep::GetZOffset           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get Z offset flag. 
<p>

</div>
</div><p>
<a class="anchor" name="aeea3ea03d886d286a5d97467ef0c4a5"></a><!-- doxytag: member="iGenericRenderStep::RemoveDisableDefaultTriggerType" ref="aeea3ea03d886d286a5d97467ef0c4a5" args="(const char *type)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::RemoveDisableDefaultTriggerType           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove a shader type that prevents default shader usage. 
<p>

</div>
</div><p>
<a class="anchor" name="08656fe1d3c7858ab40c724747ac38b9"></a><!-- doxytag: member="iGenericRenderStep::SetDefaultShader" ref="08656fe1d3c7858ab40c724747ac38b9" args="(iShader *shader)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::SetDefaultShader           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiShader.html">iShader</a> *&nbsp;</td>
          <td class="paramname"> <em>shader</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the default shader that is used if a material doesn't provide one for the shader type of this step. 
<p>

</div>
</div><p>
<a class="anchor" name="4a5f8c8088ae3da5113fc3e6284c77a9"></a><!-- doxytag: member="iGenericRenderStep::SetPortalTraversal" ref="4a5f8c8088ae3da5113fc3e6284c77a9" args="(bool p)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::SetPortalTraversal           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>p</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Enable/disable portal traversal for this renderstep. 
<p>

</div>
</div><p>
<a class="anchor" name="0093599b21e35fa1befe7c5831ea8069"></a><!-- doxytag: member="iGenericRenderStep::SetShaderType" ref="0093599b21e35fa1befe7c5831ea8069" args="(const char *type)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::SetShaderType           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set shader type. 
<p>

</div>
</div><p>
<a class="anchor" name="99df0190ac612e7c6cefea025f8d3d67"></a><!-- doxytag: member="iGenericRenderStep::SetZBufMode" ref="99df0190ac612e7c6cefea025f8d3d67" args="(csZBufMode zmode)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::SetZBufMode           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__gfx3d.html#g79fdaed7abd7a72af33d0f0c5dc99055">csZBufMode</a>&nbsp;</td>
          <td class="paramname"> <em>zmode</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set Z buffer mode. 
<p>

</div>
</div><p>
<a class="anchor" name="6dff39603684aad6b655cc5919be5a6c"></a><!-- doxytag: member="iGenericRenderStep::SetZOffset" ref="6dff39603684aad6b655cc5919be5a6c" args="(bool zOffset)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iGenericRenderStep::SetZOffset           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>zOffset</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set Z offset flag. 
<p>

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