Changeset 2240 for GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderTechniques/OgreCubeMapRenderTechnique.h

Timestamp:

03/13/07 09:27:17 (17 years ago)

Author:

szirmay

Message:

 

File:

• GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderTechniques/OgreCubeMapRenderTechnique.h (modified) (2 diffs)

GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderTechniques/OgreCubeMapRenderTechnique.h

@@ -34 +34 @@
                 @param angleTolerance                   angle tolerance used in face skip
                 @param updateAllFace                    defines if all cubemap faces should be updated in a frame or only one face per frame
+                @param renderSelf                               sets if the object should be rendered to the cube map
+                @param renderEnvironment                sets if the environment should be rendered to the cube map
+                @param selfMaterial                             the material that should be set for the object while rendering the cubemap
+                @param environmentMaterial      the material that should be set for the environment while rendering the cubemap
+                @param layer                                    the layer of this cubemap
+                @param getMinMax                                sets if the minimum and maximum values of the cubemap should be computed
+                @param attachToTexUnit                  sets if this cubemap should be attach to a texture unit of the pass
+                @param minVariableName                  sets the name of the gpu shader program parameter to which the minimum value should be bound to
+                @param maxVariableName                  sets the name of the gpu shader program parameter to which the maximum value should be bound to
                 @param pass                                             the pass to operate on                  
                 @param parentRenderable                 the object to operate on
@@ -73 +82 @@
         */
         unsigned char texID;
+        /**
+                @brief the material that should be set for the object while rendering the cubemap
+        */
         String selfMaterial;
+        /**
+                @brief the material that should be set for the environment while rendering the cubemap
+        */
         String environmentMaterial;
+        //helper string to name the created cubemaps
         String texturePostFix;
-
+        /**
+                @brief sets if the minimum and maximum values of the cubemap should be computed
+        */
         bool getMinMax;
+        /**
+                @brief sets if this cubemap should be attach to a texture unit of the pass
+        */
         bool attachToTexUnit;
+        /**
+                @brief sets the name of the gpu shader program parameter to which the minimum value should be bound to
+        */
         String minVariableName;
+        /**
+                @brief sets the name of the gpu shader program parameter to which the maximum value should be bound to
+        */
         String maxVariableName;
 
+        //inherited
         RenderingRun* createCubeMapRun();
-        void cubeMapRunChanged(RenderingRun* run);      
+        //inherited
+        void cubeMapRunChanged(RenderingRun* run);
+        //inherited
         void cubeMapRunUpdated(RenderingRun* run);      
 };
 
+/**
+        @brief RenderTechniqueFactory to create OgreCubeMapRenderTechnique instances.
+*/
 class OgreCubeMapRenderTechniqueFactory : public RenderTechniqueFactory
 {