hdMtlx.h

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_PXR_IMAGING_HD_MTLX_HDMTLX_H
#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_PXR_IMAGING_HD_MTLX_HDMTLX_H
 
// XXX: Delete this file after hdPrman drops support for USD versions
// older than 2608. There are bugfixes in 2608 which we want in our
// build.
 
#include "pxr/pxr.h"
#if PXR_VERSION >= 2608
#include <pxr/imaging/hdMtlx/hdMtlx.h> // IWYU pragma: export
#else
 
#include "pxr/base/tf/token.h"
#include "pxr/imaging/hdMtlx/api.h"
#include <map>
#include <memory>
#include <set>
#include <unordered_map>
 
#include <MaterialXCore/Library.h>
 
MATERIALX_NAMESPACE_BEGIN
    class FileSearchPath;
    using DocumentPtr = std::shared_ptr<class Document>;
    using NodeDefPtr = std::shared_ptr<class NodeDef>;
MATERIALX_NAMESPACE_END
 
PXR_NAMESPACE_OPEN_SCOPE
 
#define HdMtlxSearchPaths HdMtlxPrmanSearchPaths
#define HdMtlxStdLibraries HdMtlxPrmanStdLibraries
#define HdMtlxCreateNameFromPath HdMtlxPrmanCreateNameFromPath
#define HdMtlxCreateMtlxDocumentFromHdMaterialNetworkInterface HdMtlxPrmanCreateMtlxDocumentFromHdMaterialNetworkInterface
#define HdMtlxGetNodeDef HdMtlxPrmanGetNodeDef
#define HdMtlxGetNodeDefName HdMtlxPrmanGetNodeDefName
#define HdMtlxGetMxTerminalName HdMtlxPrmanGetMxTerminalName
 
class SdfPath;
class VtValue;
struct HdMaterialNetwork2;
struct HdMaterialNode2;
class HdMaterialNetworkInterface;
 
HDMTLX_API
const MaterialX::FileSearchPath&
HdMtlxPrmanSearchPaths();
 
HDMTLX_API
const MaterialX::DocumentPtr&
HdMtlxPrmanStdLibraries();
 
HDMTLX_API
std::string
HdMtlxPrmanConvertToString(VtValue const& hdParameterValue);
 
// Storing MaterialX-Hydra texture and primvar information
struct HdMtlxTexturePrimvarData {
    HdMtlxTexturePrimvarData() = default;
    using TextureMap = std::map<std::string, std::set<std::string>>;
    TextureMap mxHdTextureMap; // Mx-Hd texture name mapping
    std::set<SdfPath> hdTextureNodes; // Paths to HdTexture Nodes
    std::set<SdfPath> hdPrimvarNodes; // Paths to HdPrimvar nodes
};
 
HDMTLX_API
std::string
HdMtlxPrmanCreateNameFromPath(SdfPath const& path);
 
HDMTLX_API
MaterialX::NodeDefPtr
HdMtlxPrmanGetNodeDef(
    TfToken const& hdNodeType,
    MaterialX::DocumentPtr const& mxDoc=nullptr);
 
HDMTLX_API
std::string
HdMtlxPrmanGetNodeDefName(std::string const& prevMxNodeDefName);
 
HDMTLX_API
std::string
HdMtlxPrmanGetMxTerminalName(
    HdMaterialNetworkInterface *netInterface,
    TfToken const& hdTerminalNodeName);
 
HDMTLX_API
std::string
HdMtlxPrmanGetMxTerminalName(std::string const& mxTerminalType);
 
HDMTLX_API
MaterialX::DocumentPtr
HdMtlxPrmanCreateMtlxDocumentFromHdNetwork(
    HdMaterialNetwork2 const& hdNetwork,
    HdMaterialNode2 const& hdMaterialXNode,
    SdfPath const& hdMaterialXNodePath,
    SdfPath const& materialPath,
    MaterialX::DocumentPtr const& libraries,
    HdMtlxTexturePrimvarData *mxHdData = nullptr);
 
HDMTLX_API
MaterialX::DocumentPtr
HdMtlxPrmanCreateMtlxDocumentFromHdMaterialNetworkInterface(
    HdMaterialNetworkInterface *interface,
    TfToken const& terminalNodeName,
    TfTokenVector const& terminalNodeConnectionNames,
    MaterialX::DocumentPtr const& libraries,
    HdMtlxTexturePrimvarData *mxHdData = nullptr);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_VERSION >= 2608
 
#endif // EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_PXR_IMAGING_HD_MTLX_HDMTLX_H