Skip to content

Commit d088d37

Browse files
committed
Update documentation including README
1 parent 5a98b50 commit d088d37

File tree

3 files changed

+9
-13
lines changed

3 files changed

+9
-13
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Unlike...
1111
- [Apple's USDZ Tools](https://developer.apple.com/augmented-reality/tools/), it is open-source and freely available
1212

1313
guc furthermore supports near-lossless material translation via the [MaterialX](https://github.com/AcademySoftwareFoundation/MaterialX) standard.
14-
Shading networks can be encoded as UsdShade and flattened for backwards compatibility.
1514

1615
All glTF features except animation and skinning are implemented and get continuously tested in guc's [test suite](https://github.com/pablode/guc-tests).
1716

@@ -26,7 +25,7 @@ All glTF features except animation and skinning are implemented and get continuo
2625

2726
### Build
2827

29-
You need USD v23.11+ (e.g. <a href="https://github.com/PixarAnimationStudios/OpenUSD/releases/tag/v24.03">v24.03</a>) with MaterialX support enabled.
28+
You need USD v23.11+ (e.g. <a href="https://github.com/PixarAnimationStudios/OpenUSD/releases/tag/v24.05">v24.05</a>) with MaterialX support enabled.
3029

3130
Do a recursive clone of the repository and set up a build folder:
3231
```
@@ -46,8 +45,6 @@ cmake --build . -j8 --config Release
4645

4746
> Note: set `BUILD_SHARED_LIBS` for shared builds, and `CMAKE_MSVC_RUNTIME_LIBRARY` to USD's MSVC ABI.
4847
49-
> Note: if module or shared libary loading fails, try building USD with the `--opencolorio` flag.
50-
5148
### Usage
5249

5350
```
@@ -68,8 +65,6 @@ Both glTF and GLB file types are valid input. USDA, USDC and USDZ formats can be
6865

6966
An example asset conversion is described in the [Structure Mapping](docs/Structure_Mapping.md) document.
7067

71-
> Note: imaging of USD+MaterialX assets may be incorrect due to a number of current [Ecosystem Limitations](docs/Ecosystem_Limitations.md).
72-
7368
### Extension support
7469

7570
Name | Status&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -97,13 +92,14 @@ The _usdGlTF_ library implements USD's Sdf file format interface. Enable the `GU
9792
cmake --install . --component usdGlTF --config Release --prefix <USD_INSTALL_DIR>/plugin/usd
9893
```
9994

100-
> Note: the plugin only emits MaterialX materials if the `USDGLTF_ENABLE_MTLX` environment variable is set.
95+
glTF files can now be referenced as layers and opened with USD tooling.
96+
The _emitMtlx_ dynamic Sdf file format argument controls MaterialX material emission.
10197

10298
### License
10399

104100
```
105101
106-
Copyright 2022 Pablo Delgado Krämer
102+
Copyright 2024 Pablo Delgado Krämer
107103
108104
Licensed under the Apache License, Version 2.0 (the "License");
109105
you may not use this file except in compliance with the License.

docs/Ecosystem_Limitations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ This issue affects a number of render delegates, including Pixar's [HdStorm](htt
4242

4343
## MaterialX in HdStorm
4444

45+
#### Texture-coordinate related regression in USD v24.03+
46+
Issue [#3048](https://github.com/PixarAnimationStudios/OpenUSD/issues/3048) currently affects [multiple cases](https://github.com/pablode/guc-tests/commit/695f6dcc58c5b08b1d7b689dc1dc0c2d4305f154?diff=split&w=0) of the guc test suite.
47+
4548
#### One and two channel sRGB texture formats are unsupported
4649
Converted assets may use such textures, but HdStorm is not able to render them. ([Source code](https://github.com/PixarAnimationStudios/USD/blob/3abc46452b1271df7650e9948fef9f0ce602e3b2/pxr/imaging/hdSt/textureUtils.cpp#L341-L345))
4750

docs/Structure_Mapping.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -234,11 +234,8 @@ of MaterialX's `<normalmap>` node (see [Ecosystem Limitations](Ecosystem_Limitat
234234

235235
There are a number of improvements that can be made to the mapping process.
236236

237-
For instance, the MaterialX graph complexity can be reduced with the introduction
238-
of helper nodes, and color space related workarounds may be removed with proper support for attribute
239-
copying in HdMtlx (see [Ecosystem Limitations](Ecosystem_Limitations.md)).
240-
241-
Resulting USD assets may make use of payloads, and in general, incremental changes
237+
For instance, the MaterialX graph complexity can be reduced with the introduction of helper nodes.
238+
Resulting USD assets could make use of payloads, and in general, incremental changes
242239
motivated by the [USD Asset WG Structure Guidelines](https://github.com/pablode/usd-wg-assets/blob/main/docs/asset-structure-guidelines.md) are to be expected.
243240

244241
Lastly, user feedback is welcome in ensuring that assets conform to best practices.

0 commit comments

Comments
 (0)