Add a file-level comment for EffectChain.
authorSteinar H. Gunderson <sgunderson@bigfoot.com>
Fri, 17 Jan 2014 17:57:13 +0000 (18:57 +0100)
committerSteinar H. Gunderson <sgunderson@bigfoot.com>
Fri, 17 Jan 2014 17:57:16 +0000 (18:57 +0100)
effect_chain.h

index 6698c6f..407648b 100644 (file)
@@ -1,6 +1,12 @@
 #ifndef _MOVIT_EFFECT_CHAIN_H
 #define _MOVIT_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>
 #include <map>
 #include <GL/glew.h>
 #include <stdio.h>
 #include <map>