Modernize MaterialX version checks for easy reading and streamlined logic #3653
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use new MATERIALX_VERSION_INDEX and MATERIALX_GENERATE_INDEX added in MaterialX 1.39.2. This makes the version check code easier to read and avoids potential version check errors when using MATERIALX_MAJOR_VERSION, MATERIALX_MINOR_VERSION, and MATERIALX_BUILD_VERSION comparisons directly. Sample usage: #if MATERIALX_VERSION_INDEX < MATERIALX_GENERATE_INDEX(1, 39, 0) MATERIALX_VERSION_INDEX and MATERIALX_GENERATE_INDEX were added as of MaterialX 1.39.2 and then revised in 1.39.4. Will define these macros if version < 1.39.4. Tested compilation with MaterialX 1.39.3 and 1.38.10.
|
Filed as internal issue #USD-11055 (This is an automated message. See here for more information.) |
Moving MATERIALX_GENERATE_INDEX and MATERIALX_VERSION_INDEX above the MaterialX ShaderGenerator includes as there will likely be another include conditionally added for WGSL based on the MaterialX version. Putting the code in the same place so it does not have to be moved later and create merging confusion. Tested with MaterialX 1.39.3 and 1.38.10 versions on MacOS.
scotbrew
commented
May 30, 2025
| @@ -8,11 +8,22 @@ | |||
| #define PXR_IMAGING_HD_ST_MATERIALX_SHADER_GEN_H | |||
|
|
|||
| #include "pxr/pxr.h" | |||
| #include <MaterialXCore/Library.h> | |||
There was a problem hiding this comment.
Added this #include <MaterialXCore/Library.h> (which declares the MaterialX version defines) and moved the defines above the other MaterialX includes as there are plans in the future for conditionally importing MaterialXGenMsl/WgslShaderGenerator.h based on the MaterialX version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change(s)
Use the new MATERIALX_VERSION_INDEX and MATERIALX_GENERATE_INDEX added in MaterialX 1.39.2. This makes the version check code easier to read and streamlines the logic to avoids potential version check errors when using MATERIALX_MAJOR_VERSION, MATERIALX_MINOR_VERSION, and MATERIALX_BUILD_VERSION comparisons directly.
Sample usage:
#if MATERIALX_VERSION_INDEX < MATERIALX_GENERATE_INDEX(1, 39, 0)Note: MATERIALX_VERSION_INDEX and MATERIALX_GENERATE_INDEX were added as of MaterialX 1.39.2 and then revised in 1.39.4. Defining these macros if MaterialX version < 1.39.4.
Fixes Issue(s)
#3651
Testing
Manually tested compilation with MaterialX 1.39.3 and 1.38.10.
Checklist
I have created this PR based on the dev branch
I have followed the coding conventions
I have added unit tests that exercise this functionality (Reference:
testing guidelines)
I have verified that all unit tests pass with the proposed changes
I have submitted a signed Contributor License Agreement (Reference:
Contributor License Agreement instructions)