1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
7<TITLE>FNTStreamingConstruct</TITLE>
8</HEAD>
9<BODY>
10<H1>FNTStreamingConstruct</H1>
11
12<H2>Syntax</H2>
13<dl><dd><pre class="construction">
14#include &lt;revolution/fnt.h&gt;
15
16<A href="FNTConstructResult.html">FNTConstructResult</A> FNTStreamingConstruct(
17    <A href="FNTHeader.html">FNTHeader</A>* font,
18    void* stream,
19    u32 streamSize);
20</pre></dd></dl>
21
22<H2>Arguments</H2>
23<TABLE class="arguments" border="1" >
24  <TBODY>
25    <TR>
26<TH>font</TH>
27<TD>Pointer to the font data buffer.<BR>The buffer must be of the size obtained by the function <A href="FNTGetDataSize.html"><CODE>FNTGetDataSize</CODE></A>.<BR>Must be 32-byte aligned.</TD>
28    </TR>
29    <TR>
30<TH>stream</TH>
31<TD>Pointer to the buffer storing a portion of the font resource.<BR>Must be 32-byte aligned.</TD>
32    </TR>
33    <TR>
34<TH>streamSize</TH>
35<TD>Number of bytes of data stored in the buffer indicated by <SPAN class="argument">stream</SPAN>.</TD>
36    </TR>
37  </TBODY>
38</TABLE>
39
40<H2>Return Values</H2>
41<P>Returns the progress status of the expansion process.</P>
42
43<H2>Description</H2>
44<P>Reads the font resource in order and expands the data.</P>
45<P>Specify the pointer to the portion of the font resource loaded into memory and its size in <SPAN class="argument">stream</SPAN> and <SPAN class="argument">streamSize</SPAN>. As long as the portions of the specified font resource are in order from the start, there are no restrictions on size or cycles.<P>
46<P>By using the <A href="FNTInitStreamingConstruct.html"><CODE>FNTInitStreamingConstruct</CODE></A> and <CODE>FNTStreamingConstruct</CODE> functions as a pair, a font can be expanded from the disc or NAND with only a small read buffer. To expand the font, first initialize with the <A href="FNTInitStreamingConstruct.html"><CODE>FNTInitStreamingConstruct</CODE></A> function and then make subsequent calls to the <CODE>FNTStreamingConstruct</CODE> function each time data is obtained from the disc or NAND.</P>
47<P>When loading the entire font resource into memory, the simpler <A href="FNTConstruct.html"><CODE>FNTConstruct</CODE></A> function can be used.</P>
48
49<H2>See Also</H2>
50<P class="reference">
51<A href="FNTGetDataSize.html">FNTGetDataSize</A>,
52<A href="FNTInitStreamingConstruct.html">FNTInitStreamingConstruct</A>,
53<A href="FNTConstruct.html">FNTConstruct</A>
54</P>
55
56<H2>Revision History</H2>
57<P>
582006/10/01 Initial version.<BR>
59</P>
60
61<hr><p>CONFIDENTIAL</p></body>
62</HTML>