Move backend specific shadergen features behind ifdefs so that each backend is isolated from the others, and removes the need for MaterialX patches.

Author: dgovil

build_scripts/build_usd.py

@@ -1538,19 +1538,8 @@ def InstallMaterialX(context, force, buildArgs):
             # but MaterialX intertwines GLSL shadergen support with also requiring rendering support.
             cmakeOptions.extend([
                 '-DMATERIALX_BUILD_GEN_MSL=ON',
-                '-DMATERIALX_BUILD_GEN_GLSL=ON',
+                '-DMATERIALX_BUILD_GEN_GLSL=OFF',
                 '-DMATERIALX_BUILD_IOS=ON'])
-            PatchFile("CMakeLists.txt",
-                      [('    set(MATERIALX_BUILD_GEN_GLSL OFF)',
-                        '    set(MATERIALX_BUILD_GEN_GLSL ON)'),
-                       ('    if (MATERIALX_BUILD_GEN_GLSL)\n' +
-                        '        add_subdirectory(source/MaterialXRenderGlsl)\n' +
-                        '    endif()',
-                        '    if (MATERIALX_BUILD_GEN_GLSL AND NOT MATERIALX_BUILD_IOS)\n' +
-                        '        add_subdirectory(source/MaterialXRenderGlsl)\n' +
-                        '    endif()')
-                       ], multiLineMatches=True)
-
         cmakeOptions += buildArgs
         RunCMake(context, force, cmakeOptions)
 

pxr/imaging/hdSt/CMakeLists.txt

@@ -24,10 +24,16 @@ if (${PXR_ENABLE_MATERIALX_SUPPORT})
         MaterialXRender
         MaterialXCore
         MaterialXFormat
-        MaterialXGenGlsl
-        MaterialXGenMsl
         hdMtlx
     )
