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 joyid)
 
const char * SDL_JoystickName (SDL_Joystick *joystick)
 
int SDL_JoystickGetPlayerIndex (SDL_Joystick *joystick)
 
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 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_JoystickID

SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const 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_JoystickPowerLevel
Definition: SDL_joystick.h:98
@ SDL_JOYSTICK_POWER_MAX
Definition: SDL_joystick.h:105
@ SDL_JOYSTICK_POWER_FULL
Definition: SDL_joystick.h:103
@ SDL_JOYSTICK_POWER_MEDIUM
Definition: SDL_joystick.h:102
@ SDL_JOYSTICK_POWER_EMPTY
Definition: SDL_joystick.h:100
@ SDL_JOYSTICK_POWER_UNKNOWN
Definition: SDL_joystick.h:99
@ SDL_JOYSTICK_POWER_WIRED
Definition: SDL_joystick.h:104
@ SDL_JOYSTICK_POWER_LOW
Definition: SDL_joystick.h:101

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

84{
SDL_JoystickType
Definition: SDL_joystick.h:84
@ SDL_JOYSTICK_TYPE_DANCE_PAD
Definition: SDL_joystick.h:90
@ SDL_JOYSTICK_TYPE_ARCADE_PAD
Definition: SDL_joystick.h:93
@ SDL_JOYSTICK_TYPE_UNKNOWN
Definition: SDL_joystick.h:85
@ SDL_JOYSTICK_TYPE_ARCADE_STICK
Definition: SDL_joystick.h:88
@ SDL_JOYSTICK_TYPE_WHEEL
Definition: SDL_joystick.h:87
@ SDL_JOYSTICK_TYPE_THROTTLE
Definition: SDL_joystick.h:94
@ SDL_JOYSTICK_TYPE_GUITAR
Definition: SDL_joystick.h:91
@ SDL_JOYSTICK_TYPE_FLIGHT_STICK
Definition: SDL_joystick.h:89
@ SDL_JOYSTICK_TYPE_GAMECONTROLLER
Definition: SDL_joystick.h:86
@ SDL_JOYSTICK_TYPE_DRUM_KIT
Definition: SDL_joystick.h:92

Function Documentation

◆ SDL_JoystickClose()

void SDL_JoystickClose ( SDL_Joystick *  joystick)

Close a joystick previously opened with SDL_JoystickOpen().

Definition at line 643 of file SDL_joystick.c.

644{
645 SDL_Joystick *joysticklist;
646 SDL_Joystick *joysticklistprev;
647
648 if (!SDL_PrivateJoystickValid(joystick)) {
649 return;
650 }
651
653
654 /* First decrement ref count */
655 if (--joystick->ref_count > 0) {
657 return;
658 }
659
662 return;
663 }
664
665 joystick->driver->Close(joystick);
666 joystick->hwdata = NULL;
667
668 joysticklist = SDL_joysticks;
669 joysticklistprev = NULL;
670 while (joysticklist) {
671 if (joystick == joysticklist) {
672 if (joysticklistprev) {
673 /* unlink this entry */
674 joysticklistprev->next = joysticklist->next;
675 } else {
676 SDL_joysticks = joystick->next;
677 }
678 break;
679 }
680 joysticklistprev = joysticklist;
681 joysticklist = joysticklist->next;
682 }
683
684 SDL_free(joystick->name);
685
686 /* Free the data associated with this joystick */
687 SDL_free(joystick->axes);
688 SDL_free(joystick->hats);
689 SDL_free(joystick->balls);
690 SDL_free(joystick->buttons);
691 SDL_free(joystick);
692
694}
#define SDL_free
void SDL_LockJoysticks(void)
Definition: SDL_joystick.c:87
static SDL_bool SDL_updating_joystick
Definition: SDL_joystick.c:82
void SDL_UnlockJoysticks(void)
Definition: SDL_joystick.c:95
static SDL_Joystick * SDL_joysticks
Definition: SDL_joystick.c:81
int SDL_PrivateJoystickValid(SDL_Joystick *joystick)
Definition: SDL_joystick.c:394
#define NULL
Definition: begin_code.h:167

References NULL, SDL_free, 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 1702 of file SDL_joystick.c.

1703{
1704 if (!SDL_PrivateJoystickValid(joystick)) {
1706 }
1707 return joystick->epowerlevel;
1708}

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 1094 of file SDL_joystick.c.

