Add MDL Compiler dependency for genmdl tests (AcademySoftwareFoundation#2254)

Extend test for MaterialXGenMdl.

This commit extends source/MaterialXTest/MaterialXGenMdl as a test for
source/MaterialXGenMdl, plus the necessary work on the cmake scripts and github
actions to add the MDL SDK as a dependency.

New cmake variables:
- MATERIALX_MDL_SDK_DIR: if set and mdlc is found the test in
source/MaterialXTest/MaterialXGenMdl is extended to run mdlc on the generated
MDL files.
- MATERIALX_MDL_BINARY_MDLC: name of the mdlc binary, derived from MATERIALX_MDL_SDK_DIR

The CI tests use vcpkg to install the MDL SDK, but a manually built one also
works (alternative for developers).

Right now, the MDL SDK dependency is enabled only for Windows_VS2022_x64_Python313 in the extended build.

Author: krohmerNV

.github/workflows/main.yml

@@ -115,6 +115,7 @@ jobs:
           cmake_config: -G "Visual Studio 17 2022" -A "x64"
           test_shaders: ON
           extended_build_oiio: ON
+          extended_build_mdl_sdk: ON
 
         - name: Windows_VS2022_x64_SharedLibs
           os: windows-2025
@@ -167,6 +168,12 @@ jobs:
         C:/vcpkg/vcpkg install openimageio --triplet=x64-windows
         Add-Content $env:GITHUB_PATH "C:/vcpkg/installed/x64-windows/bin"
 
+    - name: Install MDL SDK
+      if: env.IS_EXTENDED_BUILD == 'true' && matrix.extended_build_mdl_sdk == 'ON' && runner.os == 'Windows'
+      run: |
+        C:/vcpkg/vcpkg install mdl-sdk --triplet=x64-windows
+        Add-Content $env:GITHUB_PATH "C:/vcpkg/installed/x64-windows/bin"
+
     - name: Install Python ${{ matrix.python }}
       if: matrix.python != 'None'
       uses: actions/setup-python@v5
@@ -185,8 +192,16 @@ jobs:
     - name: CMake Generate
       shell: bash
       run: |
-        if [ "${{ env.IS_EXTENDED_BUILD }}" == "true" ] && [ "${{ matrix.extended_build_oiio }}" == "ON" ]; then
-          EXTENDED_BUILD_CONFIG="-DMATERIALX_BUILD_OIIO=ON -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows"
+        if [ "${{ env.IS_EXTENDED_BUILD }}" == "true" ]; then
+          if [ "${{ runner.os }}" == "Windows" ]; then
+            EXTENDED_BUILD_CONFIG="-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows"
+          fi
+          if [ "${{ matrix.extended_build_oiio }}" == "ON" ]; then
+            EXTENDED_BUILD_CONFIG="$EXTENDED_BUILD_CONFIG -DMATERIALX_BUILD_OIIO=ON"
+          fi
+          if [ "${{ matrix.extended_build_mdl_sdk }}" == "ON" -a "${{ runner.os }}" == "Windows" ]; then
+            EXTENDED_BUILD_CONFIG="$EXTENDED_BUILD_CONFIG -DMATERIALX_MDL_SDK_DIR=C:/vcpkg/installed/x64-windows"
+          fi
         fi
         cmake -S . -B build -DMATERIALX_BUILD_PYTHON=ON -DMATERIALX_BUILD_VIEWER=ON -DMATERIALX_BUILD_GRAPH_EDITOR=ON -DMATERIALX_BUILD_TESTS=ON -DMATERIALX_TEST_RENDER=OFF -DMATERIALX_WARNINGS_AS_ERRORS=ON $EXTENDED_BUILD_CONFIG ${{matrix.cmake_config}}
 

CMakeLists.txt

@@ -14,7 +14,7 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin)
 
-# JavaScript setup 
+# JavaScript setup
 option(MATERIALX_BUILD_JS "Build the MaterialX JavaScript package from C++ bindings. Requires the emscripten environment." OFF)
 set(MATERIALX_EMSDK_PATH "" CACHE PATH "Path to EMSDK (e.g. 'D:/Projects/emsdk').")
 if (MATERIALX_BUILD_JS)
@@ -147,13 +147,8 @@ if (MATERIALX_BUILD_OSOS)
 endif()
 
 # Helpers for MDL validation
