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