From: Steinar H. Gunderson <sgunderson@bigfoot.com>
Date: Fri, 17 Jan 2014 17:57:13 +0000 (+0100)
Subject: Add a file-level comment for EffectChain.
X-Git-Tag: 1.0~86
X-Git-Url: https://git.sesse.net/?p=movit;a=commitdiff_plain;h=7d78534e38d50892ca57d3a17f27214ac094ea58

Add a file-level comment for EffectChain.
---

diff --git a/effect_chain.h b/effect_chain.h
index 6698c6f..407648b 100644
--- a/effect_chain.h
+++ b/effect_chain.h
@@ -1,6 +1,12 @@
 #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>