-if (MATERIALX_BUILD_GEN_MDL)
-    set(MATERIALX_MDLC_EXECUTABLE "" CACHE FILEPATH "Full path to the mdlc binary.")
-    set(MATERIALX_MDL_RENDER_EXECUTABLE "" CACHE FILEPATH "Full path to the mdl renderer binary.")
-    set(MATERIALX_MDL_RENDER_ARGUMENTS "" CACHE STRING "Custom arguments for renderer.")
-    set(MATERIALX_MDL_MODULE_PATHS "" CACHE FILEPATH "Comma separated list of MDL module paths.")
-    set(MATERIALX_INSTALL_MDL_MODULE_PATH ${MATERIALX_INSTALL_STDLIB_PATH} CACHE FILEPATH "Install path for mdl module.")
-endif()
+set(MATERIALX_MDL_SDK_DIR "" CACHE PATH "Path to the MDL SDK directory that contains 'include', 'lib', etc.")
+set(MATERIALX_MDL_MODULE_PATHS "" CACHE FILEPATH "Comma separated list of MDL module paths.")
 
 # Namespace
 set(MATERIALX_NAMESPACE_SUFFIX "" CACHE STRING "Add a suffix to the main MaterialX C++ namespace: Options include dev, staging, <YOURFACILITY> etc.")
@@ -207,13 +202,9 @@ mark_as_advanced(MATERIALX_BUILD_JS)
 mark_as_advanced(MATERIALX_EMSDK_PATH)
 mark_as_advanced(MATERIALX_BUILD_IOS)
 mark_as_advanced(MATERIALX_BUILD_APPLE_FRAMEWORK)
-if (MATERIALX_BUILD_GEN_MDL)
-    mark_as_advanced(MATERIALX_MDLC_EXECUTABLE)
-    mark_as_advanced(MATERIALX_MDL_RENDER_EXECUTABLE)
-    mark_as_advanced(MATERIALX_MDL_RENDER_ARGUMENTS)
-    mark_as_advanced(MATERIALX_MDL_MODULE_PATHS)
-    mark_as_advanced(MATERIALX_INSTALL_MDL_MODULE_PATH)
-endif()
+mark_as_advanced(MATERIALX_MDL_BINARY_MDLC)
+mark_as_advanced(MATERIALX_MDL_MODULE_PATHS)
+mark_as_advanced(MATERIALX_MDL_SDK_DIR)
 
 if (MATERIALX_BUILD_USE_CCACHE)
     # Setup CCache for C/C++ compilation
@@ -251,12 +242,11 @@ if (MATERIALX_BUILD_BENCHMARK_TESTS)
     add_definitions(-DMATERIALX_BUILD_BENCHMARK_TESTS)
 endif()
 
