SDL  2.0
SDL_joystick.h File Reference
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_joystick.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_JoystickGUID
 

Macros

#define SDL_JOYSTICK_AXIS_MAX   32767
 
#define SDL_JOYSTICK_AXIS_MIN   -32768
 

Typedefs

typedef Sint32 SDL_JoystickID
 

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
}
 

Functions

void SDL_LockJoysticks (void)
 
void SDL_UnlockJoysticks (void)
 
int SDL_NumJoysticks (void)
 
const char * SDL_JoystickNameForIndex (int device_index)
 
int SDL_JoystickGetDevicePlayerIndex (int device_index)
 
SDL_JoystickGUID SDL_JoystickGetDeviceGUID (int device_index)
 
Uint16 SDL_JoystickGetDeviceVendor (int device_index)
 
Uint16 SDL_JoystickGetDeviceProduct (int device_index)
 
Uint16 SDL_JoystickGetDeviceProductVersion (int device_index)
 
SDL_JoystickType SDL_JoystickGetDeviceType (int device_index)
 
SDL_JoystickID SDL_JoystickGetDeviceInstanceID (int device_index)
 
SDL_Joystick * SDL_JoystickOpen (int device_index)
 
SDL_Joystick * SDL_JoystickFromInstanceID (SDL_JoystickID instance_id)
 
SDL_Joystick * SDL_JoystickFromPlayerIndex (int player_index)
 
const char * SDL_JoystickName (SDL_Joystick *joystick)
 
int SDL_JoystickGetPlayerIndex (SDL_Joystick *joystick)
 
void SDL_JoystickSetPlayerIndex (SDL_Joystick *joystick, int player_index)
 
SDL_JoystickGUID SDL_JoystickGetGUID (SDL_Joystick *joystick)
 
Uint16 SDL_JoystickGetVendor (SDL_Joystick *joystick)
 
Uint16 SDL_JoystickGetProduct (SDL_Joystick *joystick)
 
Uint16 SDL_JoystickGetProductVersion (SDL_Joystick *joystick)
 
SDL_JoystickType SDL_JoystickGetType (SDL_Joystick *joystick)
 
void SDL_JoystickGetGUIDString (SDL_JoystickGUID guid, char *pszGUID, int cbGUID)
 
SDL_JoystickGUID SDL_JoystickGetGUIDFromString (const char *pchGUID)
 
SDL_bool SDL_JoystickGetAttached (SDL_Joystick *joystick)
 
SDL_JoystickID SDL_JoystickInstanceID (SDL_Joystick *joystick)
 
int SDL_JoystickNumAxes (SDL_Joystick *joystick)
 
int SDL_JoystickNumBalls (SDL_Joystick *joystick)
 
int SDL_JoystickNumHats (SDL_Joystick *joystick)
 
int SDL_JoystickNumButtons (SDL_Joystick *joystick)
 
void SDL_JoystickUpdate (void)
 
int SDL_JoystickEventState (int state)
 
Sint16 SDL_JoystickGetAxis (SDL_Joystick *joystick, int axis)
 
SDL_bool SDL_JoystickGetAxisInitialState (SDL_Joystick *joystick, int axis, Sint16 *state)
 

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)
 
Uint8 SDL_JoystickGetHat (SDL_Joystick *joystick, int hat)
 
int SDL_JoystickGetBall (SDL_Joystick *joystick, int ball, int *dx, int *dy)
 
Uint8 SDL_JoystickGetButton (SDL_Joystick *joystick, int button)
 
int SDL_JoystickRumble (SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
 
void SDL_JoystickClose (SDL_Joystick *joystick)
 
SDL_JoystickPowerLevel 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 339 of file SDL_joystick.h.

◆ SDL_HAT_DOWN

#define SDL_HAT_DOWN   0x04

Definition at line 342 of file SDL_joystick.h.

◆ SDL_HAT_LEFT

#define SDL_HAT_LEFT   0x08

Definition at line 343 of file SDL_joystick.h.

◆ SDL_HAT_LEFTDOWN

#define SDL_HAT_LEFTDOWN   (SDL_HAT_LEFT|SDL_HAT_DOWN)

Definition at line 347 of file SDL_joystick.h.

◆ SDL_HAT_LEFTUP

#define SDL_HAT_LEFTUP   (SDL_HAT_LEFT|SDL_HAT_UP)

Definition at line 346 of file SDL_joystick.h.

◆ SDL_HAT_RIGHT

#define SDL_HAT_RIGHT   0x02

Definition at line 341 of file SDL_joystick.h.

◆ SDL_HAT_RIGHTDOWN

#define SDL_HAT_RIGHTDOWN   (SDL_HAT_RIGHT|SDL_HAT_DOWN)

Definition at line 345 of file SDL_joystick.h.

◆ SDL_HAT_RIGHTUP

#define SDL_HAT_RIGHTUP   (SDL_HAT_RIGHT|SDL_HAT_UP)

Definition at line 344 of file SDL_joystick.h.

◆ SDL_HAT_UP

#define SDL_HAT_UP   0x01

Definition at line 340 of file SDL_joystick.h.

◆ SDL_JOYSTICK_AXIS_MAX

#define SDL_JOYSTICK_AXIS_MAX   32767

Definition at line 311 of file SDL_joystick.h.

◆ SDL_JOYSTICK_AXIS_MIN

#define SDL_JOYSTICK_AXIS_MIN   -32768

Definition at line 312 of file SDL_joystick.h.

Typedef Documentation

◆ SDL_JoystickID

const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char const char const SDL_SCANF_FORMAT_STRING char return SDL_ThreadFunction const char void return Uint32 return Uint32 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) a int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr int return SDL_Window return return SDL_Window int int return SDL_GLContext SDL_RWops int return return void return int int return double return SDL_bool return int int return SDL_AudioDeviceID const void Uint32 return SDL_AudioDeviceID int float float float return 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

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.

