Skip to content

kwokcb/MaterialX_Learn

Repository files navigation

Site Status

This site is now open for external contributions. Major updates to synchronize with the latest MaterialX releases can be performed by maintainers or external contributors.

Please sponsor the authors for any additional development.

Welcome to "MaterialX Elements"

main

Visit

This site "Sister" site

Overview

This is a complementary site for those interested in learning about MaterialX.

Content is synced with the MaterialX 1.39.2 release.

Content includes:

  • Node definition library with image and node graph previews.
  • Release to release delta comparisons.
  • Glossary of basic types, geometric definitions, color management and real-world unit definitions.
  • Fundamental concepts (Nodes, Nodegraphs, Documents, Definitions)
  • Python environment setup for MaterialX, OpenUSD, OpenColorIO, and Blender.
  • Interactive tutorials from basics to shader code generation, shader graph interop, definition creation, and rendering pymaterialx.

Repository Content

The content for the site is provided in the following sub-folders:

  • Documents Learning materials, utilities, and definitions.
  • PyMaterialX Python Tutorials, Jupyter Notebooks and Python utilities.
  • Python modules mxltutils)
  • Resources Additional MaterialX resource files.
  • Utilities Utilities to build the site.

Building

See the README.md file in Utilities for details on how to build this site. Except for writing content the majority of the site is generated procedurally. For Windows users run the shell scripts from the appropriate command prompt (e.g git-bash).

Contributing

The mechanisms for building this site are now exposed. Folks are encouraged to contribute. Please see the contribution guidelines in the Github repo for more details.