-if (MATERIALX_BUILD_GEN_MDL)
-    add_definitions(-DMATERIALX_MDLC_EXECUTABLE=\"${MATERIALX_MDLC_EXECUTABLE}\")
-    add_definitions(-DMATERIALX_MDL_RENDER_EXECUTABLE=\"${MATERIALX_MDL_RENDER_EXECUTABLE}\")
-    add_definitions(-DMATERIALX_MDL_RENDER_ARGUMENTS=\"${MATERIALX_MDL_RENDER_ARGUMENTS}\")
-    add_definitions(-DMATERIALX_MDL_MODULE_PATHS=\"${MATERIALX_MDL_MODULE_PATHS}\")
-    add_definitions(-DMATERIALX_INSTALL_MDL_MODULE_PATH=\"${MATERIALX_INSTALL_MDL_MODULE_PATH}\")
+# GEN MDL does not have any additional dependencies. For loading and compiling MDL, e.g., in the test renderer, the MDL SDK is needed.
+if(MATERIALX_MDL_SDK_DIR)
+    find_package(mdl QUIET CONFIG REQUIRED PATHS ${MATERIALX_MDL_SDK_DIR})
+    get_target_property(MATERIALX_MDL_BINARY_MDLC mdl::mdlc LOCATION)
+    set(MATERIALX_MDL_BINARY_MDLC ${MATERIALX_MDL_BINARY_MDLC} CACHE FILEPATH "Full path to the mdlc binary." FORCE)
 endif()
 
 # Adjust the default installation path

README.md

@@ -17,7 +17,7 @@ MaterialX is an open standard for representing rich material and look-developmen
 - Point CMake to the root of the MaterialX library and generate C++ projects for your platform and compiler.
 - Select the `MATERIALX_BUILD_PYTHON` option to build Python bindings.
 - Select the `MATERIALX_BUILD_VIEWER` option to build the [MaterialX Viewer](https://github.com/AcademySoftwareFoundation/MaterialX/blob/main/documents/DeveloperGuide/Viewer.md).
-- Select the `MATERIALX_BUILD_GRAPH_EDITOR` option to build the [MaterialX Graph Editor](https://github.com/AcademySoftwareFoundation/MaterialX/blob/main/documents/DeveloperGuide/GraphEditor.md). 
+- Select the `MATERIALX_BUILD_GRAPH_EDITOR` option to build the [MaterialX Graph Editor](https://github.com/AcademySoftwareFoundation/MaterialX/blob/main/documents/DeveloperGuide/GraphEditor.md).
 
 ## Supported Platforms
 

resources/Materials/TestSuite/_options.mtlx

@@ -62,7 +62,7 @@
     <input name="extraLibraryPaths" type="string" value="" />
 
     <!-- List of document paths for render tests -->
-    <input name="renderTestPaths" type="string" value="resources/Materials/Examples/StandardSurface,resources/Materials/TestSuite/stdlib/convolution,resources/Materials/TestSuite/stdlib/color_management,resources/Materials/TestSuite/stdlib/procedural,resources/Materials/TestSuite/pbrlib/surfaceshader,resources/Materials/TestSuite/nprlib" />
+    <input name="renderTestPaths" type="string" value="resources/Materials/Examples/StandardSurface,resources/Materials/TestSuite/stdlib/convolution,resources/Materials/TestSuite/stdlib/color_management,resources/Materials/TestSuite/stdlib/procedural,resources/Materials/TestSuite/pbrlib/surfaceshader,resources/Materials/TestSuite/nprlib,resources/Materials/TestSuite/pbrlib/bsdf" />
 
     <!-- Enable reference quality rendering.
          This option enables higher sample counts and supersampling in render tests,

source/MaterialXGenMdl/CMakeLists.txt

@@ -14,5 +14,5 @@ mx_add_library(MaterialXGenMdl
 
 if(NOT SKBUILD)
     install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/mdl
-            DESTINATION "${MATERIALX_INSTALL_MDL_MODULE_PATH}")
+            DESTINATION "${MATERIALX_INSTALL_STDLIB_PATH}")
 endif()

source/MaterialXTest/CMakeLists.txt

@@ -55,13 +55,6 @@ if(MATERIALX_BUILD_GEN_GLSL OR MATERIALX_BUILD_GEN_OSL OR MATERIALX_BUILD_GEN_MD
   if(MATERIALX_BUILD_GEN_MDL)
     add_subdirectory(MaterialXGenMdl)
     target_link_libraries(MaterialXTest MaterialXGenMdl)
-    if (NOT MATERIALX_BUILD_MONOLITHIC)
-        get_target_property(MaterialXGenMdl_SOURCE_DIR MaterialXGenMdl SOURCE_DIR)
-    else()
-        get_target_property(PROJECT_SOURCE_DIR ${MATERIALX_MONOLITHIC_TARGET} SOURCE_DIR)
-        set(MaterialXGenMdl_SOURCE_DIR "{PROJECT_SOURCE_DIR}/MaterialXGenMdl")
-    endif()
-    target_compile_definitions(MaterialXTest PRIVATE -DMATERIALX_MDL_IMPL_MODULE_PATH=\"${MaterialXGenMdl_SOURCE_DIR}/mdl\")
   endif()
   if(MATERIALX_BUILD_GEN_MSL)
     add_subdirectory(MaterialXGenMsl)
@@ -106,7 +99,7 @@ endif()
 
 if(MATERIALX_BUILD_GEN_MDL)
     install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../../source/MaterialXGenMdl/mdl/"
-        DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${MATERIALX_INSTALL_MDL_MODULE_PATH}/mdl)
+        DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${MATERIALX_INSTALL_STDLIB_PATH}/mdl)
 endif()
 
 add_custom_command(TARGET MaterialXTest POST_BUILD

source/MaterialXTest/MaterialXGenMdl/CMakeLists.txt

@@ -3,6 +3,20 @@ file(GLOB_RECURSE headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h")
 
 target_sources(MaterialXTest PUBLIC ${source} ${headers})
 
+if (NOT MATERIALX_BUILD_MONOLITHIC)
+    get_target_property(MaterialXGenMdl_SOURCE_DIR MaterialXGenMdl SOURCE_DIR)
+else()
+    get_target_property(PROJECT_SOURCE_DIR ${MATERIALX_MONOLITHIC_TARGET} SOURCE_DIR)
+    set(MaterialXGenMdl_SOURCE_DIR "{PROJECT_SOURCE_DIR}/MaterialXGenMdl")
+endif()
+
+target_compile_definitions(MaterialXTest PRIVATE
+        MATERIALX_MDL_BINARY_MDLC=\"${MATERIALX_MDL_BINARY_MDLC}\"
+        MATERIALX_MDL_IMPL_MODULE_PATH=\"${MaterialXGenMdl_SOURCE_DIR}/mdl\"
+        MATERIALX_INSTALL_MDL_MODULE_PATH=\"${MATERIALX_INSTALL_STDLIB_PATH}\"
+        MATERIALX_MDL_MODULE_PATHS=\"${MATERIALX_MDL_MODULE_PATHS}\"
+)
+
 add_tests("${source}")
 
 assign_source_group("Source Files" ${source})