1 #ifndef MSP_GL_MODULE_H_
2 #define MSP_GL_MODULE_H_
7 #include <msp/io/base.h>
9 #include "module_backend.h"
10 #include "glsl/compiler.h"
11 #include "glsl/sourcemap.h"
16 class invalid_module: public std::runtime_error
19 invalid_module(const std::string &w): runtime_error(w) { }
20 virtual ~invalid_module() throw() { }
26 Base class for shader modules. Internal representation depends on the
29 Modules can be loaded from files.
31 Applications normally use the Program class to access shaders.
45 virtual ~Module() = default;
47 virtual Format get_format() const = 0;
49 /** Sets the module's content from GLSL source code. */
50 void set_source(const std::string &);
52 /** Loads GLSL source from a file or other I/O object. Any import
53 statements are resolved using res. */
54 void load_source(IO::Base &, Resources *res, const std::string &name);
56 /** Loads GLSL source from a file or other I/O object. Only builtin
57 shader fragments can be imported. */
58 void load_source(IO::Base &, const std::string &);
61 virtual void compile(SL::Compiler &) = 0;
63 SL::Features create_features() const;
67 A shader module in GLSL source code format.
69 class GlslModule: public Module
72 std::string prepared_source;
73 SL::SourceMap source_map;
76 virtual Format get_format() const { return GLSL; }
79 virtual void compile(SL::Compiler &);
82 const std::string &get_prepared_source() const { return prepared_source; }
83 const SL::SourceMap &get_source_map() const { return source_map; }
87 A shader module in SPIR-V binary format.
89 When the module's contents are set from GLSL source, it will be automatically
90 compiled to SPIR-V. Pre-compiled SPIR-V modules can also be loaded.
92 Afterwards reflection data is available, providing information about variables
93 forming the module's interface.
95 class SpirVModule: public Module, public SpirVModuleBackend
107 UNIFORM_CONSTANT = 0,
130 Stage stage = VERTEX;
131 std::vector<const Variable *> globals;
137 DataType type = VOID;
138 const Structure *struct_type = 0;
140 unsigned array_size = 0;
141 unsigned array_stride = 0;
142 unsigned matrix_stride = 0;
143 BuiltinSemantic builtin = NOT_BUILTIN;
149 std::vector<StructMember> members;
156 StorageClass storage = static_cast<StorageClass>(-1);
157 DataType type = VOID;
158 const Structure *struct_type = 0;
159 unsigned array_size = 0;
161 unsigned descriptor_set = 0;
163 BuiltinSemantic builtin = NOT_BUILTIN;
165 bool operator==(const Variable &) const;
171 int constant_id = -1;
172 DataType type = VOID;
183 DataType type = VOID;
184 const Structure *struct_type = 0;
185 unsigned array_size = 0;
186 unsigned array_stride = 0;
187 StorageClass storage = static_cast<StorageClass>(-1);
192 typedef std::vector<std::uint32_t>::const_iterator CodeIterator;
194 std::map<unsigned, std::string> names;
195 std::map<unsigned, Constant> constants;
196 std::map<unsigned, TypeInfo> types;
197 std::map<unsigned, EntryPoint> entry_points;
198 std::map<unsigned, Structure> structs;
199 std::map<unsigned, Variable> variables;
201 static std::uint32_t get_opcode(std::uint32_t);
202 static CodeIterator get_op_end(const CodeIterator &);
203 static std::string read_string(CodeIterator &, const CodeIterator &);
205 void reflect_code(const std::vector<std::uint32_t> &);
206 void reflect_name(CodeIterator);
207 void reflect_member_name(CodeIterator);
208 void reflect_entry_point(CodeIterator);
209 void reflect_void_type(CodeIterator);
210 void reflect_bool_type(CodeIterator);
211 void reflect_int_type(CodeIterator);
212 void reflect_float_type(CodeIterator);
213 void reflect_vector_type(CodeIterator);
214 void reflect_matrix_type(CodeIterator);
215 void reflect_image_type(CodeIterator);
216 void reflect_sampled_image_type(CodeIterator);
217 void reflect_array_type(CodeIterator);
218 void reflect_struct_type(CodeIterator);
219 void reflect_pointer_type(CodeIterator);
220 void reflect_constant(CodeIterator);
221 void reflect_variable(CodeIterator);
222 void reflect_decorate(CodeIterator);
223 void reflect_member_decorate(CodeIterator);
226 std::vector<std::uint32_t> code;
227 std::vector<EntryPoint> entry_points;
228 std::vector<Structure> structs;
229 std::vector<Variable> variables;
230 std::vector<Constant> spec_constants;
233 virtual Format get_format() const { return SPIR_V; }
235 /** Loads a SPIR-V binary from a file or other I/O object. */
236 void load_code(IO::Base &);
238 virtual void compile(SL::Compiler &);
242 const std::vector<std::uint32_t> &get_code() const { return code; }
243 const std::vector<EntryPoint> &get_entry_points() const { return entry_points; }
244 const std::vector<Variable> &get_variables() const { return variables; }
245 const std::vector<Constant> &get_spec_constants() const { return spec_constants; }