]> git.tdb.fi Git - libs/gl.git/blobdiff - source/render/sequence.h
Check the flat qualifier from the correct member
[libs/gl.git] / source / render / sequence.h
index 13431ac469e824c4b9e5d1a4283678d710011090..a5ae2e7c416122933ed3770dc3ec75d38775340c 100644 (file)
@@ -16,20 +16,25 @@ 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
+class Sequence: public Renderable, public NonCopyable
 {
 public:
        class Step
@@ -56,16 +61,16 @@ public:
        };
 
 private:
-       struct PostProcStep
+       struct OwnedObject
        {
-               PostProcessor *postproc;
-               bool owned;
+               void *pointer = 0;
+               void (*delete_func)(void *) = 0;
 
-               PostProcStep(PostProcessor *pp, bool o): postproc(pp), owned(o) { }
+               OwnedObject(void *p, void (*d)(void *)): pointer(p), delete_func(d) { }
        };
 
        std::vector<Step> steps;
-       std::vector<PostProcStep> postproc;
+       std::vector<PostProcessor *> postproc;
        unsigned width = 0;
        unsigned height = 0;
        FrameFormat target_format;
@@ -75,8 +80,9 @@ private:
        std::vector<Color> clear_colors;
        float clear_depth = 1.0f;
        int clear_stencil = 0;
+       std::vector<OwnedObject> owned_data;
 
-       static Tag noclear_tag;
+       static const Tag noclear_tag;
 
 public:
        Sequence() = default;
@@ -93,21 +99,22 @@ 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 &);
 
-       /** Adds a postprocessor to the sequence. */
+       const std::vector<Step> &get_steps() const { return steps; }
+
+       /** Adds a postprocessor to the sequence.  A render target format must be
+       defined. */
        void add_postprocessor(PostProcessor &);
 
-       /** Adds a postprocessor to the sequence, transferring ownership.  The
-       postprocessor will be deleted together with with sequence.  It is also
-       deleted if this call throws an exception. */
-       void add_postprocessor_owned(PostProcessor *);
+       const std::vector<PostProcessor *> &get_postprocessors() const { return postproc; }
 
-private:
-       void add_postprocessor(PostProcessor *, bool);
+       /** Adds an owned object, which will be deleted together with the sequence. */
+       template<typename T>
+       void add_owned(T *p)
+       { owned_data.push_back({ p, [](void *ptr){ delete static_cast<T *>(ptr); } }); }
 
-public:
        virtual void setup_frame(Renderer &);
        virtual void finish_frame();