98 {
100  SDL_JOYSTICK_POWER_EMPTY, /* <= 5% */
101  SDL_JOYSTICK_POWER_LOW, /* <= 20% */
102  SDL_JOYSTICK_POWER_MEDIUM, /* <= 70% */
103  SDL_JOYSTICK_POWER_FULL, /* <= 100% */

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

Function Documentation

◆ SDL_JoystickClose()

void SDL_JoystickClose ( SDL_Joystick *  joystick)

Close a joystick previously opened with SDL_JoystickOpen().

Definition at line 800 of file SDL_joystick.c.

801 {
802  SDL_Joystick *joysticklist;
803  SDL_Joystick *joysticklistprev;
804 
805  if (!SDL_PrivateJoystickValid(joystick)) {
806  return;
807  }
808 
810 
811  /* First decrement ref count */
812  if (--joystick->ref_count > 0) {
814  return;
815  }
816 
817  if (SDL_updating_joystick) {
819  return;
820  }
821 
822  if (joystick->rumble_expiration) {
823  SDL_JoystickRumble(joystick, 0, 0, 0);
824  }
825 
826  joystick->driver->Close(joystick);
827  joystick->hwdata = NULL;
828 
829  joysticklist = SDL_joysticks;
830  joysticklistprev = NULL;
831  while (joysticklist) {
832  if (joystick == joysticklist) {
833  if (joysticklistprev) {
834  /* unlink this entry */
835  joysticklistprev->next = joysticklist->next;
836  } else {
837  SDL_joysticks = joystick->next;
838  }
839  break;
840  }
841  joysticklistprev = joysticklist;
842  joysticklist = joysticklist->next;
843  }
844 
845  SDL_free(joystick->name);
846 
847  /* Free the data associated with this joystick */
848  SDL_free(joystick->axes);
849  SDL_free(joystick->hats);
850  SDL_free(joystick->balls);
851  SDL_free(joystick->buttons);
852  SDL_free(joystick);
853 
855 }

References NULL, SDL_free, SDL_JoystickRumble(), SDL_joysticks, SDL_LockJoysticks(), SDL_PrivateJoystickValid(), SDL_UnlockJoysticks(), and SDL_updating_joystick.

Referenced by SDL_JoystickOpen(), SDL_JoystickQuit(), and SDL_JoystickUpdate().

◆ SDL_JoystickCurrentPowerLevel()

SDL_JoystickPowerLevel SDL_JoystickCurrentPowerLevel ( SDL_Joystick *  joystick)

Return the battery level of this joystick

Definition at line 2041 of file SDL_joystick.c.

2042 {
2043  if (!SDL_PrivateJoystickValid(joystick)) {
2045  }
2046  return joystick->epowerlevel;
2047 }

References SDL_JOYSTICK_POWER_UNKNOWN, and SDL_PrivateJoystickValid().

◆ SDL_JoystickEventState()

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

Definition at line 1306 of file SDL_joystick.c.

1307 {
1308 #if SDL_EVENTS_DISABLED
1309  return SDL_DISABLE;
1310 #else
1311  const Uint32 event_list[] = {
1314  };
1315  unsigned int i;
1316 
1317  switch (state) {
1318  case SDL_QUERY:
1319  state = SDL_DISABLE;
1320  for (i = 0; i < SDL_arraysize(event_list); ++i) {
1321  state = SDL_EventState(event_list[i], SDL_QUERY);
1322  if (state == SDL_ENABLE) {
1323  break;
1324  }
1325  }
1326  break;
1327  default:
1328  for (i = 0; i < SDL_arraysize(event_list); ++i) {
1329  SDL_EventState(event_list[i], state);
1330  }
1331  break;
1332  }
1333  return state;
1334 #endif /* SDL_EVENTS_DISABLED */
1335 }

References i, SDL_arraysize, SDL_DISABLE, SDL_ENABLE, SDL_EventState, SDL_JOYAXISMOTION, SDL_JOYBALLMOTION, SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_JOYDEVICEADDED, SDL_JOYDEVICEREMOVED, SDL_JOYHATMOTION, SDL_QUERY, and state.

◆ SDL_JoystickFromInstanceID()

SDL_Joystick* SDL_JoystickFromInstanceID ( SDL_JoystickID  instance_id)

Return the SDL_Joystick associated with an instance id.

Definition at line 680 of file SDL_joystick.c.

681 {
682  SDL_Joystick *joystick;
683 
685  for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
686  if (joystick->instance_id == instance_id) {
687  break;
688  }
689  }
691  return joystick;
692 }

References SDL_joysticks, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

◆ SDL_JoystickFromPlayerIndex()

SDL_Joystick* SDL_JoystickFromPlayerIndex ( int  player_index)

Return the SDL_Joystick associated with a player index.

Definition at line 698 of file SDL_joystick.c.

699 {
700  SDL_JoystickID instance_id;
701  SDL_Joystick *joystick;
702 
704  instance_id = SDL_GetJoystickIDForPlayerIndex(player_index);
705  for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
706  if (joystick->instance_id == instance_id) {
707  break;
708  }
709  }
711  return joystick;
712 }

References SDL_GetJoystickIDForPlayerIndex(), SDL_joysticks, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

◆ SDL_JoystickGetAttached()

SDL_bool SDL_JoystickGetAttached ( SDL_Joystick *  joystick)

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

Definition at line 654 of file SDL_joystick.c.

655 {
656  if (!SDL_PrivateJoystickValid(joystick)) {
657  return SDL_FALSE;
658  }
659 
660  return joystick->attached;
661 }

References SDL_FALSE, and SDL_PrivateJoystickValid().

◆ SDL_JoystickGetAxis()

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

Definition at line 546 of file SDL_joystick.c.

547 {
548  Sint16 state;
549 
550  if (!SDL_PrivateJoystickValid(joystick)) {
551  return 0;
552  }
553  if (axis < joystick->naxes) {
554  state = joystick->axes[axis].value;
555  } else {
556  SDL_SetError("Joystick only has %d axes", joystick->naxes);
557  state = 0;
558  }
559  return state;
560 }

