-
Notifications
You must be signed in to change notification settings - Fork 358
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sphinx Python Documentation (#1567) - Updated listings of modules in …
…`README.md` files.
- Loading branch information
1 parent
9d73ddc
commit 0e1e502
Showing
2 changed files
with
31 additions
and
16 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,17 @@ | ||
# Python Support | ||
|
||
A Python package is created from the following modules. The OSL and GLSL modules can | ||
be conditionally built. | ||
A Python package is created from the following modules. | ||
|
||
- [PyMaterialXCore](PyMaterialXCore): Python module for MaterialX core | ||
- [PyMaterialXFormat](PyMaterialXFormat): Python module for XML serialization support | ||
- [PyMaterialXGenShader](PyMaterialXGenShader) : Python module for core shader generation | ||
- [PyMaterialXGenOsl](PyMaterialXGenOsl) : Python module for OSL shader generation | ||
- [PyMaterialXGenGlsl](PyMaterialXGenGlsl) : Python module for GLSL shader generation | ||
The OSL, GLSL, MSL, and MDL modules can be conditionally built. | ||
|
||
- [PyMaterialXCore](PyMaterialXCore) -- Python module for core MaterialX elements and graph traversal | ||
- [PyMaterialXFormat](PyMaterialXFormat) -- Python module for XML serialization support and file accessor utilities | ||
- [PyMaterialXGenShader](PyMaterialXGenShader) -- Python module providing core shader generation support for MaterialX | ||
- [PyMaterialXGenGlsl](PyMaterialXGenGlsl) -- Python module for shader generation using OpenGL Shading Language | ||
- [PyMaterialXGenOsl](PyMaterialXGenOsl) -- Python module for shader generation using Open Shading Language | ||
- [PyMaterialXGenMdl](PyMaterialXGenMdl) -- Python module for shader generation using Material Definition Language | ||
- [PyMaterialXGenMsl](PyMaterialXGenMsl) -- Python module for shader generation using Metal Shading Language | ||
- [PyMaterialXRender](PyMaterialXRender) -- Python module providing core rendering support for MaterialX | ||
- [PyMaterialXRenderGlsl](PyMaterialXRenderGlsl) -- Python module for rendering support using OpenGL Shading Language | ||
- [PyMaterialXRenderOsl](PyMaterialXRenderOsl) -- Python module for rendering support using Open Shading Language | ||
- [PyMaterialXRenderMsl](PyMaterialXRenderMsl) -- Python module for rendering support using Metal Shading Language |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,21 @@ | ||
# MaterialX C++ Libraries | ||
|
||
- [MaterialXCore](MaterialXCore): Support for the core MaterialX elements and graph traversal. | ||
- [MaterialXFormat](MaterialXFormat): Support for XML serialization and file accessor utilities. | ||
- [MaterialXGenShader](MaterialXGenShader) : Core shader generation support [<sup>1</sup>](#1) | ||
- [MaterialXGenGlsl](MaterialXGenGlsl) : GLSL shading language generation support. | ||
- [MaterialXGenOsl](MaterialXGenOsl) : OSL shading language generation support. | ||
- [MaterialXTest](MaterialXTest) : Unit tests for all MaterialX libraries. | ||
- [MaterialXView](MaterialXView) : Default material viewer. | ||
- [PyMaterialX](PyMaterialX) : Python wrappers for C++ modules. | ||
- [JsMaterialX](JsMaterialX) : JavaScript bindings for C++ modules. | ||
The OSL, GLSL, MSL, and MDL modules can be conditionally built. | ||
|
||
- [MaterialXCore](MaterialXCore) -- Core MaterialX elements and graph traversal | ||
- [MaterialXFormat](MaterialXFormat) -- Support for XML serialization and file accessor utilities | ||
- [MaterialXGenShader](MaterialXGenShader) -- Core shader generation support [<sup>1</sup>](#1) | ||
- [MaterialXGenGlsl](MaterialXGenGlsl) -- Shader generation using OpenGL Shading Language | ||
- [MaterialXGenOsl](MaterialXGenOsl) -- Shader generation using Open Shading Language | ||
- [MaterialXGenMdl](MaterialXGenMdl) -- Shader generation using Material Definition Language | ||
- [MaterialXGenMsl](MaterialXGenMsl) -- Shader generation using Metal Shading Language | ||
- [MaterialXRender](MaterialXRender) -- Core rendering support for MaterialX | ||
- [MaterialXRenderGlsl](MaterialXRenderGlsl) -- Rendering support using OpenGL Shading Language | ||
- [MaterialXRenderOsl](MaterialXRenderOsl) -- Rendering support using Open Shading Language | ||
- [MaterialXRenderMsl](MaterialXRenderMsl) -- Rendering support using Metal Shading Language | ||
- [MaterialXTest](MaterialXTest) -- Unit tests for all MaterialX libraries | ||
- [MaterialXView](MaterialXView) -- Default material viewer | ||
- [PyMaterialX](PyMaterialX) -- Python bindings for C++ modules | ||
- [JsMaterialX](JsMaterialX) -- JavaScript bindings for C++ modules | ||
|
||
\[1\] <a class="anchor" id="1"></a> For more details, see the [Shader Generation Guide](../documents/DeveloperGuide/ShaderGeneration.md) and the [MaterialX Data Libraries](../libraries/README.md) containing node definitions and implementations. |