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>SetMpTypeFlags</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/jpeg/Overview.html">jpeg</a>::<a href="../../../../nn/jpeg/CTR/Overview.html">CTR</a>::<a href="../../../../nn/jpeg/CTR/JpegMpEncoder/Overview.html">JpegMpEncoder</a>::SetMpTypeFlags</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/jpeg.h&gt;
14
15void SetMpTypeFlags(
16     <a href="../../../../nn_types/u32.html">u32</a> flags = 0,
17     <a href="../../../../nn_types/u16.html">u16</a> image1 = 0,
18     <a href="../../../../nn_types/u16.html">u16</a> image2 = 0
19);
20</pre>
21    </div>
22<h2>Parameters</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>flags</th>
35<td>Specify either a single <a href="../../../../nn/jpeg/CTR/MpTypeFlag.html"><CODE>MpTypeFlag</CODE></a> or a bitwise OR of them. It is also possible to specify <CODE>0</CODE>.<br />If a representative image already exists, then <CODE>MP_TYPE_FLAG_REPRESENTATIVE_IMAGE</CODE> (the representative image flag) is ignored even if it is set.<br />The default value is <CODE>0</CODE>.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>image1</th>
40<td>Specifies the entry number for dependent image 1. The default value is <CODE>0</CODE>.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>image2</th>
45<td>Specifies the entry number for dependent image 2. The default value is <CODE>0</CODE>.</td>
46        </tr> </table>
47    </div>
48<h2>Return Values</h2>
49    <div class="section">
50None.
51               </div>
52<h2>Description</h2>
53    <div class="section">
54<p>Registers values to embed in the MP entry: the various flags for the individual image type management data and the dependent image entry numbers.</p><p>This function is enabled if the <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderFirst.html">StartMpEncoderFirst</a></CODE> or <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderNext.html">StartMpEncoderNext</a></CODE> function is used as the encoding function. This is invalid when using <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderLR.html">StartMpEncoderLR</a></CODE>. (The default value is registered.)</p><p>Of the individual image type management information fields, you can specify the <I>dependent parent image flag</I>, the <I>dependent child image flag</I>, and the <I>representative image flag</I>. Of the other fields, the <I>reserved</I> (<CODE>0</CODE>) and <I>data format</I> (<CODE>0: JPEG</CODE>) fields are fixed by the library and cannot be specified. The <I>type code</I> is specified by the <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderFirst.html">StartMpEncoderFirst</a></CODE> function.</p><p>You can skip this function and still use the <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderFirst.html">StartMpEncoderFirst</a></CODE> and <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderNext.html">StartMpEncoderNext</a></CODE> functions without any problems. By default the dependent parent image flag and dependent child image flag are cleared to <CODE>0</CODE>, with the representative image flag set to <CODE>1</CODE> for the starting image only and cleared to <CODE>0</CODE> for all others.</p><p>In more detail, the default behavior is as follows.</p><p><OL> <LI> <BR><BR>1. If you skip this function and use <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderFirst.html">StartMpEncoderFirst</a></CODE>, this image (the starting image) becomes the representative image (meaning its representative image flag is set to <CODE>1</CODE>).<LI> 2. If you skip this function and use <CODE><a href="../../../../nn/jpeg/CTR/JpegMpEncoder/StartMpEncoderNext.html">StartMpEncoderNext</a></CODE>, and if no representative image yet exists, this image becomes the representative image. If a representative image does exist, the representative image flag for this image is cleared to <CODE>0</CODE>.</LI></OL></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 cleared if you reinitialize the encoder object using the <a href="../../../../nn/jpeg/CTR/JpegMpEncoder/Initialize.html"><CODE>Initialize</CODE></a> function.</p><!-- write here --></div>
55<h2>Revision History</h2>
56    <div class="section">
57      <dl class="history">
58        <dt>2010/06/14</dt>
59<dd>Initial version.<br />
60        </dd>
61      </dl>
62    </div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>
65