References axis, SDL_PrivateJoystickValid(), SDL_SetError, and state.

◆ SDL_JoystickGetAxisInitialState()

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

Definition at line 566 of file SDL_joystick.c.

567 {
568  if (!SDL_PrivateJoystickValid(joystick)) {
569  return SDL_FALSE;
570  }
571  if (axis >= joystick->naxes) {
572  SDL_SetError("Joystick only has %d axes", joystick->naxes);
573  return SDL_FALSE;
574  }
575  if (state) {
576  *state = joystick->axes[axis].initial_value;
577  }
578  return joystick->axes[axis].has_initial_value;
579 }

References axis, SDL_FALSE, SDL_PrivateJoystickValid(), SDL_SetError, and state.

◆ SDL_JoystickGetBall()

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

Definition at line 605 of file SDL_joystick.c.

606 {
607  int retval;
608 
609  if (!SDL_PrivateJoystickValid(joystick)) {
610  return -1;
611  }
612 
613  retval = 0;
614  if (ball < joystick->nballs) {
615  if (dx) {
616  *dx = joystick->balls[ball].dx;
617  }
618  if (dy) {
619  *dy = joystick->balls[ball].dy;
620  }
621  joystick->balls[ball].dx = 0;
622  joystick->balls[ball].dy = 0;
623  } else {
624  return SDL_SetError("Joystick only has %d balls", joystick->nballs);
625  }
626  return retval;
627 }

References retval, SDL_PrivateJoystickValid(), and SDL_SetError.

◆ SDL_JoystickGetButton()

Uint8 SDL_JoystickGetButton ( SDL_Joystick *  joystick,
int  button 
)

Get the current state of a button on a joystick.

The button indices start at index 0.

Definition at line 633 of file SDL_joystick.c.

634 {
635  Uint8 state;
636 
637  if (!SDL_PrivateJoystickValid(joystick)) {
638  return 0;
639  }
640  if (button < joystick->nbuttons) {
641  state = joystick->buttons[button];
642  } else {
643  SDL_SetError("Joystick only has %d buttons", joystick->nbuttons);
644  state = 0;
645  }
646  return state;
647 }

References button, SDL_PrivateJoystickValid(), SDL_SetError, and state.

◆ SDL_JoystickGetDeviceGUID()

SDL_JoystickGUID SDL_JoystickGetDeviceGUID ( int  device_index)

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

Definition at line 1828 of file SDL_joystick.c.

1829 {
1830  SDL_JoystickDriver *driver;
1831  SDL_JoystickGUID guid;
1832 
1834  if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
1835  guid = driver->GetDeviceGUID(device_index);
1836  } else {
1837  SDL_zero(guid);
1838  }
1840 
1841  return guid;
1842 }

References SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), SDL_UnlockJoysticks(), and SDL_zero.

Referenced by SDL_JoystickGetDeviceProduct(), SDL_JoystickGetDeviceProductVersion(), SDL_JoystickGetDeviceType(), and SDL_JoystickGetDeviceVendor().

◆ SDL_JoystickGetDeviceInstanceID()

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

Definition at line 1885 of file SDL_joystick.c.

1886 {
1887  SDL_JoystickDriver *driver;
1888  SDL_JoystickID instance_id = -1;
1889 
1891  if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
1892  instance_id = driver->GetDeviceInstanceID(device_index);
1893  }
1895 
1896  return instance_id;
1897 }

References SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickGetDeviceIndexFromInstanceID(), and SDL_JoystickGetDevicePlayerIndex().

◆ SDL_JoystickGetDevicePlayerIndex()

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

Definition at line 321 of file SDL_joystick.c.

322 {
323  int player_index;
324 
328 
329  return player_index;
330 }

References SDL_GetPlayerIndexForJoystickID(), SDL_JoystickGetDeviceInstanceID(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

◆ SDL_JoystickGetDeviceProduct()

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

Definition at line 1853 of file SDL_joystick.c.

1854 {
1855  Uint16 product;
1856  SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1857 
1858  SDL_GetJoystickGUIDInfo(guid, NULL, &product, NULL);
1859  return product;
1860 }

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().

◆ SDL_JoystickGetDeviceProductVersion()

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

Definition at line 1862 of file SDL_joystick.c.

1863 {
1864  Uint16 version;
1865  SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1866 
1867  SDL_GetJoystickGUIDInfo(guid, NULL, NULL, &version);
1868  return version;
1869 }

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().

◆ SDL_JoystickGetDeviceType()

SDL_JoystickType SDL_JoystickGetDeviceType ( int  device_index)

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

Definition at line 1871 of file SDL_joystick.c.

1872 {
1874  SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1875 
1876  type = SDL_GetJoystickGUIDType(guid);
1878  if (SDL_IsGameController(device_index)) {
1880  }
1881  }
1882  return type;
1883 }

References SDL_GetJoystickGUIDType(), SDL_IsGameController, SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JoystickGetDeviceGUID().

◆ SDL_JoystickGetDeviceVendor()

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

Definition at line 1844 of file SDL_joystick.c.

1845 {
1846  Uint16 vendor;
1847  SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1848 
1849  SDL_GetJoystickGUIDInfo(guid, &vendor, NULL, NULL);
1850  return vendor;
1851 }

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().

◆ SDL_JoystickGetGUID()

SDL_JoystickGUID SDL_JoystickGetGUID ( SDL_Joystick *  joystick)

Return the GUID for this opened joystick

Definition at line 1916 of file SDL_joystick.c.

1917 {
1918  if (!SDL_PrivateJoystickValid(joystick)) {
1919  SDL_JoystickGUID emptyGUID;
1920  SDL_zero(emptyGUID);
1921  return emptyGUID;
1922  }
1923  return joystick->guid;
1924 }

References SDL_PrivateJoystickValid(), and SDL_zero.

