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
8    <LINK rel="stylesheet" href="./css/revolution.css" type="text/css">
9
10<TITLE>HBMDataInfo Structure</TITLE>
11<style type="text/css" media="all">
12<!--
13@import url("css/hbm_common.css");
14-->
15</style>
16</HEAD>
17<BODY>
18
19
20<H1>HBMDataInfo Structure</H1>
21
22<H2>Syntax</H2>
23<dl><dd><pre><code>
24#include &lt;revolution/hbm.h&gt;
25
26typedef struct
27{
28    void*               layoutBuf;
29    void*               spkSeBuf;
30    void*               msgBuf;
31    void*               configBuf;
32    void*               mem;
33    <A href="hbm_HBMSoundCallback.html">HBMSoundCallback</A>    sound_callback;
34    int                 backFlag;
35    int                 region;
36    int                 cursor;
37    int                 messageFlag;
38    u32                 configBufSize;
39    u32                 memSize;
40    f32                 frameDelta;
41    Vec2                adjust;
42    MEMAllocator*       pAllocator;
43} HBMDataInfo;
44</code></pre></dd></dl>
45
46<H2>Member</H2>
47<TABLE class="arguments">
48    <TR>
49<TH>layoutBuf</TH>
50<TD>Sets the start address of the memory buffer where the HOME Menu layout resource was loaded.</TD>
51    </TR>
52    <TR>
53<TH>spkSeBuf</TH>
54<TD>Sets the start address of the memory buffer where the sound resource for playing sounds from the Wii Remote speaker has been loaded.</TD>
55    </TR>
56    <TR>
57<TH>msgBuf</TH>
58<TD>Sets the start address of the memory buffer where the message resource for displaying messages in dialog boxes on the HOME Menu has been loaded.</TD>
59    </TR>
60    <TR>
61<TH>configBuf</TH>
62<TD>Sets the start address of the memory buffer where the button setup data for the HOME Menu has been loaded.</TD>
63    </TR>
64    <TR>
65<TH>mem</TH>
66<TD>When the memory allocator is created by the HBM library, be sure to set this member to the head address of a memory region whose size is greater than or equal to the value given by <SPAN class="argument">memSize</SPAN>.<BR>This value is ignored when a pointer to the memory allocator has been set in <SPAN class="argument"><CODE>pAllocator</CODE></SPAN>. <BR>
67    </TR>
68    <TR>
69<TH>sound_callback</TH>
70<TD>Sets the sound callback function when playing sound effects for an application. Set to NULL if you are not using a callback and the HBM library will play the sound effect.</TD>
71    </TR>
72    <TR>
73<TH>backFlag</TH>
74<TD>Specifies whether to fill the HOME Menu's background. If set to 0, the background is displayed as translucent; if set to 1, the background is filled.</TD>
75    </TR>
76    <TR>
77<TH>region</TH>
78<TD>Specifies the console's language setting. Be sure to set the return value of <CODE>SCGetLanguage()</CODE> in the SC library.</TD>
79    </TR>
80    <TR>
81<TH>cursor</TH>
82<TD>Must be set to zero.</TD>
83    </TR>
84    <TR>
85<TH>messageFlag</TH>
86<TD>Controls the dialog's save confirmation message (the WiiWare dialog message is the same). See <A href="hbm_HBMMSG_XXX.html"><CODE>HBMMSG_XXX</CODE></A> for more information.</TD>
87    </TR>
88    <TR>
89<TH>configBufSize</TH>
90<TD>Specifies the file size of the button configuration data (<CODE>config.txt</CODE>) for the HOME Menu.</TD>
91    </TR>
92    <TR>
93<TH>memSize</TH>
94<TD>When a memory allocator is created using the HBM library, the <A href="hbm_HBMCreate.html"><CODE>HBMCreate()</CODE></A> function sets the size of the heap region to be allocated. Be sure to set a sufficiently large value (<CODE>HBM_MEM_SIZE</CODE>). This value is ignored when a pointer to the memory allocator has been set in <SPAN class="argument"><CODE>pAllocator</CODE></SPAN>. <BR></TD>
95    </TR>
96    <TR>
97<TH>frameDelta</TH>
98<TD>Sets the playback speed for animations. Although it is usually set to <CODE>1.0f</CODE>, set it to <CODE>1.2f</CODE> when playing animation data created for NTSC (which displays at 60 frames/second) in an environment such as PAL50 (which displays at 50 frames/second).</TD>
99    </TR>
100    <TR>
101<TH>adjust</TH>
102<TD>Sets the aspect ratio adjustment factor. This value is used in drawing adjustment and controller correction.<BR><BR> When the aspect ratio is 4:3: <BR><CODE>adjust.x = 1.0f</CODE> <BR><CODE>adjust.y = 1.0f</CODE>.<BR><BR>When the aspect ratio is 16:9: <BR><CODE>adjust.x = 832.f / 608.f</CODE> <BR><CODE>adjust.y = 1.0f</CODE>.<br><BR>These values are fixed, regardless of the frame buffer resolution or VI value. <BR></TD>
103    </TR>
104    <TR>
105<TH>pAllocator</TH>
106<TD>Specifies a pointer to the memory allocator when the allocation of memory is controlled by the application. <BR>When leaving the creation of the memory allocator up to the HBM library, be sure to set NULL. <BR>
107        </TD>
108    </TR>
109</TABLE>
110
111<H2>Description</H2>
112<P>
113This structure stores setting information for the HOME Menu.
114</P>
115
116<H2>See Also</H2>
117<p>
118<code><A href="hbm_HBMCreate.html">HBMCreate</A></code>
119</P>
120
121<H2>Revision History</H2>
122<DL class="history">
123<DT>2008/04/28<DD>Added a description of <CODE>messageFlag</CODE>.
124<DT>2007/10/26<DD>Revised the header explanation.
125<DT>2007/05/09<DD>Revised the description for the SDK version.
126<DT>2007/02/14<DD>Added <SPAN class="argument">configBufSize</SPAN>.
127<DT>2007/01/30<DD>Added a description of <SPAN class="argument">adjust</SPAN>.
128<DT>2006/10/19<DD>Added <SPAN class="argument">messageFlag</SPAN>.
129<DT>2006/10/02<DD>Changed <SPAN class="argument">callback</SPAN> to <SPAN class="argument">sound_callback</SPAN>. <!--<SPAN class="argument">event_callback</SPAN> ? <SPAN class="argument">pAllocator</SPAN> ???-->
130<DT>2006/09/25<DD>Initial version.
131</DL>
132
133<hr><p>CONFIDENTIAL</p></body>
134</HTML>