Fix reflection of image types from Spir-V modules

[libs/gl.git] / source / core / module.h

diff --git a/source/core/module.h b/source/core/module.h
index 34553b44c0e239bfeccac39b873a61b4ea26333d..c669af0506ab64d26b25bf504ec28533e7e1cf92 100644 (file)
--- a/source/core/module.h
+++ b/source/core/module.h
@@ -6,6 +6,7 @@
 #include <vector>
 #include <msp/io/base.h>
 #include "datatype.h"
+#include "module_backend.h"
 #include "glsl/compiler.h"
 #include "glsl/sourcemap.h"
 
@@ -21,6 +22,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 +40,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:
@@ -61,7 +83,16 @@ public:
        const SL::SourceMap &get_source_map() const { return source_map; }
 };
 
-class SpirVModule: public Module
+/**
+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 SpirVModuleBackend
 {
 public:
        enum Stage
@@ -76,7 +107,17 @@ 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;
@@ -86,46 +127,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;
+               unsigned descriptor_set = 0;
+               int binding = -1;
+               BuiltinSemantic builtin = NOT_BUILTIN;
 
                bool operator==(const Variable &) const;
        };
@@ -133,11 +168,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 +180,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
@@ -197,16 +229,10 @@ private:
        std::vector<Variable> variables;
        std::vector<Constant> spec_constants;
 
-public:
-       SpirVModule() { }
-       SpirVModule(const SpirVModule &);
-       SpirVModule &operator=(const SpirVModule &);
-private:
-       void remap_pointers_from(const SpirVModule &);
-
 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 &);