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 "bindable.h"
   8 #include "datatype.h"
   9 #include "gl.h"
  10 #include "module.h"
  11 #include "vertexformat.h"
  12
  13 namespace Msp {
  14 namespace GL {
  15
  16 class Shader;
  17
  18 /**
  19 A complete shader program.  Programs can be assembled of individual Shaders or
  20 generated with a set of standard features.
  21 */
  22 class Program: public Bindable<Program>
  23 {
  24 public:
  25         class Loader: public DataFile::CollectionObjectLoader<Program>
  26         {
  27         public:
  28                 Loader(Program &, Collection &);
  29
  30         private:
  31                 virtual void finish();
  32
  33                 void attribute(unsigned, const std::string &);
  34                 void fragment_shader(const std::string &);
  35                 void geometry_shader(const std::string &);
  36                 void module(const std::string &);
  37                 void vertex_shader(const std::string &);
  38         };
  39
  40 private:
  41         class SpecializationLoader: public DataFile::Loader
  42         {
  43         private:
  44                 std::map<std::string, int> &spec_values;
  45
  46                 static ActionMap shared_actions;
  47
  48         public:
  49                 SpecializationLoader(std::map<std::string, int> &);
  50
  51         private:
  52                 virtual void init_actions();
  53
  54                 void specialize_bool(const std::string &, bool);
  55                 void specialize_int(const std::string &, int);
  56         };
  57
  58 public:
  59         typedef unsigned LayoutHash;
  60         struct UniformBlockInfo;
  61
  62         struct UniformInfo
  63         {
  64                 std::string name;
  65                 const UniformBlockInfo *block;
  66                 union
  67                 {
  68                         int location;
  69                         unsigned offset;
  70                 };
  71                 unsigned array_size;
  72                 unsigned array_stride;
  73                 unsigned matrix_stride;
  74                 DataType type;
  75
  76                 UniformInfo();
  77         };
  78
  79         struct UniformBlockInfo
  80         {
  81                 std::string name;
  82                 unsigned data_size;
  83                 int bind_point;
  84                 std::vector<const UniformInfo *> uniforms;
  85                 LayoutHash layout_hash;
  86
  87                 UniformBlockInfo();
  88         };
  89
  90         struct AttributeInfo
  91         {
  92                 std::string name;
  93                 unsigned location;
  94                 unsigned array_size;
  95                 DataType type;
  96
  97                 AttributeInfo();
  98         };
  99
 100 private:
 101         struct Bindings
 102         {
 103                 std::map<std::string, unsigned> textures;
 104                 std::map<std::string, unsigned> blocks;
 105         };
 106
 107         unsigned id;
 108         std::vector<unsigned> stage_ids;
 109         const Module *module;
 110         Bindings *bindings;
 111         bool linked;
 112         std::vector<UniformBlockInfo> uniform_blocks;
 113         std::vector<UniformInfo> uniforms;
 114         LayoutHash uniform_layout_hash;
 115         std::vector<AttributeInfo> attributes;
 116
 117 public:
 118         /// Constructs an empty Program with no shader stages attached.
 119         Program();
 120
 121         /// Constructs a Program from unified source code using ProgramCompiler.
 122         DEPRECATED Program(const std::string &);
 123
 124         /// Constructs a Program from vertex and fragment shader source code.
 125         DEPRECATED Program(const std::string &, const std::string &);
 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         unsigned add_stage(GLenum);
 138         void add_glsl_stages(const GlslModule &, const std::map<std::string, int> &);
 139         void compile_glsl_stage(unsigned);
 140         void add_spirv_stages(const SpirVModule &, const std::map<std::string, int> &);
 141
 142 public:
 143         DEPRECATED void attach_shader(Shader &shader);
 144         DEPRECATED void attach_shader_owned(Shader *shader);
 145         DEPRECATED void detach_shader(Shader &shader);
 146         DEPRECATED const std::vector<Shader *> &get_attached_shaders() const;
 147
 148         DEPRECATED void bind_attribute(unsigned, const std::string &);
 149         DEPRECATED void bind_attribute(VertexAttribute, const std::string &);
 150         DEPRECATED void bind_fragment_data(unsigned, const std::string &);
 151
 152         void link();
 153 private:
 154         void query_uniforms();
 155         void query_uniform_blocks(const std::vector<UniformInfo *> &);
 156         void query_attributes();
 157         void collect_uniforms();
 158         void collect_block_uniforms(const SpirVModule::Structure &, const std::string &, unsigned, std::vector<std::string> &);
 159         void collect_attributes();
 160         void update_layout_hash();
 161         static LayoutHash compute_layout_hash(const std::vector<const UniformInfo *> &);
 162         static bool uniform_location_compare(const UniformInfo *, const UniformInfo *);
 163         static bool uniform_name_compare(const UniformInfo &, const UniformInfo &);
 164         template<typename T>
 165         static bool name_search(const T &, const std::string &);
 166 public:
 167         bool is_linked() const { return linked; }
 168         DEPRECATED std::string get_info_log() const;
 169
 170         LayoutHash get_uniform_layout_hash() const { return uniform_layout_hash; }
 171         const std::vector<UniformBlockInfo> &get_uniform_blocks() const { return uniform_blocks; }
 172         const UniformBlockInfo &get_uniform_block_info(const std::string &) const;
 173         const std::vector<UniformInfo> &get_uniforms() const { return uniforms; }
 174         const UniformInfo &get_uniform_info(const std::string &) const;
 175         int get_uniform_location(const std::string &) const;
 176         const std::vector<AttributeInfo> &get_attributes() const { return attributes; }
 177         const AttributeInfo &get_attribute_info(const std::string &) const;
 178         int get_attribute_location(const std::string &) const;
 179
 180         void bind() const;
 181         static void unbind();
 182 };
 183
 184 } // namespace GL
 185 } // namespace Msp
 186
 187 #endif