Referenced by SDL_JoystickGetProduct(), SDL_JoystickGetProductVersion(), SDL_JoystickGetType(), and SDL_JoystickGetVendor().

◆ SDL_JoystickGetGUIDFromString()

SDL_JoystickGUID SDL_JoystickGetGUIDFromString ( const char *  pchGUID)

Convert a string into a joystick guid

Definition at line 2013 of file SDL_joystick.c.

2014 {
2015  SDL_JoystickGUID guid;
2016  int maxoutputbytes= sizeof(guid);
2017  size_t len = SDL_strlen(pchGUID);
2018  Uint8 *p;
2019  size_t i;
2020 
2021  /* Make sure it's even */
2022  len = (len) & ~0x1;
2023 
2024  SDL_memset(&guid, 0x00, sizeof(guid));
2025 
2026  p = (Uint8 *)&guid;
2027  for (i = 0; (i < len) && ((p - (Uint8 *)&guid) < maxoutputbytes); i+=2, p++) {
2028  *p = (nibble(pchGUID[i]) << 4) | nibble(pchGUID[i+1]);
2029  }
2030 
2031  return guid;
2032 }

References i, nibble(), SDL_memset, and SDL_strlen.

◆ SDL_JoystickGetGUIDString()

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

Definition at line 1968 of file SDL_joystick.c.

1969 {
1970  static const char k_rgchHexToASCII[] = "0123456789abcdef";
1971  int i;
1972 
1973  if ((pszGUID == NULL) || (cbGUID <= 0)) {
1974  return;
1975  }
1976 
1977  for (i = 0; i < sizeof(guid.data) && i < (cbGUID-1)/2; i++) {
1978  /* each input byte writes 2 ascii chars, and might write a null byte. */
1979  /* If we don't have room for next input byte, stop */
1980  unsigned char c = guid.data[i];
1981 
1982  *pszGUID++ = k_rgchHexToASCII[c >> 4];
1983  *pszGUID++ = k_rgchHexToASCII[c & 0x0F];
1984  }
1985  *pszGUID = '\0';
1986 }

References SDL_JoystickGUID::data, i, and NULL.

◆ SDL_JoystickGetHat()

Uint8 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:

Definition at line 585 of file SDL_joystick.c.

586 {
587  Uint8 state;
588 
589  if (!SDL_PrivateJoystickValid(joystick)) {
590  return 0;
591  }
592  if (hat < joystick->nhats) {
593  state = joystick->hats[hat];
594  } else {
595  SDL_SetError("Joystick only has %d hats", joystick->nhats);
596  state = 0;
597  }
598  return state;
599 }

References SDL_PrivateJoystickValid(), SDL_SetError, and state.

◆ SDL_JoystickGetPlayerIndex()

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

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

Definition at line 731 of file SDL_joystick.c.

732 {
733  int player_index;
734 
735  if (!SDL_PrivateJoystickValid(joystick)) {
736  return -1;
737  }
738 
740  player_index = SDL_GetPlayerIndexForJoystickID(joystick->instance_id);
742 
743  return player_index;
744 }

References SDL_GetPlayerIndexForJoystickID(), SDL_LockJoysticks(), SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

◆ SDL_JoystickGetProduct()

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

Definition at line 1935 of file SDL_joystick.c.

1936 {
1937  Uint16 product;
1938  SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1939 
1940  SDL_GetJoystickGUIDInfo(guid, NULL, &product, NULL);
1941  return product;
1942 }

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().

Referenced by SDL_JoystickAxesCenteredAtZero().

◆ SDL_JoystickGetProductVersion()

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

Definition at line 1944 of file SDL_joystick.c.

1945 {
1946  Uint16 version;
1947  SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1948 
1949  SDL_GetJoystickGUIDInfo(guid, NULL, NULL, &version);
1950  return version;
1951 }

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().

◆ SDL_JoystickGetType()

SDL_JoystickType SDL_JoystickGetType ( SDL_Joystick *  joystick)

Get the type of an opened joystick.

Definition at line 1953 of file SDL_joystick.c.

1954 {
1956  SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1957 
1958  type = SDL_GetJoystickGUIDType(guid);
1960  if (joystick && joystick->is_game_controller) {
1962  }
1963  }
1964  return type;
1965 }

References SDL_GetJoystickGUIDType(), SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JoystickGetGUID().

◆ SDL_JoystickGetVendor()

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

Definition at line 1926 of file SDL_joystick.c.

1927 {
1928  Uint16 vendor;
1929  SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1930 
1931  SDL_GetJoystickGUIDInfo(guid, &vendor, NULL, NULL);
1932  return vendor;
1933 }

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().

Referenced by SDL_JoystickAxesCenteredAtZero().

◆ SDL_JoystickInstanceID()

SDL_JoystickID SDL_JoystickInstanceID ( SDL_Joystick *  joystick)

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

Definition at line 667 of file SDL_joystick.c.

668 {
669  if (!SDL_PrivateJoystickValid(joystick)) {
670  return -1;
671  }
672 
673  return joystick->instance_id;
674 }

References SDL_PrivateJoystickValid().

◆ SDL_JoystickName()

const char* SDL_JoystickName ( SDL_Joystick *  joystick)

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

Definition at line 718 of file SDL_joystick.c.

719 {
720  if (!SDL_PrivateJoystickValid(joystick)) {
721  return NULL;
722  }
723 
724  return SDL_FixupJoystickName(joystick->name);
725 }

References NULL, SDL_FixupJoystickName(), and SDL_PrivateJoystickValid().

◆ SDL_JoystickNameForIndex()

const char* 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.

Definition at line 302 of file SDL_joystick.c.

303 {
304  SDL_JoystickDriver *driver;
305  const char *name = NULL;
306 
308  if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
309  name = SDL_FixupJoystickName(driver->GetDeviceName(device_index));
310  }
312 
313  /* FIXME: Really we should reference count this name so it doesn't go away after unlock */
314  return name;
315 }

