Skip to content

Improve MaterialXCore API for Shader Generation #2516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve MaterialXCore API for Shader Generation #2516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/MaterialXCore/Definition.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ const string NodeDef::TRANSLATION_NODE_GROUP = "translation";

const string NodeDef::NODE_ATTRIBUTE = "node";
const string NodeDef::NODE_GROUP_ATTRIBUTE = "nodegroup";
const string NodeDef::BSDF_ATTRIBUTE = "bsdf";
const string TypeDef::SEMANTIC_ATTRIBUTE = "semantic";
const string TypeDef::CONTEXT_ATTRIBUTE = "context";
const string Implementation::FILE_ATTRIBUTE = "file";
const string Implementation::FUNCTION_ATTRIBUTE = "function";
const string Implementation::NODE_GRAPH_ATTRIBUTE = "nodegraph";
const string Implementation::SOURCE_CODE_ATTRIBUTE = "sourcecode";
const string UnitDef::UNITTYPE_ATTRIBUTE = "unittype";
const string AttributeDef::ATTRNAME_ATTRIBUTE = "attrname";
const string AttributeDef::VALUE_ATTRIBUTE = "value";
Expand Down
46 changes: 46 additions & 0 deletions source/MaterialXCore/Definition.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,28 @@ class MX_CORE_API NodeDef : public InterfaceElement
return getAttribute(NODE_GROUP_ATTRIBUTE);
}

/// @}
/// @name BSDF attribute
/// @{

/// Set the bsdf attribute of the NodeDef.
void setBSDF(const string& bsdf)
{
setAttribute(BSDF_ATTRIBUTE, bsdf);
}

/// Return true if the given NodeDef has a bsdf attribute.
bool hasBSDF() const
{
return hasAttribute(BSDF_ATTRIBUTE);
}

/// Return the bsdf attribute of the NodeDef.
const string& getBSDF() const
{
return getAttribute(BSDF_ATTRIBUTE);
}

/// @}
/// @name Implementation References
/// @{
Expand Down Expand Up @@ -180,6 +202,7 @@ class MX_CORE_API NodeDef : public InterfaceElement
static const string CATEGORY;
static const string NODE_ATTRIBUTE;
static const string NODE_GROUP_ATTRIBUTE;
static const string BSDF_ATTRIBUTE;

static const string TEXTURE_NODE_GROUP;
static const string PROCEDURAL_NODE_GROUP;
Expand Down Expand Up @@ -249,6 +272,28 @@ class MX_CORE_API Implementation : public InterfaceElement
return getAttribute(FUNCTION_ATTRIBUTE);
}

/// @}
/// @name Source Code String
/// @{

/// Set the source code string for the Implementation.
void setSourceCode(const string& function)
{
setAttribute(SOURCE_CODE_ATTRIBUTE, function);
}

/// Return true if the given Implementation has a source code string.
bool hasSourceCode() const
{
return hasAttribute(SOURCE_CODE_ATTRIBUTE);
}

/// Return the source code string for the Implementation.
const string& getSourceCode() const
{
return getAttribute(SOURCE_CODE_ATTRIBUTE);
}

/// @}
/// @name Nodegraph String
/// @{
Expand Down Expand Up @@ -304,6 +349,7 @@ class MX_CORE_API Implementation : public InterfaceElement
static const string FILE_ATTRIBUTE;
static const string FUNCTION_ATTRIBUTE;
static const string NODE_GRAPH_ATTRIBUTE;
static const string SOURCE_CODE_ATTRIBUTE;
};

/// @class TypeDef
Expand Down
22 changes: 22 additions & 0 deletions source/MaterialXCore/Element.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1010,6 +1010,28 @@ class MX_CORE_API ValueElement : public TypedElement
return getAttribute(IMPLEMENTATION_NAME_ATTRIBUTE);
}

/// @}
/// @name Enum Names
/// @{

/// Set the enum names of an element.
void setEnumNames(const string& enumNames)
{
setAttribute(ENUM_ATTRIBUTE, enumNames);
}

/// Return true if the given element has enum names.
bool hasEnumNames() const
{
return hasAttribute(ENUM_ATTRIBUTE);
}

/// Return the enum names of an element.
const string& getEnumNames() const
{
return getAttribute(ENUM_ATTRIBUTE);
}

