1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50    <title>nw::gfx::res::ResMaterial</title>
51  </head>
52  <body>
53    <h1><CODE><a href="../../../../nw/Overview.html">nw</a>::<a href="../../../../nw/gfx/Overview.html">gfx</a>::<a href="../../../../nw/gfx/res/Overview.html">res</a>::ResMaterial</CODE> Class</h1>
54    <h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class ResMaterial : public <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html">nw::gfx::res::ResSceneObject</a></pre>
57    </div>
58    <h2>Description</h2>
59    <div class="section">
60      <p>Binary resource class that represents materials.</p>
61    </div>
62    <a name="enum" id="enum">
63      <h2>Enumerated Types</h2>
64      <div class="section">
65        <table class="members">
66          <tr>
67            <td width="100"> </td>
68            <th>
69              <a href="../../../../nw/gfx/res/ResMaterial/TextureCoordinateConfig.html"><CODE>TextureCoordinateConfig</CODE></a>
70            </th>
71            <td>Texture coordinator configuration.</td>
72          </tr>
73          <tr>
74            <td width="100"> </td>
75            <th>
76              <a href="../../../../nw/gfx/res/ResMaterial/TranslucencyKind.html">TranslucencyKind</a>
77            </th>
78            <td>Rendering layer.</td>
79          </tr> </table>
80      </div>
81    </a> <a name="function" id="function">
82      <h2>Member Functions</h2>
83      <div class="section">
84        <table class="members">
85          <tr>
86            <td width="100">  </td>
87            <th>
88              <a href="../../../../nw/gfx/res/ResMaterial/ResMaterial.html">ResMaterial</a>
89            </th>
90            <td>Constructor.</td>
91          </tr>
92          <tr>
93            <td width="100">  </td>
94            <th>
95              <a href="../../../../nw/gfx/res/ResMaterial/ptr.html">ptr</a>
96            </th>
97            <td>Gets a pointer to actual data.</td>
98          </tr>
99          <tr>
100            <td width="100">  </td>
101            <th>
102              <a href="../../../../nw/gfx/res/ResMaterial/ref.html"><CODE>ref</CODE></a>
103            </th>
104            <td>Gets the reference to the actual data.</td>
105          </tr>
106          <tr>
107            <td width="100">  </td>
108            <th>
109              <a href="../../../../nw/gfx/res/ResMaterial/operator==.html"><CODE>operator ==</CODE></a>
110            </th>
111            <td>
112        </td>
113          </tr>
114          <tr>
115            <td width="100">  </td>
116            <th>
117              <a href="../../../../nw/gfx/res/ResMaterial/operator!=.html"><CODE>operator!=</CODE></a>
118            </th>
119            <td>
120        </td>
121          </tr>
122          <tr>
123            <td width="100">  </td>
124            <th>
125              <a href="../../../../nw/gfx/res/ResMaterial/GetFlags.html"><CODE>GetFlags</CODE></a>
126            </th>
127            <td>Gets the flag value.</td>
128          </tr>
129          <tr>
130            <td width="100">  </td>
131            <th>
132              <a href="../../../../nw/gfx/res/ResMaterial/SetFlags.html"><CODE>SetFlags</CODE></a>
133            </th>
134            <td>Sets flag value. Unset flags are disabled.</td>
135          </tr>
136          <tr>
137            <td width="100">  </td>
138            <th>
139              <a href="../../../../nw/gfx/res/ResMaterial/EnableFlags.html"><CODE>EnableFlags</CODE></a>
140            </th>
141            <td>Enables the flag value that has been set. Unset flags are not changed.</td>
142          </tr>
143          <tr>
144            <td width="100">  </td>
145            <th>
146              <a href="../../../../nw/gfx/res/ResMaterial/DisableFlags.html"><CODE>DisableFlags</CODE></a>
147            </th>
148            <td>Disables the flag value that has been set. Unset flags are not changed.</td>
149          </tr>
150          <tr>
151            <td width="100">  </td>
152            <th>
153              <a href="../../../../nw/gfx/res/ResMaterial/GetTextureCoordinateConfig.html">GetTextureCoordinateConfig</a>
154            </th>
155            <td>Gets the unit assignment setting for texture coordinates.</td>
156          </tr>
157          <tr>
158            <td width="100">  </td>
159            <th>
160              <a href="../../../../nw/gfx/res/ResMaterial/SetTextureCoordinateConfig.html">SetTextureCoordinateConfig</a>
161            </th>
162            <td>Sets the unit assignment setting for texture coordinates.</td>
163          </tr>
164          <tr>
165            <td width="100">  </td>
166            <th>
167              <a href="../../../../nw/gfx/res/ResMaterial/GetTranslucencyKind.html">GetTranslucencyKind</a>
168            </th>
169            <td>Gets the translucency type.</td>
170          </tr>
171          <tr>
172            <td width="100">  </td>
173            <th>
174              <a href="../../../../nw/gfx/res/ResMaterial/SetTranslucencyKind.html"><CODE>SetTranslucencyKind</CODE></a>
175            </th>
176            <td>Sets the translucency type.</td>
177          </tr>
178          <tr>
179            <td width="100">  </td>
180            <th>
181              <a href="../../../../nw/gfx/res/ResMaterial/GetMaterialColor.html">GetMaterialColor</a>
182            </th>
183            <td>Gets the material color.</td>
184          </tr>
185          <tr>
186            <td width="100">  </td>
187            <th>
188              <a href="../../../../nw/gfx/res/ResMaterial/GetMaterialColorData.html">GetMaterialColorData</a>
189            </th>
190            <td>Gets the material color.</td>
191          </tr>
192          <tr>
193            <td width="100">  </td>
194            <th>
195              <a href="../../../../nw/gfx/res/ResMaterial/GetRasterization.html">GetRasterization</a>
196            </th>
197            <td>Gets the rasterization.</td>
198          </tr>
199          <tr>
200            <td width="100">  </td>
201            <th>
202              <a href="../../../../nw/gfx/res/ResMaterial/GetRasterizationData.html">GetRasterizationData</a>
203            </th>
204            <td>Gets the rasterization.</td>
205          </tr>
206          <tr>
207            <td width="100">  </td>
208            <th>
209              <a href="../../../../nw/gfx/res/ResMaterial/GetFragmentOperation.html">GetFragmentOperation</a>
210            </th>
211            <td>Gets the fragment operation.</td>
212          </tr>
213          <tr>
214            <td width="100">  </td>
215            <th>
216              <a href="../../../../nw/gfx/res/ResMaterial/GetFragmentOperationData.html">GetFragmentOperationData</a>
217            </th>
218            <td>Gets the fragment operation.</td>
219          </tr>
220          <tr>
221            <td width="100">  </td>
222            <th>
223              <a href="../../../../nw/gfx/res/ResMaterial/GetActiveTextureCoordinatorsCount.html">GetActiveTextureCoordinatorsCount</a>
224            </th>
225            <td>Gets the number of active texture coordinators.</td>
226          </tr>
227          <tr>
228            <td width="100">  </td>
229            <th>
230              <a href="../../../../nw/gfx/res/ResMaterial/SetActiveTextureCoordinatorsCount.html">SetActiveTextureCoordinatorsCount</a>
231            </th>
232            <td>Sets the number of active texture coordinators.</td>
233          </tr>
234          <tr>
235            <td width="100">  </td>
236            <th>
237              <a href="../../../../nw/gfx/res/ResMaterial/GetTextureCoordinatorsCount.html">GetTextureCoordinatorsCount</a>
238            </th>
239            <td>Gets the number of texture coordinators.</td>
240          </tr>
241          <tr>
242            <td width="100">  </td>
243            <th>
244              <a href="../../../../nw/gfx/res/ResMaterial/GetTextureCoordinators.html">GetTextureCoordinators</a>
245            </th>
246            <td>Gets texture coordinators.</td>
247          </tr>
248          <tr>
249            <td width="100">  </td>
250            <th>
251              <a href="../../../../nw/gfx/res/ResMaterial/GetTextureCoordinatorsData.html">GetTextureCoordinatorsData</a>
252            </th>
253            <td>Gets an array of texture coordinators.</td>
254          </tr>
255          <tr>
256            <td width="100">  </td>
257            <th>
258              <a href="../../../../nw/gfx/res/ResMaterial/GetTextureMappersCount.html">GetTextureMappersCount</a>
259            </th>
260            <td>Gets the number of texture mappers.</td>
261          </tr>
262          <tr>
263            <td width="100">  </td>
264            <th>
265              <a href="../../../../nw/gfx/res/ResMaterial/GetTextureMappers.html">GetTextureMappers</a>
266            </th>
267            <td>Gets texture mappers.</td>
268          </tr>
269          <tr>
270            <td width="100">  </td>
271            <th>
272              <a href="../../../../nw/gfx/res/ResMaterial/GetProceduralTextureMapper.html">GetProceduralTextureMapper</a>
273            </th>
274            <td>Gets the procedural texture unit mapper.</td>
275          </tr>
276          <tr>
277            <td width="100">  </td>
278            <th>
279              <a href="../../../../nw/gfx/res/ResMaterial/GetShader.html">GetShader</a>
280            </th>
281            <td>Gets a shader.</td>
282          </tr>
283          <tr>
284            <td width="100">  </td>
285            <th>
286              <a href="../../../../nw/gfx/res/ResMaterial/GetFragmentShader.html">GetFragmentShader</a>
287            </th>
288            <td>Gets the fragment shader.</td>
289          </tr>
290          <tr>
291            <td width="100">  </td>
292            <th>
293              <a href="../../../../nw/gfx/res/ResMaterial/GetShaderProgramDescriptionIndex.html">GetShaderProgramDescriptionIndex</a>
294            </th>
295            <td>Gets the index of the shader resource.</td>
296          </tr>
297          <tr>
298            <td width="100">  </td>
299            <th>
300              <a href="../../../../nw/gfx/res/ResMaterial/SetShaderProgramDescriptionIndex.html">SetShaderProgramDescriptionIndex</a>
301            </th>
302            <td>Sets the index of the shader resource.</td>
303          </tr>
304          <tr>
305            <td width="100">  </td>
306            <th>
307              <a href="../../../../nw/gfx/res/ResMaterial/GetShaderParametersCount.html">GetShaderParametersCount</a>
308            </th>
309            <td>Gets the number of shader parameters.</td>
310          </tr>
311          <tr>
312            <td width="100">  </td>
313            <th>
314              <a href="../../../../nw/gfx/res/ResMaterial/GetShaderParameters.html">GetShaderParameters</a>
315            </th>
316            <td>Gets shader parameters.</td>
317          </tr>
318          <tr>
319            <td width="100">  </td>
320            <th>
321              <a href="../../../../nw/gfx/res/ResMaterial/GetLightSetIndex.html">GetLightSetIndex</a>
322            </th>
323            <td>Gets the index of the light set.</td>
324          </tr>
325          <tr>
326            <td width="100">  </td>
327            <th>
328              <a href="../../../../nw/gfx/res/ResMaterial/SetLightSetIndex.html">SetLightSetIndex</a>
329            </th>
330            <td>Sets the index of the light set.</td>
331          </tr>
332          <tr>
333            <td width="100">  </td>
334            <th>
335              <a href="../../../../nw/gfx/res/ResMaterial/GetFogIndex.html">GetFogIndex</a>
336            </th>
337            <td>Gets the index of the fog.</td>
338          </tr>
339          <tr>
340            <td width="100">  </td>
341            <th>
342              <a href="../../../../nw/gfx/res/ResMaterial/SetFogIndex.html">SetFogIndex</a>
343            </th>
344            <td>Sets the index of the fog.</td>
345          </tr>
346          <tr>
347            <td width="100">  </td>
348            <th>
349              <a href="../../../../nw/gfx/res/ResMaterial/GetMaterialId.html">GetMaterialId</a>
350            </th>
351            <td>Gets the material ID to be used in render sorting.</td>
352          </tr>
353          <tr>
354            <td width="100">  </td>
355            <th>
356              <a href="../../../../nw/gfx/res/ResMaterial/SetMaterialId.html">SetMaterialId</a>
357            </th>
358            <td>Sets the material ID to be used in render sorting.</td>
359          </tr>
360          <tr>
361            <td width="100">  </td>
362            <th>
363              <a href="../../../../nw/gfx/res/ResMaterial/GetRevision.html"><CODE>GetRevision</CODE></a>
364            </th>
365            <td>Gets the revision of the material binary.</td>
366          </tr>
367          <tr>
368            <td width="100">  </td>
369            <th>
370              <a href="../../../../nw/gfx/res/ResMaterial/Setup.html">Setup</a>
371            </th>
372            <td>Initializes a resource.</td>
373          </tr>
374          <tr>
375            <td width="100">  </td>
376            <th>
377              <a href="../../../../nw/gfx/res/ResMaterial/Cleanup.html"><CODE>Cleanup</CODE></a>
378            </th>
379            <td>Cleans up a resource.</td>
380          </tr>
381          <tr>
382            <td width="100">  </td>
383            <th>
384              <a href="../../../../nw/gfx/res/ResMaterial/SetShader.html">SetShader</a>
385            </th>
386            <td>Configures a Shader after it has been set up.</td>
387          </tr>
388          <tr>
389            <td width="100">  </td>
390            <th>
391              <a href="../../../../nw/gfx/res/ResMaterial/ForceSetupTexture.html">ForceSetupTexture</a>
392            </th>
393            <td>Forcibly replaces the texture given by targetName with texture.</td>
394          </tr>
395          <tr>
396            <td width="100">  </td>
397            <th>
398              <a href="../../../../nw/gfx/res/ResMaterial/ForceSetupShader.html">ForceSetupShader</a>
399            </th>
400            <td>Forcibly replaces the shader being referenced with shader. Unlike SetShader, setup processing is carried out internally.</td>
401          </tr>
402          <tr>
403            <td width="100">  </td>
404            <th>
405              <a href="../../../../nw/gfx/res/ResMaterial/ForceSetupLookupTable.html">ForceSetupLookupTable</a>
406            </th>
407            <td>Forcibly overwrites the Lut inside FragmentShader with lut. The LookupTabel resolved for targetName is the target.</td>
408          </tr>
409          <tr>
410            <td width="100">  </td>
411            <th>
412              <a href="../../../../nw/gfx/res/ResSceneObject/GetHeader.html"><CODE>GetHeader</CODE></a>
413            </th>
414            <td>Gets the header information.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
415          </tr>
416          <tr>
417            <td width="100">  </td>
418            <th>
419              <a href="../../../../nw/gfx/res/ResSceneObject/SetHeader.html">SetHeader</a>
420            </th>
421            <td>Sets the header information.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
422          </tr>
423          <tr>
424            <td width="100">  </td>
425            <th>
426              <a href="../../../../nw/gfx/res/ResSceneObject/GetName.html"><CODE>GetName</CODE></a>
427            </th>
428            <td>Gets the name of the resource.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
429          </tr>
430          <tr>
431            <td width="100">  </td>
432            <th>
433              <a href="../../../../nw/gfx/res/ResSceneObject/GetUserDataCount.html"><CODE>GetUserDataCount</CODE></a>
434            </th>
435            <td>Gets the number of instances of user data.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
436          </tr>
437          <tr>
438            <td width="100">  </td>
439            <th>
440              <a href="../../../../nw/gfx/res/ResSceneObject/GetUserData.html"><CODE>GetUserData</CODE></a>
441            </th>
442            <td>Gets user data.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
443          </tr>
444          <tr>
445            <td width="100">  </td>
446            <th>
447              <a href="../../../../nw/gfx/res/ResSceneObject/GetUserDataIndex.html"><CODE>GetUserDataIndex</CODE></a>
448            </th>
449            <td>Gets the index number of user data in the dictionary.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
450          </tr>
451          <tr>
452            <td width="100">  </td>
453            <th>
454              <a href="../../../../nw/gfx/res/ResSceneObject/GetTypeInfo.html"><CODE>GetTypeInfo</CODE></a>
455            </th>
456            <td>Gets instance type information.(Derived from <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html"><CODE>ResSceneObject</CODE></a>.)</td>
457          </tr>
458          <tr>
459            <td width="100">  </td>
460            <th>
461              <a href="../../../../nw/ut/ResCommonBase/IsValid.html"><CODE>IsValid</CODE></a>
462            </th>
463            <td>Determines whether a pointer to a resource is <CODE>null</CODE>.(Derived from <CODE><a href="../../../../nw/ut/ResCommonBase/Overview.html">ResCommonBase</a></CODE>.)</td>
464          </tr>
465          <tr>
466            <td width="100">
467              <span class="static_style" title="static">S</span> </td>
468            <th>
469              <a href="../../../../nw/gfx/res/ResMaterial/GetClassName.html"><CODE>GetClassName</CODE></a>
470            </th>
471            <td>
472        </td>
473          </tr> </table>
474      </div>
475    </a>
476    <h2>Class Hierarchy</h2>
477    <div class="section">
478      <p class="hierarchy"><a href="../../../../nw/ut/ResCommonBase/Overview.html">nw::ut::ResCommonBase</a><br />  <a href="../../../../nw/ut/ResCommon/Overview.html">nw::ut::ResCommon</a><br />    <a href="../../../../nw/gfx/res/ResSceneObject/Overview.html">nw::gfx::res::ResSceneObject</a><br />      <b>nw::gfx::res::ResMaterial</b>
479      </p>
480    </div>
481  <hr><p>CONFIDENTIAL</p></body>
482</html>