Keyboard


Defines

#define PA_InitCustomKeyboard(bg_number, keyb_custom)
 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_InitKeyboard (u8 bg_number)
 Initialise the Keyboard on a given background. Uses 16 color palettes 14 and 15 (doesn't mix with text though, don't worry).
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).
void PA_ScrollKeyboardX (s16 x)
 Set the Keyboard's X position.
void PA_ScrollKeyboardY (s16 y)
 Set the Keyboard's Y position.
void PA_ScrollKeyboardXY (s16 x, s16 y)
 Set the Keyboard's position.
void PA_KeyboardIn (s16 x, s16 y)
 Make the keyboard enter to position (x, y), scrolling from the bottom of the screen.
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.
void PA_SetKeyboardColor (u8 color1, u8 color2)
 You can change the color used by the keyboard...
void PA_SetKeyboardScreen (u8 screen)
 Set Keyboard screen. Must be used BEFORE the keyboard init..

Detailed Description

Load a keyboard and have fun

Define Documentation

 
#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).

#define PA_InitCustomKeyboard ( bg_number,
keyb_custom   ) 

Value:

{\
        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);\
        Keyboard.Bg = bg_number;        Keyboard.Type = 0;      Keyboard.Repeat = 0;    Keyboard.Custom = 1;\
        PA_BgInfo[keyb_screen][Keyboard.Bg].Map = (u32)keyb_custom##_Map;\
}
Initialise a custom Keyboard on a given background.

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


Function Documentation

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).

void PA_InitKeyboard ( u8  bg_number  ) 

Initialise the 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)

inline void PA_KeyboardIn ( s16  x,
s16  y 
) [inline]

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

Parameters:
x X position...
y Y position...

inline void PA_KeyboardOut ( void   )  [inline]

Make the keyboard scroll out.

void PA_ReloadKeyboardCol ( void   ) 

Reloads the keyboard's palette, usefull if you changed the background palette.

inline void PA_ScrollKeyboardX ( s16  x  )  [inline]

Set the Keyboard's X position.

Parameters:
x X position...

inline void PA_ScrollKeyboardXY ( s16  x,
s16  y 
) [inline]

Set the Keyboard's position.

Parameters:
x X position...
y Y position...

inline void PA_ScrollKeyboardY ( s16  y  )  [inline]

Set the Keyboard's Y position.

Parameters:
y Y position...

inline void PA_SetKeyboardColor ( u8  color1,
u8  color2 
) [inline]

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

inline void PA_SetKeyboardScreen ( u8  screen  )  [inline]

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

Parameters:
screen 0 (bottom) or 1 (top)


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