Skip to content

Commit 4b11629

Browse files
pixar-osspixar-oss
committed
Merge release v19.11
2 parents 32ca7df + 87e0dc5 commit 4b11629

File tree

1,271 files changed

+80269
-18424
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,271 files changed

+80269
-18424
lines changed

‎BUILDING.md‎

Lines changed: 99 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,17 @@ parse metadata from OSL shaders.
121121
##### Documentation
122122

123123
Doxygen documentation can optionally be generated by specifying the cmake flag
124-
```PXR_BUILD_DOCUMENTATION=TRUE```. The additional dependencies that must
125-
be supplied for enabling documentation generation are:
124+
```PXR_BUILD_DOCUMENTATION=TRUE```.
126125

127-
| Dependency Name | Description | Version |
128-
| ------------------ |----------------------------------------------------------------------- | ------- |
129-
| DOXYGEN_EXECUTABLE | The location of Doxygen | 1.8.6 |
130-
| DOT_EXECUTABLE | The location of Dot(from GraphViz). | 2.3 |
126+
The additional dependencies that must be supplied for enabling documentation
127+
generation are:
128+
129+
| Dependency Name | Description |
130+
| ------------------ |--------------------------------------- |
131+
| DOXYGEN_EXECUTABLE | The location of Doxygen |
132+
| DOT_EXECUTABLE | The location of Dot(from GraphViz). |
133+
134+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
131135

132136

133137
##### Imaging
@@ -173,26 +177,32 @@ color management for Hydra viewports.
173177

174178
##### Embree Rendering
175179

176-
This component contains an example rendering backend for Hydra and usdview, based on the
177-
embree raycasting library. Enable the plugin in the build by specifying the cmake flag
178-
```PXR_BUILD_EMBREE_PLUGIN=TRUE``` when invoking cmake. This plugin is compatible with
179-
Embree 2.16.1. The additional dependencies that must be supplied when invoking cmake are:
180+
This component contains an example rendering backend for Hydra and usdview,
181+
based on the embree raycasting library. Enable the plugin in the build by
182+
specifying the cmake flag ```PXR_BUILD_EMBREE_PLUGIN=TRUE``` when invoking
183+
cmake.
184+
185+
The additional dependencies that must be supplied when invoking cmake are:
186+
187+
| Dependency Name | Description |
188+
| -------------- | ----------------------------------- |
189+
| EMBREE_LOCATION | The root path to an embree library install. |
180190

181-
| Dependency Name | Description | Version |
182-
| -------------- | ----------------------------------- | ------- |
183-
| EMBREE_LOCATION | The root path to an embree library install. | 2.16.1 |
191+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
184192

185193
##### RenderMan Rendering
186194

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

193-
| Dependency Name | Description | Version |
194-
| -------------- | ----------------------------------- | ------- |
195-
| RENDERMAN_LOCATION | The root path to an RenderMan install. | 22.5 |
199+
The additional dependencies that must be supplied when invoking cmake are:
200+
201+
| Dependency Name | Description |
202+
| -------------- | ----------------------------------- |
203+
| RENDERMAN_LOCATION | The root path to an RenderMan install. |
204+
205+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
196206

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

@@ -207,71 +217,97 @@ These plugins are not built by default and must be enabled via the instructions
207217

