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>PreloadSheet</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>::PreloadSheet</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool PreloadSheet(
15     <a href="../../../nw/font/CharCode.html">CharCode</a> c
16);
17</pre>
18    </div>
19    <h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25            <th>Name</th>
26            <td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30          <td>in</td>
31          <th>c</th>
32          <td>Character code indicating the glyph included on the sheet to be loaded.</td>
33        </tr> </table>
34    </div>
35    <h2>Return Values</h2>
36    <div class="section">Returns <CODE>TRUE</CODE> if the sheet was newly cached by this function; returns <CODE>FALSE</CODE> if it had already been cached. </div>
37    <h2>Description</h2>
38    <div class="section">
39      <p>Loads a sheet into cache in advance.</p><p>Loads the sheet containing the glyph specified with <CODE>c</CODE> into cache. Normally, this function does not need to be called because the sheet required for the glyph is cached by the <CODE><a href="../../../nw/font/PackedFont/GetGlyph.html">nw::font::PackedFont::GetGlyph</a></CODE>function. However, because it takes time to expand a sheet, it may be possible to reduce the load at rendering time by using this function to cache the sheet in advance.<br /> There is a caveat, though: You must pay attention to the number of caches, which can be obtained with the <a href="../../../nw/font/PackedFont/GetNumCache.html"><CODE>nw::font::PackedFont::GetNumCache</a></CODE> function. The reason is that even if you attempt to cache in advance more than the number of caches, the sheets that were first cached will be discarded. </p><p>In general, when there are insufficient caches, the very last cache to have been used is destroyed. When this function is called, the cache it touches is considered to have been used even if this function returns <CODE>FALSE</CODE>, indicating that the sheet was already cached.</p></div>
40    <h2>See Also</h2>
41    <div class="section">
42      <p class="reference"><a href="../../../nw/font/PackedFont/GetNumCache.html">nw::font::PackedFont::GetNumCache</a><br /> </p>
43    </div>
44    <h2>Revision History</h2>
45    <div class="section">
46      <dl class="history">
47        <dt>2009/11/09</dt>
48        <dd>Initial version.<br />
49        </dd>
50      </dl>
51    </div>
52  <hr><p>CONFIDENTIAL</p></body>
53</html>
54