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      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48<title>nn::gr::CTR::FragmentLight</title>
49  </head>
50  <body>
51<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/gr/Overview.html">gr</a>::<a href="../../../../nn/gr/CTR/Overview.html">CTR</a>::FragmentLight</CODE> Class</h1>
52<h2>Syntax</h2>
53    <div class="section">
54<pre class="definition">class FragmentLight</pre>
55    </div>
56<h2>Description</h2>
57    <div class="section">
58<p>Class for configuring fragment lighting settings.</p><!-- write here --></div>
59    <a name="class" id="class">
60<h2>Classes</h2>
61      <div class="section">
62        <table class="members">
63          <tr>
64            <th>
65<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html"><CODE>nn::gr::CTR::FragmentLight::LutConfig</CODE></a>
66            </th>
67<td>Class for adjusting lookup table values.</td>
68          </tr>
69          <tr>
70            <th>
71<a href="../../../../nn/gr/CTR/FragmentLight/Source/Overview.html"><CODE>nn::gr::CTR::FragmentLight::Source</CODE></a>
72            </th>
73<td>Class for making settings per light source.</td>
74          </tr> </table>
75      </div>
76    </a> <a name="constant" id="constant">
77<h2>Member Constants</h2>
78      <div class="section">
79        <table class="members">
80          <tr>
81            <td width="100">
82<span class="static_style" title="static">S</span>
83            </td>
84            <th>
85<span class="argument"><a href="../../../../nn/gr/CTR/FragmentLight/LIGHT_SOURCE_MAX.html"><CODE>LIGHT_SOURCE_MAX</CODE></a></span>
86            </th>
87<td width="100"><CODE>const u32</CODE></td>
88<td>The maximum number of light sources is 8.</td>
89          </tr> </table>
90      </div>
91    </a> <a name="variable" id="variable">
92<h2>Member Variables</h2>
93      <div class="section">
94        <table class="members">
95          <tr>
96            <td width="100"> </td>
97            <th>
98<span class="argument">globalAmbientR</span>
99            </th>
100<td width="100">u8</td>
101<td>Red component setting for global ambient. Type is <CODE>u8</CODE>. Values in the range <CODE>[0.f, 1.f]</CODE> are mapped to <CODE>[0, 255]</CODE> and then set.</td>
102          </tr>
103          <tr>
104            <td width="100"> </td>
105            <th>
106<span class="argument">globalAmbientG</span>
107            </th>
108<td width="100">u8</td>
109<td>Green component setting for global ambient. Type is <CODE>u8</CODE>. Values in the range <CODE>[0.f, 1.f]</CODE> are mapped to <CODE>[0, 255]</CODE> and then set.</td>
110          </tr>
111          <tr>
112            <td width="100"> </td>
113            <th>
114<span class="argument">globalAmbientB</span>
115            </th>
116<td width="100">u8</td>
117<td>Blue component setting for global ambient. Type is <CODE>u8</CODE>. Values in the range <CODE>[0.f, 1.f]</CODE> are mapped to <CODE>[0, 255]</CODE> and then set.</td>
118          </tr>
119          <tr>
120            <td width="100"> </td>
121            <th>
122<span class="argument">source</span>
123            </th>
124<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/Source/Overview.html"><CODE>Source</CODE></a></td>
125<td>Stores light source settings. Type is <a href="../../../../nn/gr/CTR/FragmentLight/Source/Overview.html"><CODE>nn::gr::CTR::FragmentLight::Source[]</CODE></a>.</td>
126          </tr>
127          <tr>
128            <td width="100"> </td>
129            <th>
130<span class="argument">isEnable</span>
131            </th>
132<td width="100">bool</td>
133<td>Sets enable/disable for light sources. Type is <CODE>bool[]</CODE>. Upper limit value of the array is <CODE>LIGHT_SOURCE_MAX</CODE>.</td>
134          </tr>
135          <tr>
136            <td width="100"> </td>
137            <th>
138<span class="argument">isEnableSpot</span>
139            </th>
140<td width="100">bool</td>
141<td>Sets whether spotlights are enabled. Type is <CODE>bool[]</CODE>. Upper limit value of the array is <CODE>LIGHT_SOURCE_MAX</CODE>.</td>
142          </tr>
143          <tr>
144            <td width="100"> </td>
145            <th>
146<span class="argument">isEnableDistAttn</span>
147            </th>
148<td width="100">bool</td>
149<td>Sets whether distance attenuation is enabled. Type is <CODE>bool[]</CODE>. Upper limit value of the array is <CODE>LIGHT_SOURCE_MAX</CODE>.</td>
150          </tr>
151          <tr>
152            <td width="100"> </td>
153            <th>
154<span class="argument">isShadowed</span>
155            </th>
156<td width="100">bool</td>
157<td>Sets shadow adjustment elements. Type is <CODE>bool[]</CODE>. Upper limit value of the array is <CODE>LIGHT_SOURCE_MAX</CODE>.</td>
158          </tr>
159          <tr>
160            <td width="100"> </td>
161            <th>
162<span class="argument">layerConfig</span>
163            </th>
164<td width="100"><a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvLayerConfig.html">PicaDataFragLightEnvLayerConfig</a></td>
165<td>Sets layer config. Type is <a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvLayerConfig.html"><CODE>PicaDataFragLightEnvLayerConfig</CODE></a>.</td>
166          </tr>
167          <tr>
168            <td width="100"> </td>
169            <th>
170<span class="argument">fresnelSelector</span>
171            </th>
172<td width="100"><a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvFresnel.html">PicaDataFragLightEnvFresnel</a></td>
173<td>Sets where fresnel is applied. Type is <a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvFresnel.html"><CODE>PicaDataFragLightEnvFresnel</CODE></a>.</td>
174          </tr>
175          <tr>
176            <td width="100"> </td>
177            <th>
178<span class="argument">shadowSelector</span>
179            </th>
180<td width="100"><a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvTexture.html">PicaDataFragLightEnvTexture</a></td>
181<td>Sets textures whose shadow adjustment element is to be sampled. Type is <a href="../../../../nn/gr/CTR/PicaDataFragLightTexture.html"><CODE>PicaDataFragLightTexture</CODE></a>.</td>
182          </tr>
183          <tr>
184            <td width="100"> </td>
185            <th>
186<span class="argument">bumpMode</span>
187            </th>
188<td width="100"><a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvBump.html">PicaDataFragLightEnvBump</a></td>
189<td>Sets bump mapping. Type is <a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvBump.html"><CODE>PicaDataFragLightEnvBump</CODE></a>.</td>
190          </tr>
191          <tr>
192            <td width="100"> </td>
193            <th>
194<span class="argument">bumpSelector</span>
195            </th>
196<td width="100"><a href="../../../../nn_gx_CTR_Pica/PicaDataFragLightEnvTexture.html">PicaDataFragLightEnvTexture</a></td>
197<td>Sets textures to be used as normal maps and tangent maps. Type is <a href="../../../../nn/gr/CTR/PicaDataFragLightTexture.html"><CODE>PicaDataFragLightTexture</CODE></a>.</td>
198          </tr>
199          <tr>
200            <td width="100"> </td>
201            <th>
202<span class="argument">isEnableShadowPrimary</span>
203            </th>
204<td width="100">bool</td>
205<td>Sets whether shadow attenuation is to be applied to the primary color. Type is <CODE>bool</CODE>.</td>
206          </tr>
207          <tr>
208            <td width="100"> </td>
209            <th>
210<span class="argument">isEnableShadowSecondary</span>
211            </th>
212<td width="100">bool</td>
213<td>Sets whether shadow attenuation is to be applied to the secondary color. Type is <CODE>bool</CODE>.</td>
214          </tr>
215          <tr>
216            <td width="100"> </td>
217            <th>
218<span class="argument">isEnableShadowAlpha</span>
219            </th>
220<td width="100">bool</td>
221<td>Sets whether shadow attenuation is to be applied to the alpha component. Type is <CODE>bool</CODE>.</td>
222          </tr>
223          <tr>
224            <td width="100"> </td>
225            <th>
226<span class="argument">isInvertShadow</span>
227            </th>
228<td width="100">bool</td>
229<td>Sets whether shadow attenuation is to be inverted. Type is <CODE>bool</CODE>.</td>
230          </tr>
231          <tr>
232            <td width="100"> </td>
233            <th>
234<span class="argument">isEnableBumpRenorm</span>
235            </th>
236<td width="100">bool</td>
237<td>Sets whether the z-component of the normal map is to be regenerated. Type is <CODE>bool</CODE>.</td>
238          </tr>
239          <tr>
240            <td width="100"> </td>
241            <th>
242<span class="argument">isEnableClampHighLights</span>
243            </th>
244<td width="100">bool</td>
245<td>Sets whether the specular color is to be clamped to 0 when L.n is less than 0. Type is <CODE>bool</CODE>.</td>
246          </tr>
247          <tr>
248            <td width="100"> </td>
249            <th>
250<span class="argument">isEnableLutD0</span>
251            </th>
252<td width="100">bool</td>
253<td>If <CODE>true</CODE>, the lookup table value or 1 is set for Distribution 0. Type is <CODE>bool</CODE>. The initial value is <CODE>false</CODE>.</td>
254          </tr>
255          <tr>
256            <td width="100"> </td>
257            <th>
258<span class="argument">isEnableLutD1</span>
259            </th>
260<td width="100">bool</td>
261<td>If <CODE>true</CODE>, the lookup table value or 1 is set for Distribution 1. Type is <CODE>bool</CODE>. The initial value is <CODE>false</CODE>.</td>
262          </tr>
263          <tr>
264            <td width="100"> </td>
265            <th>
266<span class="argument">isEnableLutRefl</span>
267            </th>
268<td width="100">bool</td>
269<td>If <CODE>true</CODE>, the lookup table value or 1 is set for Reflection. Type is <CODE>bool</CODE>. The initial value is <CODE>true</CODE>.</td>
270          </tr>
271          <tr>
272            <td width="100"> </td>
273            <th>
274<span class="argument">lutConfigD0</span>
275            </th>
276<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
277<td>Sets lookup table Distribution 0. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
278          </tr>
279          <tr>
280            <td width="100"> </td>
281            <th>
282<span class="argument">lutConfigD1</span>
283            </th>
284<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
285<td>Sets lookup table Distribution 1. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
286          </tr>
287          <tr>
288            <td width="100"> </td>
289            <th>
290<span class="argument">lutConfigSP</span>
291            </th>
292<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
293<td>Sets lookup table Specular. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
294          </tr>
295          <tr>
296            <td width="100"> </td>
297            <th>
298<span class="argument">lutConfigFR</span>
299            </th>
300<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
301<td>Sets lookup table FragmentLight. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
302          </tr>
303          <tr>
304            <td width="100"> </td>
305            <th>
306<span class="argument">lutConfigRB</span>
307            </th>
308<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
309<td>Sets lookup table RB. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
310          </tr>
311          <tr>
312            <td width="100"> </td>
313            <th>
314<span class="argument">lutConfigRG</span>
315            </th>
316<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
317<td>Sets lookup table RG. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
318          </tr>
319          <tr>
320            <td width="100"> </td>
321            <th>
322<span class="argument">lutConfigRR</span>
323            </th>
324<td width="100"><a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">LutConfig</a></td>
325<td>Sets lookup table RR. Type is <CODE>nn::gr:CTR::<a href="../../../../nn/gr/CTR/FragmentLight/LutConfig/Overview.html">FragmentLight::LutConfig</a></CODE>.</td>
326          </tr> </table>
327      </div>
328    </a> <a name="function" id="function">
329<h2>Member Functions</h2>
330      <div class="section">
331        <table class="members">
332          <tr>
333            <td width="100">  </td>
334            <th>
335<a href="../../../../nn/gr/CTR/FragmentLight/FragmentLight.html"><CODE>FragmentLight</CODE></a>
336            </th>
337<td>Sets the initial value for each setting.</td>
338          </tr>
339          <tr>
340            <td width="100">  </td>
341            <th>
342<a href="../../../../nn/gr/CTR/FragmentLight/MakeLightSourceCommand.html"><CODE>MakeLightSourceCommand</CODE></a>
343            </th>
344<td>Generates a command for setting each light source for fragment lighting based on information already set.</td>
345          </tr>
346          <tr>
347            <td width="100">  </td>
348            <th>
349<a href="../../../../nn/gr/CTR/FragmentLight/MakeLightEnvCommand.html"><CODE>MakeLightEnvCommand</CODE></a>
350            </th>
351<td>Generates a command for setting the light environment for fragment lighting based on information already set.</td>
352          </tr>
353          <tr>
354            <td width="100">  </td>
355            <th>
356<a href="../../../../nn/gr/CTR/FragmentLight/MakeAllCommand.html"><CODE>MakeAllCommand</CODE></a>
357            </th>
358<td>Generates a command for setting fragment lighting based on information already set.</td>
359          </tr>
360          <tr>
361            <td width="100">
362<span class="static_style" title="static">S</span> </td>
363            <th>
364<a href="../../../../nn/gr/CTR/FragmentLight/MakeDisableCommand.html"><CODE>MakeDisableCommand</CODE></a>
365            </th>
366<td>Generates the minimum number of commands for disabling fragment lighting.</td>
367          </tr> </table>
368      </div>
369    </a>
370<h2>Revision History</h2>
371    <div class="section">
372      <dl class="history">
373        <dt>2010/09/15</dt>
374<dd>Initial version.<br />
375        </dd>
376      </dl>
377    </div>
378  <hr><p>CONFIDENTIAL</p></body>
379</html>
380