Sub-Banners: Overview

Description

The TWL launcher displays application banners, but also displays separate banners, called "sub-banners," in addition to those specified in ROM specification file.
A NAND application can overwrite sub-banners, which makes it possible to implement a banner image that changes as the game progresses. However, you cannot change the game title in the banner.

If a sub-banner exits, the launcher gives priority to it and displays it. Otherwise, the launcher displays the normal banner. This has the same behavior in the Software Management screen in System Settings.

Because a sub-banner is a NAND file, once set, it is saved in that state, even if the power is turned off, and is always displayed unless it is unset.

To create a sub-banner file, prepare a BSF file set with graphic data output by bannercvtr, graphic data output by ntexconv and a banner comment. In makebanner.TWL, you can create a sub-banner by specifying the -s option.
For information on creating an ordinary banner, see Banner: Overview.

Only NAND applications can use sub-banners. Card applications cannot use them.

Implementation in Applications

Sub-banners can be used if TRUE is specified for SubBannerFile of the RSF file in the ROM specification file.

   #  ROM SPEC FILE

AppendProperty
{
    ....
    #
    # Enable SubBannerFile
    SubBannerFile    TRUE
}

Use NA_SaveSubBanner to display a sub-banner. If NA_SaveSubBanner is successful, a sub-banner is displayed. Use NA_DeleteSubBanner to hide a sub-banner.

You can dynamically create sub-banners in a program. Edit the anime member of the NASubBanner structure. Use NA_MakeSubBannerHeader to set the header member. See NASubBanner for information on the sub-banner structure.

Use NA_LoadSubBanner to get the sub-banner that is currently set.

See Also

NA Function List: Sub-Banners
NAND Application Sample Demo
Banner: Overview

Revision History

2009/03/10 Corrected method to create sub-banner.
2008/10/30 Mentioned that this can be overwritten by NAND applications.
2008/09/26 Added information about the Software Management screen.
2008/09/25 Added links to the RSF and banner overview.
2008/09/16 Initial version.

CONFIDENTIAL