Update and improve documentation

[libs/gl.git] / source / effects / effect.h

diff --git a/source/effects/effect.h b/source/effects/effect.h
index 0d794a3a2d9b6b264b17e880cf0a02c95d8218d7..ac458361700cf669052ea69039017451f2497e8f 100644 (file)
--- a/source/effects/effect.h
+++ b/source/effects/effect.h
@@ -9,13 +9,23 @@ namespace Msp {
 namespace GL {
 
 /**
-Effects are used to wrap other renderables and give them additional visual
-properties.  An Effect's render method should set up the necessary state, call
-the wrapped Renderable's render method, and clean up after itself.
+Base class for visual effects.
+
+Effects wrap other renderables and provide additional textures or uniform
+values which can be used by shaders to modify the appearance of the content
+renderable.  Some material properties require certain Effects to be present in
+order to function properly.
+
+If an Effect subclass needs to do any sideband rendering to prepare for a
+frame, that should be done in setup_frame().  The render() function should only
+set up the necessary state and call the content renderable's render() function.
 */
 class Effect: public Renderable
 {
 public:
+       /**
+       Holds the parameters for an Effect.  Used with SequenceTemplate.
+       */
        struct Template
        {
                class Loader: public DataFile::CollectionObjectLoader<Template>