References NULL, SDL_FixupJoystickName(), SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

◆ SDL_JoystickNumAxes()

int SDL_JoystickNumAxes ( SDL_Joystick *  joystick)

Get the number of general axis controls on a joystick.

Definition at line 498 of file SDL_joystick.c.

499 {
500  if (!SDL_PrivateJoystickValid(joystick)) {
501  return -1;
502  }
503  return joystick->naxes;
504 }

References SDL_PrivateJoystickValid().

◆ SDL_JoystickNumBalls()

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

Definition at line 522 of file SDL_joystick.c.

523 {
524  if (!SDL_PrivateJoystickValid(joystick)) {
525  return -1;
526  }
527  return joystick->nballs;
528 }

References SDL_PrivateJoystickValid().

◆ SDL_JoystickNumButtons()

int SDL_JoystickNumButtons ( SDL_Joystick *  joystick)

Get the number of buttons on a joystick.

Definition at line 534 of file SDL_joystick.c.

535 {
536  if (!SDL_PrivateJoystickValid(joystick)) {
537  return -1;
538  }
539  return joystick->nbuttons;
540 }

References SDL_PrivateJoystickValid().

◆ SDL_JoystickNumHats()

int SDL_JoystickNumHats ( SDL_Joystick *  joystick)

Get the number of POV hats on a joystick.

Definition at line 510 of file SDL_joystick.c.

511 {
512  if (!SDL_PrivateJoystickValid(joystick)) {
513  return -1;
514  }
515  return joystick->nhats;
516 }

References SDL_PrivateJoystickValid().

◆ SDL_JoystickOpen()

SDL_Joystick* 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.

Definition at line 372 of file SDL_joystick.c.

373 {
374  SDL_JoystickDriver *driver;
375  SDL_JoystickID instance_id;
376  SDL_Joystick *joystick;
377  SDL_Joystick *joysticklist;
378  const char *joystickname = NULL;
379 
381 
382  if (!SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
384  return NULL;
385  }
386 
387  joysticklist = SDL_joysticks;
388  /* If the joystick is already open, return it
389  * it is important that we have a single joystick * for each instance id
390  */
391  instance_id = driver->GetDeviceInstanceID(device_index);
392  while (joysticklist) {
393  if (instance_id == joysticklist->instance_id) {
394  joystick = joysticklist;
395  ++joystick->ref_count;
397  return joystick;
398  }
399  joysticklist = joysticklist->next;
400  }
401 
402  /* Create and initialize the joystick */
403  joystick = (SDL_Joystick *) SDL_calloc(sizeof(*joystick), 1);
404  if (joystick == NULL) {
405  SDL_OutOfMemory();
407  return NULL;
408  }
409  joystick->driver = driver;
410  joystick->instance_id = instance_id;
411  joystick->attached = SDL_TRUE;
412  joystick->epowerlevel = SDL_JOYSTICK_POWER_UNKNOWN;
413 
414  if (driver->Open(joystick, device_index) < 0) {
415  SDL_free(joystick);
417  return NULL;
418  }
419 
420  joystickname = driver->GetDeviceName(device_index);
421  if (joystickname) {
422  joystick->name = SDL_strdup(joystickname);
423  } else {
424  joystick->name = NULL;
425  }
426 
427  joystick->guid = driver->GetDeviceGUID(device_index);
428 
429  if (joystick->naxes > 0) {
430  joystick->axes = (SDL_JoystickAxisInfo *) SDL_calloc(joystick->naxes, sizeof(SDL_JoystickAxisInfo));
431  }
432  if (joystick->nhats > 0) {
433  joystick->hats = (Uint8 *) SDL_calloc(joystick->nhats, sizeof(Uint8));
434  }
435  if (joystick->nballs > 0) {
436  joystick->balls = (struct balldelta *) SDL_calloc(joystick->nballs, sizeof(*joystick->balls));
437  }
438  if (joystick->nbuttons > 0) {
439  joystick->buttons = (Uint8 *) SDL_calloc(joystick->nbuttons, sizeof(Uint8));
440  }
441  if (((joystick->naxes > 0) && !joystick->axes)
442  || ((joystick->nhats > 0) && !joystick->hats)
443  || ((joystick->nballs > 0) && !joystick->balls)
444  || ((joystick->nbuttons > 0) && !joystick->buttons)) {
445  SDL_OutOfMemory();
446  SDL_JoystickClose(joystick);
448  return NULL;
449  }
450 
451  /* If this joystick is known to have all zero centered axes, skip the auto-centering code */
452  if (SDL_JoystickAxesCenteredAtZero(joystick)) {
453  int i;
454 
455  for (i = 0; i < joystick->naxes; ++i) {
456  joystick->axes[i].has_initial_value = SDL_TRUE;
457  }
458  }
459 
460  joystick->is_game_controller = SDL_IsGameController(device_index);
461 
462  /* Add joystick to list */
463  ++joystick->ref_count;
464  /* Link the joystick in the list */
465  joystick->next = SDL_joysticks;
466  SDL_joysticks = joystick;
467 
469 
470  driver->Update(joystick);
471 
472  return joystick;
473 }

References i, SDL_GameController::joystick, NULL, SDL_calloc, SDL_free, SDL_GetDriverAndJoystickIndex(), SDL_IsGameController, SDL_JOYSTICK_POWER_UNKNOWN, SDL_JoystickAxesCenteredAtZero(), SDL_JoystickClose(), SDL_joysticks, SDL_LockJoysticks(), SDL_OutOfMemory, SDL_strdup, SDL_TRUE, and SDL_UnlockJoysticks().

◆ SDL_JoystickRumble()

int 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
joystickThe joystick to vibrate
low_frequency_rumbleThe intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
high_frequency_rumbleThe intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
duration_msThe duration of the rumble effect, in milliseconds
Returns
0, or -1 if rumble isn't supported on this joystick

Definition at line 762 of file SDL_joystick.c.

