SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_guid.h>
#include <SDL3/SDL_mutex.h>
#include <SDL3/SDL_properties.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Data Structures | |
struct | SDL_VirtualJoystickDesc |
Macros | |
#define | SDL_JOYSTICK_AXIS_MAX 32767 |
#define | SDL_JOYSTICK_AXIS_MIN -32768 |
#define | SDL_IPHONE_MAX_GFORCE 5.0 |
#define | SDL_VIRTUAL_JOYSTICK_DESC_VERSION 1 |
Typedefs | |
typedef struct SDL_Joystick | SDL_Joystick |
typedef SDL_GUID | SDL_JoystickGUID |
typedef Uint32 | SDL_JoystickID |
Include file for SDL joystick event handling
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 831 of file SDL_joystick.h.
#define SDL_HAT_DOWN 0x04 |
Definition at line 834 of file SDL_joystick.h.
#define SDL_HAT_LEFT 0x08 |
Definition at line 835 of file SDL_joystick.h.
#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) |
Definition at line 839 of file SDL_joystick.h.
#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) |
Definition at line 838 of file SDL_joystick.h.
#define SDL_HAT_RIGHT 0x02 |
Definition at line 833 of file SDL_joystick.h.
#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) |
Definition at line 837 of file SDL_joystick.h.
#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) |
Definition at line 836 of file SDL_joystick.h.
#define SDL_HAT_UP 0x01 |
Definition at line 832 of file SDL_joystick.h.
#define SDL_IPHONE_MAX_GFORCE 5.0 |
Definition at line 117 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MAX 32767 |
Definition at line 111 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MIN -32768 |
Definition at line 112 of file SDL_joystick.h.
#define SDL_VIRTUAL_JOYSTICK_DESC_VERSION 1 |
The current version of the SDL_VirtualJoystickDesc structure
Definition at line 364 of file SDL_joystick.h.
typedef struct SDL_Joystick SDL_Joystick |
Definition at line 72 of file SDL_joystick.h.
typedef SDL_GUID SDL_JoystickGUID |
Definition at line 75 of file SDL_joystick.h.
typedef Uint32 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 1 and increments from there. The value 0 is an invalid ID.
Definition at line 84 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 100 of file SDL_joystick.h.
enum SDL_JoystickType |
Definition at line 86 of file SDL_joystick.h.
|
extern |
Attach a new virtual joystick.
type | type of joystick |
naxes | number of axes |
nbuttons | number of buttons |
nhats | number of hats |
|
extern |
Attach a new virtual joystick with extended properties.
desc | Joystick description |
|
extern |
Close a joystick previously opened with SDL_OpenJoystick().
joystick | The joystick device to close |
|
extern |
Detach a virtual joystick.
instance_id | the joystick instance ID, previously returned from SDL_AttachVirtualJoystick() |
|
extern |
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_GetJoystickAxis() 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 |
|
extern |
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. |
|
extern |
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 |
|
extern |
Get the firmware version of an opened joystick, if available.
If the firmware version isn't available this function returns 0.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
|
extern |
Get the SDL_Joystick associated with an instance ID, if it has been opened.
instance_id | the instance ID to get the SDL_Joystick for |
|
extern |
Get the SDL_Joystick associated with a player index.
player_index | the player index to get the SDL_Joystick for |
|
extern |
Get the implementation-dependent GUID for the joystick.
This function requires an open joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
|
extern |
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 |
|
extern |
Get the device information encoded in a SDL_JoystickGUID structure
guid | the SDL_JoystickGUID you wish to get info about |
vendor | A pointer filled in with the device VID, or 0 if not available |
product | A pointer filled in with the device PID, or 0 if not available |
version | A pointer filled in with the device version, or 0 if not available |
crc16 | A pointer filled in with a CRC used to distinguish different products with the same VID/PID, or 0 if not available |
|
extern |
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 |
|
extern |
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 |
|
extern |
Get the implementation-dependent GUID of a joystick.
This can be called before any joysticks are opened.
instance_id | the joystick instance ID |
|
extern |
Get the instance ID of an opened joystick.
joystick | an SDL_Joystick structure containing joystick information |
|
extern |
Get the implementation dependent name of a joystick.
This can be called before any joysticks are opened.
instance_id | the joystick instance ID |
|
extern |
Get the implementation dependent path of a joystick.
This can be called before any joysticks are opened.
instance_id | the joystick instance ID |
|
extern |
Get the player index of a joystick.
This can be called before any joysticks are opened.
instance_id | the joystick instance ID |
|
extern |
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.
instance_id | the joystick instance ID |
|
extern |
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.
instance_id | the joystick instance ID |
|
extern |
Get the type of a joystick, if available.
This can be called before any joysticks are opened.
instance_id | the joystick instance ID |
SDL_JOYSTICK_TYPE_UNKNOWN
|
extern |
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.
instance_id | the joystick instance ID |
|
extern |
Get the implementation dependent name of a joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
|
extern |
Get the implementation dependent path of a joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
|
extern |
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_OpenJoystick() |
|
extern |
Get the battery level of a joystick as SDL_JoystickPowerLevel.
joystick | the SDL_Joystick to query |
SDL_JOYSTICK_POWER_UNKNOWN
if it is unknown
|
extern |
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_OpenJoystick() |
|
extern |
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_OpenJoystick() |
|
extern |
Get the properties associated with a joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
|
extern |
Get a list of currently connected joysticks.
count | a pointer filled in with the number of joysticks returned |
|
extern |
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_OpenJoystick() |
|
extern |
Get the type of an opened joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
|
extern |
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_OpenJoystick() |
|
extern |
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 |
|
extern |
Get the number of buttons on a joystick.
joystick | an SDL_Joystick structure containing joystick information |
|
extern |
Get the number of POV hats on a joystick.
joystick | an SDL_Joystick structure containing joystick information |
|
extern |
Query whether or not a joystick is virtual.
instance_id | the joystick instance ID |
|
extern |
Get the status of a specified joystick.
joystick | the joystick to query |
|
extern |
Query the state of joystick event processing.
If joystick events are disabled, you must call SDL_UpdateJoysticks() yourself and check the state of the joystick when you want joystick information.
|
extern |
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 |
|
extern |
Query whether a joystick has rumble support.
joystick | The joystick to query |
|
extern |
Query whether a joystick has rumble support on triggers.
joystick | The joystick to query |
|
extern |
Locking for atomic access to the joystick API
The SDL joystick functions are thread-safe, however you can lock the joysticks while processing to guarantee that the joystick list won't change and joystick and gamepad events will not be delivered.
|
extern |
Open a joystick for use.
The joystick subsystem must be initialized before a joystick can be opened for use.
instance_id | the joystick instance ID |
|
extern |
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 |
|
extern |
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 is rumbling of the triggers and not the game controller as a whole. This is currently only supported on Xbox One controllers. If you want the (more common) whole-controller rumble, use SDL_RumbleJoystick() 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 |
|
extern |
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 |
|
extern |
Set the state of joystick event processing.
If joystick events are disabled, you must call SDL_UpdateJoysticks() yourself and check the state of the joystick when you want joystick information.
enabled | whether to process joystick events or not |
|
extern |
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 |
|
extern |
Set the player index of an opened joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick() |
player_index | Player index to assign to this joystick, or -1 to clear the player index and turn off player LEDs. |
|
extern |
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_UpdateJoysticks, 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.
Note that when sending trigger axes, you should scale the value to the full range of Sint16. For example, a trigger at rest would have the value of SDL_JOYSTICK_AXIS_MIN
.
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. |
|
extern |
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_UpdateJoysticks, 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. |
|
extern |
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_UpdateJoysticks, 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. |
|
extern |
Unlocking for atomic access to the joystick API
|
extern |
Update the current state of the open joysticks.
This is called automatically by the event loop if any joystick events are enabled.