[894] | 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: DepthShadowMapRenderingRun 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 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 List</span></a></li> |
---|
| 17 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
| 18 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
| 19 | </ul></div> |
---|
| 20 | <h1>DepthShadowMapRenderingRun Class Reference</h1><!-- doxytag: class="DepthShadowMapRenderingRun" --><!-- doxytag: inherits="RenderingRun" -->Base abstract class that defines a rendering process of a shadow map. |
---|
| 21 | <a href="#_details">More...</a> |
---|
| 22 | <p> |
---|
| 23 | <p>Inheritance diagram for DepthShadowMapRenderingRun: |
---|
| 24 | <p><center><img src="class_depth_shadow_map_rendering_run.png" usemap="#DepthShadowMapRenderingRun_map" border="0" alt=""></center> |
---|
| 25 | <map name="DepthShadowMapRenderingRun_map"> |
---|
| 26 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,224,24"> |
---|
| 27 | <area href="class_ogre_depth_shadow_map_rendering_run.html" alt="OgreDepthShadowMapRenderingRun" shape="rect" coords="0,112,224,136"> |
---|
| 28 | </map> |
---|
| 29 | <a href="class_depth_shadow_map_rendering_run-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 30 | <tr><td></td></tr> |
---|
| 31 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 32 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#171d8420e6ec3c4e3d5526554cfaabb9">DepthShadowMapRenderingRun</a> (unsigned int <a class="el" href="class_depth_shadow_map_rendering_run.html#2bc80fd744492e862d9f29ec7b0d0143">resolutionX</a>, unsigned int <a class="el" href="class_depth_shadow_map_rendering_run.html#cb8eb97aeeaaa9087972b7ddbaf438f4">resolutionY</a>)</td></tr> |
---|
| 33 | |
---|
| 34 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#171d8420e6ec3c4e3d5526554cfaabb9"></a><br></td></tr> |
---|
| 35 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
| 36 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e705ef5a672a6514f38b0f2de94cc8ef"></a><!-- doxytag: member="DepthShadowMapRenderingRun::createDepthMap" ref="e705ef5a672a6514f38b0f2de94cc8ef" args="()=0" --> |
---|
| 37 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#e705ef5a672a6514f38b0f2de94cc8ef">createDepthMap</a> ()=0</td></tr> |
---|
| 38 | |
---|
| 39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the depth map texture (2D or CUBE according to light type). <br></td></tr> |
---|
| 40 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#957f2ab9c82ca93d8cb6e6969cfc371e">updateDepthCubeFace</a> (int facenum)=0</td></tr> |
---|
| 41 | |
---|
| 42 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates one face of the depth cubemap (used only in case of point lights). <a href="#957f2ab9c82ca93d8cb6e6969cfc371e"></a><br></td></tr> |
---|
| 43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="252b5fe24729574dec8fee517ba1b1ff"></a><!-- doxytag: member="DepthShadowMapRenderingRun::updateDepthMap" ref="252b5fe24729574dec8fee517ba1b1ff" args="()=0" --> |
---|
| 44 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#252b5fe24729574dec8fee517ba1b1ff">updateDepthMap</a> ()=0</td></tr> |
---|
| 45 | |
---|
| 46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates the depth map (in case of directional and spot lights). <br></td></tr> |
---|
| 47 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#de3c9eb12ebec3d57ea8fc46b809000d">updateFrame</a> (unsigned long frameNum)=0</td></tr> |
---|
| 48 | |
---|
| 49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This function does the actual update in a frame. <a href="#de3c9eb12ebec3d57ea8fc46b809000d"></a><br></td></tr> |
---|
| 50 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
| 51 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bc80fd744492e862d9f29ec7b0d0143"></a><!-- doxytag: member="DepthShadowMapRenderingRun::resolutionX" ref="2bc80fd744492e862d9f29ec7b0d0143" args="" --> |
---|
| 52 | unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#2bc80fd744492e862d9f29ec7b0d0143">resolutionX</a></td></tr> |
---|
| 53 | |
---|
| 54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">width of the depth map texture <br></td></tr> |
---|
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb8eb97aeeaaa9087972b7ddbaf438f4"></a><!-- doxytag: member="DepthShadowMapRenderingRun::resolutionY" ref="cb8eb97aeeaaa9087972b7ddbaf438f4" args="" --> |
---|
| 56 | unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_depth_shadow_map_rendering_run.html#cb8eb97aeeaaa9087972b7ddbaf438f4">resolutionY</a></td></tr> |
---|
| 57 | |
---|
| 58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">height of the depth map texture <br></td></tr> |
---|
| 59 | </table> |
---|
| 60 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 61 | Base abstract class that defines a rendering process of a shadow map. |
---|
| 62 | <p> |
---|
| 63 | A shadow map stores depth values from the lightsource. |
---|
| 64 | <p> |
---|
| 65 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 66 | <a class="anchor" name="171d8420e6ec3c4e3d5526554cfaabb9"></a><!-- doxytag: member="DepthShadowMapRenderingRun::DepthShadowMapRenderingRun" ref="171d8420e6ec3c4e3d5526554cfaabb9" args="(unsigned int resolutionX, unsigned int resolutionY)" --><p> |
---|
| 67 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 68 | <tr> |
---|
| 69 | <td class="mdRow"> |
---|
| 70 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 71 | <tr> |
---|
| 72 | <td class="md" nowrap valign="top">DepthShadowMapRenderingRun::DepthShadowMapRenderingRun </td> |
---|
| 73 | <td class="md" valign="top">( </td> |
---|
| 74 | <td class="md" nowrap valign="top">unsigned int </td> |
---|
| 75 | <td class="mdname" nowrap> <em>resolutionX</em>, </td> |
---|
| 76 | </tr> |
---|
| 77 | <tr> |
---|
| 78 | <td class="md" nowrap align="right"></td> |
---|
| 79 | <td class="md"></td> |
---|
| 80 | <td class="md" nowrap>unsigned int </td> |
---|
| 81 | <td class="mdname" nowrap> <em>resolutionY</em></td> |
---|
| 82 | </tr> |
---|
| 83 | <tr> |
---|
| 84 | <td class="md"></td> |
---|
| 85 | <td class="md">) </td> |
---|
| 86 | <td class="md" colspan="2"><code> [inline]</code></td> |
---|
| 87 | </tr> |
---|
| 88 | </table> |
---|
| 89 | </td> |
---|
| 90 | </tr> |
---|
| 91 | </table> |
---|
| 92 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 93 | <tr> |
---|
| 94 | <td> |
---|
| 95 | |
---|
| 96 | </td> |
---|
| 97 | <td> |
---|
| 98 | |
---|
| 99 | <p> |
---|
| 100 | Constructor. |
---|
| 101 | <p> |
---|
| 102 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 103 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 104 | <tr><td valign="top"></td><td valign="top"><em>resolutionX</em> </td><td>width of the depth map texture </td></tr> |
---|
| 105 | <tr><td valign="top"></td><td valign="top"><em>resolutionY</em> </td><td>height of the depth map texture </td></tr> |
---|
| 106 | </table> |
---|
| 107 | </dl> |
---|
| 108 | </td> |
---|
| 109 | </tr> |
---|
| 110 | </table> |
---|
| 111 | <hr><h2>Member Function Documentation</h2> |
---|
| 112 | <a class="anchor" name="957f2ab9c82ca93d8cb6e6969cfc371e"></a><!-- doxytag: member="DepthShadowMapRenderingRun::updateDepthCubeFace" ref="957f2ab9c82ca93d8cb6e6969cfc371e" args="(int facenum)=0" --><p> |
---|
| 113 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 114 | <tr> |
---|
| 115 | <td class="mdRow"> |
---|
| 116 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 117 | <tr> |
---|
| 118 | <td class="md" nowrap valign="top">virtual void DepthShadowMapRenderingRun::updateDepthCubeFace </td> |
---|
| 119 | <td class="md" valign="top">( </td> |
---|
| 120 | <td class="md" nowrap valign="top">int </td> |
---|
| 121 | <td class="mdname1" valign="top" nowrap> <em>facenum</em> </td> |
---|
| 122 | <td class="md" valign="top"> ) </td> |
---|
| 123 | <td class="md" nowrap><code> [inline, protected, pure virtual]</code></td> |
---|
| 124 | </tr> |
---|
| 125 | </table> |
---|
| 126 | </td> |
---|
| 127 | </tr> |
---|
| 128 | </table> |
---|
| 129 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 130 | <tr> |
---|
| 131 | <td> |
---|
| 132 | |
---|
| 133 | </td> |
---|
| 134 | <td> |
---|
| 135 | |
---|
| 136 | <p> |
---|
| 137 | Updates one face of the depth cubemap (used only in case of point lights). |
---|
| 138 | <p> |
---|
| 139 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 140 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 141 | <tr><td valign="top"></td><td valign="top"><em>facenum</em> </td><td>the number of the face to be updated </td></tr> |
---|
| 142 | </table> |
---|
| 143 | </dl> |
---|
| 144 | |
---|
| 145 | <p> |
---|
| 146 | Implemented in <a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#d41e92b1cc465d3c4eaadc9a6dcc9249">OgreDepthShadowMapRenderingRun</a>. </td> |
---|
| 147 | </tr> |
---|
| 148 | </table> |
---|
| 149 | <a class="anchor" name="de3c9eb12ebec3d57ea8fc46b809000d"></a><!-- doxytag: member="DepthShadowMapRenderingRun::updateFrame" ref="de3c9eb12ebec3d57ea8fc46b809000d" args="(unsigned long frameNum)=0" --><p> |
---|
| 150 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 151 | <tr> |
---|
| 152 | <td class="mdRow"> |
---|
| 153 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 154 | <tr> |
---|
| 155 | <td class="md" nowrap valign="top">virtual void DepthShadowMapRenderingRun::updateFrame </td> |
---|
| 156 | <td class="md" valign="top">( </td> |
---|
| 157 | <td class="md" nowrap valign="top">unsigned long </td> |
---|
| 158 | <td class="mdname1" valign="top" nowrap> <em>frameNum</em> </td> |
---|
| 159 | <td class="md" valign="top"> ) </td> |
---|
| 160 | <td class="md" nowrap><code> [protected, pure virtual]</code></td> |
---|
| 161 | </tr> |
---|
| 162 | </table> |
---|
| 163 | </td> |
---|
| 164 | </tr> |
---|
| 165 | </table> |
---|
| 166 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 167 | <tr> |
---|
| 168 | <td> |
---|
| 169 | |
---|
| 170 | </td> |
---|
| 171 | <td> |
---|
| 172 | |
---|
| 173 | <p> |
---|
| 174 | This function does the actual update in a frame. |
---|
| 175 | <p> |
---|
| 176 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 177 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 178 | <tr><td valign="top"></td><td valign="top"><em>frameNum</em> </td><td>current frame number </td></tr> |
---|
| 179 | </table> |
---|
| 180 | </dl> |
---|
| 181 | |
---|
| 182 | <p> |
---|
| 183 | Reimplemented from <a class="el" href="class_rendering_run.html#043309cb823ebddcbe2bae2c61892235">RenderingRun</a>. |
---|
| 184 | <p> |
---|
| 185 | Implemented in <a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#5953011948f5584f1a22c9318232edb7">OgreDepthShadowMapRenderingRun</a>. </td> |
---|
| 186 | </tr> |
---|
| 187 | </table> |
---|
| 188 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 189 | <li>DepthShadowMapRenderingRun.h</ul> |
---|
| 190 | <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:37 2006 for GameTools Illumination Module by |
---|
| 191 | <a href="http://www.doxygen.org/index.html"> |
---|
| 192 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 193 | </body> |
---|
| 194 | </html> |
---|