X-Git-Url: http://git.tdb.fi/?p=libs%2Fgl.git;a=blobdiff_plain;f=source%2Fcore%2Fmodule.h;h=a480b6139426efaeeb7287566d8bbdc1f2891690;hp=34553b44c0e239bfeccac39b873a61b4ea26333d;hb=959efbf61663efd7879070ce0447e02c8a447ce0;hpb=acaefb4c669f01855252818ef0a2958cbdababc3

diff --git a/source/core/module.h b/source/core/module.h
index 34553b44..a480b613 100644
--- a/source/core/module.h
+++ b/source/core/module.h
@@ -21,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:
@@ -31,19 +39,30 @@ 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;
 };
 
+/**
+A shader module in GLSL source code format.
+*/
 class GlslModule: public Module
 {
 private:
@@ -61,6 +80,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:
@@ -79,6 +107,15 @@ public:
 		OUTPUT = 3
 	};
 
+	enum BuiltinSemantic
+	{
+		NOT_BUILTIN = -1,
+		POSITION = 0,
+		CLIP_DISTANCE = 3,
+		LAYER = 9,
+		FRAG_DEPTH = 22
+	};
+
 	struct Constant;
 	struct Structure;
 	struct Variable;
@@ -86,46 +123,40 @@ public:
 	struct EntryPoint
 	{
 		std::string name;
-		Stage stage;
+		Stage stage = VERTEX;
 		std::vector<const Variable *> globals;
-
-		EntryPoint();
 	};
 
 	struct StructMember
 	{
 		std::string name;
-		DataType type;
-		const Structure *struct_type;
-		unsigned offset;
-		unsigned array_size;
-		const Constant *array_size_spec;
-		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<StructMember> members;
-		unsigned size;
+		unsigned size = 0;
 	};
 
 	struct Variable
 	{
 		std::string name;
-		StorageClass storage;
-		DataType type;
-		const Structure *struct_type;
-		const Constant *array_size_spec;
-		unsigned array_size;
-		int location;
-		int descriptor_set;
-		int binding;
-
-		Variable();
+		StorageClass storage = static_cast<StorageClass>(-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;
 	};
@@ -133,11 +164,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;
 		};
 	};
@@ -145,14 +176,11 @@ public:
 private:
 	struct TypeInfo
 	{
-		DataType type;
-		const Structure *struct_type;
-		const Constant *array_size_spec;
-		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<StorageClass>(-1);
 	};
 
 	struct Reflection
@@ -198,7 +226,7 @@ private:
 	std::vector<Constant> spec_constants;
 
 public:
-	SpirVModule() { }
+	SpirVModule() = default;
 	SpirVModule(const SpirVModule &);
 	SpirVModule &operator=(const SpirVModule &);
 private:
@@ -207,6 +235,7 @@ 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 &);