Sophie

Sophie

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

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: csLightShaderVarCache 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>csLightShaderVarCache Class Reference</h1><!-- doxytag: class="csLightShaderVarCache" -->Helper to cache names of shader variables relevant to lighting.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="lightsvcache_8h-source.html">csgfx/lightsvcache.h</a>&gt;</code>
<p>

<p>
<a href="classcsLightShaderVarCache-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">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a">DefaultSV</a> { <a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a7c8c01fbba157bbba5bbb09df1708d98">varAmbient</a> =  0, 
<a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a94dc301e6f53590b0e065b7844971f38">varLightCount</a>, 
<a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a1de7a5c60603ad44a0d7d81d8aef31ca">_varCount</a>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Other generally useful shader variables that can be obtained.  <a href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14">LightProperty</a> { <br>
&nbsp;&nbsp;<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14709238ed1b49834b099ee8173a26b0fb">lightDiffuse</a> =  0, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f146c43c0821928d5cd00bfb5161fee700a">lightSpecular</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f143a732fb887c0a37a1b165f7b99a7d7e2">lightPosition</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14dc45c9751b9412706fdaa257b21a9339">lightPositionCamera</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14be11ddc15abe301240f388c28ee041da">lightPositionWorld</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14a8dce1c283bb84cd77f69e046936a29c">lightTransformCamera</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1415ec9df2a17d1481e905c84375c925c0">lightTransformWorld</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14806a210cc5239118693476863ac87700">lightAttenuation</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1400cacb4de9c4ffb7ecd95ee7c11e324a">lightAttenuationTex</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f142bab269297a155024d619b18c0d90806">lightDirection</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14cd03482a1d84baf607ac8121b4445842">lightDirectionCamera</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f143b77b1334b01cc01317e3271be643259">lightDirectionWorld</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1490816983c9a3069d039e61f80d6f6db9">lightInnerFalloff</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1474203b72905f6d2c05e5983bfd78ddbd">lightOuterFalloff</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14df9edeb325a83b31ec59aff840f57551">lightType</a>, 
<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f145bff9a9618e8160e16d73f6f311fecb0">lightAttenuationMode</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1431d7f0ce5378ebb6d86b8ad061a69c1b">_lightCount</a>
<br>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Properties of lights for which shader variables are known.  <a href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14">More...</a><br></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="classcsLightShaderVarCache.html#51f013ee750ea3c19bf553f50555689a">csLightShaderVarCache</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an instance.  <a href="#51f013ee750ea3c19bf553f50555689a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsLightShaderVarCache.html#5431cae71f94e09b7feb065858dc9cde">GetDefaultSVId</a> (<a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a">DefaultSV</a> var)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain the name for for a lighting-relevant shader variable whose name does not depend on the number of a light.  <a href="#5431cae71f94e09b7feb065858dc9cde"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsLightShaderVarCache.html#e0f9be818f1e7d1a2f54f53f9f633f44">GetLightSVId</a> (size_t num, <a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14">LightProperty</a> prop)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain the name for for a lighting-relevant shader variable whose name also depends on the number of a light.  <a href="#e0f9be818f1e7d1a2f54f53f9f633f44"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsLightShaderVarCache.html#e5aef5235a27c8743c70618154c5573b">SetStrings</a> (<a class="el" href="structiStringSet.html">iStringSet</a> *strings)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the string set to query the name identifiers from.  <a href="#e5aef5235a27c8743c70618154c5573b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper to cache names of shader variables relevant to lighting. 
<p>Definition at line <a class="el" href="lightsvcache_8h-source.html#l00036">36</a> of file <a class="el" href="lightsvcache_8h-source.html">lightsvcache.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="6c446c27a6d6b288df720adbdaa29c3a"></a><!-- doxytag: member="csLightShaderVarCache::DefaultSV" ref="6c446c27a6d6b288df720adbdaa29c3a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a">csLightShaderVarCache::DefaultSV</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Other generally useful shader variables that can be obtained. 
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="6c446c27a6d6b288df720adbdaa29c3a7c8c01fbba157bbba5bbb09df1708d98"></a><!-- doxytag: member="varAmbient" ref="6c446c27a6d6b288df720adbdaa29c3a7c8c01fbba157bbba5bbb09df1708d98" args="" -->varAmbient</em>&nbsp;</td><td>
"light ambient" </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6c446c27a6d6b288df720adbdaa29c3a94dc301e6f53590b0e065b7844971f38"></a><!-- doxytag: member="varLightCount" ref="6c446c27a6d6b288df720adbdaa29c3a94dc301e6f53590b0e065b7844971f38" args="" -->varLightCount</em>&nbsp;</td><td>
"light count" </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6c446c27a6d6b288df720adbdaa29c3a1de7a5c60603ad44a0d7d81d8aef31ca"></a><!-- doxytag: member="_varCount" ref="6c446c27a6d6b288df720adbdaa29c3a1de7a5c60603ad44a0d7d81d8aef31ca" args="" -->_varCount</em>&nbsp;</td><td>
Number of other variables. </td></tr>
</table>
</dl>

<p>Definition at line <a class="el" href="lightsvcache_8h-source.html#l00080">80</a> of file <a class="el" href="lightsvcache_8h-source.html">lightsvcache.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14"></a><!-- doxytag: member="csLightShaderVarCache::LightProperty" ref="1469cb5d4a87149a2ea0ba70de230f14" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14">csLightShaderVarCache::LightProperty</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Properties of lights for which shader variables are known. 
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14709238ed1b49834b099ee8173a26b0fb"></a><!-- doxytag: member="lightDiffuse" ref="1469cb5d4a87149a2ea0ba70de230f14709238ed1b49834b099ee8173a26b0fb" args="" -->lightDiffuse</em>&nbsp;</td><td>
Diffuse color. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f146c43c0821928d5cd00bfb5161fee700a"></a><!-- doxytag: member="lightSpecular" ref="1469cb5d4a87149a2ea0ba70de230f146c43c0821928d5cd00bfb5161fee700a" args="" -->lightSpecular</em>&nbsp;</td><td>
Specular color. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f143a732fb887c0a37a1b165f7b99a7d7e2"></a><!-- doxytag: member="lightPosition" ref="1469cb5d4a87149a2ea0ba70de230f143a732fb887c0a37a1b165f7b99a7d7e2" args="" -->lightPosition</em>&nbsp;</td><td>
Position (object space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14dc45c9751b9412706fdaa257b21a9339"></a><!-- doxytag: member="lightPositionCamera" ref="1469cb5d4a87149a2ea0ba70de230f14dc45c9751b9412706fdaa257b21a9339" args="" -->lightPositionCamera</em>&nbsp;</td><td>
Position (camera space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14be11ddc15abe301240f388c28ee041da"></a><!-- doxytag: member="lightPositionWorld" ref="1469cb5d4a87149a2ea0ba70de230f14be11ddc15abe301240f388c28ee041da" args="" -->lightPositionWorld</em>&nbsp;</td><td>
Position (world space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14a8dce1c283bb84cd77f69e046936a29c"></a><!-- doxytag: member="lightTransformCamera" ref="1469cb5d4a87149a2ea0ba70de230f14a8dce1c283bb84cd77f69e046936a29c" args="" -->lightTransformCamera</em>&nbsp;</td><td>
Transform (camera space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f1415ec9df2a17d1481e905c84375c925c0"></a><!-- doxytag: member="lightTransformWorld" ref="1469cb5d4a87149a2ea0ba70de230f1415ec9df2a17d1481e905c84375c925c0" args="" -->lightTransformWorld</em>&nbsp;</td><td>
Transform (world space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14806a210cc5239118693476863ac87700"></a><!-- doxytag: member="lightAttenuation" ref="1469cb5d4a87149a2ea0ba70de230f14806a210cc5239118693476863ac87700" args="" -->lightAttenuation</em>&nbsp;</td><td>
Attenuation vector. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f1400cacb4de9c4ffb7ecd95ee7c11e324a"></a><!-- doxytag: member="lightAttenuationTex" ref="1469cb5d4a87149a2ea0ba70de230f1400cacb4de9c4ffb7ecd95ee7c11e324a" args="" -->lightAttenuationTex</em>&nbsp;</td><td>
Attenuation texture. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f142bab269297a155024d619b18c0d90806"></a><!-- doxytag: member="lightDirection" ref="1469cb5d4a87149a2ea0ba70de230f142bab269297a155024d619b18c0d90806" args="" -->lightDirection</em>&nbsp;</td><td>
Direction (object space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14cd03482a1d84baf607ac8121b4445842"></a><!-- doxytag: member="lightDirectionCamera" ref="1469cb5d4a87149a2ea0ba70de230f14cd03482a1d84baf607ac8121b4445842" args="" -->lightDirectionCamera</em>&nbsp;</td><td>
Direction (camera space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f143b77b1334b01cc01317e3271be643259"></a><!-- doxytag: member="lightDirectionWorld" ref="1469cb5d4a87149a2ea0ba70de230f143b77b1334b01cc01317e3271be643259" args="" -->lightDirectionWorld</em>&nbsp;</td><td>
Direction (world space). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f1490816983c9a3069d039e61f80d6f6db9"></a><!-- doxytag: member="lightInnerFalloff" ref="1469cb5d4a87149a2ea0ba70de230f1490816983c9a3069d039e61f80d6f6db9" args="" -->lightInnerFalloff</em>&nbsp;</td><td>
Spot inner falloff. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f1474203b72905f6d2c05e5983bfd78ddbd"></a><!-- doxytag: member="lightOuterFalloff" ref="1469cb5d4a87149a2ea0ba70de230f1474203b72905f6d2c05e5983bfd78ddbd" args="" -->lightOuterFalloff</em>&nbsp;</td><td>
Spot outer falloff. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f14df9edeb325a83b31ec59aff840f57551"></a><!-- doxytag: member="lightType" ref="1469cb5d4a87149a2ea0ba70de230f14df9edeb325a83b31ec59aff840f57551" args="" -->lightType</em>&nbsp;</td><td>
Light type (csLightType casted to int). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f145bff9a9618e8160e16d73f6f311fecb0"></a><!-- doxytag: member="lightAttenuationMode" ref="1469cb5d4a87149a2ea0ba70de230f145bff9a9618e8160e16d73f6f311fecb0" args="" -->lightAttenuationMode</em>&nbsp;</td><td>
Attenuation mode (csLightAttenuationMode casted to int). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1469cb5d4a87149a2ea0ba70de230f1431d7f0ce5378ebb6d86b8ad061a69c1b"></a><!-- doxytag: member="_lightCount" ref="1469cb5d4a87149a2ea0ba70de230f1431d7f0ce5378ebb6d86b8ad061a69c1b" args="" -->_lightCount</em>&nbsp;</td><td>
Number of properties. </td></tr>
</table>
</dl>

<p>Definition at line <a class="el" href="lightsvcache_8h-source.html#l00040">40</a> of file <a class="el" href="lightsvcache_8h-source.html">lightsvcache.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="51f013ee750ea3c19bf553f50555689a"></a><!-- doxytag: member="csLightShaderVarCache::csLightShaderVarCache" ref="51f013ee750ea3c19bf553f50555689a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csLightShaderVarCache::csLightShaderVarCache           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct an instance. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The instance is only useable after a call to <a class="el" href="classcsLightShaderVarCache.html#e5aef5235a27c8743c70618154c5573b" title="Set the string set to query the name identifiers from.">SetStrings()</a>. </dd></dl>

<p>Definition at line <a class="el" href="lightsvcache_8h-source.html#l00105">105</a> of file <a class="el" href="lightsvcache_8h-source.html">lightsvcache.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5431cae71f94e09b7feb065858dc9cde"></a><!-- doxytag: member="csLightShaderVarCache::GetDefaultSVId" ref="5431cae71f94e09b7feb065858dc9cde" args="(DefaultSV var)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> csLightShaderVarCache::GetDefaultSVId           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a">DefaultSV</a>&nbsp;</td>
          <td class="paramname"> <em>var</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Obtain the name for for a lighting-relevant shader variable whose name does not depend on the number of a light. 
<p>
A caching scheme is used to avoid having to re-request a name from the given string set every time one is needed. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>var</em>&nbsp;</td><td>Variable for which a name is to be retrieved. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Name of the relevant variable, csInvalidStringID in case of an error. </dd></dl>

</div>
</div><p>
<a class="anchor" name="e0f9be818f1e7d1a2f54f53f9f633f44"></a><!-- doxytag: member="csLightShaderVarCache::GetLightSVId" ref="e0f9be818f1e7d1a2f54f53f9f633f44" args="(size_t num, LightProperty prop)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> csLightShaderVarCache::GetLightSVId           </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14">LightProperty</a>&nbsp;</td>
          <td class="paramname"> <em>prop</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>
Obtain the name for for a lighting-relevant shader variable whose name also depends on the number of a light. 
<p>
A caching scheme is used to avoid having to re-request a name from the given string set every time one is needed. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>num</em>&nbsp;</td><td>Number of the light that appears in the name </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>prop</em>&nbsp;</td><td>Light property for which a variable name is to be retrieved. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Name of the relevant variable, csInvalidStringID in case of an error. </dd></dl>

<p>Referenced by <a class="el" href="vertexlight_8h-source.html#l00072">csLightProperties::csLightProperties()</a>.</p>

</div>
</div><p>
<a class="anchor" name="e5aef5235a27c8743c70618154c5573b"></a><!-- doxytag: member="csLightShaderVarCache::SetStrings" ref="e5aef5235a27c8743c70618154c5573b" args="(iStringSet *strings)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csLightShaderVarCache::SetStrings           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiStringSet.html">iStringSet</a> *&nbsp;</td>
          <td class="paramname"> <em>strings</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the string set to query the name identifiers from. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Changing the string set will clear the cached names. </dd></dl>

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