Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

There is no support for exporting Shader networks to MaterialX.

...

1. MaterialX as UsdShade
(transport, composition, file format plugin, interop, shader definition)

The import workflow of MaterialX to UsdShade is done by the UsdMtlx plugin. The UsdMtlx plugin translates MaterialX data to UsdShade. 

...

For HdStorm, a MaterialX document is reconstructed from UsdShade Network to create glslfx via CodeGen. The missing features in the UsdMtlx plugin makes HdStorm hard to use and extend for other Viewport work-flows. 

2. MaterialX in Hydra
(visualization, viewport, runtime, rendering)

To leverage MaterialX CodeGen (or ShaderGen) functionality in Hydra a delegate is required to reconstruct a MaterialX document from UsdShade or natively handle UsdShade graphs. 

...

  • For multi-backend support for Vulkan, MDL, Metal, etc applications need to maintain multiple Shader Gen paths that can easily get out of sync and are hard to maintain.
  • MaterialX nodes as ground truth definitions of UsdPreviewSurface. 
  • UsdLux v.s MaterialX Light nodes
  • Customize shaders for selection, highlighting. 
  • For Hardware renderers customize shader stages, render state management 

3. Knowledge Sharing

Goal: To facilitate sharing of knowledge / examples around consumption and rendering use cases.
This includes

  • ensuring that the documentation is up-to-date with a given version of USD and MaterialX.
  • a robust set of examples of types / configurations of shaders / materials, (in USD format, in MTLX format).
  • examples of custom shader generation integration for different renderers.   

...

Areas for Review

Expand
titleProperties List


PropertyDescriptionUSD levelUSD/MTLX levelMTLX levelStatusProposal(s)
namespaceHelpful to qualify definitions with a given scope to avoid name clashes.
e.g. there may be a Adobe vs ILM namespace.



Issue 1614 logged
  • Encode namespace as part of definition identifier (no consensus) (PR 1631)
colorspaceColor management tagging for inputs as well as color management system specification.Y

  • Agreement to support as formal property. Needs scoping and definition.
  • Issue 1532 logged for MTLX export. Internal issue: USD-6703 (old - pre-agreement)
  • "Follow what is going on with MaterialX". (vague)
ui value propertiesHints for UI. e.g. ui min, max, step etc.Y

Separate proposal for this.
unit / dimension supportSupport for a real world unit or dimension for an given shader input. The type of the unit may be dynamic / data driven.


Issue 1632 logged. Internal issue: USD-6928.
tokensImport and resolving of token names used for geometric and file identifiers. Can include consistency of token delimiters
Y


fileprefx



Issue 974 logged. Admin: not closed
  • Resolved in PR 977.
versionDefinition versioning


tbd








...

Expand
titleDefinition Handling


PropertyDescriptionUSD levelUSD/MTLX levelMTLX levelStatusProposal(s)
Support nodes with multiple outputs



issue 1581 logged. Internal issue: USD-6820







definition information associationImport does not capture the correct association between a definition and a nodegraph sometimes.


Issue 1629 logged
  • Specific code fix proposed for conversion to MaterialX
definition variationsDefinitions may be specified in a variety of different ways. Not all appear to be consumable properly. Some deal with definition discovery.


issue 1636 logged
  • Refactor import discovery logic. (PR 1641)
definition search pathRelated to definition discovery (definition not found in path) 


Issue 1586 logged. Internal issue USD-6941
  • consider USD search path env variable on read for mtlx (partial, no concensus) (PR 1628)
load / reload Robustness / repeatability of loading documents


  • Issue 1504 logged. Internal issue: USD-6670 (data loss)
  • Issue 1502 logged. Internal issue: USD-6669 (node missing)

...











Information Sharing

Issues Filtering

The "Areas for Review" is currently hand-culled from the current list of all

...

issues with the keyword MaterialX. Not all are applicable. 
Q: Iis there a better way to manage this such as by adding labels to allow for quick filtering of relevant issues. 

https://github.com/PixarAnimationStudios/USD/issues?q=is%3Aissue+is%3Aopen+Materialx


Documentation for Unsupported Features

Documentation notes (appears notes are from and there is already the intent to update. (Current notes appear to be valid for MaterialX version 1.37)
https://graphics.pixar.com/usd/docs/api/usd_mtlx_page_front.html#usdMtlx_unsupported

...

Examples

...

Renderer integration

- WIP: To decide what to add here. 

  • want to include role of shaders and backends
  • help to aid those that want to figure out how their renderer fits in
  • custom shader generator integration examples would be useful here.