Skip to content

Commit 2e4b64d

Browse files
authored
Merge branch 'release' into fix-core-profile
2 parents c6dd33b + 2864f3d commit 2e4b64d

File tree

3,440 files changed

+441414
-86468
lines changed

Some content is hidden

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

3,440 files changed

+441414
-86468
lines changed

BUILDING.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,15 @@ that depend on Metal, including:
118118

119119
##### Vulkan
120120

121+
Vulkan support for USD is currently experimental and disabled by default.
122+
121123
Building USD with Vulkan enabled requires the Vulkan SDK and glslang to
122-
be installed. The VULKAN_SDK environment variable must point to the
123-
location of the SDK. The glslang compiler headers must be locatable during
124-
the build process.
124+
be installed. If you wish to build a debug build on Windows, please make sure
125+
you have the optional component "Shader Toolchain Debug Symbols" installed as
126+
part of the Vulkan SDK.
127+
128+
The VULKAN_SDK environment variable must point to the location of the SDK. The
129+
glslang compiler headers must be locatable during the build process.
125130

126131
Support for Vulkan can optionally be enabled by specifying the cmake flag
127132
`PXR_ENABLE_VULKAN_SUPPORT=TRUE`.
@@ -157,23 +162,45 @@ parse metadata from OSL shaders.
157162
Doxygen documentation can optionally be generated by specifying the cmake flag
158163
`PXR_BUILD_DOCUMENTATION=TRUE`.
159164

160-
The additional dependencies that must be supplied for enabling documentation
165+
There are two documentation sub-components, controlled by setting
166+
`PXR_BUILD_HTML_DOCUMENTATION` and `PXR_BUILD_PYTHON_DOCUMENTATION`. See the
167+
sections below for descriptions of precisely what they control. Neither sub-
168+
component will have any effect if `PXR_BUILD_DOCUMENTATION` is not `TRUE`.
169+
170+
The additional dependencies that must be supplied for enabling documentation
161171
generation are:
162172

163173
| Dependency Name | Description |
164-
| ------------------ |--------------------------------------- |
174+
| ------------------ |--------------------------------------- |
165175
| DOXYGEN_EXECUTABLE | The location of Doxygen |
176+
177+
See [3rd Party Library and Application Versions](VERSIONS.md) for version
178+
information, including supported Doxygen versions.
179+
180+
##### HTML Documentation
181+
182+
If `PXR_BUILD_HTML_DOCUMENTATION` evaluates `TRUE` then building of the HTML
183+
documentation is enabled. This includes USD overview and general concepts, and
184+
the C++ API documentation. It defaults to `TRUE`, and so is built by default
185+
when `PXR_BUILD_DOCUMENTATION` is also enabled (but has no effect if
186+
`PXR_BUILD_DOCUMENTATION` is not set.)
187+
188+
The additional dependencies that must be supplied for enabling HTML
189+
documentation generation are:
190+
191+
| Dependency Name | Description |
192+
| ------------------ |--------------------------------------- |
166193
| DOT_EXECUTABLE | The location of Dot(from GraphViz). |
167194

168-
See [3rd Party Library and Application Versions](VERSIONS.md) for version
169-
information, including supported Doxygen and GraphViz versions.
195+
See [3rd Party Library and Application Versions](VERSIONS.md) for version
196+
information, including supported GraphViz versions.
170197

171198
##### Python Documentation
172199

173200
Python docstrings for Python entities can be generated by specifying the cmake
174201
flag `PXR_BUILD_PYTHON_DOCUMENTATION`. This process requires that Python support
175202
(`PXR_ENABLE_PYTHON_SUPPORT`) and documentation (`PXR_BUILD_DOCUMENTATION`) are
176-
enabled.
203+
enabled. It defaults to `FALSE`.
177204

178205
This process uses the scripts in the docs/python subdirectory. Relevant
179206
documentation from generated doxygen XML data is extracted and matched with

0 commit comments

Comments
 (0)