1095{
1096#if SDL_EVENTS_DISABLED
1097 return SDL_DISABLE;
1098#else
1099 const Uint32 event_list[] = {
1102 };
1103 unsigned int i;
1104
1105 switch (state) {
1106 case SDL_QUERY:
1108 for (i = 0; i < SDL_arraysize(event_list); ++i) {
1109 state = SDL_EventState(event_list[i], SDL_QUERY);
1110 if (state == SDL_ENABLE) {
1111 break;
1112 }
1113 }
1114 break;
1115 default:
1116 for (i = 0; i < SDL_arraysize(event_list); ++i) {
1117 SDL_EventState(event_list[i], state);
1118 }
1119 break;
1120 }
1121 return state;
1122#endif /* SDL_EVENTS_DISABLED */
1123}
#define SDL_EventState
@ SDL_JOYDEVICEADDED
Definition: SDL_events.h:116
@ SDL_JOYBUTTONDOWN
Definition: SDL_events.h:114
@ SDL_JOYDEVICEREMOVED
Definition: SDL_events.h:117
@ SDL_JOYBUTTONUP
Definition: SDL_events.h:115
@ SDL_JOYBALLMOTION
Definition: SDL_events.h:112
@ SDL_JOYAXISMOTION
Definition: SDL_events.h:111
@ SDL_JOYHATMOTION
Definition: SDL_events.h:113
#define SDL_QUERY
Definition: SDL_events.h:756
#define SDL_DISABLE
Definition: SDL_events.h:758
#define SDL_ENABLE
Definition: SDL_events.h:759
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:115
uint32_t Uint32
Definition: SDL_stdinc.h:203
struct xkb_state * state
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

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

Return the SDL_Joystick associated with an instance id.

Definition at line 594 of file SDL_joystick.c.

595{
596 SDL_Joystick *joystick;
597
599 for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
600 if (joystick->instance_id == joyid) {
601 break;
602 }
603 }
605 return joystick;
606}

References 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 568 of file SDL_joystick.c.

569{
570 if (!SDL_PrivateJoystickValid(joystick)) {
571 return SDL_FALSE;
572 }
573
574 return joystick->attached;
575}
@ SDL_FALSE
Definition: SDL_stdinc.h:163

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 460 of file SDL_joystick.c.

461{
463
464 if (!SDL_PrivateJoystickValid(joystick)) {
465 return 0;
466 }
467 if (axis < joystick->naxes) {
468 state = joystick->axes[axis].value;
469 } else {
470 SDL_SetError("Joystick only has %d axes", joystick->naxes);
471 state = 0;
472 }
473 return state;
474}
#define SDL_SetError
int16_t Sint16
Definition: SDL_stdinc.h:185
SDL_Texture * axis

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 480 of file SDL_joystick.c.

481{
482 if (!SDL_PrivateJoystickValid(joystick)) {
483 return SDL_FALSE;
484 }
485 if (axis >= joystick->naxes) {
486 SDL_SetError("Joystick only has %d axes", joystick->naxes);
487 return SDL_FALSE;
488 }
489 if (state) {
490 *state = joystick->axes[axis].initial_value;
491 }
492 return joystick->axes[axis].has_initial_value;
493}

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 519 of file SDL_joystick.c.

520{
521 int retval;
522
523 if (!SDL_PrivateJoystickValid(joystick)) {
524 return -1;
525 }
526
527 retval = 0;
528 if (ball < joystick->nballs) {
529 if (dx) {
530 *dx = joystick->balls[ball].dx;
531 }
532 if (dy) {
533 *dy = joystick->balls[ball].dy;
534 }
535 joystick->balls[ball].dx = 0;
536 joystick->balls[ball].dy = 0;
537 } else {
538 return SDL_SetError("Joystick only has %d balls", joystick->nballs);
539 }
540 return retval;
541}
SDL_bool retval

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 547 of file SDL_joystick.c.

548{
549 Uint8 state;
550
551 if (!SDL_PrivateJoystickValid(joystick)) {
552 return 0;
553 }
554 if (button < joystick->nbuttons) {
555 state = joystick->buttons[button];
556 } else {
557 SDL_SetError("Joystick only has %d buttons", joystick->nbuttons);
558 state = 0;
559 }
560 return state;
561}
uint8_t Uint8
Definition: SDL_stdinc.h:179
SDL_Texture * button

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 1489 of file SDL_joystick.c.

