source/render/programdata.h

   1 #ifndef MSP_GL_PROGRAMDATA_H_
   2 #define MSP_GL_PROGRAMDATA_H_
   3
   4 #include <map>
   5 #include <stdexcept>
   6 #include <msp/datafile/objectloader.h>
   7 #include "datatype.h"
   8 #include "matrix.h"
   9 #include "reflectdata.h"
  10 #include "tag.h"
  11 #include "vector.h"
  12
  13 namespace Msp {
  14 namespace GL {
  15
  16 class too_many_uniforms: public std::runtime_error
  17 {
  18 public:
  19         too_many_uniforms(const std::string &w): std::runtime_error(w) { }
  20         virtual ~too_many_uniforms() throw() { }
  21 };
  22
  23 class Buffer;
  24 class BufferBackedUniformBlock;
  25 class PipelineState;
  26 class Program;
  27 class UniformBlock;
  28 struct Color;
  29
  30 /**
  31 Stores uniform variables for shader programs.  The uniforms are stored in a
  32 program-independent way, and UniformBlocks are created to match the uniform
  33 layouts of different programs.  If multiple programs have the same layout, the
  34 same block is used for them.
  35
  36 The class is optimized for an access pattern where the set of uniforms and
  37 programs stays constants, with only the values changing.
  38 */
  39 class ProgramData
  40 {
  41 public:
  42         class Loader: public DataFile::ObjectLoader<ProgramData>
  43         {
  44         public:
  45                 Loader(ProgramData &);
  46         private:
  47                 void uniform1i(const std::string &, int);
  48                 void uniform1f(const std::string &, float);
  49                 void uniform2i(const std::string &, int, int);
  50                 void uniform2f(const std::string &, float, float);
  51                 void uniform3i(const std::string &, int, int, int);
  52                 void uniform3f(const std::string &, float, float, float);
  53                 void uniform4i(const std::string &, int, int, int, int);
  54                 void uniform4f(const std::string &, float, float, float, float);
  55                 void uniform_array_(const std::string &, DataType, unsigned);
  56                 void uniform1i_array(const std::string &);
  57                 void uniform1f_array(const std::string &);
  58                 void uniform2i_array(const std::string &);
  59                 void uniform2f_array(const std::string &);
  60                 void uniform3i_array(const std::string &);
  61                 void uniform3f_array(const std::string &);
  62                 void uniform4i_array(const std::string &);
  63                 void uniform4f_array(const std::string &);
  64                 void uniform_array(const std::string &);
  65         };
  66
  67 private:
  68         class ArrayLoader: public DataFile::Loader
  69         {
  70         private:
  71                 DataType type;
  72                 unsigned element_size;
  73                 std::vector<char> data;
  74
  75         public:
  76                 ArrayLoader(DataType, unsigned);
  77
  78                 DataType get_data_type() const { return type; }
  79                 unsigned get_element_size() const { return element_size; }
  80                 const void *get_data() const { return &data[0]; }
  81                 unsigned get_size() const { return data.size()/(4*element_size); }
  82
  83         private:
  84                 void uniform(DataType, unsigned, const void *);
  85                 void uniform1i(int);
  86                 void uniform1f(float);
  87                 void uniform2i(int, int);
  88                 void uniform2f(float, float);
  89                 void uniform3i(int, int, int);
  90                 void uniform3f(float, float, float);
  91                 void uniform4i(int, int, int, int);
  92                 void uniform4f(float, float, float, float);
  93         };
  94
  95         typedef unsigned Mask;
  96
  97         enum
  98         {
  99                 MASK_BITS = sizeof(Mask)*8,
 100                 ALL_ONES = static_cast<Mask>(-1)
 101         };
 102
 103         struct TaggedUniform
 104         {
 105                 Tag tag;
 106                 DataType type;
 107                 unsigned array_size;
 108                 unsigned data_offset;
 109                 unsigned data_size;
 110
 111                 TaggedUniform();
 112         };
 113
 114         struct SharedBlock
 115         {
 116                 ReflectData::LayoutHash block_hash;
 117                 Mask used;
 118                 Mask dirty;
 119                 UniformBlock *block;
 120                 union
 121                 {
 122                         std::uint8_t type_flag;
 123                         std::uint8_t values[16];
 124                         struct
 125                         {
 126                                 std::uint8_t type_flag;
 127                                 std::uint8_t *values;
 128                         } dynamic;
 129                 } indices;
 130
 131                 SharedBlock(ReflectData::LayoutHash);
 132
 133                 const std::uint8_t *get_uniform_indices() const;
 134         };
 135
 136         struct ProgramBlock
 137         {
 138                 ReflectData::LayoutHash prog_hash;
 139                 int bind_point;
 140                 int block_index;
 141                 union
 142                 {
 143                         UniformBlock *block;
 144                         struct
 145                         {
 146                                 Mask used;
 147                                 Mask dirty;
 148                         } masks;
 149                 };
 150
 151                 ProgramBlock(ReflectData::LayoutHash);
 152         };
 153
 154         // XXX All these mutables are a bit silly, but I'm out of better ideas
 155         const Program *tied_program;
 156         std::vector<TaggedUniform> uniforms;
 157         std::vector<char> uniform_data;
 158         unsigned generation;
 159         mutable std::vector<SharedBlock> blocks;
 160         mutable std::vector<ProgramBlock> programs;
 161         mutable UniformBlock *last_buffer_block;
 162         mutable Buffer *buffer;
 163         mutable Mask dirty;
 164         std::string debug_name;
 165
 166 public:
 167         ProgramData(const Program * = 0);
 168         ProgramData(const ProgramData &);
 169         ProgramData(const ProgramData &, const Program *);
 170         ProgramData &operator=(const ProgramData &);
 171         ~ProgramData();
 172
 173 private:
 174         void uniform(Tag, DataType, unsigned, const void *);
 175         bool validate_tag(Tag) const;
 176         void mark_dirty(Mask);
 177 public:
 178         void uniform(Tag, int);
 179         void uniform(Tag, float);
 180         void uniform(Tag, int, int);
 181         void uniform(Tag, float, float);
 182         void uniform2(Tag, const int *);
 183         void uniform2(Tag, const float *);
 184         void uniform(Tag, int, int, int);
 185         void uniform(Tag, float, float, float);
 186         void uniform3(Tag, const int *);
 187         void uniform3(Tag, const float *);
 188         void uniform(Tag, int, int, int, int);
 189         void uniform(Tag, float, float, float, float);
 190         void uniform(Tag, const Color &);
 191         void uniform4(Tag, const int *);
 192         void uniform4(Tag, const float *);
 193         void uniform_matrix2(Tag, const float *);
 194         void uniform_matrix3x2(Tag, const float *);
 195         void uniform_matrix4x2(Tag, const float *);
 196         void uniform_matrix2x3(Tag, const float *);
 197         void uniform_matrix3(Tag, const float *);
 198         void uniform_matrix4x3(Tag, const float *);
 199         void uniform_matrix2x4(Tag, const float *);
 200         void uniform_matrix3x4(Tag, const float *);
 201         void uniform(Tag, const Matrix &);
 202         void uniform_matrix4(Tag, const float *);
 203         void uniform_array(Tag, unsigned, const int *);
 204         void uniform_array(Tag, unsigned, const float *);
 205         void uniform1_array(Tag, unsigned, const int *);
 206         void uniform1_array(Tag, unsigned, const float *);
 207         void uniform2_array(Tag, unsigned, const int *);
 208         void uniform2_array(Tag, unsigned, const float *);
 209         void uniform3_array(Tag, unsigned, const int *);
 210         void uniform3_array(Tag, unsigned, const float *);
 211         void uniform4_array(Tag, unsigned, const int *);
 212         void uniform4_array(Tag, unsigned, const float *);
 213         void uniform_matrix2_array(Tag, unsigned, const float *);
 214         void uniform_matrix3x2_array(Tag, unsigned, const float *);
 215         void uniform_matrix4x2_array(Tag, unsigned, const float *);
 216         void uniform_matrix2x3_array(Tag, unsigned, const float *);
 217         void uniform_matrix3_array(Tag, unsigned, const float *);
 218         void uniform_matrix4x3_array(Tag, unsigned, const float *);
 219         void uniform_matrix2x4_array(Tag, unsigned, const float *);
 220         void uniform_matrix3x4_array(Tag, unsigned, const float *);
 221         void uniform_matrix4_array(Tag, unsigned, const float *);
 222
 223         template<typename T, unsigned N>
 224         void uniform(Tag, const LinAl::Vector<T, N> &);
 225
 226         template<typename T, unsigned R, unsigned C>
 227         void uniform(Tag, const LinAl::Matrix<T, R, C> &);
 228
 229         template<typename T, unsigned N>
 230         void uniform_array(Tag, unsigned, const LinAl::Vector<T, N> *);
 231
 232         template<typename T, unsigned R, unsigned C>
 233         void uniform_array(Tag, unsigned, const LinAl::Matrix<T, R, C> *);
 234
 235         void remove_uniform(Tag);
 236
 237         unsigned get_generation() const { return generation; }
 238
 239         std::vector<Tag> get_uniform_tags() const;
 240         void copy_uniform(const ProgramData &, Tag);
 241
 242 private:
 243         int find_uniform_index(Tag) const;
 244         std::vector<ProgramBlock>::iterator get_program(const Program &) const;
 245         void update_block_uniform_indices(SharedBlock &, const ReflectData::UniformBlockInfo &) const;
 246         void update_block(SharedBlock &, const ReflectData::UniformBlockInfo &) const;
 247
 248         std::vector<ProgramBlock>::const_iterator prepare_program(const Program &) const;
 249 public:
 250         void apply(const Program &, PipelineState &) const;
 251
 252         void set_debug_name(const std::string &);
 253 };
 254
 255 template<typename T, unsigned N>
 256 void ProgramData::uniform(Tag tag, const LinAl::Vector<T, N> &v)
 257 { uniform(tag, TypeTraits<LinAl::Vector<T, N>>::type, 1, &v.x); }
 258
 259 template<typename T, unsigned R, unsigned C>
 260 void ProgramData::uniform(Tag tag, const LinAl::Matrix<T, R, C> &v)
 261 { uniform(tag, TypeTraits<LinAl::Matrix<T, R, C>>::type, 1, &v(0, 0)); }
 262
 263 template<typename T, unsigned N>
 264 void ProgramData::uniform_array(Tag tag, unsigned n, const LinAl::Vector<T, N> *v)
 265 { uniform(tag, TypeTraits<LinAl::Vector<T, N>>::type, n, &v[0].x); }
 266
 267 template<typename T, unsigned R, unsigned C>
 268 void ProgramData::uniform_array(Tag tag, unsigned n, const LinAl::Matrix<T, R, C> *v)
 269 { uniform(tag, TypeTraits<LinAl::Matrix<T, R, C>>::type, n, &v[0](0, 0)); }
 270
 271 } // namespace GL
 272 } // namespace Msp
 273
 274 #endif