Class ShaderModule

Source/Falcor/Core/Program/Program.h:190–235

    /// Represents a single shader module made up from a list of sources (files/strings).
    /// A shader module corresponds to a single translation unit.
    struct ShaderModule
    {
        /// The name of the shader module.
        /// This is the name used by other modules to import this module.
        /// If left empty, a name based on a hash from the module sources will be generated.
        std::string name;

        /// List of shader sources.
        std::vector<ShaderSource> sources;

        ShaderModule() = default;
        explicit ShaderModule(std::string name_) : name(std::move(name_)) {}

        /// Create a shader module description containing a single file.
        static ShaderModule fromFile(std::filesystem::path path)
        {
            ShaderModule sm;
            sm.addFile(std::move(path));
            return sm;
        }

        /// Create a shader module description containing a single string.
        static ShaderModule fromString(std::string string, std::filesystem::path path = {}, std::string moduleName = {})
        {
            ShaderModule sm(std::move(moduleName));
            sm.addString(std::move(string), std::move(path));
            return sm;
        }

        /// Add a source file to the shader module.
        ShaderModule& addFile(std::filesystem::path path)
        {
            sources.push_back({ShaderSource::Type::File, std::move(path), {}});
            return *this;
        }

        /// Add a source string to the shader module.
        /// The path is optional and only used for diagnostic purposes.
        ShaderModule& addString(std::string string, std::filesystem::path path = {})
        {
            sources.push_back({ShaderSource::Type::String, std::move(path), std::move(string)});
            return *this;
        }

        bool operator==(const ShaderModule& rhs) const { return name == rhs.name && sources == rhs.sources; }
    };

    /// Represents a single entry point.
    struct EntryPoint