My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Typedefs | Enumerations | Functions
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.

Classes

struct  SDL_JoystickGUID
 

Macros

Hat 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
 
typedef Sint32 SDL_JoystickID
 

Enumerations

enum  SDL_JoystickPowerLevel {
  SDL_JOYSTICK_POWER_UNKNOWN = -1, SDL_JOYSTICK_POWER_EMPTY, SDL_JOYSTICK_POWER_LOW, SDL_JOYSTICK_POWER_MEDIUM,
  SDL_JOYSTICK_POWER_FULL, SDL_JOYSTICK_POWER_WIRED, SDL_JOYSTICK_POWER_MAX
}
 

Functions

DECLSPEC int SDLCALL SDL_NumJoysticks (void)
 
DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex (int device_index)
 
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen (int device_index)
 
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID (SDL_JoystickID joyid)
 
DECLSPEC const char *SDLCALL SDL_JoystickName (SDL_Joystick *joystick)
 
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID (int device_index)
 
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID (SDL_Joystick *joystick)
 
DECLSPEC void SDLCALL SDL_JoystickGetGUIDString (SDL_JoystickGUID guid, char *pszGUID, int cbGUID)
 
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString (const char *pchGUID)
 
DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached (SDL_Joystick *joystick)
 
DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID (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)
 
DECLSPEC
SDL_JoystickPowerLevel SDLCALL 
SDL_JoystickCurrentPowerLevel (SDL_Joystick *joystick)
 

Detailed Description

Include file for SDL joystick event handling

The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks, with the exact joystick behind a device_index changing as joysticks are plugged and unplugged.

The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.

The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of the device (a X360 wired controller for example). This identifier is platform dependent.

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.

If you would like to receive joystick updates while the application is in the background, you should set the following hint before calling SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS

Function Documentation

DECLSPEC void SDLCALL SDL_JoystickClose ( SDL_Joystick *  joystick)

Close a joystick previously opened with SDL_JoystickOpen().

DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel ( SDL_Joystick *  joystick)

Return the battery level of this joystick

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.

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

DECLSPEC SDL_Joystick* SDLCALL SDL_JoystickFromInstanceID ( SDL_JoystickID  joyid)

Return the SDL_Joystick associated with an instance id.

DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached ( SDL_Joystick *  joystick)

Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.

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

Get the current state of an axis control on a joystick.

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

The axis indices start at index 0.

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

Get the ball axis change since the last poll.

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

The ball indices start at index 0.

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

Get the current state of a button on a joystick.

The button indices start at index 0.

DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID ( int  device_index)

Return the GUID for the joystick at this index

DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID ( SDL_Joystick *  joystick)

Return the GUID for this opened joystick

DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString ( const char *  pchGUID)

convert a string into a joystick formatted guid

DECLSPEC void SDLCALL SDL_JoystickGetGUIDString ( SDL_JoystickGUID  guid,
char *  pszGUID,
int  cbGUID 
)

Return a string representation for this guid. pszGUID must point to at least 33 bytes (32 for the string plus a NULL terminator).

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

Get the current state of a POV hat on a joystick.

The hat indices start at index 0.

Returns
The return value is one of the following positions:
  • ::SDL_HAT_CENTERED
  • ::SDL_HAT_UP
  • ::SDL_HAT_RIGHT
  • ::SDL_HAT_DOWN
  • ::SDL_HAT_LEFT
  • ::SDL_HAT_RIGHTUP
  • ::SDL_HAT_RIGHTDOWN
  • ::SDL_HAT_LEFTUP
  • ::SDL_HAT_LEFTDOWN
DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID ( SDL_Joystick *  joystick)

Get the instance ID of an opened joystick or -1 if the joystick is invalid.

DECLSPEC const char* SDLCALL SDL_JoystickName ( SDL_Joystick *  joystick)

Return the name for this currently opened joystick. If no name can be found, this function returns NULL.

DECLSPEC const char* SDLCALL SDL_JoystickNameForIndex ( 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. The index passed as an argument refers to the N'th joystick on the system. This index is not the value which will identify this joystick in future joystick events. The joystick's instance id (::SDL_JoystickID) will be used there instead.

Returns
A joystick identifier, or NULL if an error occurred.
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 right now