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>GetDstBufferSize</title>
8  </head>
9  <body>
10<h1><CODE>nn::jpeg::CTR::JpegMpDecoder::GetDstBufferSize</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/jpeg.h&gt;
14
15static size_t GetDstBufferSize(
16     u32 maxWidth,
17     u32 maxHeight,
18     <a href="../../../../nn/jpeg/CTR/PixelFormat.html">PixelFormat</a> dstPixelFormat
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>maxWidth</th>
35<td>Specifies the maximum width (in pixels) of an image that can be decoded. (Up to 65536) <br />Specifies the maximum decoded width (after shrinking) when shrinking and decoding using the <CODE><a href="../../../../nn/jpeg/CTR/JpegMpDecoder/StartJpegDecoderShrink.html">StartJpegDecoderShrink</a></CODE> function. <br />Specify a larger value in this function if the width of the output image buffer is being specified by the <CODE><a href="../../../../nn/jpeg/CTR/JpegMpDecoder/SetOutputBufferWidth.html">SetOutputBufferWidth</a></CODE> function.<br />You can also specify an even larger value.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>maxHeight</th>
40<td>Specifies the maximum height (in pixels) of an image that can be decoded. (Up to 65536) <br />Specifies the maximum decoded height (after shrinking) when shrinking and decoding. You can also specify an even larger value.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>dstPixelFormat</th>
45<td>Specifies the pixel format in which to store the image.<br />When the format has been specified as <CODE>PIXEL_FORMAT_CTR_RGB565_BLOCK8</CODE>, <CODE>PIXEL_FORMAT_CTR_RGB8_BLOCK8</CODE>, or <CODE>PIXEL_FORMAT_CTR_RGBA8_BLOCK8</CODE>, round up the values for <CODE>maxWidth</CODE> and <CODE>maxHeight</CODE> to the nearest multiple of 8 when calculating the buffer size in bytes. For <CODE>PIXEL_FORMAT_YUYV8</CODE>, round up <SPAN class="argument">maxWidth</SPAN> to the nearest multiple of 2 when calculating the buffer size.</td>
46        </tr> </table>
47    </div>
48<h2>Return Values</h2>
49<div class="section">Returns the size (in bytes) of the buffer where the decoded results will be stored.<br />Returns <CODE>0</CODE> to indicate an error if the arguments are invalid or if the number of bytes exceeds the range defined by the <CODE>size_t</CODE> type. </div>
50<h2>Description</h2>
51    <div class="section">
52<p>Calculates the number of bytes in the buffer where the decoded JPEG results (one image's worth) will be stored.</p><p>The application must handle the allocation and deallocation of the buffer.</p><p>Depending on the pixel format in which to store the data (<SPAN class="argument">dstPixelFormat</SPAN>), the buffer image size is sometimes rounded up larger than the maximum allowed decodable image size (<SPAN class="argument">maxWidth</SPAN> and <SPAN class="argument">maxHeight</SPAN>).</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>