Skip to content

Commit b1942fd

Browse files
kwokcbkwokcb
committed
Docs update.
1 parent 86d8681 commit b1942fd

6 files changed

Lines changed: 138 additions & 31 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,13 @@ Some rendering of resulting USD files are shown below:
9696

9797
---------
9898

99-
| Material | Charateristic | USD Rendering |
99+
| Material | Pre-processing Required | USD Rendering |
100100
| :--: | :--: | :--: |
101-
| Line Pattern | Generate Materials for outputs on NodeGraph | <img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/linepattern/test_crosshatch_glslfx.png" width="64px"></img> |
102-
| Marble | Insert explicit stream bindings | <img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_marble_solid/Marble_3D_glslfx.png" width="64px"></img> |
103-
| Car Paint | No preprocessing | <img width="64px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_carpaint.sphere/Car_Paint_glslfx.png"></img> |
104-
| Wood (Zip) | Unzip and resolve asset paths | <img width="64px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/TH_Cathedral_Floor_Tiles_1k_8b_JRHrQHt/TH_Cathedral_Floor_Tiles/TH_Cathedral_Floor_Tiles_glslfx.png"/> |
105-
| Adobe pattern | Wrap top level nodes, create explicit output port connections | <img width="64px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/parquet_clothes/parquet_clothes/surfacematerial_glslfx.png"/> |
101+
| Line Pattern | Generate Materials for outputs on NodeGraph | <img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/linepattern/test_crosshatch_glslfx.png" width="128px"></img> |
102+
| Marble | Add downstream material + explicit stream bindings | <img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_marble_solid/Marble_3D_glslfx.png" width="128px"></img> |
103+
| Car Paint | Add downstream material | <img width="128px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_carpaint.sphere/Car_Paint_glslfx.png"></img> |
104+
| AMD GPUOpen Wood (Zip) | Unzip and resolve asset paths | <img width="128px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/TH_Cathedral_Floor_Tiles_1k_8b_JRHrQHt/TH_Cathedral_Floor_Tiles/TH_Cathedral_Floor_Tiles_glslfx.png"/> |
105+
| Adobe pattern | Wrap top level nodes, create explicit output port connections | <img width="128px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/parquet_clothes/parquet_clothes/surfacematerial_glslfx.png"/> |
106106

107107
---------
108108

@@ -135,12 +135,18 @@ An initial acceptance criteria is to be able to run MaterialX to USD conversion
135135

136136
### Gallery of Example Materials
137137

138-
Test Suite material renderings
138+
Render Test Suite material renderings
139139

140140
<iframe width="100%" height="500px" src="./tests/usd_mtlx_image_gallery.html"></iframe>
141141
<p></p>
142142

143-
Physically Based Material library rendering
143+
Unit Test renderings
144+
145+
<iframe width="100%" height="500px" src="./tests/unit_test_gallery.html"></iframe>
146+
<p></p>
147+
148+
149+
<a href="https://physicallybased.info/" target="_blank">Physically Based Material Library</a> rendering
144150

145151
<iframe width="100%" height="500px" src="./tests/usd_physically_based_gallery.html"></iframe>
146152
<p></p>

‎documents/doxygen_warnings.txt‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ D:/Work/materialx/materialxusd/README.md:140: warning: Unsupported xml/html tag
1313
D:/Work/materialx/materialxusd/README.md:140: warning: Unsupported xml/html tag </iframe> found
1414
D:/Work/materialx/materialxusd/README.md:145: warning: Unsupported xml/html tag <iframe> found
1515
D:/Work/materialx/materialxusd/README.md:145: warning: Unsupported xml/html tag </iframe> found
16-
D:/Work/materialx/materialxusd/README.md:150: warning: Unsupported xml/html tag <iframe> found
17-
D:/Work/materialx/materialxusd/README.md:150: warning: Unsupported xml/html tag </iframe> found
18-
D:/Work/materialx/materialxusd/README.md:155: warning: Unsupported xml/html tag <iframe> found
19-
D:/Work/materialx/materialxusd/README.md:155: warning: Unsupported xml/html tag </iframe> found
16+
D:/Work/materialx/materialxusd/README.md:151: warning: Unsupported xml/html tag <iframe> found
17+
D:/Work/materialx/materialxusd/README.md:151: warning: Unsupported xml/html tag </iframe> found
18+
D:/Work/materialx/materialxusd/README.md:156: warning: Unsupported xml/html tag <iframe> found
19+
D:/Work/materialx/materialxusd/README.md:156: warning: Unsupported xml/html tag </iframe> found
20+
D:/Work/materialx/materialxusd/README.md:161: warning: Unsupported xml/html tag <iframe> found
21+
D:/Work/materialx/materialxusd/README.md:161: warning: Unsupported xml/html tag </iframe> found

