X-Git-Url: http://git.tdb.fi/?p=libs%2Fgl.git;a=blobdiff_plain;f=source%2Fcore%2Fmodule.h;h=16e07053ea4abd427fac950b0b09da2bb89c6ac9;hp=3492a5ded49b795ca37a808a9c8a403fed353d60;hb=f73e671dcb36c097647cddbf5b1eaaad2ffc9299;hpb=9f6bb77743014e4321e783aae5e84af1c925e572 diff --git a/source/core/module.h b/source/core/module.h index 3492a5de..16e07053 100644 --- a/source/core/module.h +++ b/source/core/module.h @@ -1,10 +1,11 @@ #ifndef MSP_GL_MODULE_H_ #define MSP_GL_MODULE_H_ +#include #include +#include #include #include "datatype.h" -#include "gl.h" #include "glsl/compiler.h" #include "glsl/sourcemap.h" @@ -20,6 +21,14 @@ public: class Resources; +/** +Base class for shader modules. Internal representation depends on the +concrete type. + +Modules can be loaded from files. + +Applications normally use the Program class to access shaders. +*/ class Module { public: @@ -30,19 +39,32 @@ public: }; protected: - Module() { } + Module() = default; public: - virtual ~Module() { } + virtual ~Module() = default; virtual Format get_format() const = 0; + /** Sets the module's content from GLSL source code. */ void set_source(const std::string &); - void load_source(IO::Base &, Resources *, const std::string &); + + /** Loads GLSL source from a file or other I/O object. Any import + statements are resolved using res. */ + void load_source(IO::Base &, Resources *res, const std::string &name); + + /** Loads GLSL source from a file or other I/O object. Only builtin + shader fragments can be imported. */ void load_source(IO::Base &, const std::string &); + private: virtual void compile(SL::Compiler &) = 0; + + SL::Features create_features() const; }; +/** +A shader module in GLSL source code format. +*/ class GlslModule: public Module { private: @@ -60,6 +82,15 @@ public: const SL::SourceMap &get_source_map() const { return source_map; } }; +/** +A shader module in SPIR-V binary format. + +When the module's contents are set from GLSL source, it will be automatically +compiled to SPIR-V. Pre-compiled SPIR-V modules can also be loaded. + +Afterwards reflection data is available, providing information about variables +forming the module's interface. +*/ class SpirVModule: public Module { public: @@ -78,90 +109,98 @@ public: OUTPUT = 3 }; + enum BuiltinSemantic + { + NOT_BUILTIN = -1, + POSITION = 0, + CLIP_DISTANCE = 3, + LAYER = 9, + FRAG_DEPTH = 22 + }; + + struct Constant; struct Structure; struct Variable; struct EntryPoint { std::string name; - Stage stage; + Stage stage = VERTEX; std::vector globals; - - EntryPoint(); }; struct StructMember { std::string name; - DataType type; - const Structure *struct_type; - unsigned offset; - unsigned array_size; - unsigned array_stride; - unsigned matrix_stride; - - StructMember(); + DataType type = VOID; + const Structure *struct_type = 0; + unsigned offset = 0; + unsigned array_size = 0; + unsigned array_stride = 0; + unsigned matrix_stride = 0; + BuiltinSemantic builtin = NOT_BUILTIN; }; struct Structure { std::string name; std::vector members; - unsigned size; + unsigned size = 0; }; struct Variable { std::string name; - StorageClass storage; - DataType type; - const Structure *struct_type; - unsigned array_size; - int location; - int descriptor_set; - int binding; - - Variable(); + StorageClass storage = static_cast(-1); + DataType type = VOID; + const Structure *struct_type = 0; + unsigned array_size = 0; + int location = -1; + int descriptor_set = -1; + int binding = -1; + BuiltinSemantic builtin = NOT_BUILTIN; bool operator==(const Variable &) const; }; - struct SpecConstant + struct Constant { std::string name; - unsigned constant_id; - DataType type; + int constant_id = -1; + DataType type = VOID; + union + { + int i_value = 0; + float f_value; + }; }; private: struct TypeInfo { - DataType type; - const Structure *struct_type; - unsigned array_size; - unsigned array_stride; - StorageClass storage; - - TypeInfo(); + DataType type = VOID; + const Structure *struct_type = 0; + unsigned array_size = 0; + unsigned array_stride = 0; + StorageClass storage = static_cast(-1); }; struct Reflection { - typedef std::vector::const_iterator CodeIterator; + typedef std::vector::const_iterator CodeIterator; std::map names; - std::map constants; + std::map constants; std::map types; std::map entry_points; std::map structs; std::map variables; - std::map spec_constants; - static UInt32 get_opcode(UInt32); + static std::uint32_t get_opcode(std::uint32_t); static CodeIterator get_op_end(const CodeIterator &); static std::string read_string(CodeIterator &, const CodeIterator &); - void reflect_code(const std::vector &); + void reflect_code(const std::vector &); void reflect_name(CodeIterator); void reflect_member_name(CodeIterator); void reflect_entry_point(CodeIterator); @@ -177,21 +216,19 @@ private: void reflect_struct_type(CodeIterator); void reflect_pointer_type(CodeIterator); void reflect_constant(CodeIterator); - void reflect_spec_constant_bool(CodeIterator); - void reflect_spec_constant(CodeIterator); void reflect_variable(CodeIterator); void reflect_decorate(CodeIterator); void reflect_member_decorate(CodeIterator); }; - std::vector code; + std::vector code; std::vector entry_points; std::vector structs; std::vector variables; - std::vector spec_constants; + std::vector spec_constants; public: - SpirVModule() { } + SpirVModule() = default; SpirVModule(const SpirVModule &); SpirVModule &operator=(const SpirVModule &); private: @@ -200,16 +237,17 @@ private: public: virtual Format get_format() const { return SPIR_V; } + /** Loads a SPIR-V binary from a file or other I/O object. */ void load_code(IO::Base &); private: virtual void compile(SL::Compiler &); void reflect(); public: - const std::vector &get_code() const { return code; } + const std::vector &get_code() const { return code; } const std::vector &get_entry_points() const { return entry_points; } const std::vector &get_variables() const { return variables; } - const std::vector &get_spec_constants() const { return spec_constants; } + const std::vector &get_spec_constants() const { return spec_constants; } }; } // namespace GL