1490{
1491 SDL_JoystickDriver *driver;
1492 SDL_JoystickGUID guid;
1493
1495 if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
1496 guid = driver->GetDeviceGUID(device_index);
1497 } else {
1498 SDL_zero(guid);
1499 }
1501
1502 return guid;
1503}
SDL_bool SDL_GetDriverAndJoystickIndex(int device_index, SDL_JoystickDriver **driver, int *driver_index)
Definition: SDL_joystick.c:173
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
SDL_JoystickGUID(* GetDeviceGUID)(int device_index)

References SDL_JoystickDriver::GetDeviceGUID, 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 1546 of file SDL_joystick.c.

1547{
1548 SDL_JoystickDriver *driver;
1549 SDL_JoystickID instance_id = -1;
1550
1552 if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
1553 instance_id = driver->GetDeviceInstanceID(device_index);
1554 }
1556
1557 return instance_id;
1558}
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
SDL_JoystickID(* GetDeviceInstanceID)(int device_index)

References SDL_JoystickDriver::GetDeviceInstanceID, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickGetDeviceIndexFromInstanceID().

◆ 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 231 of file SDL_joystick.c.

232{
233 SDL_JoystickDriver *driver;
234 int player_index = -1;
235
237 if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
238 player_index = driver->GetDevicePlayerIndex(device_index);
239 }
241
242 return player_index;
243}
int(* GetDevicePlayerIndex)(int device_index)

References SDL_JoystickDriver::GetDevicePlayerIndex, SDL_GetDriverAndJoystickIndex(), 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 1514 of file SDL_joystick.c.

1515{
1516 Uint16 product;
1517 SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1518
1519 SDL_GetJoystickGUIDInfo(guid, NULL, &product, NULL);
1520 return product;
1521}
SDL_JoystickGUID SDL_JoystickGetDeviceGUID(int device_index)
void SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint16 *vendor, Uint16 *product, Uint16 *version)
uint16_t Uint16
Definition: SDL_stdinc.h:191

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 1523 of file SDL_joystick.c.

1524{
1525 Uint16 version;
1526 SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1527
1528 SDL_GetJoystickGUIDInfo(guid, NULL, NULL, &version);
1529 return version;
1530}

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 1532 of file SDL_joystick.c.

1533{
1535 SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1536
1539 if (SDL_IsGameController(device_index)) {
1541 }
1542 }
1543 return type;
1544}
#define SDL_IsGameController
static SDL_JoystickType SDL_GetJoystickGUIDType(SDL_JoystickGUID guid)
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1571

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 1505 of file SDL_joystick.c.

1506{
1507 Uint16 vendor;
1508 SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
1509
1510 SDL_GetJoystickGUIDInfo(guid, &vendor, NULL, NULL);
1511 return vendor;
1512}

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 1577 of file SDL_joystick.c.

1578{
1579 if (!SDL_PrivateJoystickValid(joystick)) {
1580 SDL_JoystickGUID emptyGUID;
1581 SDL_zero(emptyGUID);
1582 return emptyGUID;
1583 }
1584 return joystick->guid;
1585}

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 1674 of file SDL_joystick.c.

1675{
1676 SDL_JoystickGUID guid;
1677 int maxoutputbytes= sizeof(guid);
1678 size_t len = SDL_strlen(pchGUID);
1679 Uint8 *p;
1680 size_t i;
1681
1682 /* Make sure it's even */
1683 len = (len) & ~0x1;
1684
1685 SDL_memset(&guid, 0x00, sizeof(guid));
1686
1687 p = (Uint8 *)&guid;
1688 for (i = 0; (i < len) && ((p - (Uint8 *)&guid) < maxoutputbytes); i+=2, p++) {
1689 *p = (nibble(pchGUID[i]) << 4) | nibble(pchGUID[i+1]);
1690 }
1691
1692 return guid;
1693}
#define SDL_memset
#define SDL_strlen
static unsigned char nibble(char c)
GLenum GLsizei len
GLfloat GLfloat p

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 1629 of file SDL_joystick.c.

