The SGADE Documentation

The Socrates Gameboy Advance Development Engine

The SGADE is a development library for the Nintendo Gameboy Advance. It's free for all uses and is distributed without guarantees. For more information visit the SGADE page.

Main Page Modules Data Structures File List Data Fields Globals Related Pages

SoMultiPlayer.h File Reference

#include "SoSystem.h"

Go to the source code of this file.

Defines

#define SO_MULTI_PLAYER_PACKET_TRANSFER_SIZE

Number of 16 bit transfers in a single packet.

#define SO_MULTIPLAYER_FRAME_RATE

Frame rate at which you want each packet transfer to be complete.

#define SO_MULTI_PLAYER_9600_BPS

Baud rate: 9600 bps.

#define SO_MULTI_PLAYER_38400_BPS

Baud rate: 38400 bps.

#define SO_MULTI_PLAYER_57600_BPS

Baud rate: 57600 bps.

#define SO_MULTI_PLAYER_115200_BPS

Baud rate: 115200 bps.

Typedefs

typedef bool(* SoMultiPlayerFailureCallback )(void)

Callback routine that is called whenever something is wrong with the communication.

Functions

void SoMultiPlayerInitialize (void)

Initializes the multi player system;.

bool SoMultiPlayerStart (u32 a_BaudRate, u32 a_NumPlayers)

Starts a multiplayer session.

void SoMultiPlayerStop (void)

Stops the current multiplayer s_Session.

void SoMultiPlayerUpdate (u16 a_OutGoingPacket[SO_MULTI_PLAYER_PACKET_TRANSFER_SIZE], u16 a_IncomingPackets[4][SO_MULTI_PLAYER_PACKET_TRANSFER_SIZE])

Just call this every frame to handle all communication.

void SoMultiPlayerSetFailureCallback (SoMultiPlayerFailureCallback a_FailureCallback)

Sets the callback routine that is called whenever something is wrong with the communication either during setup, or during communication.

u32 SoMultiPlayerGetNumPlayers (void)

Returns the number of players in this s_Session.

u32 SoMultiPlayerGetID (void)

Returns the ID of this GBA in a multiplayer session.

Detailed Description

Author:: Jaap Suter

Date:: March 7 2002

See the SoMultiPlayer module for more information.


Defines
#define	SO_MULTI_PLAYER_PACKET_TRANSFER_SIZE
	Number of 16 bit transfers in a single packet.
#define	SO_MULTIPLAYER_FRAME_RATE
	Frame rate at which you want each packet transfer to be complete.
#define	SO_MULTI_PLAYER_9600_BPS
	Baud rate: 9600 bps.
#define	SO_MULTI_PLAYER_38400_BPS
	Baud rate: 38400 bps.
#define	SO_MULTI_PLAYER_57600_BPS
	Baud rate: 57600 bps.
#define	SO_MULTI_PLAYER_115200_BPS
	Baud rate: 115200 bps.
Typedefs
typedef bool(*	SoMultiPlayerFailureCallback )(void)
	Callback routine that is called whenever something is wrong with the communication.
Functions
void	SoMultiPlayerInitialize (void)
	Initializes the multi player system;.
bool	SoMultiPlayerStart (u32 a_BaudRate, u32 a_NumPlayers)
	Starts a multiplayer session.
void	SoMultiPlayerStop (void)
	Stops the current multiplayer s_Session.
void	SoMultiPlayerUpdate (u16 a_OutGoingPacket[SO_MULTI_PLAYER_PACKET_TRANSFER_SIZE], u16 a_IncomingPackets[4][SO_MULTI_PLAYER_PACKET_TRANSFER_SIZE])
	Just call this every frame to handle all communication.
void	SoMultiPlayerSetFailureCallback (SoMultiPlayerFailureCallback a_FailureCallback)
	Sets the callback routine that is called whenever something is wrong with the communication either during setup, or during communication.
u32	SoMultiPlayerGetNumPlayers (void)
	Returns the number of players in this s_Session.
u32	SoMultiPlayerGetID (void)
	Returns the ID of this GBA in a multiplayer session.