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
97 friend SpirVModuleBackend;
109 UNIFORM_CONSTANT = 0,
132 Stage stage = VERTEX;
133 std::vector<const Variable *> globals;
139 DataType type = VOID;
140 const Structure *struct_type = 0;
142 unsigned array_size = 0;
143 unsigned array_stride = 0;
144 unsigned matrix_stride = 0;
145 BuiltinSemantic builtin = NOT_BUILTIN;
151 std::vector<StructMember> members;
158 StorageClass storage = static_cast<StorageClass>(-1);
159 DataType type = VOID;
160 const Structure *struct_type = 0;
161 unsigned array_size = 0;
163 unsigned descriptor_set = 0;
165 BuiltinSemantic builtin = NOT_BUILTIN;
167 bool operator==(const Variable &) const;
173 int constant_id = -1;
174 DataType type = VOID;
182 struct InstructionBlock
184 const Constant *condition = 0;
185 bool negate_condition = false;
186 std::vector<const Variable *> accessed_variables;
187 std::vector<const InstructionBlock *> successors;
193 DataType type = VOID;
194 const Structure *struct_type = 0;
195 unsigned array_size = 0;
196 unsigned array_stride = 0;
197 StorageClass storage = static_cast<StorageClass>(-1);
202 typedef std::vector<std::uint32_t>::const_iterator CodeIterator;
204 std::map<unsigned, std::string> names;
205 std::map<unsigned, Constant> constants;
206 std::map<unsigned, TypeInfo> types;
207 std::map<unsigned, EntryPoint> entry_points;
208 std::map<unsigned, Structure> structs;
209 std::map<unsigned, Variable> variables;
210 std::map<unsigned, InstructionBlock> blocks;
211 std::map<unsigned, unsigned> access_chain_bases;
212 Constant true_condition;
213 InstructionBlock *current_block = 0;
215 static std::uint32_t get_opcode(std::uint32_t);
216 static CodeIterator get_op_end(const CodeIterator &);
217 static std::string read_string(CodeIterator &, const CodeIterator &);
219 void reflect_code(const std::vector<std::uint32_t> &);
220 void reflect_name(CodeIterator);
221 void reflect_member_name(CodeIterator);
222 void reflect_entry_point(CodeIterator);
223 void reflect_void_type(CodeIterator);
224 void reflect_bool_type(CodeIterator);
225 void reflect_int_type(CodeIterator);
226 void reflect_float_type(CodeIterator);
227 void reflect_vector_type(CodeIterator);
228 void reflect_matrix_type(CodeIterator);
229 void reflect_image_type(CodeIterator);
230 void reflect_sampled_image_type(CodeIterator);
231 void reflect_array_type(CodeIterator);
232 void reflect_struct_type(CodeIterator);
233 void reflect_pointer_type(CodeIterator);
234 void reflect_constant(CodeIterator);
235 void reflect_variable(CodeIterator);
236 void reflect_access(CodeIterator);
237 void reflect_access_chain(CodeIterator);
238 void reflect_decorate(CodeIterator);
239 void reflect_member_decorate(CodeIterator);
240 void reflect_label(CodeIterator);
241 void reflect_branch(CodeIterator);
242 void reflect_branch_conditional(CodeIterator);
245 std::vector<std::uint32_t> code;
246 std::vector<EntryPoint> entry_points;
247 std::vector<Structure> structs;
248 std::vector<Variable> variables;
249 std::vector<Constant> spec_constants;
250 std::vector<InstructionBlock> blocks;
253 virtual Format get_format() const { return SPIR_V; }
255 /** Loads a SPIR-V binary from a file or other I/O object. */
256 void load_code(IO::Base &);
258 virtual void compile(SL::Compiler &);
262 const std::vector<std::uint32_t> &get_code() const { return code; }
263 const std::vector<EntryPoint> &get_entry_points() const { return entry_points; }
264 const std::vector<Variable> &get_variables() const { return variables; }
265 const std::vector<Constant> &get_spec_constants() const { return spec_constants; }
266 const std::vector<InstructionBlock> &get_blocks() const { return blocks; }