Class ProgramDesc

Source/Falcor/Core/Program/Program.h:156–566

* Description of a program to be created. * This includes the following: * - shader sources organized into shader modules (each module is compiled as a separate translation unit) * - entry points organized into entry point groups * - type conformances (global and per entry point group) * - compiler options (shader model, flags, etc.) */

 * - compiler options (shader model, flags, etc.)
 */
struct ProgramDesc
{
    struct ShaderID
    {
        int32_t groupIndex = -1; ///< Entry point group index.
        bool isValid() const { return groupIndex >= 0; }
    };

    /// Represents a single piece of shader source code.
    /// This can either be a file or a string.
    struct ShaderSource
    {
        enum class Type
        {
            File,
            String
        };

        /// Type of the shader source.
        Type type{Type::File};

        /// Shader source file path.
        /// For Type::File this is the actual path to the file.
        /// For Type::String this is an optional virtual path used for diagnostics purposes.
        std::filesystem::path path;

        /// Shader source string if type == Type::String.
        std::string string;

        bool operator==(const ShaderSource& rhs) const { return type == rhs.type && path == rhs.path && string == rhs.string; }
    };

    /// 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 = {})
        {