PAlib: PA_BgLargeMap.h File Reference

Main Page | Modules | File List | Globals | Search for

# PA_BgLargeMap.h File Reference

Everything concerning the Background LargeMap System. More...

Go to the source code of this file.

## Defines

#define | PA_LoadLargeBg(screen, bg_select, bg_tiles, bg_map, color_mode, lx, ly)
| Completely load and initialise a background with infinite scrolling (usefull if larger or wider than 512 pixels)
#define | PA_LoadPAGfxLargeBg(screen, bg_number, bg_name)
| Completely load and initialise a background with infinite scrolling (usefull if larger or wider than 512 pixels), converted with PAGfx
#define | PA_LoadLargeBgEx(screen, bg_select, bg_tiles, tile_size, bg_map, color_mode, lx, ly)
| Completely load and initialise a background with infinite scrolling (usefull if larger or wider than 512 pixels), but here you can put yourself the tile size...

## Functions

void | PA_InfLargeScrollX (u8 screen, u8 bg_select, s32 x)
| Scroll a large infinite scrolling background horizontaly. It must have been initialised with PA_LoadLargeBg.
void | PA_InfLargeScrollY (u8 screen, u8 bg_select, s32 y)
| Scroll a large infinite scrolling background vertically. It must have been initialised with PA_LoadLargeBg.
void | PA_InfLargeScrollXY (u8 screen, u8 bg_select, s32 x, s32 y)
| Scroll a large infinite scrolling background horizontaly and vertically. It must have been initialised with PA_LoadLargeBg.
void | PA_LargeScrollX (u8 screen, u8 bg_select, s32 x)
| Scroll a large background horizontaly. It must have been initialised with PA_LoadLargeBg. This function does not wrap around, but is faster than the InfLargeScroll...
void | PA_LargeScrollY (u8 screen, u8 bg_select, s32 y)
| Scroll a large background vertically. It must have been initialised with PA_LoadLargeBg. This function does not wrap around, but is faster than the InfLargeScroll...
void | PA_LargeScrollXY (u8 screen, u8 bg_select, s32 x, s32 y)
| Scroll a large background horizontaly and vertically. It must have been initialised with PA_LoadLargeBg. This function does not wrap around, but is faster than the InfLargeScroll...
void | PA_InitParallaxX (u8 screen, s32 bg0, s32 bg1, s32 bg2, s32 bg3)
| Initialise Parallax Scrolling for multiple backgrounds, horizontaly. Chose the speed at which each background will scroll compared to the others. Then use PA_ParallaxScrollX to scroll...
void | PA_InitParallaxY (u8 screen, s32 bg0, s32 bg1, s32 bg2, s32 bg3)
| Initialise Parallax Scrolling for multiple backgrounds, horizontaly. Chose the speed at which each background will scroll compared to the others. Then use PA_ParallaxScrollX to scroll...
void | PA_ParallaxScrollX (u8 screen, s32 x)
| Scroll the backgrounds
void | PA_ParallaxScrollY (u8 screen, s32 y)
| Scroll the backgrounds
void | PA_ParallaxScrollXY (u8 screen, s32 x, s32 y)
| Scroll the backgrounds
void | PA_InitLargeBg (u8 screen, u8 bg_select, s32 lx, s32 ly, void *bg_map)

## Detailed Description

Everything concerning the Background LargeMap System.

This file contains all the macros and variables regarding LargeMaps (> 512x512)