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>SetReceiving</title>
8  </head>
9  <body>
10<h1><CODE>nn::y2r::CTR::SetReceiving</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14void SetReceiving(
15     void * pDst,
16     size_t imageSize,
17     s16 transferUnit,
18     s16 transferStride = 0
19);
20</pre>
21    </div>
22<h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>pDst</th>
35<td>Image data transfer destination.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>imageSize</th>
40<td>Specifies the total size of the data to transfer. This must be an integer multiple of <SPAN class="argument">transferUnit</SPAN>.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>transferUnit</th>
45<td>Specifies the size of a single transfer. To increase performance, we recommend setting a size equivalent to 8 lines.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>transferStride</th>
50<td>Specifies an offset value (separate from <SPAN class="argument">transferUnit</SPAN>) to add to the transfer destination address for each individual transfer. If you want to add an offset per each individual line, you must specify a size equivalent to 1 line for <SPAN class="argument">transferUnit</SPAN>.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54    <div class="section">
55None.
56               </div>
57<h2>Description</h2>
58    <div class="section">
59<p>Configures loading of RGB data. The actual transfer operation takes place after <CODE>StartConversion</CODE> is called.</p><p>
60You must use this function to configure the transfer before you start converting data with the <CODE>StartConversion</CODE> function.
61          </p></div>
62<h2>Revision History</h2>
63    <div class="section">
64      <dl class="history">
65        <dt>2010/09/24</dt>
66<dd>Explained when transfer settings must be made.
67        </dd>
68        <dt>2010/02/02</dt>
69<dd>Initial version.<br />
70        </dd>
71      </dl>
72    </div>
73  <hr><p>CONFIDENTIAL</p></body>
74</html>