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         enum ChangeMask
  93         {
  94                 MATRIX = 1,
  95                 LIGHTING = 4,
  96                 SHADER_DATA = 8
  97         };
  98
  99         MtxStack mtx_stack;
 100         unsigned char changed;
 101         bool matrices_loaded;
 102         const Camera *camera;
 103         std::vector<State> state_stack;
 104         State *state;
 105         ProgramData standard_shdata;
 106         std::vector<const ProgramData *> shdata_stack;
 107         const Buffer *element_buffer;
 108         std::set<const Renderable *> excluded;
 109
 110 public:
 111         Renderer(const Camera *);
 112         ~Renderer();
 113
 114         MatrixStack &matrix_stack() { return mtx_stack; }
 115
 116         const Camera *get_camera() const { return camera; }
 117
 118         void set_texture(const Texture *);
 119         void set_texturing(const Texturing *);
 120         unsigned allocate_effect_texunit();
 121         void set_material(const Material *);
 122
 123         void set_lighting(const Lighting *);
 124
 125         /** Sets the shader program to use.  An initial set of data can be set as
 126         well, with the same semantics as add_shader_data. */
 127         void set_shader_program(const Program *prog, const ProgramData *data = 0);
 128
 129         /** Adds another set of data to be use with shader programs.  The data is
 130         independent of any shader program changes and remains in effect until the
 131         Renderer state is popped. */
 132         void add_shader_data(const ProgramData &data);
 133
 134         void set_mesh(const Mesh *);
 135         void set_element_buffer(const Buffer *);
 136         void set_winding_test(const WindingTest *);
 137         void set_reverse_winding(bool);
 138
 139         /** Saves the current state so it can be restored later. */
 140         void push_state();
 141
 142         /** Restores a previously saved state.  Must be matched with an earlier
 143         push_state call. */
 144         void pop_state();
 145
 146         /** Prepares for temporarily bypassing the Renderer by synchronizing the
 147         current state with GL.  No additional call is necessary to resume using the
 148         Renderer.  DEPRECATED. */
 149         void escape();
 150
 151         /** Ends rendering, unbinding all objects and resetting state.  There must
 152         be no unpopped state in the stack. */
 153         void end();
 154
 155         void exclude(const Renderable &);
 156         void include(const Renderable &);
 157
 158         void render(const Renderable &, const Tag & = Tag());
 159         void draw(const Batch &);
 160
 161 private:
 162         void apply_state();
 163 };
 164
 165 } // namespace GL
 166 } // namespace Msp
 167
 168 #endif