@@ -35,10 +35,7 @@ Some examples:
3535``` bash
3636cmake \
3737-DTBB_ROOT_DIR=/path/to/tbb \
38- -DOPENEXR_LOCATION=/path/to/openexr \
3938-DOPENSUBDIV_ROOT_DIR=/path/to/opensubdiv \
40- -DPTEX_LOCATION=/path/to/ptex \
41- -DOIIO_LOCATION=/path/to/openimageio \
4239-DBOOST_ROOT=/path/to/boost \
4340/path/to/USD/source
4441
@@ -53,10 +50,7 @@ The following will generate an Xcode project that can be used to build USD.
5350cmake \
5451-G " Xcode" \
5552-DTBB_ROOT_DIR=/path/to/tbb \
56- -DOPENEXR_LOCATION=/path/to/openexr \
5753-DOPENSUBDIV_ROOT_DIR=/path/to/opensubdiv \
58- -DPTEX_LOCATION=/path/to/ptex \
59- -DOIIO_LOCATION=/path/to/openimageio \
6054-DBOOST_ROOT=/path/to/boost \
6155/path/to/USD/source
6256
@@ -65,24 +59,27 @@ cmake --build . --target install -- -j <NUM_CORES>
6559
6660#### On Windows
6761
68- The following will generate a Visual Studio 2015 solution that can be used to
62+ The following will generate a Visual Studio 2017 solution that can be used to
6963build USD.
7064
7165``` cmd.exe
7266"C:\Program Files\CMake\bin\cmake.exe" ^
73- -G "Visual Studio 14 2015 Win64" ^
67+ -G "Visual Studio 15 2017 Win64" ^
7468-DTBB_ROOT_DIR=C:\path\to\tbb ^
75- -DOPENEXR_LOCATION=C:\path\to\openexr ^
7669-DOPENSUBDIV_ROOT_DIR=C:\path\to\opensubdiv ^
77- -DPTEX_LOCATION=C:\path\to\ptex ^
78- -DOIIO_LOCATION=C:\path\to\openimageio ^
7970-DBOOST_ROOT=C:\path\to\boost ^
8071\path\to\USD\source
8172
8273cmake --build . --target install -- /m:%NUMBER_OF_PROCESSORS%
8374```
8475
85- Note: if you're trying to build with Visual Studio 2017, use the "Visual Studio 15 2017 Win64" generator.
76+ For other versions of Visual Studio, use the following cmake arguments:
77+
78+ - For VS2019: ` -G "Visual Studio 16 2019" -A x64 `
79+ - For VS2022: ` -G "Visual Studio 17 2022" -A x64 `
80+
81+ For more information on Visual Studio generators for cmake, see
82+ [ Visual Studio Generators] ( https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#visual-studio-generators ) .
8683
8784## Optional Components
8885
@@ -92,18 +89,17 @@ removes the need for their dependencies when building USD.
9289
9390##### Python
9491
95- Python support in USD refers to :
92+ Some optional USD components use Python :
9693- [ The USD Toolset] ( https://graphics.pixar.com/usd/docs/USD-Toolset.html )
9794- [ Third Party Plugins] ( https://graphics.pixar.com/usd/docs/USD-3rd-Party-Plugins.html )
9895- Python language bindings for the USD C++ API
9996- Unit tests using Python
10097
98+ Please refer to [ VERSIONS.md] ( VERSIONS.md ) for supported Python versions.
99+
101100Support for Python can optionally be disabled by specifying the cmake flag
102101` PXR_ENABLE_PYTHON_SUPPORT=FALSE ` .
103102
104- Python 3 is enabled by default, Python 2 can be enabled by specifying the cmake
105- flag ` PXR_USE_PYTHON_3=OFF ` .
106-
107103##### OpenGL
108104
109105Support for OpenGL can optionally be disabled by specifying the cmake flag
@@ -130,6 +126,23 @@ the build process.
130126Support for Vulkan can optionally be enabled by specifying the cmake flag
131127` PXR_ENABLE_VULKAN_SUPPORT=TRUE ` .
132128
129+ ##### MaterialX
130+
131+ Enable [ MaterialX] ( https://github.com/materialx/materialx ) support in the
132+ build by specifying the cmake flag ` PXR_ENABLE_MATERIALX_SUPPORT=TRUE ` when
133+ invoking cmake. Note that MaterialX with shared library support is required.
134+
135+ When building via build_usd.py, MaterialX support is enabled by default. The
136+ default can be overriden using the --materialx and --no-materialx flags.
137+
138+ The additional dependencies that must be supplied when invoking cmake are:
139+
140+ | Dependency Name | Description |
141+ | ------------------ | ----------------------------------------------------------- |
142+ | MaterialX_DIR | Path to the CMake package config of a MaterialX SDK install.|
143+
144+ See [ 3rd Party Library and Application Versions] ( VERSIONS.md ) for version information.
145+
133146##### OSL (OpenShadingLanguage)
134147
135148Support for OSL is disabled by default, and can optionally be enabled by
@@ -152,8 +165,22 @@ generation are:
152165| DOXYGEN_EXECUTABLE | The location of Doxygen |
153166| DOT_EXECUTABLE | The location of Dot(from GraphViz). |
154167
155- See [ 3rd Party Library and Application Versions] ( VERSIONS.md ) for version information.
168+ See [ 3rd Party Library and Application Versions] ( VERSIONS.md ) for version
169+ information, including supported Doxygen and GraphViz versions.
170+
171+ ##### Python Documentation
172+
173+ Python docstrings for Python entities can be generated by specifying the cmake
174+ flag ` PXR_BUILD_PYTHON_DOCUMENTATION ` . This process requires that Python support
175+ (` PXR_ENABLE_PYTHON_SUPPORT ` ) and documentation (` PXR_BUILD_DOCUMENTATION ` ) are
176+ enabled.
156177
178+ This process uses the scripts in the docs/python subdirectory. Relevant
179+ documentation from generated doxygen XML data is extracted and matched with
180+ associated Python classes, functions, and properties in the built Python
181+ modules. A ` __DOC.py ` file is generated and installed in each of the directories
182+ of the installed Python modules. The ` __DOC.py ` file adds the docstrings to the
183+ Python entities when the module is loaded.
157184
158185##### Imaging
159186
@@ -163,10 +190,6 @@ Disable this component by specifying the cmake flag `PXR_BUILD_IMAGING=FALSE` wh
163190invoking cmake. Disabling this component will also disable the [ USD Imaging] ( #usd-imaging )
164191component and any [ Imaging Plugins] ( #imaging-plugins ) .
165192
166- Support for Ptex can optionally be disabled by specifying the cmake flag
167- ` PXR_ENABLE_PTEX_SUPPORT=FALSE ` .
168-
169-
170193##### USD Imaging
171194
172195This component provides the USD imaging delegates for Hydra, as well as
@@ -176,10 +199,38 @@ Disable this component by specifying the cmake flag `PXR_BUILD_USD_IMAGING=FALSE
176199invoking cmake. usdview may also be disabled independently by specifying the cmake flag
177200` PXR_BUILD_USDVIEW=FALSE ` .
178201
202+ ##### Command-line Tools
203+
204+ USD by default builds several helpful command-line tools for validating and
205+ manipulating USD files. For more information on the tools, see [ USD Toolset] ( https://graphics.pixar.com/usd/release/toolset.html ) .
206+
207+ Disable building the command-line tools by specifying the cmake flag
208+ ` PXR_BUILD_USD_TOOLS=FALSE ` when invoking cmake.
209+
210+ ##### Examples
211+
212+ USD by default builds several example projects that demonstrate how to develop
213+ various extensions and plugins.
214+
215+ Disable building the examples by specifying the cmake flag
216+ ` PXR_BUILD_EXAMPLES=FALSE ` when invoking cmake.
217+
218+ ##### Tutorials
219+
220+ USD by default builds USD and Python files used for the [ USD Tutorials] ( https://graphics.pixar.com/usd/release/tut_usd_tutorials.html ) .
221+
222+ Disable building the tutorial support files by specifying the cmake flag
223+ ` PXR_BUILD_TUTORIALS=FALSE ` when invoking cmake.
224+
179225## Imaging Plugins
180226
181227Hydra's rendering functionality can be extended with these optional plugins.
182228
229+ ##### Ptex
230+
231+ Support for Ptex is disabled by default and can be enabled by specifying the
232+ cmake flag ` PXR_ENABLE_PTEX_SUPPORT=TRUE ` .
233+
183234##### OpenImageIO
184235
185236This plugin can optionally be enabled by specifying the cmake flag
@@ -268,20 +319,6 @@ support requires the following dependencies:
268319
269320For further information see the documentation on the Alembic plugin [ here] ( http://openusd.org/docs/Alembic-USD-Plugin.html ) .
270321
271- ##### MaterialX Plugin
272-
273- Enable [ MaterialX] ( https://github.com/materialx/materialx ) support in the
274- build by specifying the cmake flag ` PXR_ENABLE_MATERIALX_SUPPORT=TRUE ` when
275- invoking cmake. Note that MaterialX with shared library support is required.
276-
277- The additional dependencies that must be supplied when invoking cmake are:
278-
279- | Dependency Name | Description |
280- | ------------------ | ----------------------------------------------------------- |
281- | MaterialX_DIR | Path to the CMake package config of a MaterialX SDK install.|
282-
283- See [ 3rd Party Library and Application Versions] ( VERSIONS.md ) for version information.
284-
285322##### Draco Plugin
286323
287324Enable the [ Draco] ( https://github.com/google/draco ) plugin in the build by specifying the cmake flag ` PXR_BUILD_DRACO_PLUGIN=TRUE `
0 commit comments