include/nds/arm9/PA_BgLargeMap.h File Reference

Everything concerning the Background LargeMap System. More...

#include "PA_BgTiles.h"

Defines

#define PA_TileNumber(x, y)   (PA_Modulo((x)+1, 36)+(PA_Modulo((y)+1, 28)*36))
#define PA_LoadTileEngine(screen, bg_select, bg_tiles)
#define INF_JUSTTILE   268435455
#define MAX_TILES   1024
#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_InfTilesScrollX (u8 screen, u8 bg_select, s32 x)
void PA_InfTilesScrollY (u8 screen, u8 bg_select, s32 y)
void PA_InfLargeScrollXN (u8 screen, u8 bg_select, s32 x)
void PA_InfLargeScrollYN (u8 screen, u8 bg_select, s32 y)
void PA_LargeScrollXN (u8 screen, u8 bg_select, s32 x)
void PA_LargeScrollYN (u8 screen, u8 bg_select, s32 y)
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)


Define Documentation

#define INF_JUSTTILE   268435455

#define MAX_TILES   1024

#define PA_LoadTileEngine ( screen,
bg_select,
bg_tiles   ) 

Value:

{\
PA_DeleteBg(screen, bg_select);\
PA_LoadBgTilesEx(screen, bg_select, (void*)Blank, (1008<<5));\
PA_BgInfo[screen][bg_select].Tiles = (void*)bg_tiles;\
PA_LoadBgMap(screen, bg_select, Blank, BG_512X256); \
PA_InitBg(screen, bg_select, BG_512X256, 0, 1);\
PA_BGScrollXY(screen, bg_select, 0, 0);}

#define PA_TileNumber ( x,
 )     (PA_Modulo((x)+1, 36)+(PA_Modulo((y)+1, 28)*36))


Function Documentation

void PA_InfLargeScrollXN ( u8  screen,
u8  bg_select,
s32  x 
)

void PA_InfLargeScrollYN ( u8  screen,
u8  bg_select,
s32  y 
)

void PA_InfTilesScrollX ( u8  screen,
u8  bg_select,
s32  x 
)

void PA_InfTilesScrollY ( u8  screen,
u8  bg_select,
s32  y 
)

void PA_InitLargeBg ( u8  screen,
u8  bg_select,
s32  lx,
s32  ly,
void *  bg_map 
)

void PA_LargeScrollXN ( u8  screen,
u8  bg_select,
s32  x 
)

void PA_LargeScrollYN ( u8  screen,
u8  bg_select,
s32  y 
)


Generated on Sat Jun 13 12:55:13 2009 for PAlib - Programmer's Arsenal by  doxygen 1.5.8