SDL
2.0
|
Go to the source code of this file.
Data Structures | |
struct | SDL_JoystickGUID |
Macros | |
#define | SDL_IPHONE_MAX_GFORCE 5.0 |
#define | SDL_JOYSTICK_AXIS_MAX 32767 |
#define | SDL_JOYSTICK_AXIS_MIN -32768 |
Typedefs | |
typedef struct _SDL_Joystick | SDL_Joystick |
typedef Sint32 | SDL_JoystickID |
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 "player_index" is the number assigned to a player on a specific controller. For XInput controllers this returns the XInput user index. Many joysticks will not be able to supply this information.
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 732 of file SDL_joystick.h.
#define SDL_HAT_DOWN 0x04 |
Definition at line 735 of file SDL_joystick.h.
#define SDL_HAT_LEFT 0x08 |
Definition at line 736 of file SDL_joystick.h.
#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) |
Definition at line 740 of file SDL_joystick.h.
#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) |
Definition at line 739 of file SDL_joystick.h.
#define SDL_HAT_RIGHT 0x02 |
Definition at line 734 of file SDL_joystick.h.
#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) |
Definition at line 738 of file SDL_joystick.h.
#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) |
Definition at line 737 of file SDL_joystick.h.
#define SDL_HAT_UP 0x01 |
Definition at line 733 of file SDL_joystick.h.
#define SDL_IPHONE_MAX_GFORCE 5.0 |
Definition at line 113 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MAX 32767 |
Definition at line 683 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MIN -32768 |
Definition at line 684 of file SDL_joystick.h.
typedef struct _SDL_Joystick SDL_Joystick |
Definition at line 1 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 83 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 99 of file SDL_joystick.h.
enum SDL_JoystickType |
Definition at line 85 of file SDL_joystick.h.
int SDL_JoystickAttachVirtual | ( | SDL_JoystickType | type, |
int | naxes, | ||
int | nbuttons, | ||
int | nhats | ||
) |
Attach a new virtual joystick.
void SDL_JoystickClose | ( | SDL_Joystick * | joystick | ) |
Close a joystick previously opened with SDL_JoystickOpen().
joystick | The joystick device to close |
SDL_JoystickPowerLevel SDL_JoystickCurrentPowerLevel | ( | SDL_Joystick * | joystick | ) |
Get the battery level of a joystick as SDL_JoystickPowerLevel.
joystick | the SDL_Joystick to query |
SDL_JOYSTICK_POWER_UNKNOWN
if it is unknownint SDL_JoystickDetachVirtual | ( | int | device_index | ) |
Detach a virtual joystick.
device_index | a value previously returned from SDL_JoystickAttachVirtual() |
int SDL_JoystickEventState | ( | int | state | ) |
Enable/disable joystick event polling.
If joystick events are disabled, you must call SDL_JoystickUpdate() yourself and manually check the state of the joystick when you want joystick information.
It is recommended that you leave joystick event handling enabled.
WARNING: Calling this function may delete all events currently in SDL's event queue.
state | can be one of SDL_QUERY , SDL_IGNORE , or SDL_ENABLE |
If state
is SDL_QUERY
then the current state is returned, otherwise the new processing state is returned.
SDL_Joystick* SDL_JoystickFromInstanceID | ( | SDL_JoystickID | instance_id | ) |
Get the SDL_Joystick associated with an instance id.
instance_id | the instance id to get the SDL_Joystick for |
SDL_Joystick* SDL_JoystickFromPlayerIndex | ( | int | player_index | ) |
Get the SDL_Joystick associated with a player index.
player_index | the player index to get the SDL_Joystick for |
SDL_bool SDL_JoystickGetAttached | ( | SDL_Joystick * | joystick | ) |
Get the status of a specified joystick.
joystick | the joystick to query |
Sint16 SDL_JoystickGetAxis | ( | SDL_Joystick * | joystick, |
int | axis | ||
) |
Get the current state of an axis control on a joystick.
SDL makes no promises about what part of the joystick any given axis refers to. Your game should have some sort of configuration UI to let users specify what each axis should be bound to. Alternately, SDL's higher-level Game Controller API makes a great effort to apply order to this lower-level interface, so you know that a specific axis is the "left thumb stick," etc.
The value returned by SDL_JoystickGetAxis() is a signed integer (-32768 to 32767) representing the current position of the axis. It may be necessary to impose certain tolerances on these values to account for jitter.
joystick | an SDL_Joystick structure containing joystick information |
axis | the axis to query; the axis indices start at index 0 |
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.
joystick | an SDL_Joystick structure containing joystick information |
axis | the axis to query; the axis indices start at index 0 |
state | Upon return, the initial value is supplied here. |
int SDL_JoystickGetBall | ( | SDL_Joystick * | joystick, |
int | ball, | ||
int * | dx, | ||
int * | dy | ||
) |
Get the ball axis change since the last poll.
Trackballs can only return relative motion since the last call to SDL_JoystickGetBall(), these motion deltas are placed into dx
and dy
.
Most joysticks do not have trackballs.
joystick | the SDL_Joystick to query |
ball | the ball index to query; ball indices start at index 0 |
dx | stores the difference in the x axis position since the last poll |
dy | stores the difference in the y axis position since the last poll |
Uint8 SDL_JoystickGetButton | ( | SDL_Joystick * | joystick, |
int | button | ||
) |
Get the current state of a button on a joystick.
joystick | an SDL_Joystick structure containing joystick information |
button | the button index to get the state from; indices start at index 0 |
SDL_JoystickGUID SDL_JoystickGetDeviceGUID | ( | int | device_index | ) |
Get the implementation-dependent GUID for the joystick at a given device index.
This function can be called before any joysticks are opened.
device_index | the index of the joystick to query (the N'th joystick on the system |
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.
device_index | the index of the joystick to query (the N'th joystick on the system |
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.
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.
device_index | the index of the joystick to query (the N'th joystick on the system |
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.
device_index | the index of the joystick to query (the N'th joystick on the system |
SDL_JoystickType SDL_JoystickGetDeviceType | ( | int | device_index | ) |
Get the type of a joystick, if available.
This can be called before any joysticks are opened.
device_index | the index of the joystick to query (the N'th joystick on the system |
SDL_JOYSTICK_TYPE_UNKNOWN
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.
device_index | the index of the joystick to query (the N'th joystick on the system |
SDL_JoystickGUID SDL_JoystickGetGUID | ( | SDL_Joystick * | joystick | ) |
Get the implementation-dependent GUID for the joystick.
This function requires an open joystick.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
SDL_JoystickGUID SDL_JoystickGetGUIDFromString | ( | const char * | pchGUID | ) |
Convert a GUID string into a SDL_JoystickGUID structure.
Performs no error checking. If this function is given a string containing an invalid GUID, the function will silently succeed, but the GUID generated will not be useful.
pchGUID | string containing an ASCII representation of a GUID |
void SDL_JoystickGetGUIDString | ( | SDL_JoystickGUID | guid, |
char * | pszGUID, | ||
int | cbGUID | ||
) |
Get an ASCII string representation for a given SDL_JoystickGUID.
You should supply at least 33 bytes for pszGUID.
guid | the SDL_JoystickGUID you wish to convert to string |
pszGUID | buffer in which to write the ASCII string |
cbGUID | the size of pszGUID |
Uint8 SDL_JoystickGetHat | ( | SDL_Joystick * | joystick, |
int | hat | ||
) |
Get the current state of a POV hat on a joystick.
The returned value will be 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
joystick | an SDL_Joystick structure containing joystick information |
hat | the hat index to get the state from; indices start at index 0 |
int SDL_JoystickGetPlayerIndex | ( | SDL_Joystick * | joystick | ) |
Get the player index of an opened joystick.
For XInput controllers this returns the XInput user index. Many joysticks will not be able to supply this information.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
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.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
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.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
const char* SDL_JoystickGetSerial | ( | SDL_Joystick * | joystick | ) |
Get the serial number of an opened joystick, if available.
Returns the serial number of the joystick, or NULL if it is not available.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
SDL_JoystickType SDL_JoystickGetType | ( | SDL_Joystick * | joystick | ) |
Get the type of an opened joystick.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
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.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
SDL_bool SDL_JoystickHasLED | ( | SDL_Joystick * | joystick | ) |
Query whether a joystick has an LED.
An example of a joystick LED is the light on the back of a PlayStation 4's DualShock 4 controller.
joystick | The joystick to query |
SDL_bool SDL_JoystickHasRumble | ( | SDL_Joystick * | joystick | ) |
Query whether a joystick has rumble support.
joystick | The joystick to query |
SDL_bool SDL_JoystickHasRumbleTriggers | ( | SDL_Joystick * | joystick | ) |
Query whether a joystick has rumble support on triggers.
joystick | The joystick to query |
SDL_JoystickID SDL_JoystickInstanceID | ( | SDL_Joystick * | joystick | ) |
Get the instance ID of an opened joystick.
joystick | an SDL_Joystick structure containing joystick information |
SDL_bool SDL_JoystickIsVirtual | ( | int | device_index | ) |
Query whether or not the joystick at a given device index is virtual.
device_index | a joystick device index. |
const char* SDL_JoystickName | ( | SDL_Joystick * | joystick | ) |
Get the implementation dependent name of a joystick.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
const char* SDL_JoystickNameForIndex | ( | int | device_index | ) |
Get the implementation dependent name of a joystick.
This can be called before any joysticks are opened.
device_index | the index of the joystick to query (the N'th joystick on the system) |
int SDL_JoystickNumAxes | ( | SDL_Joystick * | joystick | ) |
Get the number of general axis controls on a joystick.
Often, the directional pad on a game controller will either look like 4 separate buttons or a POV hat, and not axes, but all of this is up to the device and platform.
joystick | an SDL_Joystick structure containing joystick information |
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.
Most joysticks do not have trackballs.
joystick | an SDL_Joystick structure containing joystick information |
int SDL_JoystickNumButtons | ( | SDL_Joystick * | joystick | ) |
Get the number of buttons on a joystick.
joystick | an SDL_Joystick structure containing joystick information |
int SDL_JoystickNumHats | ( | SDL_Joystick * | joystick | ) |
Get the number of POV hats on a joystick.
joystick | an SDL_Joystick structure containing joystick information |
SDL_Joystick* SDL_JoystickOpen | ( | int | device_index | ) |
Open a joystick for use.
The device_index
argument refers to the N'th joystick presently recognized by SDL on the system. It is NOT the same as the instance ID used to identify the joystick in future events. See SDL_JoystickInstanceID() for more details about instance IDs.
The joystick subsystem must be initialized before a joystick can be opened for use.
device_index | the index of the joystick to query |
int SDL_JoystickRumble | ( | SDL_Joystick * | joystick, |
Uint16 | low_frequency_rumble, | ||
Uint16 | high_frequency_rumble, | ||
Uint32 | duration_ms | ||
) |
Start 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 |
int SDL_JoystickRumbleTriggers | ( | SDL_Joystick * | joystick, |
Uint16 | left_rumble, | ||
Uint16 | right_rumble, | ||
Uint32 | duration_ms | ||
) |
Start a rumble effect in the joystick's triggers
Each call to this function cancels any previous trigger rumble effect, and calling it with 0 intensity stops any rumbling.
Note that this function is for trigger rumble; the first joystick to support this was the PlayStation 5's DualShock 5 controller. If you want the (more common) whole-controller rumble, use SDL_JoystickRumble() instead.
joystick | The joystick to vibrate |
left_rumble | The intensity of the left trigger rumble motor, from 0 to 0xFFFF |
right_rumble | The intensity of the right trigger rumble motor, from 0 to 0xFFFF |
duration_ms | The duration of the rumble effect, in milliseconds |
int SDL_JoystickSendEffect | ( | SDL_Joystick * | joystick, |
const void * | data, | ||
int | size | ||
) |
Send a joystick specific effect packet
joystick | The joystick to affect |
data | The data to send to the joystick |
size | The size of the data to send to the joystick |
int SDL_JoystickSetLED | ( | SDL_Joystick * | joystick, |
Uint8 | red, | ||
Uint8 | green, | ||
Uint8 | blue | ||
) |
Update a joystick's LED color.
An example of a joystick LED is the light on the back of a PlayStation 4's DualShock 4 controller.
joystick | The joystick to update |
red | The intensity of the red LED |
green | The intensity of the green LED |
blue | The intensity of the blue LED |
void SDL_JoystickSetPlayerIndex | ( | SDL_Joystick * | joystick, |
int | player_index | ||
) |
Set the player index of an opened joystick.
joystick | the SDL_Joystick obtained from SDL_JoystickOpen() |
player_index | the player index to set. |
int SDL_JoystickSetVirtualAxis | ( | SDL_Joystick * | joystick, |
int | axis, | ||
Sint16 | value | ||
) |
Set values on an opened, virtual-joystick's axis.
Please note that values set here will not be applied until the next call to SDL_JoystickUpdate, which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following: SDL_PollEvent, SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent.
joystick | the virtual joystick on which to set state. |
axis | the specific axis on the virtual joystick to set. |
value | the new value for the specified axis. |
int SDL_JoystickSetVirtualButton | ( | SDL_Joystick * | joystick, |
int | button, | ||
Uint8 | value | ||
) |
Set values on an opened, virtual-joystick's button.
Please note that values set here will not be applied until the next call to SDL_JoystickUpdate, which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following: SDL_PollEvent, SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent.
joystick | the virtual joystick on which to set state. |
button | the specific button on the virtual joystick to set. |
value | the new value for the specified button. |
int SDL_JoystickSetVirtualHat | ( | SDL_Joystick * | joystick, |
int | hat, | ||
Uint8 | value | ||
) |
Set values on an opened, virtual-joystick's hat.
Please note that values set here will not be applied until the next call to SDL_JoystickUpdate, which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following: SDL_PollEvent, SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent.
joystick | the virtual joystick on which to set state. |
hat | the specific hat on the virtual joystick to set. |
value | the new value for the specified hat. |
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.
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.
int SDL_NumJoysticks | ( | void | ) |
Count the number of joysticks attached to the system.
void SDL_UnlockJoysticks | ( | void | ) |
Unlocking 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.