Sophie

Sophie

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

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: csShaderExpressionAccessor 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>csShaderExpressionAccessor Class Reference<br>
<small>
[<a class="el" href="group__gfx.html">Graphics</a>]</small>
</h1><!-- doxytag: class="csShaderExpressionAccessor" --><!-- doxytag: inherits="scfImplementationExt2&lt; csShaderExpressionAccessor, csObject, iShaderVariableAccessor, iSelfDestruct &gt;" -->Shader variable accessor that evaluates a shader expression when the SV value is queried.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="shaderexpaccessor_8h-source.html">csgfx/shaderexpaccessor.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csShaderExpressionAccessor:</div>
<div class="dynsection">
<p><center><img src="classcsShaderExpressionAccessor__inherit__graph.png" border="0" usemap="#csShaderExpressionAccessor__inherit__map" alt="Inheritance graph"></center>
<map name="csShaderExpressionAccessor__inherit__map">
<area shape="rect" href="classscfImplementationExt2.html" title="scfImplementationExt2\&lt; csShaderExpressionAccessor, csObject, iShaderVariableAccessor, iSelfDestruct \&gt;" alt="" coords="1113,107,1823,133"><area shape="rect" href="classcsObject.html" title="A generic csObject class." alt="" coords="937,56,1012,83"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csObject, iObject \&gt;" alt="" coords="551,56,836,83"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; csObject \&gt;" alt="" coords="275,5,501,32"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="88,81,144,108"><area shape="rect" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject." alt="" coords="356,56,420,83"><area shape="rect" href="structiShaderVariableAccessor.html" title="Interface to an accessorcallback for shadervariables." alt="" coords="885,107,1064,133"><area shape="rect" href="structiSelfDestruct.html" title="An object implementing this interface can remove itself from its &#39;natural parent&#39;..." alt="" coords="923,157,1027,184"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="5,5,227,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsShaderExpressionAccessor-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="classcsShaderExpressionAccessor.html#7bfe671af6c23d2854164f435ec5a45d">csShaderExpressionAccessor</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="classcsShaderExpression.html">csShaderExpression</a> *expression)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct accessor.  <a href="#7bfe671af6c23d2854164f435ec5a45d"></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="classcsShaderExpressionAccessor.html#64d05ae9bbf6ca3bd38efb4176766be7">PreGetValue</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before the value of the attached SV is returned.  <a href="#64d05ae9bbf6ca3bd38efb4176766be7"></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="classcsShaderExpressionAccessor.html#5f0195f7e28402b456c35ceb23b68446">SelfDestruct</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove me!  <a href="#5f0195f7e28402b456c35ceb23b68446"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Shader variable accessor that evaluates a shader expression when the SV value is queried. 
<p>Definition at line <a class="el" href="shaderexpaccessor_8h-source.html#l00048">48</a> of file <a class="el" href="shaderexpaccessor_8h-source.html">shaderexpaccessor.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="7bfe671af6c23d2854164f435ec5a45d"></a><!-- doxytag: member="csShaderExpressionAccessor::csShaderExpressionAccessor" ref="7bfe671af6c23d2854164f435ec5a45d" args="(iObjectRegistry *object_reg, csShaderExpression *expression)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csShaderExpressionAccessor::csShaderExpressionAccessor           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsShaderExpression.html">csShaderExpression</a> *&nbsp;</td>
          <td class="paramname"> <em>expression</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>
Construct accessor. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The accessor object will take ownership of <em>expression</em>. You should not further use <em>expression</em> (especially not delete it) after using it to construct an instance of this class. <p>
<em>object_reg</em> can be 0. </dd></dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="64d05ae9bbf6ca3bd38efb4176766be7"></a><!-- doxytag: member="csShaderExpressionAccessor::PreGetValue" ref="64d05ae9bbf6ca3bd38efb4176766be7" args="(csShaderVariable *variable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csShaderExpressionAccessor::PreGetValue           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *&nbsp;</td>
          <td class="paramname"> <em>variable</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Called before the value of the attached SV is returned. 
<p>

<p>Implements <a class="el" href="structiShaderVariableAccessor.html#16924424479a6c2fd5645b3defd31d3a">iShaderVariableAccessor</a>.</p>

</div>
</div><p>
<a class="anchor" name="5f0195f7e28402b456c35ceb23b68446"></a><!-- doxytag: member="csShaderExpressionAccessor::SelfDestruct" ref="5f0195f7e28402b456c35ceb23b68446" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csShaderExpressionAccessor::SelfDestruct           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove me! 
<p>

<p>Implements <a class="el" href="structiSelfDestruct.html#cbd9e2f83310f6e6a14317816d5179af">iSelfDestruct</a>.</p>

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