SDL
2.0
|
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 |
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) |
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.
#define SDL_HAT_CENTERED 0x00 |
Definition at line 329 of file SDL_joystick.h.
#define SDL_HAT_DOWN 0x04 |
Definition at line 332 of file SDL_joystick.h.
#define SDL_HAT_LEFT 0x08 |
Definition at line 333 of file SDL_joystick.h.
#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) |
Definition at line 337 of file SDL_joystick.h.
#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) |
Definition at line 336 of file SDL_joystick.h.
#define SDL_HAT_RIGHT 0x02 |
Definition at line 331 of file SDL_joystick.h.
#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) |
Definition at line 335 of file SDL_joystick.h.
#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) |
Definition at line 334 of file SDL_joystick.h.
#define SDL_HAT_UP 0x01 |
Definition at line 330 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MAX 32767 |
Definition at line 301 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MIN -32768 |
Definition at line 302 of file SDL_joystick.h.
typedef Sint32 SDL_JoystickID |
This is a unique ID for a joystick for the time it is connected to the system, and is never reused for the lifetime of the application. If the joystick is disconnected and reconnected, it will get a new ID.
The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
Definition at line 81 of file SDL_joystick.h.
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.
enum SDL_JoystickType |
Definition at line 83 of file SDL_joystick.h.
void SDL_JoystickClose | ( | SDL_Joystick * | joystick | ) |
Close a joystick previously opened with SDL_JoystickOpen().
Definition at line 643 of file SDL_joystick.c.
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_JoystickPowerLevel SDL_JoystickCurrentPowerLevel | ( | SDL_Joystick * | joystick | ) |
Return the battery level of this joystick
Definition at line 1702 of file SDL_joystick.c.
References SDL_JOYSTICK_POWER_UNKNOWN, and SDL_PrivateJoystickValid().
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.
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_Joystick* SDL_JoystickFromInstanceID | ( | SDL_JoystickID | joyid | ) |
Return the SDL_Joystick associated with an instance id.
Definition at line 594 of file SDL_joystick.c.
References SDL_joysticks, SDL_LockJoysticks(), and SDL_UnlockJoysticks().
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.
References SDL_FALSE, and SDL_PrivateJoystickValid().
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.
References axis, SDL_PrivateJoystickValid(), SDL_SetError, and 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.
Definition at line 480 of file SDL_joystick.c.
References axis, SDL_FALSE, SDL_PrivateJoystickValid(), SDL_SetError, and state.
int SDL_JoystickGetBall | ( | SDL_Joystick * | joystick, |
int | ball, | ||
int * | dx, | ||
int * | dy | ||
) |
Get the ball axis change since the last poll.
The ball indices start at index 0.
Definition at line 519 of file SDL_joystick.c.
References retval, SDL_PrivateJoystickValid(), and SDL_SetError.
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.
References button, SDL_PrivateJoystickValid(), SDL_SetError, and state.
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.
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_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.
References SDL_JoystickDriver::GetDeviceInstanceID, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().
Referenced by SDL_JoystickGetDeviceIndexFromInstanceID().
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.
References SDL_JoystickDriver::GetDevicePlayerIndex, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().
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.
References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().
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.
References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().
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.
References SDL_GetJoystickGUIDType(), SDL_IsGameController, SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JoystickGetDeviceGUID().
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.
References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().
SDL_JoystickGUID SDL_JoystickGetGUID | ( | SDL_Joystick * | joystick | ) |
Return the GUID for this opened joystick
Definition at line 1577 of file SDL_joystick.c.
References SDL_PrivateJoystickValid(), and SDL_zero.
Referenced by SDL_JoystickGetProduct(), SDL_JoystickGetProductVersion(), SDL_JoystickGetType(), and SDL_JoystickGetVendor().
SDL_JoystickGUID SDL_JoystickGetGUIDFromString | ( | const char * | pchGUID | ) |
Convert a string into a joystick guid
Definition at line 1674 of file SDL_joystick.c.
References i, nibble(), SDL_memset, and SDL_strlen.
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.
References SDL_JoystickGUID::data, i, and NULL.
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.
Definition at line 499 of file SDL_joystick.c.
References SDL_PrivateJoystickValid(), SDL_SetError, and state.
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.
References SDL_PrivateJoystickValid().
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.
References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().
Referenced by SDL_JoystickAxesCenteredAtZero().
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.
References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().
SDL_JoystickType SDL_JoystickGetType | ( | SDL_Joystick * | joystick | ) |
Get the type of an opened joystick.
Definition at line 1614 of file SDL_joystick.c.
References SDL_GetJoystickGUIDType(), SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JoystickGetGUID().
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.
References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().
Referenced by SDL_JoystickAxesCenteredAtZero().
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.
References SDL_PrivateJoystickValid().
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.
References NULL, SDL_FixupJoystickName(), and SDL_PrivateJoystickValid().
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.
References SDL_JoystickDriver::GetDeviceName, NULL, SDL_FixupJoystickName(), SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().
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.
References SDL_PrivateJoystickValid().
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.
References SDL_PrivateJoystickValid().
int SDL_JoystickNumButtons | ( | SDL_Joystick * | joystick | ) |
Get the number of buttons on a joystick.
Definition at line 448 of file SDL_joystick.c.
References SDL_PrivateJoystickValid().
int SDL_JoystickNumHats | ( | SDL_Joystick * | joystick | ) |
Get the number of POV hats on a joystick.
Definition at line 424 of file SDL_joystick.c.
References SDL_PrivateJoystickValid().
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.
Definition at line 285 of file SDL_joystick.c.
References SDL_JoystickDriver::GetDeviceGUID, SDL_JoystickDriver::GetDeviceInstanceID, SDL_JoystickDriver::GetDeviceName, i, SDL_GameController::joystick, 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.
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.
joystick | The joystick to vibrate |
low_frequency_rumble | The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF |
high_frequency_rumble | The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF |
duration_ms | The duration of the rumble effect, in milliseconds |
Definition at line 631 of file SDL_joystick.c.
References SDL_PrivateJoystickValid().
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.
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.
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 87 of file SDL_joystick.c.
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().
int SDL_NumJoysticks | ( | void | ) |
Count the number of joysticks attached to the system right now
Definition at line 148 of file SDL_joystick.c.
References SDL_JoystickDriver::GetCount, i, SDL_arraysize, SDL_joystick_drivers, SDL_LockJoysticks(), and SDL_UnlockJoysticks().
Referenced by SDL_JoystickGetDeviceIndexFromInstanceID().
Definition at line 95 of file SDL_joystick.c.
References SDL_joystick_lock, and SDL_UnlockMutex.
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().