]> git.tdb.fi Git - libs/gl.git/blobdiff - source/effects/postprocessor.h
Update and improve documentation
[libs/gl.git] / source / effects / postprocessor.h
index 8b2884acf6a360953f2e0a63ddeec2d44a64e689..02d9d17a6f104d3672dc152849eced83f5ca9adf 100644 (file)
@@ -12,13 +12,17 @@ class Sampler;
 class Texture2D;
 
 /**
-Base class for post-processing effects.  Post-processors receive the contents
-of the entire framebuffer as a texture and render it back, altering it in the
-process.
+Base class for post-processing effects.
+
+PostProcessors can be added to a Sequence.  They receive the contents of the
+entire framebuffer as a texture and render it back, altering it in the process.
 */
 class PostProcessor
 {
 public:
+       /**
+       Holds the parameters for a PostProcessor.  Used with SequenceTemplate.
+       */
        struct Template
        {
                class Loader: public Msp::DataFile::ObjectLoader<Template>
@@ -39,7 +43,6 @@ protected:
 public:
        virtual ~PostProcessor() { }
 
-       /// Renders the effect.
        virtual void render(Renderer &, const Texture2D &, const Texture2D &) = 0;
 
        virtual void set_debug_name(const std::string &) = 0;