+    if (${PXR_ENABLE_METAL_SUPPORT})
+        list(APPEND optionalLibs MaterialXGenMsl)
+    endif()
+
+    if (${PXR_ENABLE_GL_SUPPORT})
+        list(APPEND optionalLibs MaterialXGenGlsl)
+    endif()
+
     list(APPEND optionalPrivateClasses
          materialXFilter
          materialXShaderGen

pxr/imaging/hdSt/materialXFilter.cpp

@@ -166,21 +166,27 @@ _CreateHdStMaterialXContext(
     HdSt_MxShaderGenInfo const& mxHdInfo,
     TfToken const& apiName)
 {
+#if defined(PXR_METAL_SUPPORT_ENABLED)
     if (apiName == HgiTokens->Metal) {
         return HdStMaterialXShaderGenMsl::create(mxHdInfo);
     }
+#endif
+#if defined(PXR_VULKAN_SUPPORT_ENABLED)
     if (apiName == HgiTokens->Vulkan) {
         return HdStMaterialXShaderGenVkGlsl::create(mxHdInfo);
     }
+#endif
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
     if (apiName == HgiTokens->OpenGL) {
         return HdStMaterialXShaderGenGlsl::create(mxHdInfo);
     }
-    else {
-        TF_CODING_ERROR(
-            "MaterialX Shader Generator doesn't support %s API.",
-            apiName.GetText());
-        return mx::ShaderGeneratorPtr();
-    }
+#endif
+
+    TF_CODING_ERROR(
+        "MaterialX Shader Generator doesn't support %s API.",
+        apiName.GetText());
+    return mx::ShaderGeneratorPtr();
+
 }
 
 // Use the given mxDocument to generate the corresponding glsl shader

pxr/imaging/hdSt/materialXShaderGen.cpp

@@ -12,8 +12,12 @@
 #include <MaterialXGenShader/Shader.h>
 #include <MaterialXGenShader/ShaderGenerator.h>
 #include <MaterialXGenShader/Syntax.h>
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
 #include <MaterialXGenGlsl/Nodes/SurfaceNodeGlsl.h>
+#endif
+#if defined(PXR_METAL_SUPPORT_ENABLED)
 #include <MaterialXGenMsl/Nodes/SurfaceNodeMsl.h>
+#endif
 #include <MaterialXGenMsl/MslResourceBindingContext.h>
 #include <MaterialXGenMsl/MslShaderGenerator.h>
 
@@ -482,10 +486,14 @@ HdStMaterialXShaderGen<Base>::_EmitMxVertexDataDeclarations(
     const std::string &targetShadingLanguage = Base::getTarget();
 
     // add beginning ( or {
+#if defined(PXR_GL_SUPPORT_ENABLED)
     if (targetShadingLanguage == mx::GlslShaderGenerator::TARGET) {
         line += "(";
     }
     else if (targetShadingLanguage == mx::MslShaderGenerator::TARGET) {
+#elif defined(PXR_METAL_SUPPORT_ENABLED)
+    if (targetShadingLanguage == mx::MslShaderGenerator::TARGET) {
+#endif
         line += "{";
     }
     else {
@@ -500,13 +508,16 @@ HdStMaterialXShaderGen<Base>::_EmitMxVertexDataDeclarations(
     }
 
     // add ending ) or }
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
     if (targetShadingLanguage == mx::GlslShaderGenerator::TARGET) {
         line += ")";
     }
     else if (targetShadingLanguage == mx::MslShaderGenerator::TARGET) {
+#elif defined(PXR_METAL_SUPPORT_ENABLED)
+    if (targetShadingLanguage == mx::MslShaderGenerator::TARGET) {
         line += "}";
     }
-
+#endif
     emitLine(line, mxStage);
 }
 
@@ -776,17 +787,23 @@ HdStMaterialXShaderGen<Base>::_EmitDataStructsAndFunctionDefinitions(
     }
     if (shadowing) {
         mx::ShaderGenerator::emitLibraryInclude(
-            "pbrlib/" + mx::GlslShaderGenerator::TARGET
-            + "/lib/mx_shadow.glsl", mxContext, mxStage);
+            "pbrlib/"
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
+            + mx::GlslShaderGenerator::TARGET + "/" +
+#endif
+            "lib/mx_shadow.glsl", mxContext, mxStage);
     }
 
     // Emit directional albedo table code.
     if (mxContext.getOptions().hwDirectionalAlbedoMethod ==
             mx::HwDirectionalAlbedoMethod::DIRECTIONAL_ALBEDO_TABLE ||
         mxContext.getOptions().hwWriteAlbedoTable) {
         mx::ShaderGenerator::emitLibraryInclude(
-            "pbrlib/" + mx::GlslShaderGenerator::TARGET
-            + "/lib/mx_table.glsl", mxContext, mxStage);
+            "pbrlib/"
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
++ mx::GlslShaderGenerator::TARGET + "/" +
+#endif
+            "lib/mx_table.glsl", mxContext, mxStage);
         Base::emitLineBreak(mxStage);
     }
 
@@ -832,7 +849,7 @@ HdStMaterialXShaderGen<Base>::_EmitDataStructsAndFunctionDefinitions(
 // ----------------------------------------------------------------------------
 //                          HdSt MaterialX ShaderGen OpenGL GLSL
 // ----------------------------------------------------------------------------
-
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
 namespace {
     // Create a customized version of the class mx::SurfaceNodeGlsl
     // to be able to notify the shader generator when we start/end
@@ -982,7 +999,9 @@ HdStMaterialXShaderGenGlsl::_EmitMxFunctions(
     _EmitDataStructsAndFunctionDefinitions(
         mxGraph, mxContext, mxStage, &_tokenSubstitutions);
 }
+#endif
 
+#if defined(PXR_VULKAN_SUPPORT_ENABLED)
 // ----------------------------------------------------------------------------
 //                    HdSt MaterialX ShaderGen Vulkan GLSL
 // ----------------------------------------------------------------------------
@@ -1134,7 +1153,9 @@ HdStMaterialXShaderGenVkGlsl::_EmitMxFunctions(
     _EmitDataStructsAndFunctionDefinitions(
         mxGraph, mxContext, mxStage, &_tokenSubstitutions);
 }
+#endif
 
+#if defined(PXR_METAL_SUPPORT_ENABLED)
 // ----------------------------------------------------------------------------
 //                          HdSt MaterialX ShaderGen Metal
 // ----------------------------------------------------------------------------
@@ -1295,11 +1316,17 @@ HdStMaterialXShaderGenMsl::_EmitMxFunctions(
     mx::ShaderStage& mxStage) const
 {
     mx::ShaderGenerator::emitLibraryInclude(
-        "pbrlib/" + mx::GlslShaderGenerator::TARGET
-        + "/lib/mx_microfacet.glsl", mxContext, mxStage);
+        "pbrlib/"
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
+    + mx::GlslShaderGenerator::TARGET + "/" +
+#endif
+        "lib/mx_microfacet.glsl", mxContext, mxStage);
     mx::ShaderGenerator::emitLibraryInclude(
-        "stdlib/" + mx::MslShaderGenerator::TARGET
-        + "/lib/mx_math.metal", mxContext, mxStage);
+        "stdlib/"
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
+    + mx::GlslShaderGenerator::TARGET + "/" +
+#endif
+        "lib/mx_math.metal", mxContext, mxStage);
     _EmitConstantsUniformsAndTypeDefs(
         mxContext, mxStage,_syntax->getConstantQualifier());
 
@@ -1347,6 +1374,6 @@ HdStMaterialXShaderGenMsl::_EmitMxFunctions(
     _EmitDataStructsAndFunctionDefinitions(
         mxGraph, mxContext, mxStage, &_tokenSubstitutions);
 }
-
+#endif
 
 PXR_NAMESPACE_CLOSE_SCOPE

pxr/imaging/hdSt/materialXShaderGen.h

@@ -8,10 +8,16 @@
 #define PXR_IMAGING_HD_ST_MATERIALX_SHADER_GEN_H
 
 #include "pxr/pxr.h"
-
+#include <MaterialXCore/Library.h>
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
 #include <MaterialXGenGlsl/GlslShaderGenerator.h>
+#endif
+#if defined(PXR_METAL_SUPPORT_ENABLED)
 #include <MaterialXGenMsl/MslShaderGenerator.h>
+#endif
+#if defined(PXR_VULKAN_SUPPORT_ENABLED)
 #include <MaterialXGenGlsl/VkShaderGenerator.h>
+#endif
 
 PXR_NAMESPACE_OPEN_SCOPE
 
@@ -98,7 +104,7 @@ class HdStMaterialXShaderGen : public Base
     bool _emittingSurfaceNode;
 };
 
-
+#if defined(PXR_OPENGL_SUPPORT_ENABLED)
 /// \class HdStMaterialXShaderGenGlsl
 ///
 /// Generates a glslfx shader with a surfaceShader function for a MaterialX 
@@ -128,7 +134,9 @@ class HdStMaterialXShaderGenGlsl
                           MaterialX::GenContext& mxContext,
                           MaterialX::ShaderStage& mxStage) const;
 };
+#endif
 
+#if defined(PXR_VULKAN_SUPPORT_ENABLED)
 /// \class HdStMaterialXShaderGenVkGlsl
 ///
 /// Generates a glslfx shader with a surfaceShader function for a MaterialX 
@@ -158,7 +166,9 @@ class HdStMaterialXShaderGenVkGlsl
                           MaterialX::GenContext& mxContext,
                           MaterialX::ShaderStage& mxStage) const;
 };
+#endif
 
+#if defined(PXR_METAL_SUPPORT_ENABLED)
 /// \class HdStMaterialXShaderGenMsl
 ///
 /// Generates a glslfx shader with a surfaceShader function for a MaterialX 
@@ -191,7 +201,7 @@ class HdStMaterialXShaderGenMsl
                           MaterialX::GenContext& mxContext,
                           MaterialX::ShaderStage& mxStage) const;
 };
-
+#endif
 
 PXR_NAMESPACE_CLOSE_SCOPE