‎documents/html/index.html‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -197,17 +197,17 @@ <h2><a class="anchor" id="autotoc_md3"></a>
197197
<hr />
198198
<table class="markdownTable">
199199
<tr class="markdownTableHead">
200-
<th class="markdownTableHeadCenter">Material </th><th class="markdownTableHeadCenter">Charateristic </th><th class="markdownTableHeadCenter">USD Rendering </th></tr>
200+
<th class="markdownTableHeadCenter">Material </th><th class="markdownTableHeadCenter">Pre-processing Required </th><th class="markdownTableHeadCenter">USD Rendering </th></tr>
201201
<tr class="markdownTableRowOdd">
202-
<td class="markdownTableBodyCenter">Line Pattern </td><td class="markdownTableBodyCenter">Generate Materials for outputs on NodeGraph </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/linepattern/test_crosshatch_glslfx.png" alt="" width="64px" class="inline"/> </td></tr>
202+
<td class="markdownTableBodyCenter">Line Pattern </td><td class="markdownTableBodyCenter">Generate Materials for outputs on NodeGraph </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/linepattern/test_crosshatch_glslfx.png" alt="" width="128px" class="inline"/> </td></tr>
203203
<tr class="markdownTableRowEven">
204-
<td class="markdownTableBodyCenter">Marble </td><td class="markdownTableBodyCenter">Insert explicit stream bindings </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_marble_solid/Marble_3D_glslfx.png" alt="" width="64px" class="inline"/> </td></tr>
204+
<td class="markdownTableBodyCenter">Marble </td><td class="markdownTableBodyCenter">Add downstream material + explicit stream bindings </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_marble_solid/Marble_3D_glslfx.png" alt="" width="128px" class="inline"/> </td></tr>
205205
<tr class="markdownTableRowOdd">
206-
<td class="markdownTableBodyCenter">Car Paint </td><td class="markdownTableBodyCenter">No preprocessing </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_carpaint.sphere/Car_Paint_glslfx.png" alt="" width="64px" class="inline"/> </td></tr>
206+
<td class="markdownTableBodyCenter">Car Paint </td><td class="markdownTableBodyCenter">Add downstream material </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_carpaint.sphere/Car_Paint_glslfx.png" alt="" width="128px" class="inline"/> </td></tr>
207207
<tr class="markdownTableRowEven">
208-
<td class="markdownTableBodyCenter">Wood (Zip) </td><td class="markdownTableBodyCenter">Unzip and resolve asset paths </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/TH_Cathedral_Floor_Tiles_1k_8b_JRHrQHt/TH_Cathedral_Floor_Tiles/TH_Cathedral_Floor_Tiles_glslfx.png" alt="" width="64px" class="inline"/> </td></tr>
208+
<td class="markdownTableBodyCenter">AMD GPUOpen Wood (Zip) </td><td class="markdownTableBodyCenter">Unzip and resolve asset paths </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/TH_Cathedral_Floor_Tiles_1k_8b_JRHrQHt/TH_Cathedral_Floor_Tiles/TH_Cathedral_Floor_Tiles_glslfx.png" alt="" width="128px" class="inline"/> </td></tr>
209209
<tr class="markdownTableRowOdd">
210-
<td class="markdownTableBodyCenter">Adobe pattern </td><td class="markdownTableBodyCenter">Wrap top level nodes, create explicit output port connections </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/parquet_clothes/parquet_clothes/surfacematerial_glslfx.png" alt="" width="64px" class="inline"/> </td></tr>
210+
<td class="markdownTableBodyCenter">Adobe pattern </td><td class="markdownTableBodyCenter">Wrap top level nodes, create explicit output port connections </td><td class="markdownTableBodyCenter"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/parquet_clothes/parquet_clothes/surfacematerial_glslfx.png" alt="" width="128px" class="inline"/> </td></tr>
211211
</table>
212212
<hr />
213213
<p>There is additionally a sample script that will traverse a local copy of the MaterialX test suite (<code>render_rts.sh</code>). The script calls the package's Python commands directly.</p>
@@ -233,9 +233,11 @@ <h1><a class="anchor" id="autotoc_md7"></a>
233233
<p>An initial acceptance criteria is to be able to run MaterialX to USD conversion against the MaterialX render test suite files. Preliminary results are show below:</p>
234234
<h2><a class="anchor" id="autotoc_md8"></a>
235235
Gallery of Example Materials</h2>
236-
<p>Test Suite material renderings</p>
236+
<p>Render Test Suite material renderings</p>
237237
<p>&lt;iframe width="100%" height="500px" src="./tests/usd_mtlx_image_gallery.html"&gt;&lt;/iframe&gt; </p>
238-
<p>Physically Based Material library rendering</p>
238+
<p>Unit Test renderings</p>
239+
<p>&lt;iframe width="100%" height="500px" src="./tests/unit_test_gallery.html"&gt;&lt;/iframe&gt; </p>
240+
<p><a href="https://physicallybased.info/" target="_blank">Physically Based Material Library</a> rendering</p>
239241
<p>&lt;iframe width="100%" height="500px" src="./tests/usd_physically_based_gallery.html"&gt;&lt;/iframe&gt; </p>
240242
<h2><a class="anchor" id="autotoc_md9"></a>
241243
Comparison: GLSL vs GLSLFX</h2>

