Sophie

Sophie

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

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: csShaderExpression 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>csShaderExpression Class Reference</h1><!-- doxytag: class="csShaderExpression" -->An evaluable expression attached to a shader variable.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="shaderexp_8h-source.html">csgfx/shaderexp.h</a>&gt;</code>
<p>

<p>
<a href="classcsShaderExpression-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dde20a85ceed2929abe169eac9a74e72"></a><!-- doxytag: member="csShaderExpression::arg_array" ref="dde20a85ceed2929abe169eac9a74e72" args="" -->
typedef <a class="el" href="classcsArray.html">csArray</a><br>
&lt; <a class="el" href="structcsShaderExpression_1_1oper__arg.html">oper_arg</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderExpression.html#dde20a85ceed2929abe169eac9a74e72">arg_array</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5a5141f253e4964db6373376afe3a8c"></a><!-- doxytag: member="csShaderExpression::oper_array" ref="d5a5141f253e4964db6373376afe3a8c" args="" -->
typedef <a class="el" href="classcsArray.html">csArray</a>&lt; <a class="el" href="structcsShaderExpression_1_1oper.html">oper</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderExpression.html#d5a5141f253e4964db6373376afe3a8c">oper_array</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderExpression.html#c2533fd3015ea69c8846df92e8aabbd2">GetError</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the error message if the evaluation or parsing failed.  <a href="#c2533fd3015ea69c8846df92e8aabbd2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderExpression.html#6215c0960099ed1be46dbf7843389644">Parse</a> (<a class="el" href="structiDocumentNode.html">iDocumentNode</a> *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse in the XML in the context of a symbol table.  <a href="#6215c0960099ed1be46dbf7843389644"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderExpression.html#78967f3f0789c400c1d94469a534f13b">Evaluate</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *, <a class="el" href="classcsArray.html">csShaderVarStack</a> &amp;stacks)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate this expression into a variable.  <a href="#78967f3f0789c400c1d94469a534f13b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsShaderExpression_1_1oper.html">oper</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsShaderExpression_1_1oper__arg.html">oper_arg</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An evaluable expression attached to a shader variable. 
<p>Definition at line <a class="el" href="shaderexp_8h-source.html#l00044">44</a> of file <a class="el" href="shaderexp_8h-source.html">shaderexp.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="78967f3f0789c400c1d94469a534f13b"></a><!-- doxytag: member="csShaderExpression::Evaluate" ref="78967f3f0789c400c1d94469a534f13b" args="(csShaderVariable *, csShaderVarStack &amp;stacks)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csShaderExpression::Evaluate           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsArray.html">csShaderVarStack</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>stacks</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>
Evaluate this expression into a variable. 
<p>
It will use the symbol table it was initialized with. 
</div>
</div><p>
<a class="anchor" name="c2533fd3015ea69c8846df92e8aabbd2"></a><!-- doxytag: member="csShaderExpression::GetError" ref="c2533fd3015ea69c8846df92e8aabbd2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* csShaderExpression::GetError           </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>
Retrieve the error message if the evaluation or parsing failed. 
<p>

<p>Definition at line <a class="el" href="shaderexp_8h-source.html#l00235">235</a> of file <a class="el" href="shaderexp_8h-source.html">shaderexp.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="6215c0960099ed1be46dbf7843389644"></a><!-- doxytag: member="csShaderExpression::Parse" ref="6215c0960099ed1be46dbf7843389644" args="(iDocumentNode *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csShaderExpression::Parse           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiDocumentNode.html">iDocumentNode</a> *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Parse in the XML in the context of a symbol table. 
<p>

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