#define HEL_SUBSYSTEM_SPLASH_REQUIREDMEMORY |
Required memory for the Splash-Screen System.
This define represents the amount of memory, specified in bytes, the Splash-Screen System from HEL requires to manage its internal states. When you initialize the Splash-Screen System, you must pass a buffer which equals the size of HEL_SUBSYSTEM_SPLASH_REQUIREDMEMORY.
void hel_Splash | ( | const void * | pBitmap, | |
const u16 * | pPalette, | |||
u16 | InBlendColor, | |||
u16 | OutBlendColor, | |||
u32 | BlendDelay, | |||
u32 | DisplayDelay, | |||
u32 | ContinueDelay, | |||
u32 | CompressionType, | |||
u32 | Flags | |||
) |
Display a Splash Screen.
The hel_Splash function can be used to display a splash screen in bitmap mode 4. It blends from from the color specified by InBlendColor
to the image specified by pBitmap
, waits a bit and then blends out the image to the color specified by OutBlendColor
.
[in] | pBitmap | Pointer to image data. The image must be 240x160 pixels. |
[in] | pPalette | Pointer to palette data. |
[in] | InBlendColor | The color in bgr555 format from which the image blends in. See Generic Palette Functions. |
[in] | OutBlendColor | The color in bgr555 format from which the image blends out. See Generic Palette Functions. |
[in] | BlendDelay | Milliseconds to wait between blending. |
[in] | DisplayDelay | Milliseconds to display the image. |
ContinueDelay | Milliseconds to wait after the image has been blended out. | |
[in] | CompressionType | Must be one of the COMPRESSION_TYPE_ ... values. For a complete listing, refer to BIOS Functions section. |
Flags | Flags can be used to turn on various options. This might be key presses which trigger the splash screen to quit, or to display the screen until a key press occurred. For a list of supported flags, please see Splash-Screen Flags |
void hel_SplashInit | ( | void * | pBuffer | ) |
Initialize Splash-Screen System.
The hel_SplashInit function must be called before using any Splash-Screen function, otherwise the program behaviour is undefined.
[in] | pBuffer | Must point to a buffer of at least HEL_SUBSYSTEM_SPLASH_REQUIREDMEMORY allocated bytes. The buffer must be word-aligned and should be located in EWRAM. It must not be changed after initialization as long as the Splash-Screen System is running. |
// Allocate memory for Splash-Screen System u8 ATTR_EWRAM ATTR_ALIGNED(4) g_SplashScreenSystemBuffer[HEL_SUBSYSTEM_SPLASH_REQUIREDMEMORY]; int main(void) { // Initialize Splash-Screen System hel_SplashInit((void*)g_SplashScreenSystemBuffer); // Display Splash-Screen hel_Splash(...) // Uninitialize Splash-Screen System hel_SplashQuit(); }
void hel_SplashQuit | ( | ) |
Uninitialize Splash-Screen System.
The hel_SplashQuit function uninitializes the Splash-Screen System.