source/render/sequence.h

   1 #ifndef MSP_GL_SEQUENCE_H_
   2 #define MSP_GL_SEQUENCE_H_
   3
   4 #include <map>
   5 #include <set>
   6 #include "blend.h"
   7 #include "depthtest.h"
   8 #include "framebuffer.h"
   9 #include "renderable.h"
  10 #include "rendertarget.h"
  11 #include "stenciltest.h"
  12 #include "texture2d.h"
  13
  14 namespace Msp {
  15 namespace GL {
  16
  17 class Blend;
  18 class Camera;
  19 class Clipping;
  20 class Lighting;
  21 class PostProcessor;
  22 class View;
  23
  24 /**
  25 Top-level content class.  Typically a Sequence is used as the content
  26 Renderable for a View or effects such as ShadowMap or EnvironmentMap.
  27
  28 A Sequence consists of a number of steps.  Each step is defined with a
  29 Renderable and a tag to render it with and may also have Lighting, Clipping,
  30 DepthTest and Blend states.  Scenes can be used to further organize Renderables
  31 within a step.
  32
  33 PostProcessors can be applied after all of the steps in the Sequence have been
  34 processed.  Framebuffer objects are automatically used to pass render results
  35 to the PostProcessors.  High dynamic range and multisample rendering can be
  36 requested for increased quality.
  37 */
  38 class Sequence: public Renderable
  39 {
  40 public:
  41         class Step
  42         {
  43         private:
  44                 Tag tag;
  45                 const Lighting *lighting;
  46                 DepthTest depth_test;
  47                 StencilTest stencil_test;
  48                 Blend blend;
  49                 const Clipping *clipping;
  50                 Renderable *renderable;
  51
  52         public:
  53                 Step(Tag, Renderable *);
  54
  55                 Tag get_tag() const { return tag; }
  56
  57                 void set_lighting(const Lighting *);
  58                 void set_depth_test(const DepthTest &);
  59                 void set_stencil_test(const StencilTest &);
  60                 void set_blend(const Blend &);
  61                 void set_clipping(const Clipping *);
  62                 const Lighting *get_lighting() const { return lighting; }
  63                 const DepthTest &get_depth_test() const { return depth_test; }
  64                 const StencilTest &get_stencil_test() const { return stencil_test; }
  65                 const Blend &get_blend() const { return blend; }
  66                 const Clipping *get_clipping() const { return clipping; }
  67                 Renderable *get_renderable() const { return renderable; }
  68         };
  69
  70 private:
  71         struct PostProcStep
  72         {
  73                 PostProcessor *postproc;
  74                 bool owned;
  75
  76                 PostProcStep(PostProcessor *pp, bool o): postproc(pp), owned(o) { }
  77         };
  78
  79         std::vector<Step> steps;
  80         std::vector<PostProcStep> postproc;
  81         unsigned width;
  82         unsigned height;
  83         FrameFormat target_format;
  84         RenderTarget *target[2];
  85         RenderTarget *target_ms;
  86
  87 public:
  88         Sequence(unsigned, unsigned, const FrameFormat & = FrameFormat());
  89         Sequence(const View &, const FrameFormat & = FrameFormat());
  90         Sequence(const Framebuffer &, const FrameFormat & = FrameFormat());
  91 private:
  92         void init(unsigned, unsigned, const FrameFormat &);
  93 public:
  94         ~Sequence();
  95
  96         const FrameFormat &get_target_format() { return target_format; }
  97
  98         unsigned get_width() const { return width; }
  99         unsigned get_height() const { return height; }
 100
 101         /** Adds a step to the sequence.  It's permissible to add the same
 102         Renderable multiple times. */
 103         Step &add_step(Tag, Renderable &);
 104
 105         /** Adds a postprocessor to the sequence. */
 106         void add_postprocessor(PostProcessor &);
 107
 108         /** Adds a postprocessor to the sequence, transferring ownership.  The
 109         postprocessor will be deleted together with with sequence.  It is also
 110         deleted if this call throws an exception. */
 111         void add_postprocessor_owned(PostProcessor *);
 112
 113 private:
 114         void add_postprocessor(PostProcessor *, bool);
 115
 116 public:
 117         virtual void setup_frame(Renderer &);
 118         virtual void finish_frame();
 119
 120         virtual void render(Renderer &, Tag tag = Tag()) const;
 121
 122         void set_debug_name(const std::string &);
 123 };
 124
 125 } // namespace GL
 126 } // namespace Msp
 127
 128 #endif