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>Syntax</h2>
16<dl><dd><pre class="construction">
17#include &lt;revolution/nand.h&gt;
18
19typedef struct
20{
21    u32 signature;            // Signature: 0x5749424E
22
23    u32 flag;                 // Flags
24    u16 iconSpeed;            // Icon animation speed
25    u8  reserved[22];         // for 32B align
26
27    u16 comment[2][NAND_BANNER_COMMENT_SIZE];    // title and comment
28    u8  bannerTexture[NAND_BANNER_TEXTURE_SIZE]; // Banner texture
29    u8  iconTexture[8][NAND_BANNER_ICON_SIZE];   // Icon texture 0-7
30} NANDBanner;
31</pre></dd></dl>
32
33<H2>Description</H2>
34<p>
35The <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 filename <code>banner.bin</code>. If <code>banner.bin</code> does not exist, the Wii Menu deletes the save data. In order to prevent deletion of files due to unexpected circumstances, do not create any states where <code>banner.bin</code> does not exist.
36</p>
37<p>
38The only texture format that can be used is RGB5A3. The preparation of a banner texture is required. Details about this process can be read in <I>Guidelines For Creating Wii Save Data</I>. You can also look at the sample demo program <CODE>banner</CODE>, which shows the procedure for saving a banner as a file.
39</p>
40<p>
41Two lines with <code>NAND_BANNER_COMMENT_SIZE</code> characters each have been allocated for the comment string (<SPAN class="argument">comment</SPAN>). However, the Wii Menu is only guaranteed to display 20 characters. All characters after the 20th must always be filled in with <CODE>NULL</CODE>.
42</p>
43
44<h2>See Also</h2>
45<p class="reference">
46<a href="./NANDInitBanner.html">NANDInitBanner</a>,
47<a href="./NANDGetIconSpeed.html">NANDGetIconSpeed</a>,
48<a href="./NANDSetIconSpeed.html">NANDSetIconSpeed</a>,
49<a href="./sampledemos/demos.html">Sample Demos</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 <SPAN class="argument">comment</SPAN> 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<hr><p>CONFIDENTIAL</p></body>
58</html>
59