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>StreamingConstruct</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/font/Overview.html">font</a>::<a href="../../../nw/font/PackedFont/Overview.html">PackedFont</a>::StreamingConstruct</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nw/font/ArchiveFontBase/ConstructResult.html">ConstructResult</a> StreamingConstruct(
15     <a href="../../../nw/font/ArchiveFontBase/ConstructContext/Overview.html">ConstructContext</a> * pContext,
16     const void*         stream,
17     <span>u32</span> streamSize
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>out</td>
33          <th>pContext</th>
34          <td>Pointer to the streaming construct context initialized with <a href="../../../nw/font/PackedFont/InitStreamingConstruct.html">InitStreamingConstruct()</a>.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>stream</th>
39          <td>Pointer to the buffer storing a portion of the archive font.</td>
40        </tr>
41        <tr>
42          <td>in</td>
43          <th>streamSize</th>
44          <td>Number of bytes of data stored in the buffer pointed to by <emphasis>stream</emphasis>.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">Returns the progress of the construct process. </div>
49    <h2>Description</h2>
50    <div class="section">
51      <p>Constructs a font from successive loads from the archive font.</p><p>In <span class="argument">stream</span>, specify a pointer to a portion of the archive font loaded into memory; in <span class="argument">streamSize</span>, specify the portion's size. As long as the portions of the specified archive font are in order from the start, there are no restrictions on size or cycles.</p><p>By using the <CODE><a href="../../../nw/font/PackedFont/InitStreamingConstruct.html">nw::font::PackedFont::InitStreamingConstruct</a></CODE> function and the <CODE>StreamingConstruct </CODE> function as a pair, you can build a font from a DVD or NAND using only a small read buffer.   To construct the font, first initialize the streaming construct context with the <CODE><a href="../../../nw/font/PackedFont/InitStreamingConstruct.html">nw::font::PackedFont::InitStreamingConstruct</a></CODE> function, then call the <CODE>StreamingConstruct</CODE> function each time data is obtained from DVD or NAND. </p><p>If the entire archive font can be read into memory, you can use the simpler <CODE><a href="../../../nw/font/PackedFont/Construct.html">nw::font::PackedFont::Construct</a></CODE> function.</p><p>ConstructResult, the type for the return value, is defined as follows.</p><pre>
52enum ConstructResult
53{
54    CONSTRUCT_MORE_DATA,    // Subsequent data is required to construct the font.
55    CONSTRUCT_FINISH,       // The construct process completed normally.
56    CONSTRUCT_ERROR,        // An error was generated during the construct process.
57    CONSTRUCT_CONTINUE,     // Used internally. This is never used as a return value.
58    NUM_OF_CONSTRUCT_RESULT
59};
60</pre></div>
61    <h2>Revision History</h2>
62    <div class="section">
63      <dl class="history">
64        <dt>2009/11/09</dt>
65        <dd>Initial version.<br />
66        </dd>
67      </dl>
68    </div>
69  <hr><p>CONFIDENTIAL</p></body>
70</html>
71