1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>NANDBanner</title>
9</head>
10
11<body>
12
13<h1>NANDBanner</h1>
14
15<h2>C Specification</h2>
16<dl><dd>
17<pre><code>
18#include &lt;revolution/nand.h&gt;
19
20typedef struct
21{
22    u32 signature;            // Signature: 0x5749424E
23
24    u32 flag;                 // Flags
25    u16 iconSpeed;            // Icon animation speed
26    u8  reserved[22];         // for 32B align
27
28    u16 comment[2][NAND_BANNER_COMMENT_SIZE];    // title and comment
29    u8  bannerTexture[NAND_BANNER_TEXTURE_SIZE]; // Banner texture
30    u8  iconTexture[8][NAND_BANNER_ICON_SIZE];   // Icon texture 0-7
31} NANDBanner;
32
33</code></pre>
34</dd></dl>
35
36<H2>Description</H2>
37<p>
38The <CODE>NANDBanner</CODE> structure is used for storing banner information for the save file. If you are going to save application data, <font color=#ff0000>first create the required group of files and directories, and only after that</font> save the banner data in the home directory, using the file name <code>banner.bin</code>. If <code>banner.bin</code> does not exist, the Wii Menu deletes the save data. To prevent unexpected occurrences and the deletion of files, do not create any states where <code>banner.bin</code> does not exist.
39</p>
40<p>
41The only texture format that can be used is RGB5A3. The preparation of a banner texture is required.  For details, see <I>Guidelines For Creating Wii Save Data</I>. You can also look at the sample demo program <I>banner</I>, which shows the procedure for saving a banner as a file.
42</p>
43<p>
44Although the number of characters allocated for the comment string  (<code>comment</code>) is <I>two lines times the number of characters given by <code>NAND_BANNER_COMMENT_SIZE</code></I>, the number of characters whose display on the Wii Menu is guaranteed equals 20. Be sure to pad with NULL all characters after the 21st.
45</p>
46
47<h2>See Also</h2>
48<p>
49<code><a href="./NANDInitBanner.html">NANDInitBanner</a></code>, <code><a href="./NANDGetIconSpeed.html">NANDGetIconSpeed</a></code>, <code><a href="./NANDSetIconSpeed.html">NANDSetIconSpeed</a></code>, <a href="./sampledemos/demos.html">Sample demo programs</a>
50</p>
51
52<H2>Revision History</H2>
53<p>
542007/05/09 Added information about the restriction on the number of characters in the <CODE>comment</CODE> string set for the banner file.<br>2006/11/30 Corrected the procedure for creating banner files.<br>2006/09/19 Initial version. <BR>
55</p>
56
57</body>
58</html>
59