source/renderer.h

   1 #ifndef MSP_GL_RENDERER_H_
   2 #define MSP_GL_RENDERER_H_
   3
   4 #include <set>
   5 #include <vector>
   6 #include "matrix.h"
   7 #include "programdata.h"
   8 #include "tag.h"
   9
  10 namespace Msp {
  11 namespace GL {
  12
  13 class Batch;
  14 class Buffer;
  15 class Camera;
  16 class Material;
  17 class Mesh;
  18 class Lighting;
  19 class Program;
  20 class Renderable;
  21 class Texture;
  22 class Texturing;
  23 class WindingTest;
  24
  25 /**
  26 A class for supervising the rendering process.  While many Renderables (in
  27 particular, Objects and Scenes) can by rendered without a Renderer, using one
  28 will often be more efficient.  This is especially true for ObjectInstances.
  29
  30 The Renderer works by deferring GL state changes until something is actually
  31 being drawn.  This avoids many unnecessary GL calls if consecutive renderables
  32 use the same resources.
  33
  34 A state stack is provided to help with state scoping.  Typically a Renderable
  35 will push the current state on entry, set whatever state it requires, render
  36 itself, and pop the state when it's done.  An RAII helper class is provided for
  37 the push/pop operation.
  38 */
  39 class Renderer
  40 {
  41 public:
  42         class Push
  43         {
  44         private:
  45                 Renderer &renderer;
  46
  47         public:
  48                 Push(Renderer &r): renderer(r) { renderer.push_state(); }
  49                 ~Push() { renderer.pop_state(); }
  50         };
  51
  52         class Exclude
  53         {
  54         private:
  55                 Renderer &renderer;
  56                 const Renderable &renderable;
  57
  58         public:
  59                 Exclude(Renderer &r, const Renderable &e): renderer(r), renderable(e) { renderer.exclude(renderable); }
  60                 ~Exclude() { renderer.include(renderable); }
  61         };
  62
  63 private:
  64         struct State
  65         {
  66                 const Texture *texture;
  67                 const Texturing *texturing;
  68                 unsigned lowest_effect_texunit;
  69                 const Material *material;
  70                 const Lighting *lighting;
  71                 Matrix lighting_matrix;
  72                 const Program *shprog;
  73                 unsigned shdata_count;
  74                 const Mesh *mesh;
  75                 const WindingTest *winding_test;
  76                 bool reverse_winding;
  77
  78                 State();
  79         };
  80
  81         class MtxStack: public MatrixStack
  82         {
  83         private:
  84                 Renderer &renderer;
  85
  86         public:
  87                 MtxStack(Renderer &);
  88         private:
  89                 virtual void update();
  90         };
  91
  92         MtxStack mtx_stack;
  93         bool mtx_changed;
  94         bool matrices_loaded;
  95         const Camera *camera;
  96         std::vector<State> state_stack;
  97         State *state;
  98         bool lighting_changed;
  99         ProgramData standard_shdata;
 100         std::vector<const ProgramData *> shdata_stack;
 101         bool shdata_changed;
 102         const Buffer *element_buffer;
 103         std::set<const Renderable *> excluded;
 104
 105 public:
 106         Renderer(const Camera *);
 107         ~Renderer();
 108
 109         MatrixStack &matrix_stack() { return mtx_stack; }
 110
 111         const Camera *get_camera() const { return camera; }
 112
 113         void set_texture(const Texture *);
 114         void set_texturing(const Texturing *);
 115         unsigned allocate_effect_texunit();
 116         void set_material(const Material *);
 117
 118         void set_lighting(const Lighting *);
 119
 120         /** Sets the shader program to use.  An initial set of data can be set as
 121         well, with the same semantics as add_shader_data. */
 122         void set_shader_program(const Program *prog, const ProgramData *data = 0);
 123
 124         /** Adds another set of data to be use with shader programs.  The data is
 125         independent of any shader program changes and remains in effect until the
 126         Renderer state is popped. */
 127         void add_shader_data(const ProgramData &data);
 128
 129         void set_mesh(const Mesh *);
 130         void set_element_buffer(const Buffer *);
 131         void set_winding_test(const WindingTest *);
 132         void set_reverse_winding(bool);
 133
 134         /** Saves the current state so it can be restored later. */
 135         void push_state();
 136
 137         /** Restores a previously saved state.  Must be matched with an earlier
 138         push_state call. */
 139         void pop_state();
 140
 141         /** Prepares for temporarily bypassing the Renderer by synchronizing the
 142         current state with GL.  No additional call is necessary to resume using the
 143         Renderer.  DEPRECATED. */
 144         void escape();
 145
 146         /** Ends rendering, unbinding all objects and resetting state.  There must
 147         be no unpopped state in the stack. */
 148         void end();
 149
 150         void exclude(const Renderable &);
 151         void include(const Renderable &);
 152
 153         void render(const Renderable &, const Tag & = Tag());
 154         void draw(const Batch &);
 155
 156 private:
 157         void apply_state();
 158 };
 159
 160 } // namespace GL
 161 } // namespace Msp
 162
 163 #endif