Changeset 2264 for GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderingRuns/OgrePhaseTextureRenderingRun.h

Timestamp:

03/19/07 13:02:58 (17 years ago)

Author:

szirmay

Message:

 

File:

• GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderingRuns/OgrePhaseTextureRenderingRun.h (modified) (4 diffs)

GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderingRuns/OgrePhaseTextureRenderingRun.h

@@ -14 +14 @@
 
 /**
-        @brief ColorCubeMapRenderingRun used in an OGRE environment.
+        @brief PhaseTextureRenderingRun used in an OGRE environment.
 */
 class OgrePhaseTextureRenderingRun : public OgreRenderingRun,
@@ -24 +24 @@
                 @brief Constructor.
 
-                @param sharedRuns                       a pointer to the OgreSharedRuns this run belongs to
-                @param name                                     the name of the depth map texture to be created
-                @param light                            the light source this depth shadow map belongs to
-                @param resolutionX                      the resolution width of the depth shadow map
-                @param resolutionY                      the resolution height of the depth shadow map
-                @param materialName                     the name of the material to be used when rendering the depth shadow map
+                @param name                                     the name of the phase texture to be created
+                @param resolutionX                      the resolution width of the phase texture
+                @param resolutionY                      the resolution height of the phase texture
+                @param materialName                     the name of the material to be used when rendering the phase texture
         */      
         OgrePhaseTextureRenderingRun(           String name,
@@ -37 +35 @@
 
         /**
-                @brief returns the depth shadow map texture created by this run
+                @brief returns the name of thew phase texture created by this run
         */
         String getPhaseTextureName(){return name;}
@@ -54 +52 @@
         */
         Texture* phaseTexture;
+        /**
+                @brief a pointer to the camera that was used while rendering the phase texture
+        */
         Camera* phaseCamera;
         
         //inherited
         void updateFrame(unsigned long frameNum);
+        /**
+                @brief Creates the phase texture.
+        */
         inline void createPhaseTexture();