<!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: iShaderVariableContext 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 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>
<h1>iShaderVariableContext Struct Reference</h1><!-- doxytag: class="iShaderVariableContext" --><!-- doxytag: inherits="iBase" -->This is a baseclass for all interfaces which provides shadervariables both dynamically and static.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="shader_8h-source.html">ivideo/shader/shader.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iShaderVariableContext:</div>
<div class="dynsection">
<p><center><img src="structiShaderVariableContext__inherit__graph.png" border="0" usemap="#iShaderVariableContext__inherit__map" alt="Inheritance graph"></center>
<map name="iShaderVariableContext__inherit__map">
<area shape="rect" href="classCS_1_1ShaderVariableContextImpl.html" title="Simple implementation for iShaderVariableContext." alt="" coords="335,5,561,32"><area shape="rect" href="structiMaterial.html" title="This class represents a material as seen from the engine view." alt="" coords="411,56,485,83"><area shape="rect" href="structiShader.html" title="Specific shader." alt="" coords="413,107,483,133"><area shape="rect" href="structiShaderManager.html" title="A manager for all shaders." alt="" coords="384,157,512,184"><area shape="rect" href="structiTerrainCellRenderProperties.html" title="This is a base class for per-cell renderer-specific properties." alt="" coords="347,208,549,235"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,107,61,133"><area shape="rect" href="classcsShaderVariableContext.html" title="Complete SCF class implementing iShaderVariableContext." alt="" coords="612,5,796,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiShaderVariableContext-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="structiShaderVariableContext.html#6c9373f25e41b4b0a3ece1f42612662b">AddVariable</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a variable to this context. <a href="#6c9373f25e41b4b0a3ece1f42612662b"></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="structiShaderVariableContext.html#ab67b7a6e185e0b2bfa78476ca8036dc">Clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all variables from this context. <a href="#ab67b7a6e185e0b2bfa78476ca8036dc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<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="structiShaderVariableContext.html#5f4ad2febd6f8e0936865a2fbf9545c3">GetShaderVariables</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get Array of all ShaderVariables. <a href="#5f4ad2febd6f8e0936865a2fbf9545c3"></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="structiShaderVariableContext.html#420a6c2de50fe37f822d4ceb34e38503">GetVariable</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a named variable from this context. <a href="#420a6c2de50fe37f822d4ceb34e38503"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShaderVariableContext.html#0691ea994cf59d6b59696760d0ffc391">GetVariableAdd</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Like <a class="el" href="structiShaderVariableContext.html#420a6c2de50fe37f822d4ceb34e38503" title="Get a named variable from this context.">GetVariable()</a>, but it also adds it if doesn't exist already. <a href="#0691ea994cf59d6b59696760d0ffc391"></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="structiShaderVariableContext.html#b4ba5e2a32c84ffa0d8ee8e65f2ce2bd">IsEmpty</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine whether this SV context contains any variables at all. <a href="#b4ba5e2a32c84ffa0d8ee8e65f2ce2bd"></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="structiShaderVariableContext.html#4ad04615ccb73366c32130b5f8bdb8cf">PushVariables</a> (<a class="el" href="structiShaderVarStack.html">iShaderVarStack</a> *stacks) const =0</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="#4ad04615ccb73366c32130b5f8bdb8cf"></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="structiShaderVariableContext.html#d101477212ccf9b30a21d6c0c25e9720">RemoveVariable</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the given variable from this context. <a href="#d101477212ccf9b30a21d6c0c25e9720"></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="structiShaderVariableContext.html#4f327328bffa8bd54703ad5436effb53">ReplaceVariable</a> (<a class="el" href="classcsShaderVariable.html">csShaderVariable</a> *variable)=0</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="#4f327328bffa8bd54703ad5436effb53"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a baseclass for all interfaces which provides shadervariables both dynamically and static.
<p>Definition at line <a class="el" href="shader_8h-source.html#l00093">93</a> of file <a class="el" href="shader_8h-source.html">shader.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6c9373f25e41b4b0a3ece1f42612662b"></a><!-- doxytag: member="iShaderVariableContext::AddVariable" ref="6c9373f25e41b4b0a3ece1f42612662b" args="(csShaderVariable *variable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShaderVariableContext::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> [pure 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>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#256209c72cce9df47f507e674f1d3f7b">CS::ShaderVariableContextImpl</a>.</p>
<p>Referenced by <a class="el" href="shader_8h-source.html#l00108">GetVariableAdd()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ab67b7a6e185e0b2bfa78476ca8036dc"></a><!-- doxytag: member="iShaderVariableContext::Clear" ref="ab67b7a6e185e0b2bfa78476ca8036dc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShaderVariableContext::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all variables from this context.
<p>
<p>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#52bad6fa7ed45b862bbdcd3796414f14">CS::ShaderVariableContextImpl</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f4ad2febd6f8e0936865a2fbf9545c3"></a><!-- doxytag: member="iShaderVariableContext::GetShaderVariables" ref="5f4ad2febd6f8e0936865a2fbf9545c3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsRefArray.html">csRefArray</a><<a class="el" href="classcsShaderVariable.html">csShaderVariable</a>>& iShaderVariableContext::GetShaderVariables </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get Array of all ShaderVariables.
<p>
<p>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#8fcf9d57cd61dfbf905990ff66349f7b">CS::ShaderVariableContextImpl</a>.</p>
</div>
</div><p>
<a class="anchor" name="420a6c2de50fe37f822d4ceb34e38503"></a><!-- doxytag: member="iShaderVariableContext::GetVariable" ref="420a6c2de50fe37f822d4ceb34e38503" args="(csStringID name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsShaderVariable.html">csShaderVariable</a>* iShaderVariableContext::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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a named variable from this context.
<p>
<p>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#b5b44a6967413e57494ffb7c91a5da19">CS::ShaderVariableContextImpl</a>.</p>
<p>Referenced by <a class="el" href="shader_8h-source.html#l00108">GetVariableAdd()</a>.</p>
</div>
</div><p>
<a class="anchor" name="0691ea994cf59d6b59696760d0ffc391"></a><!-- doxytag: member="iShaderVariableContext::GetVariableAdd" ref="0691ea994cf59d6b59696760d0ffc391" args="(csStringID name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsShaderVariable.html">csShaderVariable</a>* iShaderVariableContext::GetVariableAdd </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%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Like <a class="el" href="structiShaderVariableContext.html#420a6c2de50fe37f822d4ceb34e38503" title="Get a named variable from this context.">GetVariable()</a>, but it also adds it if doesn't exist already.
<p>
<p>Definition at line <a class="el" href="shader_8h-source.html#l00108">108</a> of file <a class="el" href="shader_8h-source.html">shader.h</a>.</p>
<p>References <a class="el" href="structiShaderVariableContext.html#6c9373f25e41b4b0a3ece1f42612662b">AddVariable()</a>, and <a class="el" href="structiShaderVariableContext.html#420a6c2de50fe37f822d4ceb34e38503">GetVariable()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b4ba5e2a32c84ffa0d8ee8e65f2ce2bd"></a><!-- doxytag: member="iShaderVariableContext::IsEmpty" ref="b4ba5e2a32c84ffa0d8ee8e65f2ce2bd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iShaderVariableContext::IsEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine whether this SV context contains any variables at all.
<p>
<p>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#5566b12c7bac8df3df4d2dc2acb6ae2f">CS::ShaderVariableContextImpl</a>.</p>
</div>
</div><p>
<a class="anchor" name="4ad04615ccb73366c32130b5f8bdb8cf"></a><!-- doxytag: member="iShaderVariableContext::PushVariables" ref="4ad04615ccb73366c32130b5f8bdb8cf" args="(iShaderVarStack *stacks) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShaderVariableContext::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> [pure 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>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#c2ed7213e0ecb128a7034b33152c049d">CS::ShaderVariableContextImpl</a>.</p>
</div>
</div><p>
<a class="anchor" name="d101477212ccf9b30a21d6c0c25e9720"></a><!-- doxytag: member="iShaderVariableContext::RemoveVariable" ref="d101477212ccf9b30a21d6c0c25e9720" args="(csShaderVariable *variable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iShaderVariableContext::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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the given variable from this context.
<p>
<p>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#769e9ec74d745b269520a2b073370322">CS::ShaderVariableContextImpl</a>.</p>
</div>
</div><p>
<a class="anchor" name="4f327328bffa8bd54703ad5436effb53"></a><!-- doxytag: member="iShaderVariableContext::ReplaceVariable" ref="4f327328bffa8bd54703ad5436effb53" args="(csShaderVariable *variable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShaderVariableContext::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> [pure 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="structiShaderVariableContext.html#6c9373f25e41b4b0a3ece1f42612662b" title="Add a variable to this context.">AddVariable()</a> as this method replaces the variable *object*, not just the contents. </dd></dl>
<p>Implemented in <a class="el" href="classCS_1_1ShaderVariableContextImpl.html#8522b5eee4caa57cd3ba074e838b1047">CS::ShaderVariableContextImpl</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivideo/shader/<a class="el" href="shader_8h-source.html">shader.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3642
