Add a file-level comment for EffectChain.

[movit] / effect_chain.h

diff --git a/effect_chain.h b/effect_chain.h
index 2199a5d8b28d56a1a0fe54c85cc2ae9505ede61d..407648bc9c5a6887e331d01bb4d372390509c219 100644 (file)
--- a/effect_chain.h
+++ b/effect_chain.h
@@ -1,5 +1,11 @@
-#ifndef _EFFECT_CHAIN_H
-#define _EFFECT_CHAIN_H 1
+#ifndef _MOVIT_EFFECT_CHAIN_H
+#define _MOVIT_EFFECT_CHAIN_H 1
+
+// An EffectChain is the largest basic entity in Movit; it contains everything
+// needed to connects a series of effects, from inputs to outputs, and render
+// them. Generally you set up your effect chain once and then call its render
+// functions once per frame; setting one up can be relatively expensive,
+// but rendering is fast.
 
 #include <GL/glew.h>
 #include <stdio.h>
@@ -8,12 +14,9 @@
 #include <string>
 #include <vector>
 
-#include "effect.h"
 #include "image_format.h"
-#include "input.h"
 
 class Effect;
-class EffectChain;
 class Input;
 struct Phase;
 
@@ -232,12 +235,10 @@ private:
        Effect *dither_effect;
 
        std::vector<Input *> inputs;  // Also contained in nodes.
-
-       GLuint fbo;
        std::vector<Phase *> phases;
 
        unsigned num_dither_bits;
        bool finalized;
 };
 
-#endif // !defined(_EFFECT_CHAIN_H)
+#endif // !defined(_MOVIT_EFFECT_CHAIN_H)