Changeset 9419 for code/branches/shaders/src/orxonox/RenderQueueListener.cc

Timestamp:

Oct 29, 2012, 3:48:20 PM (12 years ago)

Author:

davidsa

Message:

Added documentation to orxonox::RenderQueueListener

File:

• code/branches/shaders/src/orxonox/RenderQueueListener.cc (modified) (3 diffs)

code/branches/shaders/src/orxonox/RenderQueueListener.cc

@@ -28 +28 @@
  */
 
+/**
+  @file RenderQueueListener.cc
+  @brief Definition of the RenderQueueListener class.
+*/
+
 #include "RenderQueueListener.h"
 
@@ -35 +40 @@
 namespace orxonox
 {
+    /**
+    @brief
+    This function is called just before a RenderQueueGroup is rendered, this function is called by Ogre automatically with the correct parameters.
+
+    In this case we use it to set the stencil buffer parameters of the render system
+    */
     void RenderQueueListener::renderQueueStarted(Ogre::uint8 queueGroupId, const Ogre::String& invocation, bool& skipThisInvocation)
     {
@@ -56 +67 @@
         }
     }
-   
+    
+    /**
+    @brief
+        This function is called just after a RenderQueueGroup has been rendered, this function is called by Ogre automatically with the correct parameters.
+        
+        in this case we use it to unset the stencil buffer parameters, so the rest of the render queue is unaffected by it.
+    */
     void RenderQueueListener::renderQueueEnded(Ogre::uint8 queueGroupId, const Ogre::String& invocation, bool& repeatThisInvocation)
     {