forked from AcademySoftwareFoundation/materialx-website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DeveloperReference.html
358 lines (333 loc) · 12.3 KB
/
DeveloperReference.html
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>MaterialX - <a href="DeveloperReference.html">Developer Reference</a></title>
<link rel="icon" href="faviconMX.ico" type="image/x-icon" />
<link rel="stylesheet" href="style/rst.css" type="text/css">
<link rel="stylesheet" href="style/default.css" type="text/css">
<link rel="stylesheet" href="style/flavor.css" type="text/css">
<link rel="stylesheet" href="style/renderman-university.css" type="text/css">
<style>
#mainContentContainer {
left: 15px;
margin-left: 255px;
}
ul.creatorFooterNav {
margin-left: 250px;
}
.navigation {
background-color: #272727;
margin-top: 10px;
margin-left: 10px;
}
.footer-Confluence {
text-align: center;
margin-top: 15px;
}
.footer-Confluence hr.footer {
display: block;
margin-left: -10px;
width: 100%;
}
.footer-Confluence img {
margin-bottom: 0;
max-width: none;
}
.copyrightFooter {
font-size: 9px;
margin-top: 25px;
text-align: center;
float: none;
}
.copyrightFooter a {
color: #666666;
}
.copyrightFooter a:hover {
color: #fff;
}
table.warningMacro, table.noteMacro {
margin: 20px 0 20px 0;
}
</style>
</head>
<body>
<div class="navigation">
<br>
<div class="quickLinks">
<div>
<a href="index.html"><img alt="<MaterialX Logo>" src="images/MaterialXLogoSmallA.png"></a>
</div>
<ul>
<li>
<a href="Specification.html">Specification</a>
<ul>
<li>
<a href="assets/MaterialX.v1.38.Spec.pdf">MaterialX Spec PDF (v1.38)</a>
</li>
</ul>
<ul>
<li>
<a href="assets/MaterialX.v1.38.PBRSpec.pdf">Physically Based Shading Nodes</a>
</li>
</ul>
<ul>
<li>
<a href="assets/MaterialX.v1.38.Supplement.pdf">Supplemental Notes PDF</a>
</li>
</ul>
<ul>
<li>
<a href="Specification.html#RevisionHistory">Specification Revision History</a>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="DeveloperReference.html">Developer Reference</a>
<ul>
<li>
<a href="DeveloperReference.html#DeveloperGuide">Developer Guide</a>
</li>
</ul>
<ul>
<li>
<a href="DeveloperReference.html#ExampleCode">Example Code</a>
</li>
</ul>
<ul>
<li>
<a href="DeveloperReference.html#ExampleFiles">Example MaterialX Files</a>
</li>
</ul>
<ul>
<li>
<a href="DeveloperReference.html#Discussion">Discussion Forum</a>
</li>
</ul>
<ul>
<li>
<a href="DeveloperReference.html#LogoImages">MaterialX Logo Images</a>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="Tools.html">Rendering and Tools</a>
<ul>
<li>
<a href="Tools.html#ShaderGen">ShaderGen</a>
</li>
</ul>
<ul>
<li>
<a href="Tools.html#Viewer">MaterialX Viewer</a>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html">Third-Party MaterialX Support</a>
<ul>
<li>
<a href="ThirdPartySupport.html#USD">Pixar USD</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#Houdini">SideFX Houdini</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#Maya">Autodesk Maya</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#Apple">Apple VisionOS</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#Omniverse">NVIDIA Omniverse</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#Unreal">Unreal Engine</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#Arnold">Autodesk Arnold</a>
</li>
</ul>
<ul>
<li>
<a href="ThirdPartySupport.html#RenderMan">Pixar RenderMan</a>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="Contributing.html">Contributing to MaterialX</a>
<ul>
<li>
<a href="Contributing.html#CLA">Contributor License Agreement</a>
</li>
</ul>
<ul>
<li>
<a href="Contributing.html#Contributors">Current Contributors</a>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="https://github.com/AcademySoftwareFoundation/MaterialX/blob/main/LICENSE">License</a>
</li>
</ul>
</div>
</div>
<div class="document">
<h1 class="title">
<span id="title-text">
MaterialX
</span>
</h1>
<div id="mainContentContainer">
<div class="fullWidth headerColor">
<div class="center">
<div id="mainSiteNavigation">
<ul class="creatorMainNav floatRight" id="menu">
<li class="">
<a href="index.html">Home</a>
</li>
<li class="">
<a target="_blank" href="docs/api/index.html">Developer Guide</a>
</li>
<li class="">
<a target="_blank" href="Specification.html">Specification</a>
</li>
<li class="">
<a class="blueButton" style="font-size:14px" href="https://github.com/AcademySoftwareFoundation/MaterialX">GitHub</a>
</li>
<a class="iconButton" href="https://twitter.com/MaterialXCG" style="float:right">
<img src="images/Twitter_Logo_Gray_sm.png" width=20 height=20>
</a>
</ul>
</div>
</div>
</div>
<!-- Page Title ---------------------------------------------------------------------- -->
<div class="clearBoth"></div>
<h1 class="articleContentTitle">Developer Reference</h1>
<div class="clearBoth"></div>
<hr>
<!-- --------------------------------------------------------------------------------- -->
<div class="clearBoth"></div>
<div class="coursewareBackground">
<div 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 developed by Khronos.</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://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>
<!-- --------------------------------------------------------------------------------- -->
</div>
</div>
</div>
<div class="clearBoth"></div>
<div class="center">
<br>
</div>
<div class="clearBoth"></div>
<div class="center">
<div class="copyrightFooter">
<p>
<a href="" style="color: #666666">TERMS OF USE</a>
<a href="" style="color: #666666">PRIVACY POLICY</a>
<a href="" style="color: #666666">LEGAL NOTICES</a>
<a href="" style="color: #666666">CHILDREN’S ONLINE PRIVACY POLICY</a>
<a href="" style="color: #666666">YOUR CALIFORNIA PRIVACY POLICY</a>
</div>
</div>
</div>
</body>
</html>