MdlShaderGenerator.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_MDLSHADERGENERATOR_H
#define MATERIALX_MDLSHADERGENERATOR_H

 
#include <MaterialXGenMdl/Export.h>
 
#include <MaterialXGenShader/ShaderGenerator.h>
 
MATERIALX_NAMESPACE_BEGIN

class MX_GENMDL_API GenMdlOptions : public GenUserData
{
  public:
    enum class MdlVersion
    {
        MDL_1_6,
        MDL_1_7,
        MDL_1_8,
        MDL_1_9,
        MDL_1_10,
        MDL_LATEST = MDL_1_10
    };

    GenMdlOptions() :
        targetVersion(MdlVersion::MDL_LATEST) { }

    static const string GEN_CONTEXT_USER_DATA_KEY;

    MdlVersion targetVersion;
};

using GenMdlOptionsPtr = shared_ptr<class GenMdlOptions>;

using MdlShaderGeneratorPtr = shared_ptr<class MdlShaderGenerator>;

class MX_GENMDL_API MdlShaderGenerator : public ShaderGenerator
{
  public:
    MdlShaderGenerator(TypeSystemPtr typeSystem);

    static ShaderGeneratorPtr create(TypeSystemPtr typeSystem = nullptr)
    {
        return std::make_shared<MdlShaderGenerator>(typeSystem ? typeSystem : TypeSystem::create());
    }

    const string& getTarget() const override { return TARGET; }

    void applyDefaultOptions(GenOptions& options) const override;

    ShaderPtr generate(const string& name, ElementPtr element, GenContext& context) const override;

    ShaderNodeImplPtr createShaderNodeImplForNodeGraph(const NodeGraph& nodegraph) const override;

    ShaderNodeImplPtr createShaderNodeImplForImplementation(const Implementation& implementation) const override;

    string getUpstreamResult(const ShaderInput* input, GenContext& context) const override;

    static const string TARGET;

    static const std::unordered_map<string, string> GEOMPROP_DEFINITIONS;

    GenMdlOptions::MdlVersion getMdlVersion(GenContext& context) const;

    void emitMdlVersionNumber(GenContext& context, ShaderStage& stage) const;

    void emitMdlVersionFilenameSuffix(GenContext& context, ShaderStage& stage) const;

    const string& getMdlVersionFilenameSuffix(GenContext& context) const;

    void emitTypeDefinitions(GenContext& context, ShaderStage& stage) const override;
 
  protected:
    // Create and initialize a new MDL shader for shader generation.
    ShaderPtr createShader(const string& name, ElementPtr element, GenContext& context) const;
 
    // Emit a block of shader inputs.
    void emitShaderInputs(const VariableBlock& inputs, ShaderStage& stage) const;
};
 
namespace MDL
{
 
// Identifiers for MDL variable blocks
extern MX_GENMDL_API const string INPUTS;
extern MX_GENMDL_API const string OUTPUTS;
 
} // namespace MDL
 
MATERIALX_NAMESPACE_END
 
#endif