materialx-website/DeveloperReference.html at main · AcademySoftwareFoundation/materialx-website · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>MaterialX - Developer Reference</title>

  <link rel="icon" href="faviconMX.ico" type="image/x-icon" />
  <link rel="stylesheet" href="style/default.css" type="text/css">
  <script src="javascript/components.js"></script>
</head>
<body>

  <div id="navigation-container"></div>

  <main class="document">
    <h1 class="title">
      <span id="title-text">
        MaterialX
      </span>
    </h1>

    <div id="mainContentContainer">
      <div id="header-container"></div>

      <!-- Page Title ---------------------------------------------------------------------- -->
      <div class="clearBoth"></div>
      <h1 class="articleContentTitle">Developer Reference</h1>
      <div class="clearBoth"></div>
      <hr>
      <!-- --------------------------------------------------------------------------------- -->

      <div class="clearBoth"></div>
      <section class="coursewareBackground">
        <article class="topicLeftData-MainData">

          <!-- Page Content -------------------------------------------------------------------- -->

          <h2 id="DeveloperGuide"><strong>Developer Guide</strong></h2>
          <p>
            The <a href="docs/api/index.html">Developer Guide</a> contains an overview for building and installing MaterialX C++ and Python,
            along with detailed documentation for the <a href="docs/api/annotated.html">MaterialX C++ API</a>.
          </p>

          <h2 id="ExampleCode"><strong>Example Code</strong></h2>
          <p>
            The <a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/source/MaterialXTest">MaterialX Unit Tests</a>
            are a validation suite for the MaterialX C++ libraries, and can provide a useful guide for coding patterns in MaterialX C++.
          </p>
          <p>
            The <a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/python/Scripts">Python Code Examples</a>
            folder contains a collection of standalone Python scripts that build upon the MaterialX Python API.
          </p>

          <h2 id="ExampleFiles"><strong>Example MaterialX Files</strong></h2>
          <p>
            The <a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/resources/Materials/Examples">Example Materials</a>
            folder of the MaterialX distribution provides examples of uniform, procedural, and textured materials based on a variety of shading
            models:
          </p>
          <ul>
            <li><a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/resources/Materials/Examples/StandardSurface">Standard Surface</a>,
                 a shading model developed by Autodesk.</li>
            <li><a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/resources/Materials/Examples/UsdPreviewSurface">UsdPreviewSurface</a>,
                 a shading model developed by Pixar.</li>
            <li><a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/resources/Materials/Examples/GltfPbr">glTF PBR</a>,
                 a shading model maintained by Khronos.</li>
            <li><a href="https://github.com/AcademySoftwareFoundation/MaterialX/tree/main/resources/Materials/Examples/OpenPbr">OpenPBR Surface</a>,
                 a shading model maintained by the Academy Software Foundation.</li>
          </ul>
          <p>
            See the <a href="https://github.com/AcademySoftwareFoundation/MaterialX/blob/main/libraries/bxdf">BxDF Libraries</a>
            folder for the MaterialX graph definitions of each of these shading models.
          </p>
          <p>
            AMD maintains the <a href="https://matlib.gpuopen.com/main/materials/all">GPUOpen MaterialX Library</a>,
            providing a wide variety of MaterialX examples under a Creative Commons license.
            The library is well-organized and searchable, with support for real-time preview, web API integration,
            and contributions from the community.
          </p>
          <p>
            The <a href="https://polyhaven.com/">Poly Haven</a> site maintains an open, searchable library of texture
            and material assets, supporting downloads in the MaterialX format.
          </p>
          <p>
            The <a href="https://physicallybased.info/">Physically Based</a> database is another useful resource,
            providing downloadable reference materials in the MaterialX format.
          </p>

          <h2 id="Discussion"><strong>Discussion Forum</strong></h2>
          <p>
            The <a href="https://slack.aswf.io/">Academy Software Foundation Slack</a>
            is the central discussion forum for the MaterialX project, with a dedicated <strong>#materialx</strong>
            channel that is open to the entire community.
            This venue is appropriate for general questions, feature requests, and discussion of the MaterialX
            project as a whole.
          </p>

          <h2 id="LogoImages"><strong>MaterialX Logo Images</strong></h2>
          <p>
            A number of different high-resolution versions of the MaterialX Logo are available
            for inclusion in application visuals and promotional materials for products using
            or compatible with MaterialX:
          </p>
          <ul>
            <li>
              <a href="LogoImages/MaterialXLogo2K.png">MaterialXLogo2K.png</a>:
              Logo with mask, 2048x1580 RGBA, 8-bit per channel, sRGB colorspace (699KB)
            </li>
            <li>
              <a href="LogoImages/MaterialXLogo2KBlack.png">MaterialXLogo2KBlack.png</a>:
              Logo over black, 2048x1580 RGB, 8-bit per channel, sRGB colorspace (512KB)
            </li>
            <li>
              <a href="LogoImages/MaterialXLogo2KWhite.png">MaterialXLogo2KWhite.png</a>:
              Logo over white, 2048x1580 RGB, 8-bit per channel, sRGB colorspace (531KB)
            </li>
          </ul>
          <!-- --------------------------------------------------------------------------------- -->

        </article>
      </section>
    </div>

    <div class="clearBoth"></div>

  </main>

  <div id="footer-container"></div>

</body>
</html>