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

Classes
struct	SDL_JoystickGUID

Macros
#define	SDL_JOYSTICK_AXIS_MAX 32767

#define	SDL_JOYSTICK_AXIS_MIN -32768

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

Functions
DECLSPEC void SDLCALL	SDL_LockJoysticks (void)

DECLSPEC void SDLCALL	SDL_UnlockJoysticks (void)

DECLSPEC int SDLCALL	SDL_NumJoysticks (void)

DECLSPEC const char *SDLCALL	SDL_JoystickNameForIndex (int device_index)

DECLSPEC int SDLCALL	SDL_JoystickGetDevicePlayerIndex (int device_index)

DECLSPEC SDL_JoystickGUID SDLCALL	SDL_JoystickGetDeviceGUID (int device_index)

DECLSPEC Uint16 SDLCALL	SDL_JoystickGetDeviceVendor (int device_index)

DECLSPEC Uint16 SDLCALL	SDL_JoystickGetDeviceProduct (int device_index)

DECLSPEC Uint16 SDLCALL	SDL_JoystickGetDeviceProductVersion (int device_index)

DECLSPEC SDL_JoystickType SDLCALL	SDL_JoystickGetDeviceType (int device_index)

DECLSPEC SDL_JoystickID SDLCALL	SDL_JoystickGetDeviceInstanceID (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 int SDLCALL	SDL_JoystickGetPlayerIndex (SDL_Joystick *joystick)

DECLSPEC SDL_JoystickGUID SDLCALL	SDL_JoystickGetGUID (SDL_Joystick *joystick)

DECLSPEC Uint16 SDLCALL	SDL_JoystickGetVendor (SDL_Joystick *joystick)

DECLSPEC Uint16 SDLCALL	SDL_JoystickGetProduct (SDL_Joystick *joystick)

DECLSPEC Uint16 SDLCALL	SDL_JoystickGetProductVersion (SDL_Joystick *joystick)

DECLSPEC SDL_JoystickType SDLCALL	SDL_JoystickGetType (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 SDL_bool SDLCALL	SDL_JoystickGetAxisInitialState (SDL_Joystick joystick, int axis, Sint16 state)

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 int SDLCALL	SDL_JoystickRumble (SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)

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

Definition in file SDL_joystick.h.

Macro Definition Documentation

◆ SDL_HAT_CENTERED

#define SDL_HAT_CENTERED 0x00

Definition at line 329 of file SDL_joystick.h.

◆ SDL_HAT_DOWN

#define SDL_HAT_DOWN 0x04

Definition at line 332 of file SDL_joystick.h.

◆ SDL_HAT_LEFT

#define SDL_HAT_LEFT 0x08

Definition at line 333 of file SDL_joystick.h.

◆ SDL_HAT_LEFTDOWN

#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)

Definition at line 337 of file SDL_joystick.h.

◆ SDL_HAT_LEFTUP

#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)

Definition at line 336 of file SDL_joystick.h.

◆ SDL_HAT_RIGHT

#define SDL_HAT_RIGHT 0x02

Definition at line 331 of file SDL_joystick.h.

◆ SDL_HAT_RIGHTDOWN

#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)

Definition at line 335 of file SDL_joystick.h.

◆ SDL_HAT_RIGHTUP

#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)

Definition at line 334 of file SDL_joystick.h.

◆ SDL_HAT_UP

#define SDL_HAT_UP 0x01

Definition at line 330 of file SDL_joystick.h.

◆ SDL_JOYSTICK_AXIS_MAX

#define SDL_JOYSTICK_AXIS_MAX 32767

Definition at line 301 of file SDL_joystick.h.

◆ SDL_JOYSTICK_AXIS_MIN

#define SDL_JOYSTICK_AXIS_MIN -32768

Definition at line 302 of file SDL_joystick.h.

Typedef Documentation

◆ SDL_Joystick

typedef struct _SDL_Joystick SDL_Joystick

Definition at line 67 of file SDL_joystick.h.

◆ SDL_JoystickID

typedef Sint32 SDL_JoystickID

This is a unique ID for a joystick for the time it is connected to the system, and is never reused for the lifetime of the application. If the joystick is disconnected and reconnected, it will get a new ID.

The ID value starts at 0 and increments from there. The value -1 is an invalid ID.

Definition at line 81 of file SDL_joystick.h.

Enumeration Type Documentation

◆ SDL_JoystickPowerLevel

enum SDL_JoystickPowerLevel

Enumerator
SDL_JOYSTICK_POWER_UNKNOWN
SDL_JOYSTICK_POWER_EMPTY
SDL_JOYSTICK_POWER_LOW
SDL_JOYSTICK_POWER_MEDIUM
SDL_JOYSTICK_POWER_FULL
SDL_JOYSTICK_POWER_WIRED
SDL_JOYSTICK_POWER_MAX

Definition at line 97 of file SDL_joystick.h.

 {
     SDL_JOYSTICK_POWER_UNKNOWN = -1,
     SDL_JOYSTICK_POWER_EMPTY,   /* <= 5% */
     SDL_JOYSTICK_POWER_LOW,     /* <= 20% */
     SDL_JOYSTICK_POWER_MEDIUM,  /* <= 70% */
     SDL_JOYSTICK_POWER_FULL,    /* <= 100% */
     SDL_JOYSTICK_POWER_WIRED,
     SDL_JOYSTICK_POWER_MAX
 } SDL_JoystickPowerLevel;

◆ SDL_JoystickType

enum SDL_JoystickType

Enumerator
SDL_JOYSTICK_TYPE_UNKNOWN
SDL_JOYSTICK_TYPE_GAMECONTROLLER
SDL_JOYSTICK_TYPE_WHEEL
SDL_JOYSTICK_TYPE_ARCADE_STICK
SDL_JOYSTICK_TYPE_FLIGHT_STICK
SDL_JOYSTICK_TYPE_DANCE_PAD
SDL_JOYSTICK_TYPE_GUITAR
SDL_JOYSTICK_TYPE_DRUM_KIT
SDL_JOYSTICK_TYPE_ARCADE_PAD
SDL_JOYSTICK_TYPE_THROTTLE

Definition at line 83 of file SDL_joystick.h.

 {
     SDL_JOYSTICK_TYPE_UNKNOWN,
     SDL_JOYSTICK_TYPE_GAMECONTROLLER,
     SDL_JOYSTICK_TYPE_WHEEL,
     SDL_JOYSTICK_TYPE_ARCADE_STICK,
     SDL_JOYSTICK_TYPE_FLIGHT_STICK,
     SDL_JOYSTICK_TYPE_DANCE_PAD,
     SDL_JOYSTICK_TYPE_GUITAR,
     SDL_JOYSTICK_TYPE_DRUM_KIT,
     SDL_JOYSTICK_TYPE_ARCADE_PAD,
     SDL_JOYSTICK_TYPE_THROTTLE
 } SDL_JoystickType;

Function Documentation

◆ SDL_JoystickClose()

DECLSPEC void SDLCALL SDL_JoystickClose ( SDL_Joystick * joystick )

Close a joystick previously opened with SDL_JoystickOpen().

◆ SDL_JoystickCurrentPowerLevel()

DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel ( SDL_Joystick * joystick )

Return the battery level of this joystick

◆ SDL_JoystickEventState()

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.

◆ SDL_JoystickFromInstanceID()

DECLSPEC SDL_Joystick* SDLCALL SDL_JoystickFromInstanceID ( SDL_JoystickID joyid )

Return the SDL_Joystick associated with an instance id.

◆ SDL_JoystickGetAttached()

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.

◆ SDL_JoystickGetAxis()

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.

◆ SDL_JoystickGetAxisInitialState()

DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState	(	SDL_Joystick *	joystick,
		int	axis,
		Sint16 *	state
	)

Get the initial 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.

Returns: SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.

◆ SDL_JoystickGetBall()

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.

◆ SDL_JoystickGetButton()

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.

◆ SDL_JoystickGetDeviceGUID()

DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID ( int device_index )

Return the GUID for the joystick at this index This can be called before any joysticks are opened.

◆ SDL_JoystickGetDeviceInstanceID()

DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID ( int device_index )

Get the instance ID of a joystick. This can be called before any joysticks are opened. If the index is out of range, this function will return -1.

◆ SDL_JoystickGetDevicePlayerIndex()

DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex ( int device_index )

Get the player index of a joystick, or -1 if it's not available This can be called before any joysticks are opened.

◆ SDL_JoystickGetDeviceProduct()

DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct ( int device_index )

Get the USB product ID of a joystick, if available. This can be called before any joysticks are opened. If the product ID isn't available this function returns 0.

◆ SDL_JoystickGetDeviceProductVersion()

DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion ( int device_index )

Get the product version of a joystick, if available. This can be called before any joysticks are opened. If the product version isn't available this function returns 0.

◆ SDL_JoystickGetDeviceType()

DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType ( int device_index )

Get the type of a joystick, if available. This can be called before any joysticks are opened.

◆ SDL_JoystickGetDeviceVendor()

DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor ( int device_index )

Get the USB vendor ID of a joystick, if available. This can be called before any joysticks are opened. If the vendor ID isn't available this function returns 0.

◆ SDL_JoystickGetGUID()

DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID ( SDL_Joystick * joystick )

Return the GUID for this opened joystick

◆ SDL_JoystickGetGUIDFromString()

DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString ( const char * pchGUID )

Convert a string into a joystick guid

◆ SDL_JoystickGetGUIDString()

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

◆ SDL_JoystickGetHat()

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_JoystickGetPlayerIndex()

DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex ( SDL_Joystick * joystick )

Get the player index of an opened joystick, or -1 if it's not available

For XInput controllers this returns the XInput user index.

◆ SDL_JoystickGetProduct()

DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct ( SDL_Joystick * joystick )

Get the USB product ID of an opened joystick, if available. If the product ID isn't available this function returns 0.

◆ SDL_JoystickGetProductVersion()

DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion ( SDL_Joystick * joystick )

Get the product version of an opened joystick, if available. If the product version isn't available this function returns 0.

◆ SDL_JoystickGetType()

DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType ( SDL_Joystick * joystick )

Get the type of an opened joystick.

◆ SDL_JoystickGetVendor()

DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor ( SDL_Joystick * joystick )

Get the USB vendor ID of an opened joystick, if available. If the vendor ID isn't available this function returns 0.

◆ SDL_JoystickInstanceID()

DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID ( SDL_Joystick * joystick )

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

◆ SDL_JoystickName()

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.

◆ SDL_JoystickNameForIndex()

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.

◆ SDL_JoystickNumAxes()

DECLSPEC int SDLCALL SDL_JoystickNumAxes ( SDL_Joystick * joystick )

Get the number of general axis controls on a joystick.

◆ SDL_JoystickNumBalls()

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.

◆ SDL_JoystickNumButtons()

DECLSPEC int SDLCALL SDL_JoystickNumButtons ( SDL_Joystick * joystick )

Get the number of buttons on a joystick.

◆ SDL_JoystickNumHats()

DECLSPEC int SDLCALL SDL_JoystickNumHats ( SDL_Joystick * joystick )

Get the number of POV hats on a joystick.

◆ SDL_JoystickOpen()

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.

◆ SDL_JoystickRumble()

DECLSPEC int SDLCALL SDL_JoystickRumble	(	SDL_Joystick *	joystick,
		Uint16	low_frequency_rumble,
		Uint16	high_frequency_rumble,
		Uint32	duration_ms
	)

Trigger a rumble effect Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.

Parameters

joystick	The joystick to vibrate
low_frequency_rumble	The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
high_frequency_rumble	The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
duration_ms	The duration of the rumble effect, in milliseconds

Returns: 0, or -1 if rumble isn't supported on this joystick

◆ SDL_JoystickUpdate()

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.

◆ SDL_LockJoysticks()

DECLSPEC void SDLCALL SDL_LockJoysticks ( void )

Locking for multi-threaded access to the joystick API

If you are using the joystick API or handling events from multiple threads you should use these locking functions to protect access to the joysticks.

In particular, you are guaranteed that the joystick list won't change, so the API functions that take a joystick index will be valid, and joystick and game controller events will not be delivered.

◆ SDL_NumJoysticks()

DECLSPEC int SDLCALL SDL_NumJoysticks ( void )

Count the number of joysticks attached to the system right now

◆ SDL_UnlockJoysticks()

DECLSPEC void SDLCALL SDL_UnlockJoysticks ( void )

Enumerations
enum	SDL_JoystickType { SDL_JOYSTICK_TYPE_UNKNOWN, SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_WHEEL, SDL_JOYSTICK_TYPE_ARCADE_STICK, SDL_JOYSTICK_TYPE_FLIGHT_STICK, SDL_JOYSTICK_TYPE_DANCE_PAD, SDL_JOYSTICK_TYPE_GUITAR, SDL_JOYSTICK_TYPE_DRUM_KIT, SDL_JOYSTICK_TYPE_ARCADE_PAD, SDL_JOYSTICK_TYPE_THROTTLE }

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 }

Classes

Macros

Typedefs

Enumerations

Functions