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::ResShaderProgramDescription</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>::ResShaderProgramDescription</CODE> Class</h1>
54    <h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class ResShaderProgramDescription : public <a href="../../../../nw/ut/ResCommon/Overview.html">nw::ut::ResCommon&lt; ResShaderProgramDescriptionData &gt;</a></pre>
57    </div>
58    <h2>Description</h2>
59    <div class="section">
60      <p>Binary resource class that represents detailed settings for shader programs.</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/ResShaderProgramDescription/Flag.html">Flag</a>
70            </th>
71            <td>Flag definitinos for shader program resources.</td>
72          </tr> </table>
73      </div>
74    </a> <a name="function" id="function">
75      <h2>Member Functions</h2>
76      <div class="section">
77        <table class="members">
78          <tr>
79            <td width="100">  </td>
80            <th>
81              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/ResShaderProgramDescription.html">ResShaderProgramDescription</a>
82            </th>
83            <td>Constructor.</td>
84          </tr>
85          <tr>
86            <td width="100">  </td>
87            <th>
88              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/ref.html"><CODE>ref</CODE></a>
89            </th>
90            <td>
91        </td>
92          </tr>
93          <tr>
94            <td width="100">  </td>
95            <th>
96              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/operator==.html"><CODE>operator ==</CODE></a>
97            </th>
98            <td>
99        </td>
100          </tr>
101          <tr>
102            <td width="100">  </td>
103            <th>
104              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/operator!=.html"><CODE>operator!=</CODE></a>
105            </th>
106            <td>
107        </td>
108          </tr>
109          <tr>
110            <td width="100">  </td>
111            <th>
112              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetFlags.html"><CODE>GetFlags</CODE></a>
113            </th>
114            <td>Gets the flag value.</td>
115          </tr>
116          <tr>
117            <td width="100">  </td>
118            <th>
119              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetFlags.html"><CODE>SetFlags</CODE></a>
120            </th>
121            <td>Sets flag value. Unset flags are disabled.</td>
122          </tr>
123          <tr>
124            <td width="100">  </td>
125            <th>
126              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/EnableFlags.html"><CODE>EnableFlags</CODE></a>
127            </th>
128            <td>Enables the flag value that has been set. Unset flags are not changed.</td>
129          </tr>
130          <tr>
131            <td width="100">  </td>
132            <th>
133              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/DisableFlags.html"><CODE>DisableFlags</CODE></a>
134            </th>
135            <td>Disables the flag value that has been set. Unset flags are not changed.</td>
136          </tr>
137          <tr>
138            <td width="100">  </td>
139            <th>
140              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetVertexShaderObject.html">GetVertexShaderObject</a>
141            </th>
142            <td>Gets a vertex shader object.</td>
143          </tr>
144          <tr>
145            <td width="100">  </td>
146            <th>
147              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetVertexShaderObject.html">SetVertexShaderObject</a>
148            </th>
149            <td>Sets a vertex shader object.</td>
150          </tr>
151          <tr>
152            <td width="100">  </td>
153            <th>
154              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetGeometryShaderObject.html">GetGeometryShaderObject</a>
155            </th>
156            <td>Gets a geometry shader object.</td>
157          </tr>
158          <tr>
159            <td width="100">  </td>
160            <th>
161              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetGeometryShaderObject.html">SetGeometryShaderObject</a>
162            </th>
163            <td>Sets a geometry shader object.</td>
164          </tr>
165          <tr>
166            <td width="100">  </td>
167            <th>
168              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetVertexShaderIndex.html">GetVertexShaderIndex</a>
169            </th>
170            <td>Gets the vertex shader index in the shader binary.</td>
171          </tr>
172          <tr>
173            <td width="100">  </td>
174            <th>
175              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetVertexShaderIndex.html">SetVertexShaderIndex</a>
176            </th>
177            <td>Sets the vertex shader index in the shader binary.</td>
178          </tr>
179          <tr>
180            <td width="100">  </td>
181            <th>
182              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetGeometryShaderIndex.html">GetGeometryShaderIndex</a>
183            </th>
184            <td>Gets the geometry shader index in the shader binary.</td>
185          </tr>
186          <tr>
187            <td width="100">  </td>
188            <th>
189              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetGeometryShaderIndex.html">SetGeometryShaderIndex</a>
190            </th>
191            <td>Sets the geometry shader index in the shader binary.</td>
192          </tr>
193          <tr>
194            <td width="100">  </td>
195            <th>
196              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetSymbolsCount.html">GetSymbolsCount</a>
197            </th>
198            <td>Gets the number of symbols.</td>
199          </tr>
200          <tr>
201            <td width="100">  </td>
202            <th>
203              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetSymbols.html">GetSymbols</a>
204            </th>
205            <td>Gets a symbol.</td>
206          </tr>
207          <tr>
208            <td width="100">  </td>
209            <th>
210              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetAttributeSymbolsCount.html">GetAttributeSymbolsCount</a>
211            </th>
212            <td>Gets the number of vertex attribute symbol names.</td>
213          </tr>
214          <tr>
215            <td width="100">  </td>
216            <th>
217              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetAttributeSymbols.html">GetAttributeSymbols</a>
218            </th>
219            <td>Gets the symbol name of the vertex attribute.</td>
220          </tr>
221          <tr>
222            <td width="100">  </td>
223            <th>
224              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetAttributeIndicesCount.html">GetAttributeIndicesCount</a>
225            </th>
226            <td>Gets the index of the vertex attribute.</td>
227          </tr>
228          <tr>
229            <td width="100">  </td>
230            <th>
231              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetAttributeIndices.html">GetAttributeIndices</a>
232            </th>
233            <td>Gets the index of the vertex attribute.</td>
234          </tr>
235          <tr>
236            <td width="100">  </td>
237            <th>
238              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetAttributeIndices.html">SetAttributeIndices</a>
239            </th>
240            <td>Sets an item in the vertex attributes index table list.</td>
241          </tr>
242          <tr>
243            <td width="100">  </td>
244            <th>
245              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetMaxBoneCount.html">GetMaxBoneCount</a>
246            </th>
247            <td>Gets the maximum value of the matrix palette that can be set once.</td>
248          </tr>
249          <tr>
250            <td width="100">  </td>
251            <th>
252              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetMaxBoneCount.html">SetMaxBoneCount</a>
253            </th>
254            <td>Sets the maximum value of the matrix palette that can be set once.</td>
255          </tr>
256          <tr>
257            <td width="100">  </td>
258            <th>
259              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetMaxVertexLightCount.html">GetMaxVertexLightCount</a>
260            </th>
261            <td>Gets the maximum number of vertex lights that can be processed.</td>
262          </tr>
263          <tr>
264            <td width="100">  </td>
265            <th>
266              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetMaxVertexLightCount.html">SetMaxVertexLightCount</a>
267            </th>
268            <td>Sets the maximum number of vertex lights that can be processed.</td>
269          </tr>
270          <tr>
271            <td width="100">  </td>
272            <th>
273              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetVertexLightEndUniform.html">GetVertexLightEndUniform</a>
274            </th>
275            <td>Gets the end uniform of the vertex light.</td>
276          </tr>
277          <tr>
278            <td width="100">  </td>
279            <th>
280              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetVertexLightEndUniform.html">SetVertexLightEndUniform</a>
281            </th>
282            <td>Sets the end uniform of the vertex light.</td>
283          </tr>
284          <tr>
285            <td width="100">  </td>
286            <th>
287              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetGeometryShaderMode.html">GetGeometryShaderMode</a>
288            </th>
289            <td>Gets the geometry shader mode.</td>
290          </tr>
291          <tr>
292            <td width="100">  </td>
293            <th>
294              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetGeometryShaderMode.html">SetGeometryShaderMode</a>
295            </th>
296            <td>Sets the geometry shader mode.</td>
297          </tr>
298          <tr>
299            <td width="100">  </td>
300            <th>
301              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetProgramObject.html"><CODE>GetProgramObject</CODE></a>
302            </th>
303            <td>Gets a program object.</td>
304          </tr>
305          <tr>
306            <td width="100">  </td>
307            <th>
308              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/SetProgramObject.html">SetProgramObject</a>
309            </th>
310            <td>Sets a program object.</td>
311          </tr>
312          <tr>
313            <td width="100">  </td>
314            <th>
315              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetOwnerShaderData.html">GetOwnerShaderData</a>
316            </th>
317            <td>Gets the shader binary that owns this shader program.</td>
318          </tr>
319          <tr>
320            <td width="100">  </td>
321            <th>
322              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetShaderBinaryInfo.html">GetShaderBinaryInfo</a>
323            </th>
324            <td>Gets the shader binary analysis information class.</td>
325          </tr>
326          <tr>
327            <td width="100">  </td>
328            <th>
329              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetVertexUniformIndex.html"><CODE>GetVertexUniformIndex</CODE></a>
330            </th>
331            <td>Gets the vertex shader uniform index.</td>
332          </tr>
333          <tr>
334            <td width="100">  </td>
335            <th>
336              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetGeometryUniformIndex.html">GetGeometryUniformIndex</a>
337            </th>
338            <td>Gets the geometry shader uniform index.</td>
339          </tr>
340          <tr>
341            <td width="100">  </td>
342            <th>
343              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/Setup.html">Setup</a>
344            </th>
345            <td>Initializes a resource.</td>
346          </tr>
347          <tr>
348            <td width="100">  </td>
349            <th>
350              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/Cleanup.html"><CODE>Cleanup</CODE></a>
351            </th>
352            <td>Cleans up a resource.</td>
353          </tr>
354          <tr>
355            <td width="100">  </td>
356            <th>
357              <a href="../../../../nw/ut/ResCommon/ptr.html">ptr</a>
358            </th>
359            <td>Returns a pointer to a binary resource structure. (Derived from <CODE><a href="../../../../nw/ut/ResCommon/Overview.html">ResCommon</a></CODE>)</td>
360          </tr>
361          <tr>
362            <td width="100">  </td>
363            <th>
364              <a href="../../../../nw/ut/ResCommonBase/IsValid.html"><CODE>IsValid</CODE></a>
365            </th>
366            <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>
367          </tr>
368          <tr>
369            <td width="100">
370              <span class="static_style" title="static">S</span> </td>
371            <th>
372              <a href="../../../../nw/gfx/res/ResShaderProgramDescription/GetClassName.html"><CODE>GetClassName</CODE></a>
373            </th>
374            <td>
375        </td>
376          </tr> </table>
377      </div>
378    </a>
379    <h2>Class Hierarchy</h2>
380    <div class="section">
381      <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 />    <b>nw::gfx::res::ResShaderProgramDescription</b>
382      </p>
383    </div>
384  <hr><p>CONFIDENTIAL</p></body>
385</html>