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                 unsigned location;
  67                 unsigned array_size;
  68                 unsigned array_stride;
  69                 unsigned matrix_stride;
  70                 DataType type;
  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         typedef std::map<std::string, UniformInfo> UniformMap;
  97         typedef std::map<std::string, UniformBlockInfo> UniformBlockMap;
  98         typedef std::map<std::string, AttributeInfo> AttributeMap;
  99
 100 private:
 101         unsigned id;
 102         std::vector<unsigned> stage_ids;
 103         const Module *module;
 104         bool linked;
 105         UniformBlockMap uniform_blocks;
 106         UniformMap uniforms;
 107         LayoutHash uniform_layout_hash;
 108         AttributeMap attributes;
 109
 110 public:
 111         /// Constructs an empty Program with no shader stages attached.
 112         Program();
 113
 114         /// Constructs a Program from unified source code using ProgramCompiler.
 115         DEPRECATED Program(const std::string &);
 116
 117         /// Constructs a Program from vertex and fragment shader source code.
 118         DEPRECATED Program(const std::string &, const std::string &);
 119
 120         /// Constructs a Program from a Module, with specialization constants.
 121         Program(const Module &, const std::map<std::string, int> & = std::map<std::string, int>());
 122
 123 private:
 124         void init();
 125 public:
 126         virtual ~Program();
 127
 128         void add_stages(const Module &, const std::map<std::string, int> & = std::map<std::string, int>());
 129 private:
 130         unsigned add_stage(GLenum);
 131         void add_glsl_stages(const GlslModule &, const std::map<std::string, int> &);
 132         void compile_glsl_stage(unsigned);
 133         void add_spirv_stages(const SpirVModule &, const std::map<std::string, int> &);
 134
 135 public:
 136         DEPRECATED void attach_shader(Shader &shader);
 137         DEPRECATED void attach_shader_owned(Shader *shader);
 138         DEPRECATED void detach_shader(Shader &shader);
 139         DEPRECATED const std::vector<Shader *> &get_attached_shaders() const;
 140
 141         DEPRECATED void bind_attribute(unsigned, const std::string &);
 142         DEPRECATED void bind_attribute(VertexAttribute, const std::string &);
 143         DEPRECATED void bind_fragment_data(unsigned, const std::string &);
 144
 145         void link();
 146 private:
 147         void query_uniforms();
 148         void query_uniform_blocks(const std::vector<UniformInfo *> &);
 149         void query_attributes();
 150         void collect_uniforms();
 151         void collect_block_uniforms(UniformBlockInfo &, const SpirVModule::Structure &, const std::string &, unsigned);
 152         void collect_attributes();
 153         void update_layout_hash();
 154         static LayoutHash compute_layout_hash(const std::vector<const UniformInfo *> &);
 155         static bool uniform_location_compare(const UniformInfo *, const UniformInfo *);
 156 public:
 157         bool is_linked() const { return linked; }
 158         DEPRECATED std::string get_info_log() const;
 159
 160         LayoutHash get_uniform_layout_hash() const { return uniform_layout_hash; }
 161         const UniformBlockMap &get_uniform_blocks() const { return uniform_blocks; }
 162         const UniformBlockInfo &get_uniform_block_info(const std::string &) const;
 163         const UniformMap &get_uniforms() const { return uniforms; }
 164         const UniformInfo &get_uniform_info(const std::string &) const;
 165         int get_uniform_location(const std::string &) const;
 166         const AttributeMap &get_attributes() const { return attributes; }
 167         const AttributeInfo &get_attribute_info(const std::string &) const;
 168         int get_attribute_location(const std::string &) const;
 169
 170         void bind() const;
 171         static void unbind();
 172 };
 173
 174 } // namespace GL
 175 } // namespace Msp
 176
 177 #endif