1630{
1631 static const char k_rgchHexToASCII[] = "0123456789abcdef";
1632 int i;
1633
1634 if ((pszGUID == NULL) || (cbGUID <= 0)) {
1635 return;
1636 }
1637
1638 for (i = 0; i < sizeof(guid.data) && i < (cbGUID-1)/2; i++) {
1639 /* each input byte writes 2 ascii chars, and might write a null byte. */
1640 /* If we don't have room for next input byte, stop */
1641 unsigned char c = guid.data[i];
1642
1643 *pszGUID++ = k_rgchHexToASCII[c >> 4];
1644 *pszGUID++ = k_rgchHexToASCII[c & 0x0F];
1645 }
1646 *pszGUID = '\0';
1647}
const GLubyte * c
Uint8 data[16]
Definition: SDL_joystick.h:71

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 499 of file SDL_joystick.c.

500{
501 Uint8 state;
502
503 if (!SDL_PrivateJoystickValid(joystick)) {
504 return 0;
505 }
506 if (hat < joystick->nhats) {
507 state = joystick->hats[hat];
508 } else {
509 SDL_SetError("Joystick only has %d hats", joystick->nhats);
510 state = 0;
511 }
512 return state;
513}

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.

Definition at line 622 of file SDL_joystick.c.

623{
624 if (!SDL_PrivateJoystickValid(joystick)) {
625 return -1;
626 }
627 return joystick->player_index;
628}

References SDL_PrivateJoystickValid().

◆ 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 1596 of file SDL_joystick.c.

1597{
1598 Uint16 product;
1599 SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1600
1601 SDL_GetJoystickGUIDInfo(guid, NULL, &product, NULL);
1602 return product;
1603}
SDL_JoystickGUID SDL_JoystickGetGUID(SDL_Joystick *joystick)

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 1605 of file SDL_joystick.c.

1606{
1607 Uint16 version;
1608 SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1609
1610 SDL_GetJoystickGUIDInfo(guid, NULL, NULL, &version);
1611 return version;
1612}

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 1614 of file SDL_joystick.c.

1615{
1617 SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1618
1621 if (joystick && joystick->is_game_controller) {
1623 }
1624 }
1625 return type;
1626}

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 1587 of file SDL_joystick.c.

1588{
1589 Uint16 vendor;
1590 SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
1591
1592 SDL_GetJoystickGUIDInfo(guid, &vendor, NULL, NULL);
1593 return vendor;
1594}

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 581 of file SDL_joystick.c.

582{
583 if (!SDL_PrivateJoystickValid(joystick)) {
584 return -1;
585 }
586
587 return joystick->instance_id;
588}

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 612 of file SDL_joystick.c.

613{
614 if (!SDL_PrivateJoystickValid(joystick)) {
615 return NULL;
616 }
617
618 return SDL_FixupJoystickName(joystick->name);
619}
static const char * SDL_FixupJoystickName(const char *name)
Definition: SDL_joystick.c:198

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 215 of file SDL_joystick.c.

216{
217 SDL_JoystickDriver *driver;
218 const char *name = NULL;
219
221 if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
222 name = SDL_FixupJoystickName(driver->GetDeviceName(device_index));
223 }
225
226 /* FIXME: Really we should reference count this name so it doesn't go away after unlock */
227 return name;
228}
GLuint const GLchar * name
const char *(* GetDeviceName)(int device_index)

References SDL_JoystickDriver::GetDeviceName, 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 412 of file SDL_joystick.c.

413{
414 if (!SDL_PrivateJoystickValid(joystick)) {
415 return -1;
416 }
417 return joystick->naxes;
418}

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 436 of file SDL_joystick.c.

437{
438 if (!SDL_PrivateJoystickValid(joystick)) {
439 return -1;
440 }
441 return joystick->nballs;
442}

References SDL_PrivateJoystickValid().

◆ SDL_JoystickNumButtons()

int SDL_JoystickNumButtons ( SDL_Joystick *  joystick)

Get the number of buttons on a joystick.

Definition at line 448 of file SDL_joystick.c.

449{
450 if (!SDL_PrivateJoystickValid(joystick)) {
451 return -1;
452 }
453 return joystick->nbuttons;
454}

References SDL_PrivateJoystickValid().

◆ SDL_JoystickNumHats()

int SDL_JoystickNumHats ( SDL_Joystick *  joystick)

Get the number of POV hats on a joystick.

Definition at line 424 of file SDL_joystick.c.

