Skip to content

Commit e68ea45

Browse files
kwokcbkwokcb
authored
API and use doc cleanup. (#26)
1 parent f2d8c1e commit e68ea45

222 files changed

Lines changed: 2701 additions & 15440 deletions

File tree

Some content is hidden

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

‎README.html‎

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -396,13 +396,15 @@ <h3>Introduction</h3>
396396
</div>
397397
</p>
398398
Each currently has <code>Python</code> and / or <code>Javascript</code> implementations.
399-
<p><strong>Links</strong></p>
399+
<h3>Links</h3>
400400
<ul>
401401
<li><a href="https://kwokcb.github.io/materialxMaterials" target="_blank">Home Page</a></li>
402-
<li>Main tooling site: <div class="btn btn-outline-secondary"><a href="https://kwokcb.github.io/MaterialXLab" target="_blank"><img src="https://kwokcb.github.io/MaterialXLab/documents/icons/teapot_logo.svg" height=24px> MaterialXLab</a></li>
403-
<li>The API reference can be found <a href="https://kwokcb.github.io/materialxMaterials/documents/html/index.html">here</a></li>
404-
<li><a href="https://github.com/kwokcb/materialxMaterials"><img src="https://raw.githubusercontent.com/kwokcb/materialxMaterials/4125d04c73fc2b1755f5b6054b25b6d1bdabcf6b/documents/icons/github-mark-white.svg" width=16px> GitHub repository</a>.</li>
402+
<li>Main tooling site: <div class="btn btn-outline-secondary"><br>
403+
<a href="https://kwokcb.github.io/MaterialXLab" target="_blank"><img src="https://kwokcb.github.io/MaterialXLab/documents/icons/teapot_logo.svg" height=24px> MaterialXLab</a></li>
405404
</ul>
405+
</div>
406+
- The API reference can be found <a href="https://kwokcb.github.io/materialxMaterials/documents/html/index.html">here</a>
407+
- <a href="https://github.com/kwokcb/materialxMaterials"><img src="https://raw.githubusercontent.com/kwokcb/materialxMaterials/4125d04c73fc2b1755f5b6054b25b6d1bdabcf6b/documents/icons/github-mark-white.svg" width=16px> GitHub repository</a>.
406408
<p>A <code>Jupyter</code> notebook demonstrates the direct usage of the Python library. The output of the notebook can be found <a href="https://kwokcb.github.io/materialxMaterials/examples/materialxMaterials_tutorial_out_iframe.html">here</a>. The notebook can found in the Github repository under the <code>examples</code> folder.</p>
407409
<h4>Examples</h4>
408410
<p>The following are some samples which have been rendered using the <code>MaterialXView</code> utility which is part of the MaterialX binary distribution.</p>
@@ -414,15 +416,15 @@ <h4>Examples</h4>
414416
<table>
415417
<tr>
416418
<td>
417-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/GPUOpenMaterialX/Emerald Peaks Wallpaper/Emerald_Peaks_Wallpaper.png" width=100%><br>
419+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/GPUOpenMaterialX/Emerald Peaks Wallpaper/Emerald_Peaks_Wallpaper.png" width=256px><br>
418420
Emerald Peaks Wallpaper
419421
</td>
420422
<td>
421-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/GPUOpenMaterialX/Indigo Palm Wallpaper/Indigo_Palm_Wallpaper.png" width=100%><br>
423+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/GPUOpenMaterialX/Indigo Palm Wallpaper/Indigo_Palm_Wallpaper.png" width=256px><br>
422424
Indigo Palm Wallpaper
423425
</td>
424426
<td>
425-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/GPUOpenMaterialX/Oliana Blue Painted Wood/Oliana_Blue_Painted_Wood.png" width=100%><br>
427+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/GPUOpenMaterialX/Oliana Blue Painted Wood/Oliana_Blue_Painted_Wood.png" width=256px><br>
426428
Oliana Blue Painted Wood
427429
</td>
428430
</tr>
@@ -433,15 +435,15 @@ <h4>Examples</h4>
433435
<table>
434436
<tr>
435437
<td>
436-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/Ketchup.png" width=100%><br>
438+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/Ketchup.png" width=256px><br>
437439
Ketchup
438440
</td>
439441
<td>
440-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/Cooking_Oil.png" width=100%><br>
442+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/Cooking_Oil.png" width=256px><br>
441443
Cooking Oil
442444
</td>
443445
<td>
444-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/Brass.png" width=100%><br>
446+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/Brass.png" width=256px><br>
445447
Brass
446448
</td>
447449
</tr>
@@ -454,15 +456,15 @@ <h4>Examples</h4>
454456
<table>
455457
<tr>
456458
<td>
457-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/ambientCgMaterials/Metal053C_1K-PNG.png" width=100%><br>
459+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/ambientCgMaterials/Metal053C_1K-PNG.png" width=256px><br>
458460
Metal (53)
459461
</td>
460462
<td>
461-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/ambientCgMaterials/PavingStones142_1K-PNG.png" width=100%><br>
463+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/ambientCgMaterials/PavingStones142_1K-PNG.png" width=256px><br>
462464
Paving Stones (142)
463465
</td>
464466
<td>
465-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/ambientCgMaterials/WoodFloor038_1K-PNG.png" width=100%><br>
467+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/ambientCgMaterials/WoodFloor038_1K-PNG.png" width=256px><br>
466468
Wood Floor (38)
467469
</td>
468470
</tr>
@@ -473,15 +475,15 @@ <h4>Examples</h4>
473475
<table>
474476
<tr>
475477
<td>
476-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PolyHavenMaterialX/polyhaven_aerial_asphalt_1.png" width=100%><br>
478+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PolyHavenMaterialX/polyhaven_aerial_asphalt_1.png" width=256px%><br>
477479
Ashphalt
478480
</td>
479481
<td>
480-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PolyHavenMaterialX/polyhaven_polystrylene.png" width=100%><br>
482+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PolyHavenMaterialX/polyhaven_polystrylene.png" width=256px><br>
481483
Polystyrene
482484
</td>
483485
<td>
484-
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PolyHavenMaterialX/polyhave_wood_trunk_wall.png" width=100%><br>
486+
<img src="https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PolyHavenMaterialX/polyhave_wood_trunk_wall.png" width=256px><br>
485487
Wood Trunk Wall
486488
</td>
487489
</tr>
@@ -496,35 +498,36 @@ <h3>Details</h3>
496498
<td class="col-sm p-2 border border-outline-secondary">
497499
<h4>1. PhysicallyBased</h4>
498500
<p>An <a href="https://kwokcb.github.io/MaterialXLab/javascript/PhysicallyBasedMaterialX_out.html" target="_blank">interactive page</a> for extracting <code>PhysicallyBased</code> uses a Javascript implementation found <a href="https://github.com/kwokcb/materialxMaterials/blob/main/javascript/JsMaterialXPhysicallyBased.js">here</p>
499-
<img src="https://raw.githubusercontent.com/kwokcb/materialxMaterials/refs/heads/main/documents/images/physicallyBased_material_fetch.png" width=100%/>
501+
<img src="https://raw.githubusercontent.com/kwokcb/materialxMaterials/refs/heads/main/documents/images/physicallyBased_material_fetch.png" width=512px/>
500502
</a>
501503
</td>
502504
<td class="col-sm p-2 border border-outline-secondary">
503505
<h4>2. AMD GPUOpen</h4>
504506
<p>A command line utility is available <a href="https://github.com/kwokcb/materialxMaterials/tree/main/javascript/JsGPUOpenLoaderPackage">here</a>. This uses <code>Node.js</code> to allow access to fetch materials from the <code>GPU Open</code> site(which is not available via a web page).</p>
505507
<p><a href="https://github.com/kwokcb/materialxWeb/blob/main/flask/gpuopen/README.md">A <b>Flask</b> application</a> is also available which uses the Python package with a Web based front here.
506508
<br>
507-
<img src="https://raw.githubusercontent.com/kwokcb/materialxWeb/refs/heads/main/flask/gpuopen/images/extract_material_2.png" width=100%>
509+
<img src="https://raw.githubusercontent.com/kwokcb/materialxWeb/refs/heads/main/flask/gpuopen/images/extract_material_2.png" width=512px>
508510
</p>
509511
</td>
510512
<tr>
511513
<td class="col-sm p-2 border border-outline-secondary">
512514
<h4>3. ambientCg</h4>
513-
<p>A sample <a href="https://materialx-materials-library-inspector.onrender.com/">
515+
<p>A sample <a href="https://materialx-materials-library-inspector.onrender.com/"><br>
514516
<b>NodeJS / Express</b></a> application is available from the <a href="https://kwokcb.github.io/materialxWeb/index.html" target="_blank">MaterialXWeb</a> site. <code>Flask</code> deployment is on <code>Render</code>.</p>
515517
<p>This is designed to be a general purpose MaterialX <em>material inspector</em> supporting <code>ambientCg</code> and <code>GPUOpen</code> currently with the intent to add new libraries as they become available.</p>
516-
<img src="https://github.com/kwokcb/materialxWeb/blob/main/nodejs/materialxLibraryInspector/public/images/ambientCg_download_2.png?raw=true" width=100%>
518+
<img src="https://github.com/kwokcb/materialxWeb/blob/main/nodejs/materialxLibraryInspector/public/images/ambientCg_download_2.png?raw=true" width=512px>
517519
</td>
518520
<td class="col-sm p-2 border border-outline-secondary">
519521
<h4>4. PolyHaven</h4>
520-
<p>A Python library and command <code>polyHavenLoader</code> and <code>polyHavenLoaderCmd</code> can be used to get a list of assets which can be downloaded in zip
522+
<p>A Python library and command <code>polyHavenLoader</code> and <code>polyHavenLoaderCmd</code> can be used to get a list of assets which can be downloaded in zip<br>
521523
format.</p>
522-
<p>A Javascript library and Web interface is available <a href="https://kwokcb.github.io/materialxMaterials/javascript/JsPolyHaven/" target="__default"><b>here</b>.</p>
524+
<p>A Javascript library and Web interface is available <a href="https://kwokcb.github.io/materialxMaterials/javascript/JsPolyHaven/" target="__default"><b>here</b>.<br>
525+
<br></p>
523526
<table>
524527
<tr>
525-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_0.png" width=100%></td>
526-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1a.png" width=100%></td>
527-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1b.png" width=100%></td>
528+
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_0.png" width=320px></td>
529+
<!-- <td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1a.png" width=256px></td> -->
530+
<!-- <td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1b.png" height=256px></td> -->
528531
</tr>
529532
</table>
530533
</a>
@@ -541,10 +544,10 @@ <h4>MaterialXLab Node Editor</h4>
541544
<p>Note that the material zip from <code>GPU Open</code> and <code>ambientCg</code> is directly read into the editor via it's zip loading option. <code>PolyHaven</code> packages material content into a zip to allow loading via the zip loading option.</p>
542545
<table>
543546
<tr>
544-
<td><img src="https://kwokcb.github.io/MaterialXLab/documents/help/images/load_phybased_node_editor.png" width=100%></td>
545-
<td><img src="https://kwokcb.github.io/MaterialXLab/documents/help/images/load_zip_node_editor_3.png" width=100%></td>
546-
<td><img src="https://kwokcb.github.io/MaterialXLab/documents/help/images/load_ambientCG_node_editor.png" width=100%></td>
547-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/load_polyhaven_node_editor.png" width=100%></td>
547+
<td><img src="https://kwokcb.github.io/MaterialXLab/documents/help/images/load_phybased_node_editor.png" width=256px></td>
548+
<td><img src="https://kwokcb.github.io/MaterialXLab/documents/help/images/load_zip_node_editor_3.png" width=256px></td>
549+
<td><img src="https://kwokcb.github.io/MaterialXLab/documents/help/images/load_ambientCG_node_editor.png" width=256px></td>
550+
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/load_polyhaven_node_editor.png" width=256px></td>
548551
</tr>
549552
</table>
550553
</p>
@@ -594,7 +597,7 @@ <h3>Package Building</h3>
594597
<li><code>buildDocs.sh</code> will prepare documents and run Doxygen to build API docs.</li>
595598
<li><code>build_examples.sh</code> will download material examples and optionally render them. <code>PhysicallyBased</code> rendering requires <code>MaterialXView</code> to be installed.</li>
596599
</ul>
597-
<p>The Javascript utilities require <code>Node.js</code> to be installed. From the package folders
600+
<p>The Javascript utilities require <code>Node.js</code> to be installed. From the package folders<br>
598601
the following should be run:</p>
599602
<pre class="hljs"><code><div>npm install # Install dependent packages
600603
npm run [build/start] # Build distribution or run the package
@@ -622,7 +625,7 @@ <h4>Python</h4>
622625
</div></code></pre>
623626
</li>
624627
<li>
625-
<p>Extract out a material package for the &quot;WoodFloor038&quot; material from ambientCG requesting the
628+
<p>Extract out a material package for the &quot;WoodFloor038&quot; material from ambientCG requesting the<br>
626629
package where the images are 2K PNG files:</p>
627630
<pre class="hljs"><code><div>materialxMaterials acg --downloadMaterial <span class="hljs-string">"WoodFloor038"</span> --downloadResolution 2
628631
</div></code></pre>

‎README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,12 @@ This site hosts a set of libraries and utilities to query remote databases for m
3939
</p>
4040
Each currently has <code>Python</code> and / or <code>Javascript</code> implementations.
4141

42-
**Links**
42+
<h3>Links</h3>
4343

4444
- <a href="https://kwokcb.github.io/materialxMaterials" target="_blank">Home Page</a>
45-
- Main tooling site: <div class="btn btn-outline-secondary"><a href="https://kwokcb.github.io/MaterialXLab" target="_blank"><img src="https://kwokcb.github.io/MaterialXLab/documents/icons/teapot_logo.svg" height=24px> MaterialXLab</a>
45+
- Main tooling site: <div class="btn btn-outline-secondary">
46+
<a href="https://kwokcb.github.io/MaterialXLab" target="_blank"><img src="https://kwokcb.github.io/MaterialXLab/documents/icons/teapot_logo.svg" height=24px> MaterialXLab</a>
47+
</div>
4648
- The API reference can be found <a href="https://kwokcb.github.io/materialxMaterials/documents/html/index.html">here</a>
4749
- <a href="https://github.com/kwokcb/materialxMaterials"><img src="https://raw.githubusercontent.com/kwokcb/materialxMaterials/4125d04c73fc2b1755f5b6054b25b6d1bdabcf6b/documents/icons/github-mark-white.svg" width=16px> GitHub repository</a>.
4850

@@ -191,12 +193,12 @@ A Python library and command `polyHavenLoader` and `polyHavenLoaderCmd` can be u
191193
format.
192194

193195
A Javascript library and Web interface is available <a href="https://kwokcb.github.io/materialxMaterials/javascript/JsPolyHaven/" target="__default"><b>here</b>.
194-
196+
<br>
195197
<table>
196198
<tr>
197-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_0.png" width=256px></td>
198-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1a.png" width=256px></td>
199-
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1b.png" width=256px></td>
199+
<td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_0.png" width=320px></td>
200+
<!-- <td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1a.png" width=256px></td> -->
201+
<!-- <td><img src="https://kwokcb.github.io/materialxMaterials/documents/images/PolyHaven_Page_1b.png" height=256px></td> -->
200202
</tr>
201203
</table>
202204
</a>

‎documents/custom_header.html‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@
3030
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.1/dist/js/bootstrap.bundle.min.js"></script>
3131
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.0/css/brands.min.css">
3232
-->
33+
<style>
34+
.table, th, td {
35+
font-size: small;
36+
}
37+
</style>
3338
</head>
3439
<body>
3540
<!--BEGIN FULL_SIDEBAR-->
@@ -47,9 +52,9 @@
4752
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></td>
4853
<!--END PROJECT_LOGO-->
4954
<!--BEGIN PROJECT_NAME-->
50-
<td id="projectalign">
55+
<td id="projectalign">
5156
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
52-
</div>
57+
</div>
5358
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
5459
</td>
5560
<!--END PROJECT_NAME-->

0 commit comments

Comments
 (0)
⚡