Sophie

Sophie

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

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: csgfx/lightsvcache.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csgfx/lightsvcache.h</h1><a href="lightsvcache_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2005 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">              (C) 2005 by Frank Richter</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSGFX_SHADER_LIGHTSVCACHE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSGFX_SHADER_LIGHTSVCACHE_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="ref_8h.html" title="Smart Pointers.">csutil/ref.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="iutil_2strset_8h.html" title="Stringset interface.">iutil/strset.h</a>"</span>
<a name="l00028"></a>00028 
<a name="l00036"></a><a class="code" href="classcsLightShaderVarCache.html">00036</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsLightShaderVarCache.html" title="Helper to cache names of shader variables relevant to lighting.">csLightShaderVarCache</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00040"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14">00040</a>   <span class="keyword">enum</span> <a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14" title="Properties of lights for which shader variables are known.">LightProperty</a>
<a name="l00041"></a>00041   {
<a name="l00043"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14709238ed1b49834b099ee8173a26b0fb">00043</a>     lightDiffuse = 0,
<a name="l00045"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f146c43c0821928d5cd00bfb5161fee700a">00045</a>     lightSpecular,
<a name="l00047"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f143a732fb887c0a37a1b165f7b99a7d7e2">00047</a>     lightPosition,
<a name="l00049"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14dc45c9751b9412706fdaa257b21a9339">00049</a>     lightPositionCamera,
<a name="l00051"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14be11ddc15abe301240f388c28ee041da">00051</a>     lightPositionWorld,
<a name="l00053"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14a8dce1c283bb84cd77f69e046936a29c">00053</a>     lightTransformCamera,
<a name="l00055"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1415ec9df2a17d1481e905c84375c925c0">00055</a>     lightTransformWorld,
<a name="l00057"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14806a210cc5239118693476863ac87700">00057</a>     lightAttenuation,
<a name="l00059"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1400cacb4de9c4ffb7ecd95ee7c11e324a">00059</a>     lightAttenuationTex,
<a name="l00061"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f142bab269297a155024d619b18c0d90806">00061</a>     lightDirection,
<a name="l00063"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14cd03482a1d84baf607ac8121b4445842">00063</a>     lightDirectionCamera,
<a name="l00065"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f143b77b1334b01cc01317e3271be643259">00065</a>     lightDirectionWorld,
<a name="l00067"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1490816983c9a3069d039e61f80d6f6db9">00067</a>     lightInnerFalloff,
<a name="l00069"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1474203b72905f6d2c05e5983bfd78ddbd">00069</a>     lightOuterFalloff,
<a name="l00071"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f14df9edeb325a83b31ec59aff840f57551">00071</a>     lightType,
<a name="l00073"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f145bff9a9618e8160e16d73f6f311fecb0">00073</a>     lightAttenuationMode,
<a name="l00074"></a>00074 
<a name="l00076"></a><a class="code" href="classcsLightShaderVarCache.html#1469cb5d4a87149a2ea0ba70de230f1431d7f0ce5378ebb6d86b8ad061a69c1b">00076</a>     _lightCount
<a name="l00077"></a>00077   };
<a name="l00078"></a>00078 
<a name="l00080"></a><a class="code" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a">00080</a>   <span class="keyword">enum</span> <a class="code" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a" title="Other generally useful shader variables that can be obtained.">DefaultSV</a>
<a name="l00081"></a>00081   {
<a name="l00083"></a><a class="code" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a7c8c01fbba157bbba5bbb09df1708d98">00083</a>     varAmbient = 0,
<a name="l00085"></a><a class="code" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a94dc301e6f53590b0e065b7844971f38">00085</a>     varLightCount,
<a name="l00086"></a>00086     
<a name="l00088"></a><a class="code" href="classcsLightShaderVarCache.html#6c446c27a6d6b288df720adbdaa29c3a1de7a5c60603ad44a0d7d81d8aef31ca">00088</a>     _varCount
<a name="l00089"></a>00089   };
<a name="l00090"></a>00090 <span class="keyword">private</span>:
<a name="l00091"></a>00091   <span class="keyword">struct </span>LightSvIdCacheEntry
<a name="l00092"></a>00092   {
<a name="l00093"></a>00093     <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> ids[_lightCount];
<a name="l00094"></a>00094   };
<a name="l00095"></a>00095   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;LightSvIdCacheEntry&gt;</a> lightSVIdCache;
<a name="l00096"></a>00096   <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iStringSet&gt;</a> strings;
<a name="l00097"></a>00097   <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> defaultVars[_varCount];
<a name="l00098"></a>00098   
<a name="l00099"></a>00099   <span class="keywordtype">void</span> ClearDefVars ();
<a name="l00100"></a>00100 <span class="keyword">public</span>:
<a name="l00105"></a><a class="code" href="classcsLightShaderVarCache.html#51f013ee750ea3c19bf553f50555689a">00105</a>   <a class="code" href="classcsLightShaderVarCache.html" title="Helper to cache names of shader variables relevant to lighting.">csLightShaderVarCache</a> () { ClearDefVars(); }
<a name="l00106"></a>00106   
<a name="l00111"></a>00111   <span class="keywordtype">void</span> SetStrings (<a class="code" href="structiStringSet.html" title="The string set is a collection of unique strings.">iStringSet</a>* strings);
<a name="l00112"></a>00112   
<a name="l00123"></a>00123   <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> GetLightSVId (<span class="keywordtype">size_t</span> num, LightProperty prop);
<a name="l00124"></a>00124     
<a name="l00134"></a>00134   <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> GetDefaultSVId (DefaultSV var);
<a name="l00135"></a>00135 };
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="preprocessor">#endif // __CS_CSGFX_SHADER_LIGHTSVCACHE_H__</span>
</pre></div><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>