425{
426 if (!SDL_PrivateJoystickValid(joystick)) {
427 return -1;
428 }
429 return joystick->nhats;
430}

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 285 of file SDL_joystick.c.

286{
287 SDL_JoystickDriver *driver;
288 SDL_JoystickID instance_id;
289 SDL_Joystick *joystick;
290 SDL_Joystick *joysticklist;
291 const char *joystickname = NULL;
292
294
295 if (!SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
297 return NULL;
298 }
299
300 joysticklist = SDL_joysticks;
301 /* If the joystick is already open, return it
302 * it is important that we have a single joystick * for each instance id
303 */
304 instance_id = driver->GetDeviceInstanceID(device_index);
305 while (joysticklist) {
306 if (instance_id == joysticklist->instance_id) {
307 joystick = joysticklist;
308 ++joystick->ref_count;
310 return joystick;
311 }
312 joysticklist = joysticklist->next;
313 }
314
315 /* Create and initialize the joystick */
316 joystick = (SDL_Joystick *) SDL_calloc(sizeof(*joystick), 1);
317 if (joystick == NULL) {
320 return NULL;
321 }
322 joystick->driver = driver;
323 joystick->instance_id = instance_id;
324 joystick->attached = SDL_TRUE;
325 joystick->player_index = -1;
326 joystick->epowerlevel = SDL_JOYSTICK_POWER_UNKNOWN;
327
328 if (driver->Open(joystick, device_index) < 0) {
329 SDL_free(joystick);
331 return NULL;
332 }
333
334 joystickname = driver->GetDeviceName(device_index);
335 if (joystickname) {
336 joystick->name = SDL_strdup(joystickname);
337 } else {
338 joystick->name = NULL;
339 }
340
341 joystick->guid = driver->GetDeviceGUID(device_index);
342
343 if (joystick->naxes > 0) {
344 joystick->axes = (SDL_JoystickAxisInfo *) SDL_calloc(joystick->naxes, sizeof(SDL_JoystickAxisInfo));
345 }
346 if (joystick->nhats > 0) {
347 joystick->hats = (Uint8 *) SDL_calloc(joystick->nhats, sizeof(Uint8));
348 }
349 if (joystick->nballs > 0) {
350 joystick->balls = (struct balldelta *) SDL_calloc(joystick->nballs, sizeof(*joystick->balls));
351 }
352 if (joystick->nbuttons > 0) {
353 joystick->buttons = (Uint8 *) SDL_calloc(joystick->nbuttons, sizeof(Uint8));
354 }
355 if (((joystick->naxes > 0) && !joystick->axes)
356 || ((joystick->nhats > 0) && !joystick->hats)
357 || ((joystick->nballs > 0) && !joystick->balls)
358 || ((joystick->nbuttons > 0) && !joystick->buttons)) {
360 SDL_JoystickClose(joystick);
362 return NULL;
363 }
364
365 /* If this joystick is known to have all zero centered axes, skip the auto-centering code */
366 if (SDL_JoystickAxesCenteredAtZero(joystick)) {
367 int i;
368
369 for (i = 0; i < joystick->naxes; ++i) {
370 joystick->axes[i].has_initial_value = SDL_TRUE;
371 }
372 }
373
374 joystick->is_game_controller = SDL_IsGameController(device_index);
375
376 /* Add joystick to list */
377 ++joystick->ref_count;
378 /* Link the joystick in the list */
379 joystick->next = SDL_joysticks;
380 SDL_joysticks = joystick;
381
383
384 driver->Update(joystick);
385
386 return joystick;
387}
#define SDL_strdup
#define SDL_calloc
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
static SDL_bool SDL_JoystickAxesCenteredAtZero(SDL_Joystick *joystick)
Definition: SDL_joystick.c:251
void SDL_JoystickClose(SDL_Joystick *joystick)
Definition: SDL_joystick.c:643
@ SDL_TRUE
Definition: SDL_stdinc.h:164
void(* Update)(SDL_Joystick *joystick)
int(* Open)(SDL_Joystick *joystick, int device_index)

References SDL_JoystickDriver::GetDeviceGUID, SDL_JoystickDriver::GetDeviceInstanceID, SDL_JoystickDriver::GetDeviceName, i, NULL, SDL_JoystickDriver::Open, 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, SDL_UnlockJoysticks(), and SDL_JoystickDriver::Update.

◆ 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 631 of file SDL_joystick.c.