763 {
764  int result;
765 
766  if (!SDL_PrivateJoystickValid(joystick)) {
767  return -1;
768  }
769 
771  if (low_frequency_rumble == joystick->low_frequency_rumble &&
772  high_frequency_rumble == joystick->high_frequency_rumble) {
773  /* Just update the expiration */
774  result = 0;
775  } else {
776  result = joystick->driver->Rumble(joystick, low_frequency_rumble, high_frequency_rumble);
777  }
778 
779  /* Save the rumble value regardless of success, so we don't spam the driver */
780  joystick->low_frequency_rumble = low_frequency_rumble;
781  joystick->high_frequency_rumble = high_frequency_rumble;
782 
783  if ((low_frequency_rumble || high_frequency_rumble) && duration_ms) {
784  joystick->rumble_expiration = SDL_GetTicks() + SDL_min(duration_ms, SDL_MAX_RUMBLE_DURATION_MS);
785  if (!joystick->rumble_expiration) {
786  joystick->rumble_expiration = 1;
787  }
788  } else {
789  joystick->rumble_expiration = 0;
790  }
792 
793  return result;
794 }

References SDL_GetTicks(), SDL_LockJoysticks(), SDL_MAX_RUMBLE_DURATION_MS, SDL_min, SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickClose(), and SDL_JoystickUpdate().

◆ SDL_JoystickSetPlayerIndex()

void SDL_JoystickSetPlayerIndex ( SDL_Joystick *  joystick,
int  player_index 
)

Set the player index of an opened joystick

Definition at line 750 of file SDL_joystick.c.

751 {
752  if (!SDL_PrivateJoystickValid(joystick)) {
753  return;
754  }
755 
757  SDL_SetJoystickIDForPlayerIndex(player_index, joystick->instance_id);
759 }

References SDL_LockJoysticks(), SDL_PrivateJoystickValid(), SDL_SetJoystickIDForPlayerIndex(), and SDL_UnlockJoysticks().

◆ SDL_JoystickUpdate()

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

Definition at line 1214 of file SDL_joystick.c.

1215 {
1216  int i;
1217  SDL_Joystick *joystick, *next;
1218 
1220  return;
1221  }
1222 
1224 
1225  if (SDL_updating_joystick) {
1226  /* The joysticks are already being updated */
1228  return;
1229  }
1230 
1232 
1233  /* Make sure the list is unlocked while dispatching events to prevent application deadlocks */
1235 
1236 #ifdef SDL_JOYSTICK_HIDAPI
1237  /* Special function for HIDAPI devices, as a single device can provide multiple SDL_Joysticks */
1239 #endif /* SDL_JOYSTICK_HIDAPI */
1240 
1241  for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
1242  if (joystick->attached) {
1243  /* This should always be true, but seeing a crash in the wild...? */
1244  if (joystick->driver) {
1245  joystick->driver->Update(joystick);
1246  }
1247 
1248  if (joystick->delayed_guide_button) {
1250  }
1251  }
1252 
1253  if (joystick->rumble_expiration) {
1255  /* Double check now that the lock is held */
1256  if (joystick->rumble_expiration &&
1257  SDL_TICKS_PASSED(SDL_GetTicks(), joystick->rumble_expiration)) {
1258  SDL_JoystickRumble(joystick, 0, 0, 0);
1259  }
1261  }
1262 
1263  if (joystick->force_recentering) {
1264  /* Tell the app that everything is centered/unpressed... */
1265  for (i = 0; i < joystick->naxes; i++) {
1266  if (joystick->axes[i].has_initial_value) {
1267  SDL_PrivateJoystickAxis(joystick, i, joystick->axes[i].zero);
1268  }
1269  }
1270 
1271  for (i = 0; i < joystick->nbuttons; i++) {
1272  SDL_PrivateJoystickButton(joystick, i, 0);
1273  }
1274 
1275  for (i = 0; i < joystick->nhats; i++) {
1277  }
1278 
1279  joystick->force_recentering = SDL_FALSE;
1280  }
1281  }
1282 
1284 
1286 
1287  /* If any joysticks were closed while updating, free them here */
1288  for (joystick = SDL_joysticks; joystick; joystick = next) {
1289  next = joystick->next;
1290  if (joystick->ref_count <= 0) {
1291  SDL_JoystickClose(joystick);
1292  }
1293  }
1294 
1295  /* this needs to happen AFTER walking the joystick list above, so that any
1296  dangling hardware data from removed devices can be free'd
1297  */
1298  for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
1299  SDL_joystick_drivers[i]->Detect();
1300  }
1301 
1303 }

References HIDAPI_UpdateDevices(), i, SDL_arraysize, SDL_FALSE, SDL_GameControllerHandleDelayedGuideButton(), SDL_GetTicks(), SDL_HAT_CENTERED, SDL_INIT_JOYSTICK, SDL_joystick_drivers, SDL_JoystickClose(), SDL_JoystickRumble(), SDL_joysticks, SDL_LockJoysticks(), SDL_PrivateJoystickAxis(), SDL_PrivateJoystickButton(), SDL_PrivateJoystickHat(), SDL_TICKS_PASSED, SDL_TRUE, SDL_UnlockJoysticks(), SDL_updating_joystick, and SDL_WasInit.

◆ SDL_LockJoysticks()

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

Definition at line 672 of file SDL_dynapi_procs.h.

References SDL_joystick_lock, and SDL_LockMutex.

Referenced by SDL_JoystickClose(), SDL_JoystickFromInstanceID(), SDL_JoystickFromPlayerIndex(), SDL_JoystickGetDeviceGUID(), SDL_JoystickGetDeviceIndexFromInstanceID(), SDL_JoystickGetDeviceInstanceID(), SDL_JoystickGetDevicePlayerIndex(), SDL_JoystickGetPlayerIndex(), SDL_JoystickNameForIndex(), SDL_JoystickOpen(), SDL_JoystickQuit(), SDL_JoystickRumble(), SDL_JoystickSetPlayerIndex(), SDL_JoystickUpdate(), SDL_NumJoysticks(), SDL_PrivateJoystickAdded(), and SDL_PrivateJoystickRemoved().

