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<title>SetAutoWhiteBalanceWindow</title>
8  </head>
9  <body>
10<h1><CODE>nn::camera::CTR::SetAutoWhiteBalanceWindow</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> SetAutoWhiteBalanceWindow(
15     <a href="../../../nn/camera/CTR/CameraSelect.html">CameraSelect</a> select,
16     s16 startX,
17     s16 startY,
18     s16 width ,
19     s16 height
20);
21</pre>
22    </div>
23<h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th>select</th>
36<td>Specifies which camera to change settings for.</td>
37        </tr>
38        <tr>
39<td>in</td>
40<th><SPAN class="argument">startX</SPAN></th>
41<td>Specifies the x-coordinate of the region's upper-left corner. If the x-coordinate of the image's upper-left corner is defined as 0, this argument can be specified in 40-pixel increments in the range [0, 600].</td>
42        </tr>
43        <tr>
44<td>in</td>
45<th><SPAN class="argument">startY</SPAN></th>
46<td>Specifies the y-coordinate of the region's upper-left corner. If the y-coordinate of the image's upper-left corner is defined as 0, this argument can be specified in 30-pixel increments in the range [0, 450].</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>width</th>
51<td>Specifies the region's width. This can be specified in 40-pixel increments in the range [40, 640]. The sum of this value and <SPAN class="argument">startX</SPAN> must be no larger than 640.</td>
52        </tr>
53        <tr>
54<td>in</td>
55<th>height</th>
56<td>Specifies the region's height. This can be specified in 30-pixel increments in the range [30, 480]. The sum of this value and <SPAN class="argument">startY</SPAN> must be no larger than 480.</td>
57        </tr> </table>
58    </div>
59<h2>Return Values</h2>
60<div class="section">Returns the function's execution result. Returns one of the <a href="../../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
61      <table class="arguments">
62        <thead>
63          <tr>
64<th>Value</th>
65<td>Description</td>
66          </tr>
67        </thead>
68        <tr>
69<th><CODE>ResultSuccess</CODE></th>
70<td>Process was successful.</td>
71        </tr>
72        <tr>
73<th><CODE>ResultIsSleeping</CODE></th>
74<td>Unusable because the system is closed.</td>
75        </tr>
76        <tr>
77<th><CODE>ResultFatalError</CODE></th>
78<td>There may be something physically wrong with the camera.</td>
79        </tr>
80      </table> </div>
81<h2>Description</h2>
82    <div class="section">
83<p>Sets the region within the view to use as the basis for calculating auto white balance (the response frame).</p><p>
84The rectangular region specified by <SPAN class="argument">startX</SPAN>, <SPAN class="argument">startY</SPAN>, <SPAN class="argument">width</SPAN>, and <SPAN class="argument">height</SPAN> must be no larger than 640x480.
85            </p><p>
86All cameras share the following default values.
87</p><table><tr><th><SPAN class="argument">startX</SPAN></th><td>0</td></tr><tr><th><SPAN class="argument">startY</SPAN></th><td>0</td></tr><tr><th><SPAN class="argument">width</SPAN></th><td>640</td></tr><tr><th><SPAN class="argument">height</SPAN></th><td>480</td></tr></table><p>
88Although the cameras only use the response frame that can be set by this function when auto white balance is enabled, you can set the response frame with this function even when auto white balance is disabled. You must therefore specify appropriate values when you call this function even if auto white balance is disabled.
89</p><p><B>Note:</B> This function may block for an extended period if a camera is restarting.</p></div>
90<h2>Revision History</h2>
91    <div class="section">
92      <dl class="history">
93        <dt>2010/12/13</dt>
94<dd>Mentioned that this function can set values even when auto white balance is disabled.
95        </dd>
96        <dt>2010/12/07</dt>
97<dd>Fixed errors in the description of the range for the <SPAN class="argument">width</SPAN> and <SPAN class="argument">height</SPAN> values.
98        </dd>
99        <dt>2010/09/13</dt>
100<dd>Initial version.<br />
101        </dd>
102      </dl>
103    </div>
104  <hr><p>CONFIDENTIAL</p></body>
105</html>