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 "framebuffer.h"
   7 #include "renderable.h"
   8 #include "renderbuffer.h"
   9 #include "rendertarget.h"
  10 #include "texture2d.h"
  11
  12 namespace Msp {
  13 namespace GL {
  14
  15 class Blend;
  16 class Camera;
  17 class Clipping;
  18 class DepthTest;
  19 class Lighting;
  20 class PostProcessor;
  21 class View;
  22
  23 /**
  24 Top-level content class.  Typically a Sequence is used as the content
  25 Renderable for a View or effects such as ShadowMap or EnvironmentMap.
  26
  27 A Sequence consists of a number of steps.  Each step is defined with a
  28 Renderable and a tag to render it with and may also have Lighting, Clipping,
  29 DepthTest and Blend states.  Scenes can be used to further organize Renderables
  30 within a step.
  31
  32 PostProcessors can be applied after all of the steps in the Sequence have been
  33 processed.  Framebuffer objects are automatically used to pass render results
  34 to the PostProcessors.  High dynamic range and multisample rendering can be
  35 requested for increased quality.
  36 */
  37 class Sequence: public Renderable
  38 {
  39 public:
  40         class Step
  41         {
  42         private:
  43                 Tag tag;
  44                 const Lighting *lighting;
  45                 const DepthTest *depth_test;
  46                 const Blend *blend;
  47                 const Clipping *clipping;
  48                 Renderable *renderable;
  49
  50         public:
  51                 Step(Tag, Renderable *);
  52
  53                 Tag get_tag() const { return tag; }
  54
  55                 void set_lighting(const Lighting *);
  56                 void set_depth_test(const DepthTest *);
  57                 void set_blend(const Blend *);
  58                 void set_clipping(const Clipping *);
  59                 const Lighting *get_lighting() const { return lighting; }
  60                 const DepthTest *get_depth_test() const { return depth_test; }
  61                 const Blend *get_blend() const { return blend; }
  62                 const Clipping *get_clipping() const { return clipping; }
  63                 Renderable *get_renderable() const { return renderable; }
  64         };
  65
  66         DEPRECATED typedef Step Pass;
  67
  68 private:
  69         struct Slot
  70         {
  71                 Renderable *renderable;
  72                 std::set<Tag> passes;
  73
  74                 Slot(Renderable *);
  75         };
  76
  77         typedef std::list<Step> StepList;
  78
  79         StepList steps;
  80         const Camera *camera;
  81         std::vector<Slot> renderables;
  82         std::vector<RefPtr<PostProcessor> > postproc;
  83         unsigned width;
  84         unsigned height;
  85         bool hdr;
  86         bool alpha;
  87         unsigned samples;
  88         RenderTarget *target[2];
  89         RenderTarget *target_ms;
  90
  91 public:
  92         Sequence(unsigned, unsigned, bool = false);
  93         Sequence(const View &);
  94         Sequence(const Framebuffer &);
  95 private:
  96         void init(unsigned, unsigned);
  97 public:
  98         ~Sequence();
  99
 100         /* Sets high dynamic range mode.  Requires floating-point texture support.
 101         A ColorCurve postprocessor is recommended for full benefit. */
 102         void set_hdr(bool);
 103
 104         /* Enable or disable alpha channel.  When enabled, all render targets are
 105         created with an RGBA pixel format instead of RGB. */
 106         void set_alpha(bool);
 107
 108         void set_multisample(unsigned);
 109
 110         unsigned get_width() const { return width; }
 111         unsigned get_height() const { return height; }
 112         bool get_hdr() const { return hdr; }
 113         unsigned get_multisample() const { return samples; }
 114
 115         /** Adds a step to the sequence.  It's permissible to add the same
 116         Renderable multiple times. */
 117         Step &add_step(Tag, Renderable &);
 118
 119         DEPRECATED Step &add_pass(Tag t, Renderable &r) { return add_step(t, r); }
 120
 121         /** Adds a postprocessor to the sequence. */
 122         void add_postprocessor(PostProcessor &);
 123
 124         /** Adds a postprocessor to the sequence, transferring ownership.  The
 125         postprocessor will be deleted together with with sequence.  It is also
 126         deleted if this call throws an exception. */
 127         void add_postprocessor_owned(PostProcessor *);
 128
 129 private:
 130         void add_postprocessor(PostProcessor *, bool);
 131
 132 public:
 133         virtual void setup_frame(Renderer &);
 134         virtual void finish_frame();
 135
 136         virtual void render(Renderer &, Tag tag = Tag()) const;
 137
 138 private:
 139         void create_targets(unsigned);
 140 };
 141
 142 } // namespace GL
 143 } // namespace Msp
 144
 145 #endif