◆ SDL_NumJoysticks()

int SDL_NumJoysticks ( void  )

Count the number of joysticks attached to the system right now

Definition at line 235 of file SDL_joystick.c.

236 {
237  int i, total_joysticks = 0;
239  for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
240  total_joysticks += SDL_joystick_drivers[i]->GetCount();
241  }
243  return total_joysticks;
244 }

References i, SDL_arraysize, SDL_joystick_drivers, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickGetDeviceIndexFromInstanceID().

◆ SDL_UnlockJoysticks()

SDL_zero
#define SDL_zero(x)
Definition: SDL_stdinc.h:418
SDL_JOYSTICK_TYPE_GAMECONTROLLER
@ SDL_JOYSTICK_TYPE_GAMECONTROLLER
Definition: SDL_joystick.h:86
SDL_memset
#define SDL_memset
Definition: SDL_dynapi_overrides.h:386
c
const GLubyte * c
Definition: SDL_opengl_glext.h:11096
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
SDL_MAX_RUMBLE_DURATION_MS
#define SDL_MAX_RUMBLE_DURATION_MS
Definition: SDL_sysjoystick.h:143
SDL_IsGameController
#define SDL_IsGameController
Definition: SDL_dynapi_overrides.h:138
SDL_JoystickAxesCenteredAtZero
static SDL_bool SDL_JoystickAxesCenteredAtZero(SDL_Joystick *joystick)
Definition: SDL_joystick.c:338
SDL_HAT_CENTERED
#define SDL_HAT_CENTERED
Definition: SDL_joystick.h:339
NULL
#define NULL
Definition: begin_code.h:167
SDL_JOYSTICK_POWER_MAX
@ SDL_JOYSTICK_POWER_MAX
Definition: SDL_joystick.h:105
SDL_INIT_JOYSTICK
#define SDL_INIT_JOYSTICK
Definition: SDL.h:81
SDL_FixupJoystickName
static const char * SDL_FixupJoystickName(const char *name)
Definition: SDL_joystick.c:285
SDL_JoystickPowerLevel
SDL_JoystickPowerLevel
Definition: SDL_joystick.h:97
SDL_SetJoystickIDForPlayerIndex
static SDL_bool SDL_SetJoystickIDForPlayerIndex(int player_index, SDL_JoystickID instance_id)
Definition: SDL_joystick.c:144
SDL_JOYSTICK_POWER_LOW
@ SDL_JOYSTICK_POWER_LOW
Definition: SDL_joystick.h:101
SDL_ENABLE
#define SDL_ENABLE
Definition: SDL_events.h:760
SDL_JOYSTICK_TYPE_GUITAR
@ SDL_JOYSTICK_TYPE_GUITAR
Definition: SDL_joystick.h:91
SDL_JoystickGUID::data
Uint8 data[16]
Definition: SDL_joystick.h:71
SDL_UnlockJoysticks
void SDL_UnlockJoysticks(void)
Definition: SDL_joystick.c:98
SDL_JOYDEVICEREMOVED
@ SDL_JOYDEVICEREMOVED
Definition: SDL_events.h:117
x1
GLuint GLfloat GLfloat GLfloat x1
Definition: SDL_opengl_glext.h:8586
SDL_JOYSTICK_POWER_EMPTY
@ SDL_JOYSTICK_POWER_EMPTY
Definition: SDL_joystick.h:100
SDL_JoystickGetDeviceInstanceID
SDL_JoystickID SDL_JoystickGetDeviceInstanceID(int device_index)
Definition: SDL_joystick.c:1885
result
GLuint64EXT * result
Definition: SDL_opengl_glext.h:9435
SDL_JOYSTICK_TYPE_DANCE_PAD
@ SDL_JOYSTICK_TYPE_DANCE_PAD
Definition: SDL_joystick.h:90
SDL_PrivateJoystickAxis
int SDL_PrivateJoystickAxis(SDL_Joystick *joystick, Uint8 axis, Sint16 value)
Definition: SDL_joystick.c:1023
SDL_JoystickGetGUID
SDL_JoystickGUID SDL_JoystickGetGUID(SDL_Joystick *joystick)
Definition: SDL_joystick.c:1916
SDL_JoystickID
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
SDL_JOYSTICK_TYPE_DRUM_KIT
@ SDL_JOYSTICK_TYPE_DRUM_KIT
Definition: SDL_joystick.h:92
SDL_QUERY
#define SDL_QUERY
Definition: SDL_events.h:757
Sint16
int16_t Sint16
Definition: SDL_stdinc.h:185
len
GLenum GLsizei len
Definition: SDL_opengl_glext.h:2929
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
SDL_JOYSTICK_POWER_MEDIUM
@ SDL_JOYSTICK_POWER_MEDIUM
Definition: SDL_joystick.h:102
SDL_GameControllerHandleDelayedGuideButton
void SDL_GameControllerHandleDelayedGuideButton(SDL_Joystick *joystick)
Definition: SDL_gamecontroller.c:2151
p
GLfloat GLfloat p
Definition: SDL_opengl_glext.h:11093
retval
SDL_bool retval
Definition: testgamecontroller.c:65
SDL_PrivateJoystickValid
SDL_bool SDL_PrivateJoystickValid(SDL_Joystick *joystick)
Definition: SDL_joystick.c:480
SDL_JOYSTICK_POWER_UNKNOWN
@ SDL_JOYSTICK_POWER_UNKNOWN
Definition: SDL_joystick.h:99
SDL_GetJoystickGUIDInfo
void SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint16 *vendor, Uint16 *product, Uint16 *version)
Definition: SDL_joystick.c:1337
SDL_GetJoystickGUIDType
static SDL_JoystickType SDL_GetJoystickGUIDType(SDL_JoystickGUID guid)
Definition: SDL_joystick.c:1611
SDL_free
#define SDL_free
Definition: SDL_dynapi_overrides.h:377
SDL_updating_joystick
static SDL_bool SDL_updating_joystick
Definition: SDL_joystick.c:83
SDL_JOYSTICK_TYPE_FLIGHT_STICK
@ SDL_JOYSTICK_TYPE_FLIGHT_STICK
Definition: SDL_joystick.h:89
name
GLuint const GLchar * name
Definition: SDL_opengl_glext.h:663
SDL_JOYSTICK_POWER_WIRED
@ SDL_JOYSTICK_POWER_WIRED
Definition: SDL_joystick.h:104
SDL_PrivateJoystickButton
int SDL_PrivateJoystickButton(SDL_Joystick *joystick, Uint8 button, Uint8 state)
Definition: SDL_joystick.c:1162
SDL_JOYSTICK_TYPE_THROTTLE
@ SDL_JOYSTICK_TYPE_THROTTLE
Definition: SDL_joystick.h:94
Uint16
uint16_t Uint16
Definition: SDL_stdinc.h:191
nibble
static unsigned char nibble(char c)
Definition: SDL_joystick.c:1993
SDL_GetTicks
Uint32 SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
SDL_GetDriverAndJoystickIndex
SDL_bool SDL_GetDriverAndJoystickIndex(int device_index, SDL_JoystickDriver **driver, int *driver_index)
Definition: SDL_joystick.c:260
SDL_min
#define SDL_min(x, y)
Definition: SDL_stdinc.h:406
SDL_JOYAXISMOTION
@ SDL_JOYAXISMOTION
Definition: SDL_events.h:111
SDL_joystick_lock
static SDL_mutex * SDL_joystick_lock
Definition: SDL_joystick.c:84
SDL_LockJoysticks
void SDL_LockJoysticks(void)
Definition: SDL_joystick.c:90
SDL_joystick_drivers
static SDL_JoystickDriver * SDL_joystick_drivers[]
Definition: SDL_joystick.c:49
SDL_DISABLE
#define SDL_DISABLE
Definition: SDL_events.h:759
axis
SDL_Texture * axis
Definition: testgamecontroller.c:67
SDL_OutOfMemory
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
SDL_PrivateJoystickHat
int SDL_PrivateJoystickHat(SDL_Joystick *joystick, Uint8 hat, Uint8 value)
Definition: SDL_joystick.c:1086
SDL_arraysize
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:115
SDL_calloc
#define SDL_calloc
Definition: SDL_dynapi_overrides.h:375
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
SDL_GetJoystickIDForPlayerIndex
static SDL_JoystickID SDL_GetJoystickIDForPlayerIndex(int player_index)
Definition: SDL_joystick.c:135
SDL_JoystickClose
void SDL_JoystickClose(SDL_Joystick *joystick)
Definition: SDL_joystick.c:800
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
SDL_JOYBUTTONUP
@ SDL_JOYBUTTONUP
Definition: SDL_events.h:115
SDL_JOYSTICK_POWER_FULL
@ SDL_JOYSTICK_POWER_FULL
Definition: SDL_joystick.h:103
SDL_JOYSTICK_TYPE_ARCADE_PAD
@ SDL_JOYSTICK_TYPE_ARCADE_PAD
Definition: SDL_joystick.h:93
SDL_EventState
#define SDL_EventState
Definition: SDL_dynapi_overrides.h:131
SDL_strdup
#define SDL_strdup
Definition: SDL_dynapi_overrides.h:397
SDL_joysticks
static SDL_Joystick * SDL_joysticks
Definition: SDL_joystick.c:82
SDL_GetPlayerIndexForJoystickID
static int SDL_GetPlayerIndexForJoystickID(SDL_JoystickID instance_id)
Definition: SDL_joystick.c:119
SDL_strlen
#define SDL_strlen
Definition: SDL_dynapi_overrides.h:393
SDL_JOYDEVICEADDED
@ SDL_JOYDEVICEADDED
Definition: SDL_events.h:116
SDL_JoystickRumble
int SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Definition: SDL_joystick.c:762
SDL_TICKS_PASSED
#define SDL_TICKS_PASSED(A, B)
Compare SDL ticks values, and return true if A has passed B.
Definition: SDL_timer.h:56
HIDAPI_UpdateDevices
void HIDAPI_UpdateDevices(void)
SDL_JoystickGetDeviceGUID
SDL_JoystickGUID SDL_JoystickGetDeviceGUID(int device_index)
Definition: SDL_joystick.c:1828
SDL_JOYBUTTONDOWN
@ SDL_JOYBUTTONDOWN
Definition: SDL_events.h:114
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:262
SDL_WasInit
#define SDL_WasInit
Definition: SDL_dynapi_overrides.h:57
SDL_JoystickGUID
Definition: SDL_joystick.h:70
SDL_JOYSTICK_TYPE_WHEEL
@ SDL_JOYSTICK_TYPE_WHEEL
Definition: SDL_joystick.h:87
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1571
state
struct xkb_state * state
Definition: SDL_waylandsym.h:114
SDL_JOYHATMOTION
@ SDL_JOYHATMOTION
Definition: SDL_events.h:113
SDL_JOYSTICK_TYPE_UNKNOWN
@ SDL_JOYSTICK_TYPE_UNKNOWN
Definition: SDL_joystick.h:85
button
SDL_Texture * button
Definition: testgamecontroller.c:67
i
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
SDL_JOYBALLMOTION
@ SDL_JOYBALLMOTION
Definition: SDL_events.h:112
SDL_JoystickType
SDL_JoystickType
Definition: SDL_joystick.h:83
SDL_JOYSTICK_TYPE_ARCADE_STICK
@ SDL_JOYSTICK_TYPE_ARCADE_STICK
Definition: SDL_joystick.h:88
Uint8
uint8_t Uint8
Definition: SDL_stdinc.h:179