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 Clipping;
  17 class Material;
  18 class Mesh;
  19 class Lighting;
  20 class Program;
  21 class Renderable;
  22 class Texture;
  23 class Texturing;
  24 class WindingTest;
  25
  26 /**
  27 A class for supervising the rendering process.  While many Renderables (in
  28 particular, Objects and Scenes) can by rendered without a Renderer, using one
  29 will often be more efficient.  This is especially true for ObjectInstances.
  30
  31 The Renderer works by deferring GL state changes until something is actually
  32 being drawn.  This avoids many unnecessary GL calls if consecutive renderables
  33 use the same resources.
  34
  35 A state stack is provided to help with state scoping.  Typically a Renderable
  36 will push the current state on entry, set whatever state it requires, render
  37 itself, and pop the state when it's done.  An RAII helper class is provided for
  38 the push/pop operation.
  39 */
  40 class Renderer
  41 {
  42 public:
  43         class Push
  44         {
  45         private:
  46                 Renderer &renderer;
  47
  48         public:
  49                 Push(Renderer &r): renderer(r) { renderer.push_state(); }
  50                 ~Push() { renderer.pop_state(); }
  51         };
  52
  53         class Exclude
  54         {
  55         private:
  56                 Renderer &renderer;
  57                 const Renderable &renderable;
  58
  59         public:
  60                 Exclude(Renderer &r, const Renderable &e): renderer(r), renderable(e) { renderer.exclude(renderable); }
  61                 ~Exclude() { renderer.include(renderable); }
  62         };
  63
  64 private:
  65         struct State
  66         {
  67                 Matrix modelview_matrix;
  68                 const Texture *texture;
  69                 const Texturing *texturing;
  70                 unsigned lowest_effect_texunit;
  71                 const Material *material;
  72                 const Lighting *lighting;
  73                 Matrix lighting_matrix;
  74                 const Clipping *clipping;
  75                 Matrix clipping_matrix;
  76                 const Program *shprog;
  77                 unsigned shdata_count;
  78                 const Mesh *mesh;
  79                 const WindingTest *winding_test;
  80                 bool reverse_winding;
  81
  82                 State();
  83         };
  84
  85         enum ChangeMask
  86         {
  87                 LEGACY_MATRIX = 1,
  88                 MODERN_MATRIX = 2,
  89                 MATRIX = LEGACY_MATRIX|MODERN_MATRIX,
  90                 LEGACY_LIGHTING = 4,
  91                 LEGACY_CLIPPING = 8,
  92                 SHADER_DATA = 16,
  93                 MATERIAL_SHDATA = 32,
  94                 STANDARD_SHDATA = 64
  95         };
  96
  97         unsigned char changed;
  98         bool matrices_loaded;
  99         unsigned shdata_applied;
 100         const Camera *camera;
 101         std::vector<State> state_stack;
 102         State *state;
 103         ProgramData standard_shdata;
 104         std::vector<const ProgramData *> shdata_stack;
 105         std::set<const Renderable *> excluded;
 106
 107 public:
 108         Renderer(const Camera *);
 109         ~Renderer();
 110
 111         /** Resets all internal state and restarts rendering.  There must be no
 112         unpopped state in the stack.  It is permissible to call begin() multiple
 113         times without an intervening end(). */
 114         void begin(const Camera *);
 115
 116         /** Replaces the Renderer's modelview matrix. */
 117         void set_matrix(const Matrix &);
 118
 119         /** Applies a transform to the Renderer's modelview matrix. */
 120         void transform(const Matrix &);
 121
 122         /** Returns the current modelview matrix. */
 123         const Matrix &get_matrix() const { return state->modelview_matrix; }
 124
 125         const Camera *get_camera() const { return camera; }
 126
 127         void set_texture(const Texture *);
 128         void set_texturing(const Texturing *);
 129         unsigned allocate_effect_texunit();
 130         void set_material(const Material *);
 131
 132         void set_lighting(const Lighting *);
 133         void set_clipping(const Clipping *);
 134
 135         /** Sets the shader program to use.  An initial set of data can be set as
 136         well, with the same semantics as add_shader_data. */
 137         void set_shader_program(const Program *prog, const ProgramData *data = 0);
 138
 139         /** Adds another set of data to be use with shader programs.  The data is
 140         independent of any shader program changes and remains in effect until the
 141         Renderer state is popped. */
 142         void add_shader_data(const ProgramData &data);
 143
 144         void set_mesh(const Mesh *);
 145         void set_winding_test(const WindingTest *);
 146         void set_reverse_winding(bool);
 147
 148         /** Saves the current state so it can be restored later. */
 149         void push_state();
 150
 151         /** Restores a previously saved state.  Must be matched with an earlier
 152         push_state call. */
 153         void pop_state();
 154
 155         /** Prepares for temporarily bypassing the Renderer by synchronizing the
 156         current state with GL.  No additional call is necessary to resume using the
 157         Renderer.  DEPRECATED. */
 158         void escape();
 159
 160         /** Unbinds all objects and resets related state.  There must be no unpopped
 161         state in the stack.  Rendering with the same camera can be restarted without
 162         an explicit begin() call. */
 163         void end();
 164
 165         void exclude(const Renderable &);
 166         void include(const Renderable &);
 167
 168         void render(const Renderable &, const Tag & = Tag());
 169         void draw(const Batch &);
 170
 171 private:
 172         void apply_state();
 173         void reset_state();
 174 };
 175
 176 } // namespace GL
 177 } // namespace Msp
 178
 179 #endif