HBMDataInfo Structure

Syntax


#include <revolution/hbm.h>

typedef struct
{
    void*               layoutBuf;
    void*               spkSeBuf;
    void*               msgBuf;
    void*               configBuf;
    void*               mem;
    HBMSoundCallback    sound_callback;
    int                 backFlag;
    int                 region;
    int                 cursor;
    int                 messageFlag;
    u32                 configBufSize;
    u32                 memSize;
    f32                 frameDelta;
    Vec2                adjust;
    MEMAllocator*       pAllocator;
} HBMDataInfo;

Members

layoutBuf Sets the start address of the memory buffer where the HOME Menu layout resource was loaded.
spkSeBuf Sets the start address of the memory buffer where the sound resource for playing sounds from the Wii Remote speaker has been loaded.
msgBuf 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.
configBuf Sets the start address of the memory buffer where the button setup data for the HOME Menu has been loaded.
mem 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 memSize.
This value is ignored when a pointer to the memory allocator has been set in pAllocator.
sound_callback 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.
backFlag 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.
region Specifies the console's language setting. Be sure to set the return value of SCGetLanguage in the SC library.
cursor Must be set to zero.
messageFlag Controls the dialog's save confirmation message (the WiiWare dialog message is the same). See HBMMSG_XXX for more information.
configBufSize Specifies the file size of the button configuration data (config.txt) for the HOME Menu.
memSize When a memory allocator is created using the HBM library, the HBMCreate function sets the size of the heap region to be allocated. Be sure to set a sufficiently large value (HBM_MEM_SIZE). This value is ignored when a pointer to the memory allocator has been set in pAllocator.
frameDelta Sets the playback speed for animations. Although it is usually set to 1.0f, set it to 1.2f 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). Note: Adjust the playback rate here even in cases where the game's frame rate has been changed.
adjust Sets the aspect ratio adjustment factor. This value is used in drawing adjustment and controller correction.

When the screen aspect ratio is 4:3, the result is adjust.x = 1.0f and adjust.y = 1.0f. When the aspect ratio is 16:9:
adjust.x = 832.f / 608.f
adjust.y = 1.0f.

These values are fixed, regardless of the frame buffer resolution or VI value.
pAllocator Specifies a pointer to the memory allocator when the allocation of memory is controlled by the application.
When leaving the creation of the memory allocator up to the HBM library, be sure to set NULL.

Description

This structure stores setting information for the HOME Menu.

See Also

HBMCreate

Revision History

2008/09/24
Added a description of frameDelta.
2008/04/28
Added a description of messageFlag.
2007/10/26
Revised the header explanation.
2007/05/09
Revised the description for the SDK version.
2007/02/14
Added configBufSize.
2007/01/30
Added a description of adjust.
2006/10/19
Added messageFlag.
2006/10/02
Changed callback to sound_callback.
2006/09/25
Initial version.

CONFIDENTIAL