X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fcore%2Fmodule.h;h=5067895de662e2a29676f07f988df3d9e7d1e371;hb=e70662d7812464159f2e47f4bebb69d88f89ae93;hp=6ca522a5563d8a79348563f4c6170cc8ba2efcb6;hpb=1f71ec73edacd6c1bd230abace3cb791eb2ca759;p=libs%2Fgl.git diff --git a/source/core/module.h b/source/core/module.h index 6ca522a5..5067895d 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: @@ -75,53 +106,60 @@ public: UNIFORM_CONSTANT = 0, INPUT = 1, UNIFORM = 2, - OUTPUT = 3 + OUTPUT = 3, + PUSH_CONSTANT = 9 + }; + + 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 = 0; + int binding = -1; + BuiltinSemantic builtin = NOT_BUILTIN; bool operator==(const Variable &) const; }; @@ -129,11 +167,11 @@ public: struct Constant { std::string name; - int constant_id; - DataType type; + int constant_id = -1; + DataType type = VOID; union { - int i_value; + int i_value = 0; float f_value; }; }; @@ -141,18 +179,16 @@ public: 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; @@ -161,11 +197,11 @@ private: std::map structs; std::map variables; - 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); @@ -186,14 +222,14 @@ private: 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; public: - SpirVModule() { } + SpirVModule() = default; SpirVModule(const SpirVModule &); SpirVModule &operator=(const SpirVModule &); private: @@ -202,13 +238,14 @@ 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; }