/// @}
/// @name Typed Value
/// @{
Expand Down
4 changes: 2 additions & 2 deletions source/MaterialXGenMdl/Nodes/CustomNodeMdl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ void CustomCodeNodeMdl::initializeForInlineSourceCode(const InterfaceElement& el
const Implementation& impl = static_cast<const Implementation&>(element);
// Store the inline source because the `_functionSource` is used for the function call template string
// that matched the regular MaterialX to MDL function mapping.
_inlineSourceCode = impl.getAttribute("sourcecode");
_inlineSourceCode = impl.getSourceCode();
if (_inlineSourceCode.empty())
{
throw ExceptionShaderGenError("No source code was specified for the implementation '" + impl.getName() + "'");
Expand Down Expand Up @@ -92,7 +92,7 @@ void CustomCodeNodeMdl::initializeForExternalSourceCode(const InterfaceElement&

// Map `file` to a qualified MDL module name
const Implementation& impl = static_cast<const Implementation&>(element);
string moduleName = impl.getAttribute("file");
string moduleName = impl.getFile();
if (moduleName.empty())
{
throw ExceptionShaderGenError("No source file was specified for the implementation '" + impl.getName() + "'");
Expand Down
6 changes: 3 additions & 3 deletions source/MaterialXGenShader/Nodes/SourceCodeNode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ void SourceCodeNode::resolveSourceCode(const InterfaceElement& element, GenConte
const Implementation& impl = static_cast<const Implementation&>(element);

FilePath localPath = FilePath(impl.getActiveSourceUri()).getParentPath();
_sourceFilename = context.resolveSourceFile(impl.getAttribute("file"), localPath);
_sourceFilename = context.resolveSourceFile(impl.getFile(), localPath);
_functionSource = readFile(_sourceFilename);
if (_functionSource.empty())
{
Expand All @@ -52,15 +52,15 @@ void SourceCodeNode::initialize(const InterfaceElement& element, GenContext& con
const Implementation& impl = static_cast<const Implementation&>(element);

// Get source code from either an attribute or a file.
_functionSource = impl.getAttribute("sourcecode");
_functionSource = impl.getSourceCode();
if (_functionSource.empty())
{
resolveSourceCode(element, context);
}

// Find the function name to use
// If no function is given the source will be inlined.
_functionName = impl.getAttribute("function");
_functionName = impl.getFunction();

_inlined = _functionName.empty();
if (!_inlined)
Expand Down
6 changes: 3 additions & 3 deletions source/MaterialXGenShader/ShaderGraph.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ void ShaderGraph::addInputSockets(const InterfaceElement& elem, GenContext& cont
ValuePtr portValue = input->getResolvedValue();
const string& portValueString = portValue ? portValue->getValueString() : EMPTY_STRING;
std::pair<TypeDesc, ValuePtr> enumResult;
const string& enumNames = input->getAttribute(ValueElement::ENUM_ATTRIBUTE);
const string& enumNames = input->getEnumNames();
const TypeDesc portType = context.getTypeDesc(input->getType());
if (context.getShaderGenerator().getSyntax().remapEnumeration(portValueString, portType, enumNames, enumResult))
{
Expand Down Expand Up @@ -245,7 +245,7 @@ void ShaderGraph::addDefaultGeomNode(ShaderInput* input, const GeomPropDef& geom
if (spaceInput && nodeDefSpaceInput)
{
std::pair<TypeDesc, ValuePtr> enumResult;
const string& enumNames = nodeDefSpaceInput->getAttribute(ValueElement::ENUM_ATTRIBUTE);
const string& enumNames = nodeDefSpaceInput->getEnumNames();
const TypeDesc portType = context.getTypeDesc(nodeDefSpaceInput->getType());
if (context.getShaderGenerator().getSyntax().remapEnumeration(space, portType, enumNames, enumResult))
{
Expand Down Expand Up @@ -589,7 +589,7 @@ ShaderGraphPtr ShaderGraph::create(const ShaderGraph* parent, const string& name
const string& valueString = value->getValueString();
std::pair<TypeDesc, ValuePtr> enumResult;
const TypeDesc type = context.getTypeDesc(nodedefInput->getType());
const string& enumNames = nodedefInput->getAttribute(ValueElement::ENUM_ATTRIBUTE);
const string& enumNames = nodedefInput->getEnumNames();
if (context.getShaderGenerator().getSyntax().remapEnumeration(valueString, type, enumNames, enumResult))
{
inputSocket->setValue(enumResult.second);
Expand Down
6 changes: 3 additions & 3 deletions source/MaterialXGenShader/ShaderNode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ ShaderNodePtr ShaderNode::create(const ShaderGraph* parent, const string& name,
ShaderInput* input;
const string& portValue = port->getResolvedValueString();
std::pair<TypeDesc, ValuePtr> enumResult;
const string& enumNames = port->getAttribute(ValueElement::ENUM_ATTRIBUTE);
const string& enumNames = port->getEnumNames();
if (context.getShaderGenerator().getSyntax().remapEnumeration(portValue, portType, enumNames, enumResult))
{
input = newNode->addInput(port->getName(), enumResult.first);
Expand Down Expand Up @@ -263,7 +263,7 @@ ShaderNodePtr ShaderNode::create(const ShaderGraph* parent, const string& name,
newNode->_classification = Classification::BSDF | Classification::CLOSURE;

// Add additional classifications for BSDF reflection and/or transmission.
const string& bsdfType = nodeDef.getAttribute("bsdf");
const string& bsdfType = nodeDef.getBSDF();
if (bsdfType == BSDF_R)
{
newNode->_classification |= Classification::BSDF_R;
Expand Down Expand Up @@ -358,7 +358,7 @@ void ShaderNode::initialize(const Node& node, const NodeDef& nodeDef, GenContext
// We explicitly check the valueString is not empty before checking the enumeration,
// because otherwise the enumeration value would always return nullptr
std::pair<TypeDesc, ValuePtr> enumResult;
const string& enumNames = nodeDefInput->getAttribute(ValueElement::ENUM_ATTRIBUTE);
const string& enumNames = nodeDefInput->getEnumNames();
const TypeDesc type = context.getTypeDesc(nodeDefInput->getType());
if (context.getShaderGenerator().getSyntax().remapEnumeration(valueString, type, enumNames, enumResult))
{
Expand Down