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>SetTrimmingParams</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/camera/Overview.html">camera</a>::<a href="../../../nn/camera/CTR/Overview.html">CTR</a>::SetTrimmingParams</CODE> Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14void SetTrimmingParams(
15     <a href="../../../nn/camera/CTR/Port.html">Port</a> port,
16     <a href="../../../nn_types/s16.html">s16</a> xStart,
17     <a href="../../../nn_types/s16.html">s16</a> yStart,
18     <a href="../../../nn_types/s16.html">s16</a> xEnd,
19     <a href="../../../nn_types/s16.html">s16</a> yEnd
20);
21</pre>
22    </div>
23    <h2>Parameters</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>port</th>
36          <td>Specifies which port to change settings for.</td>
37        </tr>
38        <tr>
39          <td>in</td>
40          <th>xStart</th>
41          <td>Starting position for trimming (x-coordinate)</td>
42        </tr>
43        <tr>
44          <td>in</td>
45          <th>yStart</th>
46          <td>Starting position for trimming (y-coordinate)</td>
47        </tr>
48        <tr>
49          <td>in</td>
50          <th>xEnd</th>
51          <td>Ending position for trimming (x-coordinate)</td>
52        </tr>
53        <tr>
54          <td>in</td>
55          <th>yEnd</th>
56          <td>Ending position for trimming (y-coordinate)</td>
57        </tr> </table>
58    </div>
59    <h2>Return Values</h2>
60    <div class="section">
61                None.
62               </div>
63    <h2>Description</h2>
64    <div class="section">
65      <p>Sets the positions to which to trim.</p><p>The following restrictions apply to the values that can be set:<br />• The trimming range is from (<SPAN class="argument">xStart</SPAN>, <SPAN class="argument">yStart</SPAN>) to (<SPAN class="argument">xEnd</SPAN>-1, <SPAN class="argument">yEnd</SPAN>-1).<br /> • The values of (<SPAN class="argument">xEnd</SPAN> - <SPAN class="argument">xStart</SPAN>) and (<SPAN class="argument">yEnd</SPAN> - <SPAN class="argument">yStart</SPAN>) must both be even numbers.<br /> • The values of <SPAN class="argument">xStart</SPAN> and <SPAN class="argument">yStart</SPAN> must also be even numbers.</p><P>
66                To use this function, you must first enable trimming with the <CODE><a href="../../../nn/camera/CTR/SetTrimming.html">nn::camera::CTR::SetTrimming</a></CODE> function.
67            </P><P>
68                This function does not set any value if it is called during image capture (while the <CODE><a href="../../../nn/camera/CTR/IsBusy.html">nn::camera::CTR::IsBusy</a></CODE> function returns <CODE>true</CODE>). If you wish to change the setting, do not call this function until you have used the <CODE><a href="../../../nn/camera/CTR/StopCapture.html">nn::camera::CTR::StopCapture</a></CODE> function to stop capturing and then waited for the <CODE><a href="../../../nn/camera/CTR/IsBusy.html">nn::camera::CTR::IsBusy</a></CODE> function's return value to change to <CODE>false</CODE>.
69            </P></div>
70    <h2>Revision History</h2>
71    <div class="section">
72      <dl class="history">
73        <dt>2010/06/18</dt>
74        <dd>Explained that settings cannot be applied while capturing.<br />
75        </dd>
76        <dt>2010/04/09</dt>
77        <dd>Added description text.<br />
78        </dd>
79        <dt>2010/01/07</dt>
80        <dd>Initial version.<br />
81        </dd>
82      </dl>
83    </div>
84  <hr><p>CONFIDENTIAL</p></body>
85</html>