Update and improve documentation

[libs/gl.git] / source / render / sequence.h

diff --git a/source/render/sequence.h b/source/render/sequence.h
index dd9fd8849b62b47f338970bdb9206f240c4470b6..b6a8cb34a158271468e3b9195b10709a93728b93 100644 (file)
--- a/source/render/sequence.h
+++ b/source/render/sequence.h
@@ -16,18 +16,23 @@ class PostProcessor;
 class RenderTarget;
 
 /**
-Top-level content class.  Typically a Sequence is used as the content
-Renderable for a View or effects such as ShadowMap or EnvironmentMap.
+Top-level content class.  Typically a Sequence is used as content for a View
+or sideband content for effects such as ShadowMap or EnvironmentMap.
 
 A Sequence consists of a number of steps.  Each step is defined with a
-Renderable and a tag to render it with and may also have Lighting, DepthTest
-and Blend states.  Scenes can be used to further organize Renderables within a
-step.
+Renderable and a tag to render it with.  Lighting, DepthTest and StencilTest
+states may also be applied to steps.  Scenes can be used to organize multiple
+Renderables within a step.
+
+The target framebuffer can optionally be cleared before the first step.
 
 PostProcessors can be applied after all of the steps in the Sequence have been
 processed.  Framebuffer objects are automatically used to pass render results
-to the PostProcessors.  High dynamic range and multisample rendering can be
-requested for increased quality.
+to the PostProcessors.  The Sequence must be created with a size and a frame
+format.
+
+A Sequence itself is normally rendered with an empty tag.  A special "noclear"
+tag can be used to suppress clearing.
 */
 class Sequence: public Renderable
 {
@@ -94,12 +99,13 @@ public:
        void set_clear_stencil(int);
 
        /** Adds a step to the sequence.  It's permissible to add the same
-       Renderable multiple times. */
+       Renderable or tag multiple times. */
        Step &add_step(Tag, Renderable &);
 
        const std::vector<Step> &get_steps() const { return steps; }
 
-       /** Adds a postprocessor to the sequence. */
+       /** Adds a postprocessor to the sequence.  A render target format must be
+       defined. */
        void add_postprocessor(PostProcessor &);
 
        const std::vector<PostProcessor *> &get_postprocessors() const { return postproc; }