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_power.h>
#include <SDL3/SDL_properties.h>
#include <SDL3/SDL_sensor.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_VirtualJoystickTouchpadDesc |
struct | SDL_VirtualJoystickSensorDesc |
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_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN "SDL.joystick.cap.mono_led" |
#define | SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN "SDL.joystick.cap.rgb_led" |
#define | SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN "SDL.joystick.cap.player_led" |
#define | SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN "SDL.joystick.cap.rumble" |
#define | SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN "SDL.joystick.cap.trigger_rumble" |
#define | SDL_HAT_CENTERED 0x00u |
#define | SDL_HAT_UP 0x01u |
#define | SDL_HAT_RIGHT 0x02u |
#define | SDL_HAT_DOWN 0x04u |
#define | SDL_HAT_LEFT 0x08u |
#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) |
Typedefs | |
typedef struct SDL_Joystick | SDL_Joystick |
typedef Uint32 | SDL_JoystickID |
#define SDL_HAT_CENTERED 0x00u |
Definition at line 1039 of file SDL_joystick.h.
#define SDL_HAT_DOWN 0x04u |
Definition at line 1042 of file SDL_joystick.h.
#define SDL_HAT_LEFT 0x08u |
Definition at line 1043 of file SDL_joystick.h.
#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) |
Definition at line 1047 of file SDL_joystick.h.
#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) |
Definition at line 1046 of file SDL_joystick.h.
#define SDL_HAT_RIGHT 0x02u |
Definition at line 1041 of file SDL_joystick.h.
#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) |
Definition at line 1045 of file SDL_joystick.h.
#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) |
Definition at line 1044 of file SDL_joystick.h.
#define SDL_HAT_UP 0x01u |
Definition at line 1040 of file SDL_joystick.h.
#define SDL_IPHONE_MAX_GFORCE 5.0 |
Definition at line 166 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MAX 32767 |
The largest value an SDL_Joystick's axis can report.
Definition at line 149 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MIN -32768 |
The smallest value an SDL_Joystick's axis can report.
This is a negative number!
Definition at line 160 of file SDL_joystick.h.
#define SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN "SDL.joystick.cap.mono_led" |
Definition at line 648 of file SDL_joystick.h.
#define SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN "SDL.joystick.cap.player_led" |
Definition at line 650 of file SDL_joystick.h.
#define SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN "SDL.joystick.cap.rgb_led" |
Definition at line 649 of file SDL_joystick.h.
#define SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN "SDL.joystick.cap.rumble" |
Definition at line 651 of file SDL_joystick.h.
#define SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN "SDL.joystick.cap.trigger_rumble" |
Definition at line 652 of file SDL_joystick.h.
typedef struct SDL_Joystick SDL_Joystick |
SDL joystick support.
This is the lower-level joystick handling. If you want the simpler option, where what buttons does what is well-defined, you should use the gamepad API instead.
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.
SDL_GUID is used as 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 The joystick structure used to identify an SDL joystick.
This is opaque data.
Definition at line 86 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 value 0 is an invalid ID.
Definition at line 98 of file SDL_joystick.h.
Possible connection states for a joystick device.
This is used by SDL_GetJoystickConnectionState to report how a device is connected to the system.
Enumerator | |
---|---|
SDL_JOYSTICK_CONNECTION_INVALID | |
SDL_JOYSTICK_CONNECTION_UNKNOWN | |
SDL_JOYSTICK_CONNECTION_WIRED | |
SDL_JOYSTICK_CONNECTION_WIRELESS |
Definition at line 134 of file SDL_joystick.h.
enum SDL_JoystickType |
An enum of some common joystick types.
In some cases, SDL can identify a low-level joystick as being a certain type of device, and will report it through SDL_GetJoystickType (or SDL_GetJoystickTypeForID).
This is by no means a complete list of everything that can be plugged into a computer.
Definition at line 112 of file SDL_joystick.h.
|
extern |
Attach a new virtual joystick.
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 ball axis change since the last poll.
Trackballs can only return relative motion since the last call to SDL_GetJoystickBall(), 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. |
|
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 connection state of a joystick.
joystick | the joystick to query. |
SDL_JOYSTICK_CONNECTION_INVALID
on failure; call SDL_GetError() for more information.
|
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 |
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 device information encoded in a SDL_GUID structure.
guid | the SDL_GUID 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 the current state of a POV hat on a joystick.
The returned value will be one of the SDL_HAT_*
values.
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 instance ID of an opened joystick.
joystick | an SDL_Joystick structure containing joystick information. |
|
extern |
Get the implementation dependent name of a joystick.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick(). |
|
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.
joystick | the SDL_Joystick obtained from SDL_OpenJoystick(). |
|
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 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 player index of a joystick.
This can be called before any joysticks are opened.
instance_id | the joystick instance ID. |
|
extern |
Get the battery state of a joystick.
You should never take a battery status as absolute truth. Batteries (especially failing batteries) are delicate hardware, and the values reported here are best estimates based on what that hardware reports. It's not uncommon for older batteries to lose stored power much faster than it reports, or completely drain when reporting it has 20 percent left, etc.
joystick | the joystick to query. |
percent | a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. |
SDL_POWERSTATE_ERROR
on failure; call SDL_GetError() for more information.
|
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 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 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 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 properties associated with a joystick.
The following read-only properties are provided by SDL:
SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN
: true if this joystick has an LED that has adjustable brightnessSDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN
: true if this joystick has an LED that has adjustable colorSDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN
: true if this joystick has a player LEDSDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN
: true if this joystick has left/right rumbleSDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN
: true if this joystick has simple trigger rumblejoystick | 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, may be NULL. |
|
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 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 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 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 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 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. |
|
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 |
Return whether a joystick is currently connected.
|
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 |
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.
This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
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.
This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
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 |
Send a sensor update for an opened virtual joystick.
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. |
type | the type of the sensor on the virtual joystick to update. |
sensor_timestamp | a 64-bit timestamp in nanoseconds associated with the sensor reading. |
data | the data associated with the sensor reading. |
num_values | the number of values pointed to by data . |
|
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.
For joysticks with a single color LED, the maximum of the RGB values will be used as the LED brightness.
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 the state of an axis on an opened virtual joystick.
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 index of the axis on the virtual joystick to update. |
value | the new value for the specified axis. |
|
extern |
Generate ball motion on an opened virtual joystick.
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. |
ball | the index of the ball on the virtual joystick to update. |
xrel | the relative motion on the X axis. |
yrel | the relative motion on the Y axis. |
|
extern |
Set the state of a button on an opened virtual joystick.
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 index of the button on the virtual joystick to update. |
value | the new value for the specified button. |
|
extern |
Set the state of a hat on an opened virtual joystick.
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 index of the hat on the virtual joystick to update. |
value | the new value for the specified hat. |
|
extern |
Set touchpad finger state on an opened virtual joystick.
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. |
touchpad | the index of the touchpad on the virtual joystick to update. |
finger | the index of the finger on the touchpad to set. |
state | SDL_PRESSED if the finger is pressed, SDL_RELEASED if the finger is released. |
x | the x coordinate of the finger on the touchpad, normalized 0 to 1, with the origin in the upper left. |
y | the y coordinate of the finger on the touchpad, normalized 0 to 1, with the origin in the upper left. |
pressure | the pressure of the finger. |
|
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.