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>SetInputBufferWidth</title>
8  </head>
9  <body>
10<h1><CODE>nn::jpeg::CTR::JpegMpEncoder::SetInputBufferWidth</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/jpeg.h&gt;
14
15void SetInputBufferWidth(
16     u32 width
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>width</th>
33<td>Specifies the width (in pixels) of the input image buffer.<br />Specify <CODE>0</CODE> to give priority to the value specified in the encoding function over this value.<br />Any value specified in excess of <CODE>MAX_ENCODER_INPUT_BUFFER_WIDTH</CODE> (65536) is ignored.</td>
34        </tr> </table>
35    </div>
36<h2>Return Values</h2>
37    <div class="section">
38None.
39               </div>
40<h2>Description</h2>
41    <div class="section">
42<p>Sets the width of the input image buffer.</p><p>Use this function when the image buffer (for example, the GPU texture buffer) has a larger image width than the image you want to encode.</p><p>If you specify the image width of the input image buffer, the encoding function processes the input buffer starting from the left and discards any area beyond the specified width. When creating a thumbnail to add, the scaling-down operation is likewise carried out after cropping in this way.</p><p>Call this function before calling the encoding function. The values specified by this function are cleared after the encoding function completes, regardless of whether the encoding function succeeded or failed. When encoding multiple times, you must call this function before each encoding function call. The values specified by this function are also cleared if you specify <CODE>0</CODE> for the <SPAN class="argument">width</SPAN> argument, or if you reinitialize the encoder object using the <a href="../../../../nn/jpeg/CTR/JpegMpEncoder/Initialize.html"><CODE>Initialize</CODE></a> function.</p><p>If the image width specified by the encoding function is larger than the value specified in this function, the encoding function value takes priority.</p><p>The <SPAN class="argument">width</SPAN> argument has the following restrictions depending on the input pixel format specified in the encoding function. (When encoding, round down to these respective multiples.) <br /> Must be a multiple of 2 when the format is <CODE>PIXEL_FORMAT_YUYV8</CODE>. Must be a multiple of 8 for the formats <CODE>PIXEL_FORMAT_CTR_RGB565_BLOCK8</CODE>, <CODE>PIXEL_FORMAT_CTR_RGB8_BLOCK8</CODE> or <CODE>PIXEL_FORMAT_CTR_RGBA8_BLOCK8</CODE>.</p><!-- write here --></div>
43<h2>Revision History</h2>
44    <div class="section">
45      <dl class="history">
46        <dt>2010/06/14</dt>
47<dd>Initial version.<br />
48        </dd>
49      </dl>
50    </div>
51  <hr><p>CONFIDENTIAL</p></body>
52</html>