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