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>Initialize</title>
8  </head>
9  <body>
10<h1><CODE>nn::jpeg::CTR::JpegMpEncoder::Initialize</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/jpeg.h&gt;
14
15bool Initialize(
16     void * workBuffer,
17     size_t workBufferSize,
18     u32 numImages = 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>out</td>
34<th>workBuffer</th>
35<td>Specifies the work buffer for the encoder object. Must be 4-byte aligned.<br />The buffer size is calculated by <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/GetWorkBufferSize.html">GetWorkBufferSize</a></CODE>. Each encoder object requires its own work buffer.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>workBufferSize</th>
40<td>Specifies the size of the buffer in bytes. Specify the return value of <a href="../../../../nn/jpeg/CTR/JpegMpDecoder/GetWorkBufferSize.html"><CODE>GetWorkBufferSize</CODE></a>.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>numImages</th>
45<td>Specifies the number of images to store in MP format.<br />Specify a value either equal to or less than the value that was specified when <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/GetWorkBufferSize.html">GetWorkBufferSize</a></CODE> was called.<br />The default value is <CODE>0</CODE>.</td>
46        </tr> </table>
47    </div>
48<h2>Return Values</h2>
49<div class="section">Returns <CODE>true</CODE> on success. Returns <CODE>false</CODE> on failure. Check the alignment of <SPAN class="argument">workBuffer</SPAN> and the other arguments. </div>
50<h2>Description</h2>
51    <div class="section">
52<p>Initializes the encoder object.</p><p>It also initializes the work buffer for the encoder object.</p><p>After initializing once there is no need to initialize again until after finalization, so long as the number of images stored in MP format does not change. As long as the <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderNext.html">StartMpEncoderNext</a></CODE> function has been called, initializing again causes no problems.</p><!-- write here --></div>
53<h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/04/14</dt>
57<dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>