source/core/program.h

   1 #ifndef MSP_GL_PROGRAM_H_
   2 #define MSP_GL_PROGRAM_H_
   3
   4 #include <string>
   5 #include <vector>
   6 #include <msp/datafile/objectloader.h>
   7 #include "datatype.h"
   8 #include "gl.h"
   9 #include "module.h"
  10 #include "tag.h"
  11 #include "vertexformat.h"
  12
  13 namespace Msp {
  14 namespace GL {
  15
  16 /**
  17 A complete shader program.  Programs can be assembled of individual Shaders or
  18 generated with a set of standard features.
  19 */
  20 class Program
  21 {
  22 public:
  23         class Loader: public DataFile::CollectionObjectLoader<Program>
  24         {
  25         public:
  26                 Loader(Program &, Collection &);
  27
  28         private:
  29                 virtual void finish();
  30
  31                 void module(const std::string &);
  32         };
  33
  34 private:
  35         class SpecializationLoader: public DataFile::Loader
  36         {
  37         private:
  38                 std::map<std::string, int> &spec_values;
  39
  40                 static ActionMap shared_actions;
  41
  42         public:
  43                 SpecializationLoader(std::map<std::string, int> &);
  44
  45         private:
  46                 virtual void init_actions();
  47
  48                 void specialize_bool(const std::string &, bool);
  49                 void specialize_int(const std::string &, int);
  50         };
  51
  52 public:
  53         typedef unsigned LayoutHash;
  54         struct UniformBlockInfo;
  55
  56         struct UniformInfo
  57         {
  58                 std::string name;
  59                 const UniformBlockInfo *block;
  60                 union
  61                 {
  62                         int location;
  63                         unsigned offset;
  64                 };
  65                 unsigned array_size;
  66                 unsigned array_stride;
  67                 unsigned matrix_stride;
  68                 DataType type;
  69                 Tag tag;
  70                 int binding;
  71
  72                 UniformInfo();
  73         };
  74
  75         struct UniformBlockInfo
  76         {
  77                 std::string name;
  78                 unsigned data_size;
  79                 int bind_point;
  80                 std::vector<const UniformInfo *> uniforms;
  81                 LayoutHash layout_hash;
  82
  83                 UniformBlockInfo();
  84         };
  85
  86         struct AttributeInfo
  87         {
  88                 std::string name;
  89                 unsigned location;
  90                 unsigned array_size;
  91                 DataType type;
  92
  93                 AttributeInfo();
  94         };
  95
  96 private:
  97         enum Stage
  98         {
  99                 VERTEX,
 100                 GEOMETRY,
 101                 FRAGMENT,
 102                 MAX_STAGES
 103         };
 104
 105         struct TransientData
 106         {
 107                 std::map<std::string, unsigned> textures;
 108                 std::map<std::string, unsigned> blocks;
 109                 std::map<unsigned, int> spec_values;
 110         };
 111
 112         unsigned id;
 113         unsigned stage_ids[MAX_STAGES];
 114         const Module *module;
 115         TransientData *transient;
 116         bool linked;
 117         std::vector<UniformBlockInfo> uniform_blocks;
 118         std::vector<UniformInfo> uniforms;
 119         LayoutHash uniform_layout_hash;
 120         std::vector<AttributeInfo> attributes;
 121         std::string debug_name;
 122
 123 public:
 124         /// Constructs an empty Program with no shader stages attached.
 125         Program();
 126
 127         /// Constructs a Program from a Module, with specialization constants.
 128         Program(const Module &, const std::map<std::string, int> & = std::map<std::string, int>());
 129
 130 private:
 131         void init();
 132 public:
 133         virtual ~Program();
 134
 135         void add_stages(const Module &, const std::map<std::string, int> & = std::map<std::string, int>());
 136 private:
 137         bool has_stages() const;
 138         unsigned add_stage(Stage);
 139         void add_glsl_stages(const GlslModule &, const std::map<std::string, int> &);
 140         void compile_glsl_stage(unsigned);
 141         void add_spirv_stages(const SpirVModule &, const std::map<std::string, int> &);
 142
 143 public:
 144         void link();
 145 private:
 146         void query_uniforms();
 147         void query_uniform_blocks(const std::vector<UniformInfo *> &);
 148         void query_attributes();
 149         void collect_uniforms();
 150         void collect_block_uniforms(const SpirVModule::Structure &, const std::string &, unsigned, std::vector<std::string> &);
 151         void collect_attributes();
 152         void update_layout_hash();
 153         static LayoutHash compute_layout_hash(const std::vector<const UniformInfo *> &);
 154         static bool uniform_location_compare(const UniformInfo *, const UniformInfo *);
 155 public:
 156         bool is_linked() const { return linked; }
 157
 158         LayoutHash get_uniform_layout_hash() const { return uniform_layout_hash; }
 159         const std::vector<UniformBlockInfo> &get_uniform_blocks() const { return uniform_blocks; }
 160         const UniformBlockInfo &get_uniform_block_info(const std::string &) const;
 161         const std::vector<UniformInfo> &get_uniforms() const { return uniforms; }
 162         const UniformInfo &get_uniform_info(const std::string &) const;
 163         const UniformInfo &get_uniform_info(Tag) const;
 164         int get_uniform_location(const std::string &) const;
 165         int get_uniform_location(Tag) const;
 166         int get_uniform_binding(Tag) const;
 167         const std::vector<AttributeInfo> &get_attributes() const { return attributes; }
 168         const AttributeInfo &get_attribute_info(const std::string &) const;
 169         int get_attribute_location(const std::string &) const;
 170
 171         unsigned get_id() const { return id; }
 172
 173         void set_debug_name(const std::string &);
 174 private:
 175         void set_stage_debug_name(unsigned, Stage);
 176 };
 177
 178 } // namespace GL
 179 } // namespace Msp
 180
 181 #endif