Skip to content

Commit

Permalink
Add documentation and pointers to online docs
Browse files Browse the repository at this point in the history
for RenderMan Hydra plugin.

(Internal change: 1979133)
  • Loading branch information
sunyab authored and pixar-oss committed Jun 8, 2019
1 parent aa59a6d commit 5f4a86c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,20 @@ Embree 2.16.1. The additional dependencies that must be supplied when invoking c
| -------------- | ----------------------------------- | ------- |
| EMBREE_LOCATION | The root path to an embree library install. | 2.16.1 |

##### RenderMan Rendering

This plugin uses Pixar's RenderMan as a rendering backend for Hydra and
usdview. Enable the plugin in the build by specifying the cmake flag
```PXR_BUILD_PRMAN_PLUGIN=TRUE``` when invoking cmake. This plugin is
compatible with RenderMan 22.5. The additional dependencies that must be
supplied when invoking cmake are:

| Dependency Name | Description | Version |
| -------------- | ----------------------------------- | ------- |
| RENDERMAN_LOCATION | The root path to an RenderMan install. | 22.5 |

More documentation is available [here](http://openusd.org/docs/RenderMan-USD-Imaging-Plugin.html).

## Third Party Plugins

USD provides several plugins for integration with third-party software packages,
Expand Down
4 changes: 4 additions & 0 deletions build_scripts/build_usd.py
Original file line number Diff line number Diff line change
Expand Up @@ -1912,3 +1912,7 @@ def FormatBuildArguments(buildArgs):
if context.buildHoudini:
Print("See documentation at http://openusd.org/docs/Houdini-USD-Plugins.html "
"for setting up the Houdini plugin.\n")

if context.buildPrman:
Print("See documentation at http://openusd.org/docs/RenderMan-USD-Imaging-Plugin.html "
"for setting up the RenderMan plugin.\n")
2 changes: 2 additions & 0 deletions third_party/renderman-22/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ RenderMan 22 Plugins
====================

This section contains libraries and plugins for RenderMan 22.

See the [online documentation](http://openusd.org/docs/RenderMan-USD-Imaging-Plugin.html) for more details.

0 comments on commit 5f4a86c

Please sign in to comment.