Miguel Ruiz
SDL standard library
SDL_joystick.h File Reference
Include file for SDL joystick event handling. More...
Go to the source code of this file.
Functions | |
| DECLSPEC int SDLCALL | SDL_NumJoysticks (void) |
| Count the number of joysticks attached to the system right now. | |
| DECLSPEC const char *SDLCALL | SDL_JoystickNameForIndex (int device_index) |
| Get the implementation dependent name of a joystick. | |
| DECLSPEC SDL_Joystick *SDLCALL | SDL_JoystickOpen (int device_index) |
| Open a joystick for use. | |
| DECLSPEC const char *SDLCALL | SDL_JoystickName (SDL_Joystick *joystick) |
| Return the name for this currently opened joystick. | |
| DECLSPEC SDL_JoystickGUID SDLCALL | SDL_JoystickGetDeviceGUID (int device_index) |
| Return the GUID for the joystick at this index. | |
| DECLSPEC SDL_JoystickGUID SDLCALL | SDL_JoystickGetGUID (SDL_Joystick *joystick) |
| Return the GUID for this opened joystick. | |
| DECLSPEC void SDLCALL | SDL_JoystickGetGUIDString (SDL_JoystickGUID guid, char *pszGUID, int cbGUID) |
| Return a string representation for this guid. | |
| DECLSPEC SDL_JoystickGUID SDLCALL | SDL_JoystickGetGUIDFromString (const char *pchGUID) |
| convert a string into a joystick formatted guid | |
| DECLSPEC SDL_bool SDLCALL | SDL_JoystickGetAttached (SDL_Joystick *joystick) |
| Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not. | |
| DECLSPEC SDL_JoystickID SDLCALL | SDL_JoystickInstanceID (SDL_Joystick *joystick) |
| Get the instance ID of an opened joystick or -1 if the joystick is invalid. | |
| DECLSPEC int SDLCALL | SDL_JoystickNumAxes (SDL_Joystick *joystick) |
| Get the number of general axis controls on a joystick. | |
| DECLSPEC int SDLCALL | SDL_JoystickNumBalls (SDL_Joystick *joystick) |
| Get the number of trackballs on a joystick. | |
| DECLSPEC int SDLCALL | SDL_JoystickNumHats (SDL_Joystick *joystick) |
| Get the number of POV hats on a joystick. | |
| DECLSPEC int SDLCALL | SDL_JoystickNumButtons (SDL_Joystick *joystick) |
| Get the number of buttons on a joystick. | |
| DECLSPEC void SDLCALL | SDL_JoystickUpdate (void) |
| Update the current state of the open joysticks. | |
| DECLSPEC int SDLCALL | SDL_JoystickEventState (int state) |
| Enable/disable joystick event polling. | |
| DECLSPEC Sint16 SDLCALL | SDL_JoystickGetAxis (SDL_Joystick *joystick, int axis) |
| Get the current state of an axis control on a joystick. | |
| DECLSPEC Uint8 SDLCALL | SDL_JoystickGetHat (SDL_Joystick *joystick, int hat) |
| Get the current state of a POV hat on a joystick. | |
| DECLSPEC int SDLCALL | SDL_JoystickGetBall (SDL_Joystick *joystick, int ball, int *dx, int *dy) |
| Get the ball axis change since the last poll. | |
| DECLSPEC Uint8 SDLCALL | SDL_JoystickGetButton (SDL_Joystick *joystick, int button) |
| Get the current state of a button on a joystick. | |
| DECLSPEC void SDLCALL | SDL_JoystickClose (SDL_Joystick *joystick) |
| Close a joystick previously opened with SDL_JoystickOpen(). | |
Detailed Description
Include file for SDL joystick event handling.
In order to use these functions, SDL_Init() must have been called with the SDL_INIT_JOYSTICK flag.
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.
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.
Function Documentation
| DECLSPEC void SDLCALL SDL_JoystickClose | ( | SDL_Joystick * | joystick ) |
Close a joystick previously opened with SDL_JoystickOpen().
| DECLSPEC int SDLCALL SDL_JoystickEventState | ( | int | state ) |
Enable/disable joystick event polling.
If joystick events are disabled, you must call SDL_JoystickUpdate() yourself and check the state of the joystick when you want joystick information.
The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE.
| DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached | ( | SDL_Joystick * | joystick ) |
Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
| DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis | ( | SDL_Joystick * | joystick, |
| int | axis | ||
| ) |
Get the current state of an axis control on a joystick.
The state is a value ranging from -32768 to 32767.
The axis indices start at index 0.
| DECLSPEC int SDLCALL SDL_JoystickGetBall | ( | SDL_Joystick * | joystick, |
| int | ball, | ||
| int * | dx, | ||
| int * | dy | ||
| ) |
Get the ball axis change since the last poll.
- Returns:
- 0, or -1 if you passed it invalid parameters.
The ball indices start at index 0.
| DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton | ( | SDL_Joystick * | joystick, |
| int | button | ||
| ) |
Get the current state of a button on a joystick.
The button indices start at index 0.
| DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID | ( | int | device_index ) |
Return the GUID for the joystick at this index.
| DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID | ( | SDL_Joystick * | joystick ) |
Return the GUID for this opened joystick.
| DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString | ( | const char * | pchGUID ) |
convert a string into a joystick formatted guid
| DECLSPEC void SDLCALL SDL_JoystickGetGUIDString | ( | SDL_JoystickGUID | guid, |
| char * | pszGUID, | ||
| int | cbGUID | ||
| ) |
Return a string representation for this guid.
pszGUID must point to at least 33 bytes (32 for the string plus a NULL terminator).
| DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat | ( | SDL_Joystick * | joystick, |
| int | hat | ||
| ) |
Get the current state of a POV hat on a joystick.
The hat indices start at index 0.
- Returns:
- The return value is one of the following positions:
- SDL_HAT_CENTERED
- SDL_HAT_UP
- SDL_HAT_RIGHT
- SDL_HAT_DOWN
- SDL_HAT_LEFT
- SDL_HAT_RIGHTUP
- SDL_HAT_RIGHTDOWN
- SDL_HAT_LEFTUP
- SDL_HAT_LEFTDOWN
| DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID | ( | SDL_Joystick * | joystick ) |
Get the instance ID of an opened joystick or -1 if the joystick is invalid.
| DECLSPEC const char* SDLCALL SDL_JoystickName | ( | SDL_Joystick * | joystick ) |
Return the name for this currently opened joystick.
If no name can be found, this function returns NULL.
| DECLSPEC const char* SDLCALL SDL_JoystickNameForIndex | ( | int | device_index ) |
Get the implementation dependent name of a joystick.
This can be called before any joysticks are opened. If no name can be found, this function returns NULL.
| DECLSPEC int SDLCALL SDL_JoystickNumAxes | ( | SDL_Joystick * | joystick ) |
Get the number of general axis controls on a joystick.
| DECLSPEC int SDLCALL SDL_JoystickNumBalls | ( | SDL_Joystick * | joystick ) |
Get the number of trackballs on a joystick.
Joystick trackballs have only relative motion events associated with them and their state cannot be polled.
| DECLSPEC int SDLCALL SDL_JoystickNumButtons | ( | SDL_Joystick * | joystick ) |
Get the number of buttons on a joystick.
| DECLSPEC int SDLCALL SDL_JoystickNumHats | ( | SDL_Joystick * | joystick ) |
Get the number of POV hats on a joystick.
| DECLSPEC SDL_Joystick* SDLCALL SDL_JoystickOpen | ( | int | device_index ) |
Open a joystick for use.
The index passed as an argument refers tothe N'th joystick on the system. This index is the value which will identify this joystick in future joystick events.
- Returns:
- A joystick identifier, or NULL if an error occurred.
| DECLSPEC void SDLCALL SDL_JoystickUpdate | ( | void | ) |
Update the current state of the open joysticks.
This is called automatically by the event loop if any joystick events are enabled.
| DECLSPEC int SDLCALL SDL_NumJoysticks | ( | void | ) |
Count the number of joysticks attached to the system right now.
Generated on Tue Jul 12 2022 13:56:25 by
1.7.2