General Functions


Defines

#define PA_LidClosed()   (PA_IPC_compat->buttons>>7)
 Check if the DS is closed. Returns 0 if open, 1 if closed.
#define PA_CloseLidSound(close_sound)
 Check if the DS is closed. If closed, it pauses the DS, and plays a sound.
#define PA_CloseLidSound2(close_sound, open_sound)
 Check if the DS is closed. If closed, it pauses the DS, and plays a sound. The sound system must be initialized before.
#define PA_WaitFor(something)   {PA_WaitForVBL(); while(!(something)){PA_WaitForVBL(); }}
 Wait for a specific thing to happen...

Functions

void PA_Init (void)
 Initialise the library. Must be used at the beginning or main().
void PA_Init2D (void)
 Resets to 2D state after using 3D functions.
void PA_SetVideoMode (u8 screen, u8 mode)
 Change the video mode... Use this with caution.
void PA_UpdateUserInfo (void)
 Updates the user info. This is automatically done in PA_Init. You can then get any info with the following variables : PA_UserInfo.Color (favorite color), .BdayDay, .BdayMonth, .AlarmHour, .AlarmMinute, .Name, .NameLength, .Message, .MessageLength, .Language.
void PA_UpdateRTC (void)
 Updates the Real Time Clock, with info on the current date and hour. Automatically updated in the PA VBL... Get the info with PA_RTC.Minutes, .Hour, .Seconds, .Day, .Month, and .Year.
void PA_SwitchScreens (void)
 Switch the bottom and top screens...
void PA_SetAutoCheckLid (u8 on)
 Automatically check if the DS is closed in PA_WaitForVBL.
u8 PA_CheckLid (void)
 Check if the DS is closed. If closed, it pauses the DS, and returns 1.
void PA_WaitForVBL (void)
 Wait for the VBlank to occur.
void PA_SetScreenLight (u8 screen, u8 light)
 Set on or off the screen's light.
void PA_SetLedBlink (u8 blink, u8 speed)
 Set teh DS Led blinking.
void PA_SetDSLBrightness (u8 level)
 Set the DS Lite Light level...
bool PA_Locate (char *start, char *target, bool isDir, int depth, char *result)
 Find a directory in the file system within a given depth.

Variables

u8 PA_ExtPal [2][2]

Detailed Description

Initialise the lib, and other general functions...

Define Documentation

#define PA_CloseLidSound ( close_sound   ) 

Value:

{\
                        if(PA_LidClosed()){\
                                PA_PlaySimpleSound(close_sound);\
                                PA_CheckLid(); \
                        }}
Check if the DS is closed. If closed, it pauses the DS, and plays a sound.

Parameters:
close_sound Sound to play, check the sounds doc if you're not sure what to do here

#define PA_CloseLidSound2 ( close_sound,
open_sound   ) 

Value:

{\
                        if(PA_LidClosed()){\
                                PA_PlaySimpleSound(close_sound);\
                                PA_CheckLid(); \
                                PA_PlaySimpleSound(open_sound); \
                        }}
Check if the DS is closed. If closed, it pauses the DS, and plays a sound. The sound system must be initialized before.

Parameters:
close_sound Sound to play when closes, check the sounds doc if you're not sure what to do here
open_sound Sound to play when opens, check the sounds doc if you're not sure what to do here

 
#define PA_LidClosed (  )     (PA_IPC_compat->buttons>>7)

Check if the DS is closed. Returns 0 if open, 1 if closed.

#define PA_WaitFor ( something   )     {PA_WaitForVBL(); while(!(something)){PA_WaitForVBL(); }}

Wait for a specific thing to happen...

Parameters:
something Thing to wait for, like Pad.Newpress.A, or Stylus.Newpress, etc...


Function Documentation

inline u8 PA_CheckLid ( void   )  [inline]

Check if the DS is closed. If closed, it pauses the DS, and returns 1.

void PA_Init ( void   ) 

Initialise the library. Must be used at the beginning or main().

void PA_Init2D ( void   ) 

Resets to 2D state after using 3D functions.

bool PA_Locate ( char *  start,
char *  target,
bool  isDir,
int  depth,
char *  result 
)

Find a directory in the file system within a given depth.

Parameters:
start from which directory to start, use "/" to search from the root
target what to look for: the name of a file or directory
isDir look for a directory or a file?
depth how much depth level (in number of directories) to traverse; limiting this speeds up the search on crowded cards. A reasonable value is, for example, 3.
result pointer to a buffer where the result will be stored
Returns:
true if the target was found

inline void PA_SetAutoCheckLid ( u8  on  )  [inline]

Automatically check if the DS is closed in PA_WaitForVBL.

Parameters:
on 1 for on, 0 for off

inline void PA_SetDSLBrightness ( u8  level  )  [inline]

Set the DS Lite Light level...

Parameters:
level Light level (0-3)

inline void PA_SetLedBlink ( u8  blink,
u8  speed 
) [inline]

Set teh DS Led blinking.

Parameters:
blink 1 for blinking, 0 for always on
speed Speed : 0 for slow, 1 for fast

void PA_SetScreenLight ( u8  screen,
u8  light 
) [inline]

Set on or off the screen's light.

Parameters:
screen Screen...
light Light, 1 for on, 0 for off

inline void PA_SetVideoMode ( u8  screen,
u8  mode 
)

Change the video mode... Use this with caution.

Parameters:
screen Screen...
mode Mode 0 for normal, 1 for 1 rotating backgrounds, 2 for 2

inline void PA_SwitchScreens ( void   )  [inline]

Switch the bottom and top screens...

void PA_UpdateRTC ( void   ) 

Updates the Real Time Clock, with info on the current date and hour. Automatically updated in the PA VBL... Get the info with PA_RTC.Minutes, .Hour, .Seconds, .Day, .Month, and .Year.

void PA_UpdateUserInfo ( void   ) 

Updates the user info. This is automatically done in PA_Init. You can then get any info with the following variables : PA_UserInfo.Color (favorite color), .BdayDay, .BdayMonth, .AlarmHour, .AlarmMinute, .Name, .NameLength, .Message, .MessageLength, .Language.

void PA_WaitForVBL ( void   )  [inline]

Wait for the VBlank to occur.


Variable Documentation

u8 PA_ExtPal[2][2]


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