‎index.html‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -210,35 +210,35 @@ <h3>Installation and Usage</h3>
210210
<thead>
211211
<tr>
212212
<th style="text-align: center;">Material</th>
213-
<th style="text-align: center;">Charateristic</th>
213+
<th style="text-align: center;">Pre-processing Required</th>
214214
<th style="text-align: center;">USD Rendering</th>
215215
</tr>
216216
</thead>
217217
<tbody>
218218
<tr>
219219
<td style="text-align: center;">Line Pattern</td>
220220
<td style="text-align: center;">Generate Materials for outputs on NodeGraph</td>
221-
<td style="text-align: center;"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/linepattern/test_crosshatch_glslfx.png" width="64px"></img></td>
221+
<td style="text-align: center;"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/linepattern/test_crosshatch_glslfx.png" width="128px"></img></td>
222222
</tr>
223223
<tr>
224224
<td style="text-align: center;">Marble</td>
225-
<td style="text-align: center;">Insert explicit stream bindings</td>
226-
<td style="text-align: center;"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_marble_solid/Marble_3D_glslfx.png" width="64px"></img></td>
225+
<td style="text-align: center;">Add downstream material + explicit stream bindings</td>
226+
<td style="text-align: center;"><img src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_marble_solid/Marble_3D_glslfx.png" width="128px"></img></td>
227227
</tr>
228228
<tr>
229229
<td style="text-align: center;">Car Paint</td>
230-
<td style="text-align: center;">No preprocessing</td>
231-
<td style="text-align: center;"><img width="64px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_carpaint.sphere/Car_Paint_glslfx.png"></img></td>
230+
<td style="text-align: center;">Add downstream material</td>
231+
<td style="text-align: center;"><img width="128px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/standard_surface_carpaint.sphere/Car_Paint_glslfx.png"></img></td>
232232
</tr>
233233
<tr>
234-
<td style="text-align: center;">Wood (Zip)</td>
234+
<td style="text-align: center;">AMD GPUOpen Wood (Zip)</td>
235235
<td style="text-align: center;">Unzip and resolve asset paths</td>
236-
<td style="text-align: center;"><img width="64px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/TH_Cathedral_Floor_Tiles_1k_8b_JRHrQHt/TH_Cathedral_Floor_Tiles/TH_Cathedral_Floor_Tiles_glslfx.png"/></td>
236+
<td style="text-align: center;"><img width="128px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/TH_Cathedral_Floor_Tiles_1k_8b_JRHrQHt/TH_Cathedral_Floor_Tiles/TH_Cathedral_Floor_Tiles_glslfx.png"/></td>
237237
</tr>
238238
<tr>
239239
<td style="text-align: center;">Adobe pattern</td>
240240
<td style="text-align: center;">Wrap top level nodes, create explicit output port connections</td>
241-
<td style="text-align: center;"><img width="64px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/parquet_clothes/parquet_clothes/surfacematerial_glslfx.png"/></td>
241+
<td style="text-align: center;"><img width="128px" src="https://raw.githubusercontent.com/kwokcb/materialxusd/refs/heads/main/tests/examples/parquet_clothes/parquet_clothes/surfacematerial_glslfx.png"/></td>
242242
</tr>
243243
</tbody>
244244
</table>
@@ -265,11 +265,15 @@ <h3>Documentation</h3>
265265
<h2>Acceptance</h2>
266266
<p>An initial acceptance criteria is to be able to run MaterialX to USD conversion against the MaterialX render test suite files. Preliminary results are show below:</p>
267267
<h3>Gallery of Example Materials</h3>
268-
<p>Test Suite material renderings</p>
268+
<p>Render Test Suite material renderings</p>
269269
<iframe width="100%" height="500px" src="./tests/usd_mtlx_image_gallery.html"></iframe>
270270
<p></p>
271271

272-
<p>Physically Based Material library rendering</p>
272+
<p>Unit Test renderings</p>
273+
<iframe width="100%" height="500px" src="./tests/unit_test_gallery.html"></iframe>
274+
<p></p>
275+
276+
<p><a href="https://physicallybased.info/" target="_blank">Physically Based Material Library</a> rendering</p>
273277
<iframe width="100%" height="500px" src="./tests/usd_physically_based_gallery.html"></iframe>
274278
<p></p>
275279

‎tests/create_summary.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
python ../utilities/create_image_path.py ./resources/Materials -r "https://kwokcb.github.io/materialxusd/tests"
22
python ../utilities/create_image_path.py -hd "PhysicallyBased Materials USD Gallery" ./physically_based -o usd_physicallY_based_gallery.html -r "https://kwokcb.github.io/materialxusd/tests"
3+
python ../utilities/create_image_path.py -hd "Unit Test Gallery" ./examples -o unit_test_gallery.html -r "https://kwokcb.github.io/materialxusd/tests"

0 commit comments

Comments
 (0)