Keyboard

Macros
#define	PA_InitKeyboard   PA_LoadDefaultKeyboard
	Old name for PA_LoadDefaultKeyboard().
#define	PA_InitCustomKeyboard(bg_number, keyb_custom)
	[DEPRECATED] Initialise a custom Keyboard on a given background.
#define	PA_EraseLastKey()   PA_SetLetterPal(PA_Keyboard_Struct.oldX, PA_Keyboard_Struct.oldY, 15)
	Erase the last key lit up (if it didn't on it's own)

Functions
void	PA_LoadDefaultKeyboard (u8 bg_number)
	Initialise the default Keyboard on a given background. Uses 16 color palettes 14 and 15 (doesn't mix with text though, don't worry)
void	PA_LoadKeyboard (u8 bg_number, const PA_BgStruct *keyboard)
	Load a custom Keyboard on a given background.
char	PA_CheckKeyboard (void)
	Checks if the keyboard is used, and return the letter :) Use this every turn (even if the stylus isn't pressed)
static void	PA_ScrollKeyboardX (s16 x)
	Set the Keyboard's X position
static void	PA_ScrollKeyboardY (s16 y)
	Set the Keyboard's Y position
static void	PA_ScrollKeyboardXY (s16 x, s16 y)
	Set the Keyboard's position
static void	PA_KeyboardIn (s16 x, s16 y)
	Make the keyboard enter to position (x, y), scrolling from the bottom of the screen
static void	PA_KeyboardOut (void)
	Make the keyboard scroll out.
void	PA_ReloadKeyboardCol (void)
	Reloads the keyboard's palette, usefull if you changed the background palette.
static void	PA_SetKeyboardColor (u8 color1, u8 color2)
	You can change the color used by the keyboard...
static void	PA_SetKeyboardScreen (u8 screen)
	Set Keyboard screen. Must be used BEFORE the keyboard init..

Detailed Description

Load a keyboard and have fun

Macro Definition Documentation

PA_InitCustomKeyboard

#define PA_InitCustomKeyboard	(		bg_number,
			keyb_custom
	)

Value:

    do{\
    PA_DEPRECATED_MACRO;\
    PA_LoadBgPal(keyb_screen, bg_number, (void*)keyb_custom##_Pal);\
    PA_LoadSimpleBg(keyb_screen, bg_number, keyb_custom##_Tiles, keyb_custom##_Map, BG_256X512, 1, 1);\
    PA_Keyboard_Struct.Bg = bg_number;  PA_Keyboard_Struct.Type = 0;    PA_Keyboard_Struct.Repeat = 0;\
    PA_Keyboard_Struct.Custom = 1;\
    PA_BgInfo[keyb_screen][PA_Keyboard_Struct.Bg].Map = (u32)keyb_custom##_Map;\
}while(0)

[DEPRECATED] Initialise a custom Keyboard on a given background.

Deprecated:

Parameters

bg_number	Background number (0-3)
keyb_custom	Custom Keyboard name, converted as EasyBg

Function Documentation

PA_LoadDefaultKeyboard()

void PA_LoadDefaultKeyboard

(

u8

bg_number

)

Initialise the default Keyboard on a given background. Uses 16 color palettes 14 and 15 (doesn't mix with text though, don't worry)

Parameters

bg_number

Background number (0-3)

PA_LoadKeyboard()

void PA_LoadKeyboard	(	u8	bg_number,
		const PA_BgStruct *	keyboard
	)

Load a custom Keyboard on a given background.

Parameters

bg_number	Background number (0-3)
keyboard	Pointer to the keyboard background, converted as EasyBg

PA_ScrollKeyboardX()

static inline void PA_ScrollKeyboardX ( s16  x )

inlinestatic

Set the Keyboard's X position

Parameters

x	X position...

PA_ScrollKeyboardY()

static inline void PA_ScrollKeyboardY ( s16  y )

inlinestatic

Set the Keyboard's Y position

Parameters

y	Y position...

PA_ScrollKeyboardXY()

static inline void PA_ScrollKeyboardXY ( s16  x, s16  y  )

inlinestatic

Set the Keyboard's position

Parameters

x	X position...
y	Y position...

PA_KeyboardIn()

static inline void PA_KeyboardIn ( s16  x, s16  y  )

inlinestatic

Make the keyboard enter to position (x, y), scrolling from the bottom of the screen

Parameters

x	X position...
y	Y position...

PA_SetKeyboardColor()

static inline void PA_SetKeyboardColor ( u8  color1, u8  color2  )

inlinestatic

You can change the color used by the keyboard...

Parameters

color1	Normal color, 0 for blue, 1 for red, 2 for green
color2	Pressed key color, 0 for blue, 1 for red, 2 for green

PA_SetKeyboardScreen()

static inline void PA_SetKeyboardScreen ( u8  screen )

inlinestatic

Set Keyboard screen. Must be used BEFORE the keyboard init..

Parameters

screen

0 (bottom) or 1 (top)