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