632{
633 if (!SDL_PrivateJoystickValid(joystick)) {
634 return -1;
635 }
636 return joystick->driver->Rumble(joystick, low_frequency_rumble, high_frequency_rumble, duration_ms);
637}

References SDL_PrivateJoystickValid().

◆ 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 1018 of file SDL_joystick.c.

1019{
1020 int i;
1021 SDL_Joystick *joystick;
1022
1024 return;
1025 }
1026
1028
1030 /* The joysticks are already being updated */
1032 return;
1033 }
1034
1036
1037 /* Make sure the list is unlocked while dispatching events to prevent application deadlocks */
1039
1040 for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
1041 if (joystick->attached) {
1042 /* This should always be true, but seeing a crash in the wild...? */
1043 if (joystick->driver) {
1044 joystick->driver->Update(joystick);
1045 }
1046
1047 if (joystick->delayed_guide_button) {
1049 }
1050 }
1051
1052 if (joystick->force_recentering) {
1053 /* Tell the app that everything is centered/unpressed... */
1054 for (i = 0; i < joystick->naxes; i++) {
1055 if (joystick->axes[i].has_initial_value) {
1056 SDL_PrivateJoystickAxis(joystick, i, joystick->axes[i].zero);
1057 }
1058 }
1059
1060 for (i = 0; i < joystick->nbuttons; i++) {
1061 SDL_PrivateJoystickButton(joystick, i, 0);
1062 }
1063
1064 for (i = 0; i < joystick->nhats; i++) {
1066 }
1067
1068 joystick->force_recentering = SDL_FALSE;
1069 }
1070 }
1071
1073
1075
1076 /* If any joysticks were closed while updating, free them here */
1077 for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
1078 if (joystick->ref_count <= 0) {
1079 SDL_JoystickClose(joystick);
1080 }
1081 }
1082
1083 /* this needs to happen AFTER walking the joystick list above, so that any
1084 dangling hardware data from removed devices can be free'd
1085 */
1086 for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
1088 }
1089
1091}
#define SDL_INIT_JOYSTICK
Definition: SDL.h:80
#define SDL_WasInit
void SDL_GameControllerHandleDelayedGuideButton(SDL_Joystick *joystick)
static SDL_JoystickDriver * SDL_joystick_drivers[]
Definition: SDL_joystick.c:48
int SDL_PrivateJoystickHat(SDL_Joystick *joystick, Uint8 hat, Uint8 value)
Definition: SDL_joystick.c:890
int SDL_PrivateJoystickAxis(SDL_Joystick *joystick, Uint8 axis, Sint16 value)
Definition: SDL_joystick.c:833
int SDL_PrivateJoystickButton(SDL_Joystick *joystick, Uint8 button, Uint8 state)
Definition: SDL_joystick.c:966
#define SDL_HAT_CENTERED
Definition: SDL_joystick.h:329
void(* Detect)(void)

References SDL_JoystickDriver::Detect, i, SDL_arraysize, SDL_FALSE, SDL_GameControllerHandleDelayedGuideButton(), SDL_HAT_CENTERED, SDL_INIT_JOYSTICK, SDL_joystick_drivers, SDL_JoystickClose(), SDL_joysticks, SDL_LockJoysticks(), SDL_PrivateJoystickAxis(), SDL_PrivateJoystickButton(), SDL_PrivateJoystickHat(), 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_JoystickGetDeviceGUID(), SDL_JoystickGetDeviceIndexFromInstanceID(), SDL_JoystickGetDeviceInstanceID(), SDL_JoystickGetDevicePlayerIndex(), SDL_JoystickNameForIndex(), SDL_JoystickOpen(), SDL_JoystickQuit(), SDL_JoystickUpdate(), and SDL_NumJoysticks().

◆ SDL_NumJoysticks()

int SDL_NumJoysticks ( void  )

Count the number of joysticks attached to the system right now

Definition at line 148 of file SDL_joystick.c.

149{
150 int i, total_joysticks = 0;
152 for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
153 total_joysticks += SDL_joystick_drivers[i]->GetCount();
154 }
156 return total_joysticks;
157}
int(* GetCount)(void)

References SDL_JoystickDriver::GetCount, i, SDL_arraysize, SDL_joystick_drivers, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickGetDeviceIndexFromInstanceID().

◆ SDL_UnlockJoysticks()