<!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: iLightingProcessInfo 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>iLightingProcessInfo Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__light.html">Lighting</a>]</small>
</h1><!-- doxytag: class="iLightingProcessInfo" --><!-- doxytag: inherits="iFrustumViewUserdata" -->The <a class="el" href="structiLightingProcessInfo.html" title="The iLightingProcessInfo interface holds information for the lighting system.">iLightingProcessInfo</a> interface holds information for the lighting system.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="light_8h-source.html">iengine/light.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iLightingProcessInfo:</div>
<div class="dynsection">
<p><center><img src="structiLightingProcessInfo__inherit__graph.png" border="0" usemap="#iLightingProcessInfo__inherit__map" alt="Inheritance graph"></center>
<map name="iLightingProcessInfo__inherit__map">
<area shape="rect" href="structiFrustumViewUserdata.html" title="User data which can be attached to iFrustumView." alt="" coords="5,84,173,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="61,7,117,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiLightingProcessInfo-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="structiLightingProcessInfo.html#4e3201bb36b47ee2948779f7dd75a31a">AttachUserdata</a> (<a class="el" href="structiLightingProcessData.html">iLightingProcessData</a> *userdata)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach some userdata to the process info. <a href="#4e3201bb36b47ee2948779f7dd75a31a"></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="structiLightingProcessInfo.html#b8bf55a73cb9495b18034285647342c7">FinalizeLighting</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize lighting. <a href="#b8bf55a73cb9495b18034285647342c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsColor.html">csColor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightingProcessInfo.html#f32e1a3f3763ff7832d805bc2d87c197">GetColor</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current color. <a href="#f32e1a3f3763ff7832d805bc2d87c197"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiLight.html">iLight</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightingProcessInfo.html#622fb22c5355ecc46676a69730550501">GetLight</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the light. <a href="#622fb22c5355ecc46676a69730550501"></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="structiLightingProcessInfo.html#502bb78126f46ae8dfa2a35dd1034366">IsDynamic</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if dynamic. <a href="#502bb78126f46ae8dfa2a35dd1034366"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiLightingProcessData.html">iLightingProcessData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightingProcessInfo.html#c6c207be3fa79b1a256155c5537feebf">QueryUserdata</a> (<a class="el" href="group__scf.html#ge3095ac94f71a5ff42374271c90222cd">scfInterfaceID</a> id, int version)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query for userdata based on SCF type. <a href="#c6c207be3fa79b1a256155c5537feebf"></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="structiLightingProcessInfo.html#1d81d35ca1084d53a95c4dec904d92a9">SetColor</a> (const <a class="el" href="classcsColor.html">csColor</a> &col)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current color. <a href="#1d81d35ca1084d53a95c4dec904d92a9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="structiLightingProcessInfo.html" title="The iLightingProcessInfo interface holds information for the lighting system.">iLightingProcessInfo</a> interface holds information for the lighting system.
<p>
You can query the userdata from <a class="el" href="structiFrustumView.html" title="This structure represents all information needed for the frustum visibility calculator...">iFrustumView</a> for this interface while in a 'portal' callback. This way you can get specific information from the lighting system for your null-portal.
<p>Definition at line <a class="el" href="light_8h-source.html#l00480">480</a> of file <a class="el" href="light_8h-source.html">light.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4e3201bb36b47ee2948779f7dd75a31a"></a><!-- doxytag: member="iLightingProcessInfo::AttachUserdata" ref="4e3201bb36b47ee2948779f7dd75a31a" args="(iLightingProcessData *userdata)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iLightingProcessInfo::AttachUserdata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiLightingProcessData.html">iLightingProcessData</a> * </td>
<td class="paramname"> <em>userdata</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach some userdata to the process info.
<p>
You can later query for this by doing <a class="el" href="structiLightingProcessInfo.html#c6c207be3fa79b1a256155c5537feebf" title="Query for userdata based on SCF type.">QueryUserdata()</a> with the correct SCF version number.
</div>
</div><p>
<a class="anchor" name="b8bf55a73cb9495b18034285647342c7"></a><!-- doxytag: member="iLightingProcessInfo::FinalizeLighting" ref="b8bf55a73cb9495b18034285647342c7" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iLightingProcessInfo::FinalizeLighting </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finalize lighting.
<p>
This function is called by the lighting routines after performing CheckFrustum(). It will call <a class="el" href="structiLightingProcessInfo.html#b8bf55a73cb9495b18034285647342c7" title="Finalize lighting.">FinalizeLighting()</a> on all user datas.
</div>
</div><p>
<a class="anchor" name="f32e1a3f3763ff7832d805bc2d87c197"></a><!-- doxytag: member="iLightingProcessInfo::GetColor" ref="f32e1a3f3763ff7832d805bc2d87c197" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsColor.html">csColor</a>& iLightingProcessInfo::GetColor </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 the current color.
<p>
</div>
</div><p>
<a class="anchor" name="622fb22c5355ecc46676a69730550501"></a><!-- doxytag: member="iLightingProcessInfo::GetLight" ref="622fb22c5355ecc46676a69730550501" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiLight.html">iLight</a>* iLightingProcessInfo::GetLight </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 the light.
<p>
</div>
</div><p>
<a class="anchor" name="502bb78126f46ae8dfa2a35dd1034366"></a><!-- doxytag: member="iLightingProcessInfo::IsDynamic" ref="502bb78126f46ae8dfa2a35dd1034366" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iLightingProcessInfo::IsDynamic </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>
Return true if dynamic.
<p>
</div>
</div><p>
<a class="anchor" name="c6c207be3fa79b1a256155c5537feebf"></a><!-- doxytag: member="iLightingProcessInfo::QueryUserdata" ref="c6c207be3fa79b1a256155c5537feebf" args="(scfInterfaceID id, int version)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiLightingProcessData.html">iLightingProcessData</a>> iLightingProcessInfo::QueryUserdata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__scf.html#ge3095ac94f71a5ff42374271c90222cd">scfInterfaceID</a> </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>version</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query for userdata based on SCF type.
<p>
</div>
</div><p>
<a class="anchor" name="1d81d35ca1084d53a95c4dec904d92a9"></a><!-- doxytag: member="iLightingProcessInfo::SetColor" ref="1d81d35ca1084d53a95c4dec904d92a9" args="(const csColor &col)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iLightingProcessInfo::SetColor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td>
<td class="paramname"> <em>col</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current color.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="light_8h-source.html">light.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
>
3205
