<!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: CS::ShaderVariableContextImpl 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 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 Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="nav"> <a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="classCS_1_1ShaderVariableContextImpl.html">ShaderVariableContextImpl</a></div> <h1>CS::ShaderVariableContextImpl Class Reference</h1><!-- doxytag: class="CS::ShaderVariableContextImpl" --><!-- doxytag: inherits="iShaderVariableContext" -->Simple implementation for <a class="el" href="structiShaderVariableContext.html" title="This is a baseclass for all interfaces which provides shadervariables both dynamically...">iShaderVariableContext</a>. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="shadervarcontext_8h-source.html">csgfx/shadervarcontext.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for CS::ShaderVariableContextImpl:</div> <div class="dynsection"> <p><center><img src="classCS_1_1ShaderVariableContextImpl__inherit__graph.png" border="0" usemap="#CS_1_1ShaderVariableContextImpl__inherit__map" alt="Inheritance graph"></center> <map name="CS_1_1ShaderVariableContextImpl__inherit__map"> <area shape="rect" href="classcsShaderVariableContext.html" title="Complete SCF class implementing iShaderVariableContext." alt="" coords="27,239,211,265"><area shape="rect" href="structiShaderVariableContext.html" title="This is a baseclass for all interfaces which provides shadervariables both dynamically..." alt="" coords="32,84,205,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="91,7,147,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classCS_1_1ShaderVariableContextImpl-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#256209c72cce9df47f507e674f1d3f7b">AddVariable</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a variable to this context. <a href="#256209c72cce9df47f507e674f1d3f7b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#52bad6fa7ed45b862bbdcd3796414f14">Clear</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all variables from this context. <a href="#52bad6fa7ed45b862bbdcd3796414f14"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsRefArray.html">csRefArray</a><br> < <a class="el" href="classcsShaderVariable.html">csShaderVariable</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#8fcf9d57cd61dfbf905990ff66349f7b">GetShaderVariables</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get Array of all ShaderVariables. <a href="#8fcf9d57cd61dfbf905990ff66349f7b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br> <a class="el" href="classcsShaderVariable.html">csShaderVariable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#b5b44a6967413e57494ffb7c91a5da19">GetVariable</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> name) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a named variable from this context. <a href="#b5b44a6967413e57494ffb7c91a5da19"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#5566b12c7bac8df3df4d2dc2acb6ae2f">IsEmpty</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Determine whether this SV context contains any variables at all. <a href="#5566b12c7bac8df3df4d2dc2acb6ae2f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#c2ed7213e0ecb128a7034b33152c049d">PushVariables</a> (<a class="el" href="structiShaderVarStack.html">iShaderVarStack</a> *stacks) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Push the variables of this context onto the variable stacks supplied in the "stacks" argument. <a href="#c2ed7213e0ecb128a7034b33152c049d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#769e9ec74d745b269520a2b073370322">RemoveVariable</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the given variable from this context. <a href="#769e9ec74d745b269520a2b073370322"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#8522b5eee4caa57cd3ba074e838b1047">ReplaceVariable</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Replace the current variable object of the same name as <em>variable</em> with the latter, add <em>variable</em> otherwise. <a href="#8522b5eee4caa57cd3ba074e838b1047"></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="312d0565f1fcd26d3599e530507d3976"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::variables" ref="312d0565f1fcd26d3599e530507d3976" args="" --> <a class="el" href="classcsRefArray.html">csRefArray</a><br> < <a class="el" href="classcsShaderVariable.html">csShaderVariable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1ShaderVariableContextImpl.html#312d0565f1fcd26d3599e530507d3976">variables</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Simple implementation for <a class="el" href="structiShaderVariableContext.html" title="This is a baseclass for all interfaces which provides shadervariables both dynamically...">iShaderVariableContext</a>. <p> Can be inherited from for use in SCF classes. For an example, see <a class="el" href="classcsShaderVariableContext.html" title="Complete SCF class implementing iShaderVariableContext.">csShaderVariableContext</a>. <p>Definition at line <a class="el" href="shadervarcontext_8h-source.html#l00041">41</a> of file <a class="el" href="shadervarcontext_8h-source.html">shadervarcontext.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="256209c72cce9df47f507e674f1d3f7b"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::AddVariable" ref="256209c72cce9df47f507e674f1d3f7b" args="(csShaderVariable *variable)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void CS::ShaderVariableContextImpl::AddVariable </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a> * </td> <td class="paramname"> <em>variable</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add a variable to this context. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>If a variable of the same name exists in the current context, its contents are replaced with those of <em>variable</em>. </dd></dl> <p>Implements <a class="el" href="structiShaderVariableContext.html#6c9373f25e41b4b0a3ece1f42612662b">iShaderVariableContext</a>.</p> </div> </div><p> <a class="anchor" name="52bad6fa7ed45b862bbdcd3796414f14"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::Clear" ref="52bad6fa7ed45b862bbdcd3796414f14" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void CS::ShaderVariableContextImpl::Clear </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Remove all variables from this context. <p> <p>Implements <a class="el" href="structiShaderVariableContext.html#ab67b7a6e185e0b2bfa78476ca8036dc">iShaderVariableContext</a>.</p> <p>Definition at line <a class="el" href="shadervarcontext_8h-source.html#l00057">57</a> of file <a class="el" href="shadervarcontext_8h-source.html">shadervarcontext.h</a>.</p> </div> </div><p> <a class="anchor" name="8fcf9d57cd61dfbf905990ff66349f7b"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::GetShaderVariables" ref="8fcf9d57cd61dfbf905990ff66349f7b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcsRefArray.html">csRefArray</a><<a class="el" href="classcsShaderVariable.html">csShaderVariable</a>>& CS::ShaderVariableContextImpl::GetShaderVariables </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get Array of all ShaderVariables. <p> <p>Implements <a class="el" href="structiShaderVariableContext.html#5f4ad2febd6f8e0936865a2fbf9545c3">iShaderVariableContext</a>.</p> <p>Definition at line <a class="el" href="shadervarcontext_8h-source.html#l00050">50</a> of file <a class="el" href="shadervarcontext_8h-source.html">shadervarcontext.h</a>.</p> </div> </div><p> <a class="anchor" name="b5b44a6967413e57494ffb7c91a5da19"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::GetVariable" ref="b5b44a6967413e57494ffb7c91a5da19" args="(csStringID name) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classcsShaderVariable.html">csShaderVariable</a>* CS::ShaderVariableContextImpl::GetVariable </td> <td>(</td> <td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get a named variable from this context. <p> <p>Implements <a class="el" href="structiShaderVariableContext.html#420a6c2de50fe37f822d4ceb34e38503">iShaderVariableContext</a>.</p> </div> </div><p> <a class="anchor" name="5566b12c7bac8df3df4d2dc2acb6ae2f"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::IsEmpty" ref="5566b12c7bac8df3df4d2dc2acb6ae2f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool CS::ShaderVariableContextImpl::IsEmpty </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Determine whether this SV context contains any variables at all. <p> <p>Implements <a class="el" href="structiShaderVariableContext.html#b4ba5e2a32c84ffa0d8ee8e65f2ce2bd">iShaderVariableContext</a>.</p> <p>Definition at line <a class="el" href="shadervarcontext_8h-source.html#l00055">55</a> of file <a class="el" href="shadervarcontext_8h-source.html">shadervarcontext.h</a>.</p> </div> </div><p> <a class="anchor" name="c2ed7213e0ecb128a7034b33152c049d"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::PushVariables" ref="c2ed7213e0ecb128a7034b33152c049d" args="(iShaderVarStack *stacks) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void CS::ShaderVariableContextImpl::PushVariables </td> <td>(</td> <td class="paramtype"><a class="el" href="structiShaderVarStack.html">iShaderVarStack</a> * </td> <td class="paramname"> <em>stacks</em> </td> <td> ) </td> <td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Push the variables of this context onto the variable stacks supplied in the "stacks" argument. <p> <p>Implements <a class="el" href="structiShaderVariableContext.html#4ad04615ccb73366c32130b5f8bdb8cf">iShaderVariableContext</a>.</p> </div> </div><p> <a class="anchor" name="769e9ec74d745b269520a2b073370322"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::RemoveVariable" ref="769e9ec74d745b269520a2b073370322" args="(csShaderVariable *variable)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool CS::ShaderVariableContextImpl::RemoveVariable </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a> * </td> <td class="paramname"> <em>variable</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Remove the given variable from this context. <p> <p>Implements <a class="el" href="structiShaderVariableContext.html#d101477212ccf9b30a21d6c0c25e9720">iShaderVariableContext</a>.</p> </div> </div><p> <a class="anchor" name="8522b5eee4caa57cd3ba074e838b1047"></a><!-- doxytag: member="CS::ShaderVariableContextImpl::ReplaceVariable" ref="8522b5eee4caa57cd3ba074e838b1047" args="(csShaderVariable *variable)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void CS::ShaderVariableContextImpl::ReplaceVariable </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a> * </td> <td class="paramname"> <em>variable</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Replace the current variable object of the same name as <em>variable</em> with the latter, add <em>variable</em> otherwise. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This differs from <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#256209c72cce9df47f507e674f1d3f7b" title="Add a variable to this context.">AddVariable()</a> as this method replaces the variable *object*, not just the contents. </dd></dl> <p>Implements <a class="el" href="structiShaderVariableContext.html#4f327328bffa8bd54703ad5436effb53">iShaderVariableContext</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csgfx/<a class="el" href="shadervarcontext_8h-source.html">shadervarcontext.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>