/Users/hercules/trunk/SDL-1.2/include/SDL_joystick.h File Reference

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Defines
Hat Positions
The return value of SDL_JoystickGetHat() is one of the following positions:
#define	SDL_HAT_CENTERED   0x00
#define	SDL_HAT_UP   0x01
#define	SDL_HAT_RIGHT   0x02
#define	SDL_HAT_DOWN   0x04
#define	SDL_HAT_LEFT   0x08
#define	SDL_HAT_RIGHTUP   (SDL_HAT_RIGHT|SDL_HAT_UP)
#define	SDL_HAT_RIGHTDOWN   (SDL_HAT_RIGHT|SDL_HAT_DOWN)
#define	SDL_HAT_LEFTUP   (SDL_HAT_LEFT|SDL_HAT_UP)
#define	SDL_HAT_LEFTDOWN   (SDL_HAT_LEFT|SDL_HAT_DOWN)
Typedefs
typedef struct _SDL_Joystick	SDL_Joystick
Functions
DECLSPEC int SDLCALL	SDL_NumJoysticks (void)
DECLSPEC const char *SDLCALL	SDL_JoystickName (int device_index)
DECLSPEC SDL_Joystick *SDLCALL	SDL_JoystickOpen (int device_index)
DECLSPEC int SDLCALL	SDL_JoystickOpened (int device_index)
DECLSPEC int SDLCALL	SDL_JoystickIndex (SDL_Joystick *joystick)
DECLSPEC int SDLCALL	SDL_JoystickNumAxes (SDL_Joystick *joystick)
DECLSPEC int SDLCALL	SDL_JoystickNumBalls (SDL_Joystick *joystick)
DECLSPEC int SDLCALL	SDL_JoystickNumHats (SDL_Joystick *joystick)
DECLSPEC int SDLCALL	SDL_JoystickNumButtons (SDL_Joystick *joystick)
DECLSPEC void SDLCALL	SDL_JoystickUpdate (void)
DECLSPEC int SDLCALL	SDL_JoystickEventState (int state)
DECLSPEC Sint16 SDLCALL	SDL_JoystickGetAxis (SDL_Joystick *joystick, int axis)
DECLSPEC Uint8 SDLCALL	SDL_JoystickGetHat (SDL_Joystick *joystick, int hat)
DECLSPEC int SDLCALL	SDL_JoystickGetBall (SDL_Joystick *joystick, int ball, int *dx, int *dy)
DECLSPEC Uint8 SDLCALL	SDL_JoystickGetButton (SDL_Joystick *joystick, int button)
DECLSPEC void SDLCALL	SDL_JoystickClose (SDL_Joystick *joystick)

---

Detailed Description

Include file for SDL joystick event handling

Note:

In order to use these functions, SDL_Init() must have been called with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system for joysticks, and load appropriate drivers.

---

Function Documentation

DECLSPEC void SDLCALL SDL_JoystickClose

(

SDL_Joystick *

joystick

)

Close a joystick previously opened with SDL_JoystickOpen()

DECLSPEC int SDLCALL SDL_JoystickEventState

(

int

state

)

Enable/disable joystick event polling.

If joystick events are disabled, you must call SDL_JoystickUpdate() yourself and check the state of the joystick when you want joystick information.

Parameters:

[in]

state

The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE.

DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis	(	SDL_Joystick *	joystick,
		int	axis
	)

Get the current state of an axis control on a joystick

Parameters:

[in]

axis

The axis indices start at index 0.

Returns:

The state is a value ranging from -32768 to 32767.

DECLSPEC int SDLCALL SDL_JoystickGetBall	(	SDL_Joystick *	joystick,
		int	ball,
		int *	dx,
		int *	dy
	)

Get the ball axis change since the last poll

Parameters:

[in]

ball

The ball indices start at index 0.

Returns:

This returns 0, or -1 if you passed it invalid parameters.

DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton	(	SDL_Joystick *	joystick,
		int	button
	)

Get the current state of a button on a joystick

Parameters:

[in]

button

The button indices start at index 0.

DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat	(	SDL_Joystick *	joystick,
		int	hat
	)

Get the current state of a POV hat on a joystick

Parameters:

[in]

hat

The hat indices start at index 0.

DECLSPEC int SDLCALL SDL_JoystickIndex

(

SDL_Joystick *

joystick

)

Get the device index of an opened joystick.

DECLSPEC const char* SDLCALL SDL_JoystickName

(

int

device_index

)

Get the implementation dependent name of a joystick.

This can be called before any joysticks are opened. If no name can be found, this function returns NULL.

DECLSPEC int SDLCALL SDL_JoystickNumAxes

(

SDL_Joystick *

joystick

)

Get the number of general axis controls on a joystick

DECLSPEC int SDLCALL SDL_JoystickNumBalls

(

SDL_Joystick *

joystick

)

Get the number of trackballs on a joystick

Joystick trackballs have only relative motion events associated with them and their state cannot be polled.

DECLSPEC int SDLCALL SDL_JoystickNumButtons

(

SDL_Joystick *

joystick

)

Get the number of buttons on a joystick

DECLSPEC int SDLCALL SDL_JoystickNumHats

(

SDL_Joystick *

joystick

)

Get the number of POV hats on a joystick

DECLSPEC SDL_Joystick* SDLCALL SDL_JoystickOpen

(

int

device_index

)

Open a joystick for use.

Parameters:

[in]

device_index

The index passed as an argument refers to the N'th joystick on the system. This index is the value which will identify this joystick in future joystick events.

Returns:

This function returns a joystick identifier, or NULL if an error occurred.

DECLSPEC int SDLCALL SDL_JoystickOpened

(

int

device_index

)

Returns 1 if the joystick has been opened, or 0 if it has not.

DECLSPEC void SDLCALL SDL_JoystickUpdate

(

void

)

Update the current state of the open joysticks.

This is called automatically by the event loop if any joystick events are enabled.

DECLSPEC int SDLCALL SDL_NumJoysticks

(

void

)

Count the number of joysticks attached to the system