208218
Enable the [Alembic](https://github.com/alembic/alembic) plugin in the build
209219
by specifying the cmake flag ```PXR_BUILD_ALEMBIC_PLUGIN=TRUE``` when invoking cmake.
210-
This plugin is compatible with Alembic 1.5.2. The additional dependencies that must be supplied when invoking cmake are:
211220

212-
| Dependency Name | Description | Version |
213-
| ------------------ |----------------------------------------------------------------------- | ------- |
214-
| ALEMBIC_DIR | The location of [Alembic](https://https://github.com/alembic/alembic) | 1.5.2 |
215-
| OPENEXR_LOCATION | The location of [OpenEXR](http://www.openexr.com) | 2.2.0 |
221+
The additional dependencies that must be supplied when invoking cmake are:
222+
223+
| Dependency Name | Description |
224+
| ------------------ |-------------------------------------------------- |
225+
| ALEMBIC_DIR | The location of [Alembic](https://https://github.com/alembic/alembic) |
226+
| OPENEXR_LOCATION | The location of [OpenEXR](http://www.openexr.com) |
227+
228+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
216229

217230
Support for Alembic files using the HDF5 backend is enabled by default but can be
218231
disabled by specifying the cmake flag ```PXR_ENABLE_HDF5_SUPPORT=FALSE```. HDF5
219232
support requires the following dependencies:
220233

221-
| Dependency Name | Description | Version |
222-
| ------------------ |----------------------------------------------------------------------- | ------- |
223-
| HDF5_LOCATION | The location of [HDF5](https://www.hdfgroup.org/HDF5/) | 1.8.11 |
234+
| Dependency Name | Description |
235+
| ------------------ |---------------- |
236+
| HDF5_LOCATION | The location of [HDF5](https://www.hdfgroup.org/HDF5/) |
224237

225238
For further information see the documentation on the Alembic plugin [here](http://openusd.org/docs/Alembic-USD-Plugin.html).
226239

227240
##### Maya Plugin
228241

229-
Enable the Maya plugin in the build by specifying the cmake flag ```PXR_BUILD_MAYA_PLUGIN=TRUE```
230-
when invoking cmake. This plugin is compatible with Maya 2016. The additional dependencies that must be supplied when invoking cmake are:
242+
Enable the Maya plugin in the build by specifying the cmake flag
243+
```PXR_BUILD_MAYA_PLUGIN=TRUE``` when invoking cmake.
244+
245+
The additional dependencies that must be supplied when invoking cmake are:
246+
247+
| Dependency Name | Description |
248+
| ----------------- | ----------------------------------- |
249+
| MAYA_LOCATION | The root path to a Maya SDK install |
250+
| MAYA_tbb_LIBRARY | The location of TBB, this should be the same as TBB_tbb_LIBRARY provided to the core USD build |
231251

232-
| Dependency Name | Description | Version |
233-
| ----------------- | ----------------------------------- | --------- |
234-
| MAYA_LOCATION | The root path to a Maya SDK install | Maya 2016 EXT2 SP2 |
235-
| MAYA_tbb_LIBRARY | The location of TBB, this should be the same as TBB_tbb_LIBRARY provided to the core USD build | |
252+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
236253

237254
For further information see the documentation on the Maya plugin [here](http://openusd.org/docs/Maya-USD-Plugins.html).
238255

239256
##### Katana Plugin
240257

241-
Enable the Katana plugin in the build by specifying the cmake flag ```PXR_BUILD_KATANA_PLUGIN=TRUE```
242-
when invoking cmake. This plugin is compatible with Katana 2.5v1. The additional dependencies that must be supplied when invoking cmake are:
258+
Enable the Katana plugin in the build by specifying the cmake flag
259+
```PXR_BUILD_KATANA_PLUGIN=TRUE``` when invoking cmake.
243260

244-
| Dependency Name | Description | Version |
245-
| -------------- | ----------------------------------- | ------- |
246-
| KATANA_API_LOCATION | The root path to a Katana SDK install.| 2.5v1 |
261+
The additional dependencies that must be supplied when invoking cmake are:
262+
263+
| Dependency Name | Description |
264+
| -------------- | ----------------------------------- |
265+
| KATANA_API_LOCATION | The root path to a Katana SDK install.|
266+
267+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
247268

248269
For further information see our additional documentation on the Katana plugins [here](http://openusd.org/docs/Katana-USD-Plugins.html).
249270

250271
##### Houdini Plugin
251272

252-
Enable the Houdini plugin in the build by specifying the cmake flag ```PXR_BUILD_HOUDINI_PLUGIN=TRUE```
253-
when invoking cmake. This plugin is compatible with Houdini 16.0. The additional dependencies that must be supplied when invoking cmake are:
273+
Enable the Houdini plugin in the build by specifying the cmake flag
274+
```PXR_BUILD_HOUDINI_PLUGIN=TRUE``` when invoking cmake.
275+
276+
The additional dependencies that must be supplied when invoking cmake are:
254277

255-
| Dependency Name | Description | Version |
256-
| -------------- | ----------------------------------- | ------- |
257-
| HOUDINI_ROOT | The root path to a Houdini SDK install.| 16.0 |
278+
| Dependency Name | Description |
279+
| -------------- | ----------------------------------- |
280+
| HOUDINI_ROOT | The root path to a Houdini SDK install.|
258281

259-
Note that the Houdini plugin is only tested on Linux.
282+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
260283

261284
For further information see our additional documentation on the Houdini plugins [here](http://openusd.org/docs/Houdini-USD-Plugins.html).
262285

263286
##### MaterialX Plugin
264287

265-
Enable the [MaterialX](https://github.com/materialx/materialx) plugin in the build
266-
by specifying the cmake flag ```PXR_BUILD_MATERIALX_PLUGIN=TRUE``` when invoking cmake.
267-
This plugin is compatible with MaterialX 1.36.0. The additional dependencies that must be supplied when invoking cmake are:
288+
Enable the [MaterialX](https://github.com/materialx/materialx) plugin in the
289+
build by specifying the cmake flag ```PXR_BUILD_MATERIALX_PLUGIN=TRUE``` when
290+
invoking cmake.
268291

269-
| Dependency Name | Description | Version |
270-
| ------------------ |---------------------------------------- | ------- |
271-
| MATERIALX_ROOT | The root path to a MaterialX SDK install.| 1.36.0 |
292+
The additional dependencies that must be supplied when invoking cmake are:
293+
294+
| Dependency Name | Description |
295+
| ------------------ |---------------------------------------- |
296+
| MATERIALX_ROOT | The root path to a MaterialX SDK install.|
297+
298+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
272299

273300
For further information see our additional documentation on the MaterialX plugins [here](http://openusd.org/docs/MaterialX-USD-Plugins.html).
274301

302+
##### Draco Plugin
303+
304+
Enable the [Draco](https://github.com/google/draco) plugin in the build by specifying the cmake flag ```PXR_BUILD_DRACO_PLUGIN=TRUE```
305+
when invoking cmake. This plugin is compatible with Draco 1.3.4. The additional dependencies that must be supplied when invoking cmake are:
306+
307+
| Dependency Name | Description | Version |
308+
| ------------------ |---------------------------------------- | ------- |
309+
| DRACO_ROOT | The root path to a Draco SDK install. | 1.3.4 |
310+
275311
## Tests
276312

277313
Disable unit testing and prevent tests from being built by specifying the cmake flag ```PXR_BUILD_TESTS=FALSE```
@@ -352,10 +388,13 @@ If you choose to edit the ASCII parsers, make sure
352388
that check the generated code in [sdf](pxr/usd/lib/sdf) and
353389
[gf](pxr/base/lib/gf).
354390

355-
| Dependency Name | Description | Version |
356-
| ------------------------------ |----------------------------------------------------------------- | ------- |
357-
| FLEX_EXECUTABLE | Path to [flex](http://flex.sourceforge.net/) executable | 2.5.35 |
358-
| BISON_EXECUTABLE | Path to [bison](https://www.gnu.org/software/bison/) executable | 2.4.1 |
391+
| Dependency Name | Description |
392+
| ------------------ | ------------------------------------------------------- |
393+
| FLEX_EXECUTABLE | Path to [flex](http://flex.sourceforge.net/) executable |
394+
| BISON_EXECUTABLE | Path to [bison](https://www.gnu.org/software/bison/) executable |
395+
396+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
397+
359398

360399
##### USD Schema Generation
361400

@@ -365,10 +404,12 @@ and available on the syspath. You can learn more about Schemas and why you
365404
might want to generate them
366405
[here](http://openusd.org//docs/Generating-New-Schema-Classes.html).
367406

368-
| Python Module Name | Description | Version |
369-
| ------------------------------------------------------------ |----------------------------------------------------------------- | ------- |
370-
| [Jinja2](http://jinja.pocoo.org/docs/dev/) | Jinja is the core code generator of usdGenSchema | 2.0 |
371-
| [Argparse](https://docs.python.org/3/library/argparse.html) | Argparse is used for basic command line arguments | |
407+
| Python Module Name | Description |
408+
| ------------------------------------------ |------------------------------- |
409+
| [Jinja2](http://jinja.pocoo.org/docs/dev/) | Jinja is the core code generator of usdGenSchema |
410+
| [Argparse](https://docs.python.org/3/library/argparse.html) | Argparse is used for basic command line arguments |
411+
412+
See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
372413

373414

374415
## Optimization Options

0 commit comments

Comments
 (0)