source: Documentation/D5.3 Stand-alone computation package for illumination algorithms/appendix/IlluminationModule/html/class_ogre_s_b_b_render_technique.html @ 2910

Revision 2910, 9.3 KB checked in by hbeneit, 16 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>GameTools Illumination Module: OgreSBBRenderTechnique Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
13  </ul></div>
14<div class="tabs">
15  <ul>
16    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
17    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
18    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
19  </ul></div>
20<h1>OgreSBBRenderTechnique Class Reference</h1><!-- doxytag: class="OgreSBBRenderTechnique" --><!-- doxytag: inherits="OgreRenderTechnique,SBBRenderTechnique" --><a class="el" href="class_s_b_b_render_technique.html">SBBRenderTechnique</a> used in an OGRE environment. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for OgreSBBRenderTechnique:
24<p><center><img src="class_ogre_s_b_b_render_technique.png" usemap="#OgreSBBRenderTechnique_map" border="0" alt=""></center>
25<map name="OgreSBBRenderTechnique_map">
26<area href="class_ogre_render_technique.html" alt="OgreRenderTechnique" shape="rect" coords="0,56,164,80">
27<area href="class_s_b_b_render_technique.html" alt="SBBRenderTechnique" shape="rect" coords="174,56,338,80">
28<area href="class_render_technique.html" alt="RenderTechnique" shape="rect" coords="0,0,164,24">
29<area href="class_render_technique.html" alt="RenderTechnique" shape="rect" coords="174,0,338,24">
30</map>
31<a href="class_ogre_s_b_b_render_technique-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
32<tr><td></td></tr>
33<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
34<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_s_b_b_render_technique.html#58bd31af3e0df13e328810db87af70bf">OgreSBBRenderTechnique</a> (unsigned char <a class="el" href="class_ogre_s_b_b_render_technique.html#ba9a792d2b42726970d17b63cfb46655">depthTexID</a>, Pass *<a class="el" href="class_ogre_render_technique.html#d52ee875206d5c373bbec1315131b96f">pass</a>, <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *<a class="el" href="class_render_technique.html#888980e685779fa6801cda413e8c3637">parentRenderable</a>, <a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *<a class="el" href="class_render_technique.html#f1246cf759d7b81eb25195834a7ad349">parentTechniqueGroup</a>)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#58bd31af3e0df13e328810db87af70bf"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_s_b_b_render_technique.html#b90a1eee5fd1924e13e292bc77daea73">update</a> (unsigned long frameNum)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the resources in the given frame.  <a href="#b90a1eee5fd1924e13e292bc77daea73"></a><br></td></tr>
40<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_s_b_b_render_technique.html#ba9a792d2b42726970d17b63cfb46655">depthTexID</a></td></tr>
42
43</table>
44<hr><a name="_details"></a><h2>Detailed Description</h2>
45<a class="el" href="class_s_b_b_render_technique.html">SBBRenderTechnique</a> used in an OGRE environment.
46<p>
47<hr><h2>Constructor &amp; Destructor Documentation</h2>
48<a class="anchor" name="58bd31af3e0df13e328810db87af70bf"></a><!-- doxytag: member="OgreSBBRenderTechnique::OgreSBBRenderTechnique" ref="58bd31af3e0df13e328810db87af70bf" args="(unsigned char depthTexID, Pass *pass, OgreRenderable *parentRenderable, OgreTechniqueGroup *parentTechniqueGroup)" --><p>
49<table class="mdTable" cellpadding="2" cellspacing="0">
50  <tr>
51    <td class="mdRow">
52      <table cellpadding="0" cellspacing="0" border="0">
53        <tr>
54          <td class="md" nowrap valign="top">OgreSBBRenderTechnique::OgreSBBRenderTechnique           </td>
55          <td class="md" valign="top">(&nbsp;</td>
56          <td class="md" nowrap valign="top">unsigned char&nbsp;</td>
57          <td class="mdname" nowrap> <em>depthTexID</em>, </td>
58        </tr>
59        <tr>
60          <td class="md" nowrap align="right"></td>
61          <td class="md"></td>
62          <td class="md" nowrap>Pass *&nbsp;</td>
63          <td class="mdname" nowrap> <em>pass</em>, </td>
64        </tr>
65        <tr>
66          <td class="md" nowrap align="right"></td>
67          <td class="md"></td>
68          <td class="md" nowrap><a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *&nbsp;</td>
69          <td class="mdname" nowrap> <em>parentRenderable</em>, </td>
70        </tr>
71        <tr>
72          <td class="md" nowrap align="right"></td>
73          <td class="md"></td>
74          <td class="md" nowrap><a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *&nbsp;</td>
75          <td class="mdname" nowrap> <em>parentTechniqueGroup</em></td>
76        </tr>
77        <tr>
78          <td class="md"></td>
79          <td class="md">)&nbsp;</td>
80          <td class="md" colspan="2"></td>
81        </tr>
82      </table>
83    </td>
84  </tr>
85</table>
86<table cellspacing="5" cellpadding="0" border="0">
87  <tr>
88    <td>
89      &nbsp;
90    </td>
91    <td>
92
93<p>
94Constructor.
95<p>
96<dl compact><dt><b>Parameters:</b></dt><dd>
97  <table border="0" cellspacing="2" cellpadding="0">
98    <tr><td valign="top"></td><td valign="top"><em>depthTexID</em>&nbsp;</td><td>the id of the texture unit state the resulting scene depth map should be bound to </td></tr>
99    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the pass to operate on </td></tr>
100    <tr><td valign="top"></td><td valign="top"><em>parentRenderable</em>&nbsp;</td><td>the object to operate on </td></tr>
101    <tr><td valign="top"></td><td valign="top"><em>parentTechniqueGroup</em>&nbsp;</td><td>the <a class="el" href="class_technique_group.html">TechniqueGroup</a> this RenderedTechnique is attached to </td></tr>
102  </table>
103</dl>
104    </td>
105  </tr>
106</table>
107<hr><h2>Member Function Documentation</h2>
108<a class="anchor" name="b90a1eee5fd1924e13e292bc77daea73"></a><!-- doxytag: member="OgreSBBRenderTechnique::update" ref="b90a1eee5fd1924e13e292bc77daea73" args="(unsigned long frameNum)" --><p>
109<table class="mdTable" cellpadding="2" cellspacing="0">
110  <tr>
111    <td class="mdRow">
112      <table cellpadding="0" cellspacing="0" border="0">
113        <tr>
114          <td class="md" nowrap valign="top">void OgreSBBRenderTechnique::update           </td>
115          <td class="md" valign="top">(&nbsp;</td>
116          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
117          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
118          <td class="md" valign="top">&nbsp;)&nbsp;</td>
119          <td class="md" nowrap><code> [virtual]</code></td>
120        </tr>
121      </table>
122    </td>
123  </tr>
124</table>
125<table cellspacing="5" cellpadding="0" border="0">
126  <tr>
127    <td>
128      &nbsp;
129    </td>
130    <td>
131
132<p>
133Updates the resources in the given frame.
134<p>
135A <a class="el" href="class_render_technique.html">RenderTechnique</a> is usually need some resources from several runs, so these runs will be updated.<p>
136<dl compact><dt><b>Parameters:</b></dt><dd>
137  <table border="0" cellspacing="2" cellpadding="0">
138    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>the actual framenumber </td></tr>
139  </table>
140</dl>
141
142<p>
143Reimplemented from <a class="el" href="class_render_technique.html#1599dc6e287d7c87a71c8b5bfbd871f8">RenderTechnique</a>.    </td>
144  </tr>
145</table>
146<hr><h2>Member Data Documentation</h2>
147<a class="anchor" name="ba9a792d2b42726970d17b63cfb46655"></a><!-- doxytag: member="OgreSBBRenderTechnique::depthTexID" ref="ba9a792d2b42726970d17b63cfb46655" args="" --><p>
148<table class="mdTable" cellpadding="2" cellspacing="0">
149  <tr>
150    <td class="mdRow">
151      <table cellpadding="0" cellspacing="0" border="0">
152        <tr>
153          <td class="md" nowrap valign="top">unsigned char <a class="el" href="class_ogre_s_b_b_render_technique.html#ba9a792d2b42726970d17b63cfb46655">OgreSBBRenderTechnique::depthTexID</a><code> [protected]</code>          </td>
154        </tr>
155      </table>
156    </td>
157  </tr>
158</table>
159<table cellspacing="5" cellpadding="0" border="0">
160  <tr>
161    <td>
162      &nbsp;
163    </td>
164    <td>
165
166<p>
167&amp;brief the id of the texture unit state the resulting scene depth map should be bound to     </td>
168  </tr>
169</table>
170<hr>The documentation for this class was generated from the following files:<ul>
171<li>OgreSBBRenderTechnique.h<li>OgreSBBRenderTechnique.cpp</ul>
172<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:41 2006 for GameTools Illumination Module by&nbsp;
173<a href="http://www.doxygen.org/index.html">
174<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
175</body>
176</html>
Note: See TracBrowser for help on using the repository browser.