1#ifndef SDL3PP_JOYSTICK_H_
2#define SDL3PP_JOYSTICK_H_
4#include <SDL3/SDL_joystick.h>
5#include "SDL3pp_error.h"
6#include "SDL3pp_guid.h"
7#include "SDL3pp_mutex.h"
8#include "SDL3pp_power.h"
9#include "SDL3pp_properties.h"
10#include "SDL3pp_rect.h"
11#include "SDL3pp_sensor.h"
12#include "SDL3pp_stdinc.h"
76 constexpr explicit operator bool()
const {
return !!
value; }
106 SDL_JOYSTICK_TYPE_UNKNOWN;
109 SDL_JOYSTICK_TYPE_GAMEPAD;
112 SDL_JOYSTICK_TYPE_WHEEL;
115 SDL_JOYSTICK_TYPE_ARCADE_STICK;
118 SDL_JOYSTICK_TYPE_FLIGHT_STICK;
121 SDL_JOYSTICK_TYPE_DANCE_PAD;
124 SDL_JOYSTICK_TYPE_GUITAR;
127 SDL_JOYSTICK_TYPE_DRUM_KIT;
130 SDL_JOYSTICK_TYPE_ARCADE_PAD;
133 SDL_JOYSTICK_TYPE_THROTTLE;
136 SDL_JOYSTICK_TYPE_COUNT;
159 : m_joystickID(joystickID)
350 SDL_JOYSTICK_CONNECTION_INVALID;
353 SDL_JOYSTICK_CONNECTION_UNKNOWN;
356 SDL_JOYSTICK_CONNECTION_WIRED;
359 SDL_JOYSTICK_CONNECTION_WIRELESS;
410 : m_resource(resource)
441 : m_resource(
CheckError(SDL_OpenJoystick(instance_id)))
451 std::swap(m_resource, other.m_resource);
462 m_resource =
nullptr;
470 constexpr bool operator==(std::nullptr_t _)
const {
return !m_resource; }
473 constexpr explicit operator bool()
const {
return !!m_resource; }
912 void GetBall(
int ball,
int* dx,
int* dy);
960 Uint16 high_frequency_rumble,
1141 auto r =
reinterpret_cast<JoystickID*
>(SDL_GetJoysticks(&count));
1161 return SDL_GetJoystickNameForID(instance_id);
1185 return SDL_GetJoystickPathForID(instance_id);
1208 return SDL_GetJoystickPlayerIndexForID(instance_id);
1232 return SDL_GetJoystickGUIDForID(instance_id);
1257 return SDL_GetJoystickVendorForID(instance_id);
1282 return SDL_GetJoystickProductForID(instance_id);
1307 return SDL_GetJoystickProductVersionForID(instance_id);
1331 return SDL_GetJoystickTypeForID(instance_id);
1371 return {
CheckError(SDL_GetJoystickFromID(instance_id))};
1393 return {
CheckError(SDL_GetJoystickFromPlayerIndex(player_index))};
1442 return SDL_AttachVirtualJoystick(&desc);
1458 CheckError(SDL_DetachVirtualJoystick(instance_id));
1476 return SDL_IsJoystickVirtual(instance_id);
1507 CheckError(SDL_SetJoystickVirtualAxis(joystick, axis, value));
1536 CheckError(SDL_SetJoystickVirtualBall(joystick, ball, xrel, yrel));
1563 CheckError(SDL_SetJoystickVirtualButton(joystick, button, down));
1588 CheckError(SDL_SetJoystickVirtualHat(joystick, hat, value));
1623 joystick, touchpad, finger, down, p.x, p.y, pressure));
1633 m_resource, touchpad, finger, down, p, pressure);
1660 CheckError(SDL_SendJoystickVirtualSensorData(
1661 joystick, type, sensor_timestamp, data, num_values));
1670 m_resource, type, sensor_timestamp, data, num_values);
1697 return {
CheckError(SDL_GetJoystickProperties(joystick))};
1705namespace prop::JoystickCap {
1707constexpr auto MONO_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN;
1709constexpr auto RGB_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN;
1711constexpr auto PLAYER_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN;
1713constexpr auto RUMBLE_BOOLEAN = SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN;
1715constexpr auto TRIGGER_RUMBLE_BOOLEAN =
1716 SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN;
1733 return SDL_GetJoystickName(joystick);
1754 return SDL_GetJoystickPath(joystick);
1777 return SDL_GetJoystickPlayerIndex(joystick);
1799 CheckError(SDL_SetJoystickPlayerIndex(joystick, player_index));
1823 return SDL_GetJoystickGUID(joystick);
1842 return SDL_GetJoystickVendor(joystick);
1864 return SDL_GetJoystickProduct(joystick);
1886 return SDL_GetJoystickProductVersion(joystick);
1906 return SDL_GetJoystickFirmwareVersion(joystick);
1927 return SDL_GetJoystickSerial(joystick);
1947 return SDL_GetJoystickType(joystick);
1977 SDL_GetJoystickGUIDInfo(guid, vendor, product, version,
crc16);
1991 return SDL_JoystickConnected(joystick);
2007 return CheckError(SDL_GetJoystickID(joystick));
2032 return CheckError(SDL_GetNumJoystickAxes(joystick));
2061 return CheckError(SDL_GetNumJoystickBalls(joystick));
2085 return CheckError(SDL_GetNumJoystickHats(joystick));
2109 return CheckError(SDL_GetNumJoystickButtons(joystick));
2132 SDL_SetJoystickEventsEnabled(enabled);
2183 return SDL_GetJoystickAxis(joystick, axis);
2209 return SDL_GetJoystickAxisInitialState(joystick, axis, state);
2237 CheckError(SDL_GetJoystickBall(joystick, ball, dx, dy));
2260 return SDL_GetJoystickHat(joystick, hat);
2282 return SDL_GetJoystickButton(joystick, button);
2310 Uint16 low_frequency_rumble,
2311 Uint16 high_frequency_rumble,
2314 return SDL_RumbleJoystick(
2315 joystick, low_frequency_rumble, high_frequency_rumble, duration_ms);
2319 Uint16 high_frequency_rumble,
2323 m_resource, low_frequency_rumble, high_frequency_rumble, duration_ms);
2357 joystick, left_rumble, right_rumble, duration_ms));
2365 m_resource, left_rumble, right_rumble, duration_ms);
2390 CheckError(SDL_SetJoystickLED(joystick, red, green, blue));
2412 CheckError(SDL_SendJoystickEffect(joystick, data, size));
2445 return CheckError(SDL_GetJoystickConnectionState(joystick));
2473 return SDL_GetJoystickPowerInfo(joystick, percent);
This is a unique ID for a joystick for the time it is connected to the system, and is never reused fo...
Definition: SDL3pp_joystick.h:149
constexpr JoystickID(JoystickIDRaw joystickID={})
Wraps JoystickID.
Definition: SDL3pp_joystick.h:158
The joystick structure used to identify an SDL joystick.
Definition: SDL3pp_joystick.h:395
Joystick & operator=(Joystick other)
Assignment operator.
Definition: SDL3pp_joystick.h:449
constexpr auto operator<=>(const Joystick &other) const =default
Comparison.
constexpr JoystickRaw get() const
Retrieves underlying JoystickRaw.
Definition: SDL3pp_joystick.h:456
constexpr Joystick(const Joystick &other)=delete
Copy constructor.
~Joystick()
Destructor.
Definition: SDL3pp_joystick.h:446
constexpr bool operator==(std::nullptr_t _) const
Comparison.
Definition: SDL3pp_joystick.h:470
constexpr Joystick()=default
Default ctor.
Joystick(JoystickID instance_id)
Open a joystick for use.
Definition: SDL3pp_joystick.h:440
constexpr Joystick(Joystick &&other)
Move constructor.
Definition: SDL3pp_joystick.h:418
constexpr JoystickRaw release()
Retrieves underlying JoystickRaw and clear this.
Definition: SDL3pp_joystick.h:459
constexpr Joystick(const JoystickRaw resource)
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:409
Base class for SDL memory allocated array wrap.
Definition: SDL3pp_ownPtr.h:44
constexpr void CheckError(bool result)
Check and throw if returned value from SDL is an error.
Definition: SDL3pp_error.h:197
PropertiesRef GetJoystickProperties(JoystickParam joystick)
Get the properties associated with a joystick.
Definition: SDL3pp_joystick.h:1695
SDL_Joystick * JoystickRaw
Alias to raw representation for Joystick.
Definition: SDL3pp_joystick.h:53
int GetJoystickPlayerIndexForID(JoystickID instance_id)
Get the player index of a joystick.
Definition: SDL3pp_joystick.h:1206
constexpr JoystickType JOYSTICK_TYPE_COUNT
JOYSTICK_TYPE_COUNT.
Definition: SDL3pp_joystick.h:135
Uint16 GetProductVersion()
Get the product version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1889
constexpr Uint8 HAT_UP
UP.
Definition: SDL3pp_joystick.h:369
int GetJoystickPlayerIndexForID()
Get the player index of a joystick.
Definition: SDL3pp_joystick.h:1211
int GetPlayerIndex()
Get the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1780
void LockJoysticks()
Locking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1106
bool IsJoystickVirtual()
Query whether or not a joystick is virtual.
Definition: SDL3pp_joystick.h:1479
Uint16 GetJoystickVendorForID()
Get the USB vendor ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1260
int GetNumJoystickBalls(JoystickParam joystick)
Get the number of trackballs on a joystick.
Definition: SDL3pp_joystick.h:2059
constexpr JoystickType JOYSTICK_TYPE_ARCADE_STICK
JOYSTICK_TYPE_ARCADE_STICK.
Definition: SDL3pp_joystick.h:114
bool HasJoystick()
Return whether a joystick is currently connected.
Definition: SDL3pp_joystick.h:1124
constexpr Uint8 HAT_LEFT
LEFT.
Definition: SDL3pp_joystick.h:375
Uint16 GetJoystickProductForID(JoystickID instance_id)
Get the USB product ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1280
Uint16 GetProduct()
Get the USB product ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1867
int GetNumBalls()
Get the number of trackballs on a joystick.
Definition: SDL3pp_joystick.h:2064
bool GetButton(int button)
Get the current state of a button on a joystick.
Definition: SDL3pp_joystick.h:2285
JoystickID AttachVirtualJoystick(const VirtualJoystickDesc &desc)
Attach a new virtual joystick.
Definition: SDL3pp_joystick.h:1440
Sint16 GetAxis(int axis)
Get the current state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2186
void SetJoystickLED(JoystickParam joystick, Uint8 red, Uint8 green, Uint8 blue)
Update a joystick's LED color.
Definition: SDL3pp_joystick.h:2385
Uint16 GetVendor()
Get the USB vendor ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1845
constexpr Uint8 HAT_DOWN
DOWN.
Definition: SDL3pp_joystick.h:373
SDL_VirtualJoystickTouchpadDesc VirtualJoystickTouchpadDesc
The structure that describes a virtual joystick touchpad.
Definition: SDL3pp_joystick.h:1403
constexpr JoystickType JOYSTICK_TYPE_DRUM_KIT
JOYSTICK_TYPE_DRUM_KIT.
Definition: SDL3pp_joystick.h:126
void SetJoystickVirtualHat(JoystickParam joystick, int hat, Uint8 value)
Set the state of a hat on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1586
void SetJoystickVirtualBall(JoystickParam joystick, int ball, Sint16 xrel, Sint16 yrel)
Generate ball motion on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1531
const char * GetJoystickName(JoystickParam joystick)
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1731
constexpr JoystickConnectionState JOYSTICK_CONNECTION_INVALID
JOYSTICK_CONNECTION_INVALID.
Definition: SDL3pp_joystick.h:349
constexpr JoystickConnectionState JOYSTICK_CONNECTION_UNKNOWN
JOYSTICK_CONNECTION_UNKNOWN.
Definition: SDL3pp_joystick.h:352
void SetJoystickVirtualAxis(JoystickParam joystick, int axis, Sint16 value)
Set the state of an axis on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1503
JoystickID GetJoystickID(JoystickParam joystick)
Get the instance ID of an opened joystick.
Definition: SDL3pp_joystick.h:2005
GUID GetGUID()
Get the implementation-dependent GUID for the joystick.
Definition: SDL3pp_joystick.h:1826
Uint16 GetJoystickVendor(JoystickParam joystick)
Get the USB vendor ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1840
int GetNumHats()
Get the number of POV hats on a joystick.
Definition: SDL3pp_joystick.h:2088
JoystickType GetJoystickTypeForID(JoystickID instance_id)
Get the type of a joystick, if available.
Definition: SDL3pp_joystick.h:1329
JoystickRef GetJoystickFromPlayerIndex(int player_index)
Get the Joystick associated with a player index.
Definition: SDL3pp_joystick.h:1391
Uint16 GetJoystickProductVersionForID()
Get the product version of a joystick, if available.
Definition: SDL3pp_joystick.h:1310
void SendJoystickVirtualSensorData(JoystickParam joystick, SensorType type, Uint64 sensor_timestamp, const float *data, int num_values)
Send a sensor update for an opened virtual joystick.
Definition: SDL3pp_joystick.h:1654
const char * GetPath()
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1757
constexpr JoystickType JOYSTICK_TYPE_WHEEL
JOYSTICK_TYPE_WHEEL.
Definition: SDL3pp_joystick.h:111
bool RumbleJoystick(JoystickParam joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Start a rumble effect.
Definition: SDL3pp_joystick.h:2309
constexpr Uint8 HAT_RIGHTDOWN
RIGHTDOWN.
Definition: SDL3pp_joystick.h:379
void GetJoystickBall(JoystickParam joystick, int ball, int *dx, int *dy)
Get the ball axis change since the last poll.
Definition: SDL3pp_joystick.h:2235
void UpdateJoysticks()
Update the current state of the open joysticks.
Definition: SDL3pp_joystick.h:2157
Joystick OpenJoystick()
Open a joystick for use.
Definition: SDL3pp_joystick.h:1358
void SendEffect(const void *data, int size)
Send a joystick specific effect packet.
Definition: SDL3pp_joystick.h:2415
void SetJoystickPlayerIndex(JoystickParam joystick, int player_index)
Set the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1797
void SetVirtualButton(int button, bool down)
Set the state of a button on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1566
int GetNumJoystickAxes(JoystickParam joystick)
Get the number of general axis controls on a joystick.
Definition: SDL3pp_joystick.h:2030
void DetachVirtualJoystick(JoystickID instance_id)
Detach a virtual joystick.
Definition: SDL3pp_joystick.h:1456
SDL_JoystickID JoystickIDRaw
Alias to raw representation for JoystickID.
Definition: SDL3pp_joystick.h:86
constexpr JoystickType JOYSTICK_TYPE_GUITAR
JOYSTICK_TYPE_GUITAR.
Definition: SDL3pp_joystick.h:123
JoystickType GetJoystickTypeForID()
Get the type of a joystick, if available.
Definition: SDL3pp_joystick.h:1334
void SetVirtualBall(int ball, Sint16 xrel, Sint16 yrel)
Generate ball motion on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1539
int GetNumAxes()
Get the number of general axis controls on a joystick.
Definition: SDL3pp_joystick.h:2035
constexpr JoystickType JOYSTICK_TYPE_UNKNOWN
JOYSTICK_TYPE_UNKNOWN.
Definition: SDL3pp_joystick.h:105
void DetachVirtualJoystick()
Detach a virtual joystick.
Definition: SDL3pp_joystick.h:1461
void SetVirtualTouchpad(int touchpad, int finger, bool down, const FPointRaw &p, float pressure)
Set touchpad finger state on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1626
void SetLED(Uint8 red, Uint8 green, Uint8 blue)
Update a joystick's LED color.
Definition: SDL3pp_joystick.h:2393
void RumbleTriggers(Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
Start a rumble effect in the joystick's triggers.
Definition: SDL3pp_joystick.h:2360
Uint16 GetJoystickVendorForID(JoystickID instance_id)
Get the USB vendor ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1255
bool GetJoystickButton(JoystickParam joystick, int button)
Get the current state of a button on a joystick.
Definition: SDL3pp_joystick.h:2280
JoystickType GetJoystickType(JoystickParam joystick)
Get the type of an opened joystick.
Definition: SDL3pp_joystick.h:1945
void SetVirtualAxis(int axis, Sint16 value)
Set the state of an axis on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1510
constexpr Uint8 HAT_RIGHT
RIGHT.
Definition: SDL3pp_joystick.h:371
constexpr JoystickType JOYSTICK_TYPE_FLIGHT_STICK
JOYSTICK_TYPE_FLIGHT_STICK.
Definition: SDL3pp_joystick.h:117
constexpr JoystickType JOYSTICK_TYPE_GAMEPAD
JOYSTICK_TYPE_GAMEPAD.
Definition: SDL3pp_joystick.h:108
void SetJoystickVirtualTouchpad(JoystickParam joystick, int touchpad, int finger, bool down, const FPointRaw &p, float pressure)
Set touchpad finger state on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1615
constexpr JoystickType JOYSTICK_TYPE_DANCE_PAD
JOYSTICK_TYPE_DANCE_PAD.
Definition: SDL3pp_joystick.h:120
void UnlockJoysticks()
Unlocking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1113
PropertiesRef GetProperties()
Get the properties associated with a joystick.
Definition: SDL3pp_joystick.h:1700
GUID GetJoystickGUIDForID()
Get the implementation-dependent GUID of a joystick.
Definition: SDL3pp_joystick.h:1235
Uint16 GetFirmwareVersion()
Get the firmware version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1909
constexpr Uint8 HAT_LEFTUP
LEFTUP.
Definition: SDL3pp_joystick.h:381
GUID GetJoystickGUID(JoystickParam joystick)
Get the implementation-dependent GUID for the joystick.
Definition: SDL3pp_joystick.h:1821
constexpr JoystickType JOYSTICK_TYPE_THROTTLE
JOYSTICK_TYPE_THROTTLE.
Definition: SDL3pp_joystick.h:132
const char * GetSerial()
Get the serial number of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1930
bool Rumble(Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Start a rumble effect.
Definition: SDL3pp_joystick.h:2318
OwnArray< JoystickID > GetJoysticks()
Get a list of currently connected joysticks.
Definition: SDL3pp_joystick.h:1138
constexpr int JOYSTICK_AXIS_MAX
The largest value an Joystick's axis can report.
Definition: SDL3pp_joystick.h:1084
PowerState GetJoystickPowerInfo(JoystickParam joystick, int *percent)
Get the battery state of a joystick.
Definition: SDL3pp_joystick.h:2471
constexpr int JOYSTICK_AXIS_MIN
The smallest value an Joystick's axis can report.
Definition: SDL3pp_joystick.h:1095
int GetJoystickPlayerIndex(JoystickParam joystick)
Get the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1775
Uint16 GetJoystickProductVersionForID(JoystickID instance_id)
Get the product version of a joystick, if available.
Definition: SDL3pp_joystick.h:1305
void SetJoystickEventsEnabled(bool enabled)
Set the state of joystick event processing.
Definition: SDL3pp_joystick.h:2130
constexpr Uint8 HAT_RIGHTUP
RIGHTUP.
Definition: SDL3pp_joystick.h:377
bool Connected()
Get the status of a specified joystick.
Definition: SDL3pp_joystick.h:1994
GUID GetJoystickGUIDForID(JoystickID instance_id)
Get the implementation-dependent GUID of a joystick.
Definition: SDL3pp_joystick.h:1230
void SendJoystickEffect(JoystickParam joystick, const void *data, int size)
Send a joystick specific effect packet.
Definition: SDL3pp_joystick.h:2408
Uint16 GetJoystickFirmwareVersion(JoystickParam joystick)
Get the firmware version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1904
Uint8 GetJoystickHat(JoystickParam joystick, int hat)
Get the current state of a POV hat on a joystick.
Definition: SDL3pp_joystick.h:2258
constexpr Uint8 HAT_CENTERED
CENTERED.
Definition: SDL3pp_joystick.h:367
const char * GetJoystickPath(JoystickParam joystick)
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1752
Uint16 GetJoystickProduct(JoystickParam joystick)
Get the USB product ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1862
const char * GetJoystickSerial(JoystickParam joystick)
Get the serial number of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1925
JoystickType GetType()
Get the type of an opened joystick.
Definition: SDL3pp_joystick.h:1950
int GetNumJoystickButtons(JoystickParam joystick)
Get the number of buttons on a joystick.
Definition: SDL3pp_joystick.h:2107
int GetNumJoystickHats(JoystickParam joystick)
Get the number of POV hats on a joystick.
Definition: SDL3pp_joystick.h:2083
SDL_VirtualJoystickSensorDesc VirtualJoystickSensorDesc
The structure that describes a virtual joystick sensor.
Definition: SDL3pp_joystick.h:1412
SDL_JoystickConnectionState JoystickConnectionState
Possible connection states for a joystick device.
Definition: SDL3pp_joystick.h:347
bool GetJoystickAxisInitialState(JoystickParam joystick, int axis, Sint16 *state)
Get the initial state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2205
constexpr JoystickConnectionState JOYSTICK_CONNECTION_WIRELESS
JOYSTICK_CONNECTION_WIRELESS.
Definition: SDL3pp_joystick.h:358
bool JoystickConnected(JoystickParam joystick)
Get the status of a specified joystick.
Definition: SDL3pp_joystick.h:1989
void SendVirtualSensorData(SensorType type, Uint64 sensor_timestamp, const float *data, int num_values)
Send a sensor update for an opened virtual joystick.
Definition: SDL3pp_joystick.h:1664
bool GetAxisInitialState(int axis, Sint16 *state)
Get the initial state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2212
JoystickRef GetJoystickFromID(JoystickID instance_id)
Get the Joystick associated with an instance ID, if it has been opened.
Definition: SDL3pp_joystick.h:1369
JoystickRef GetJoystickFromID()
Get the Joystick associated with an instance ID, if it has been opened.
Definition: SDL3pp_joystick.h:1374
void Close()
Close a joystick previously opened with JoystickID.OpenJoystick().
Definition: SDL3pp_joystick.h:2431
bool JoystickEventsEnabled()
Query the state of joystick event processing.
Definition: SDL3pp_joystick.h:2147
void CloseJoystick(JoystickRaw joystick)
Close a joystick previously opened with JoystickID.OpenJoystick().
Definition: SDL3pp_joystick.h:2429
SDL_VirtualJoystickDesc VirtualJoystickDesc
The structure that describes a virtual joystick.
Definition: SDL3pp_joystick.h:1427
const char * GetJoystickPathForID()
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1188
Uint8 HatState
Represents tbe HatState for a Joystick.
Definition: SDL3pp_joystick.h:365
void SetVirtualHat(int hat, Uint8 value)
Set the state of a hat on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1591
constexpr JoystickType JOYSTICK_TYPE_ARCADE_PAD
JOYSTICK_TYPE_ARCADE_PAD.
Definition: SDL3pp_joystick.h:129
JoystickConnectionState GetConnectionState()
Get the connection state of a joystick.
Definition: SDL3pp_joystick.h:2448
PowerState GetPowerInfo(int *percent)
Get the battery state of a joystick.
Definition: SDL3pp_joystick.h:2476
Sint16 GetJoystickAxis(JoystickParam joystick, int axis)
Get the current state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2181
bool IsJoystickVirtual(JoystickID instance_id)
Query whether or not a joystick is virtual.
Definition: SDL3pp_joystick.h:1474
JoystickID GetID()
Get the instance ID of an opened joystick.
Definition: SDL3pp_joystick.h:2010
constexpr JoystickConnectionState JOYSTICK_CONNECTION_WIRED
JOYSTICK_CONNECTION_WIRED.
Definition: SDL3pp_joystick.h:355
const char * GetJoystickNameForID()
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1164
const char * GetJoystickPathForID(JoystickID instance_id)
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1183
void GetJoystickGUIDInfo(GUID guid, Uint16 *vendor, Uint16 *product, Uint16 *version, Uint16 *crc16)
Get the device information encoded in a GUID structure.
Definition: SDL3pp_joystick.h:1971
constexpr Uint8 HAT_LEFTDOWN
LEFTDOWN.
Definition: SDL3pp_joystick.h:383
Joystick OpenJoystick(JoystickID instance_id)
Open a joystick for use.
Definition: SDL3pp_joystick.h:1353
Uint16 GetJoystickProductVersion(JoystickParam joystick)
Get the product version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1884
const char * GetName()
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1736
Uint8 GetHat(int hat)
Get the current state of a POV hat on a joystick.
Definition: SDL3pp_joystick.h:2263
void SetPlayerIndex(int player_index)
Set the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1802
JoystickConnectionState GetJoystickConnectionState(JoystickParam joystick)
Get the connection state of a joystick.
Definition: SDL3pp_joystick.h:2442
void GetBall(int ball, int *dx, int *dy)
Get the ball axis change since the last poll.
Definition: SDL3pp_joystick.h:2240
Uint16 GetJoystickProductForID()
Get the USB product ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1285
void RumbleJoystickTriggers(JoystickParam joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
Start a rumble effect in the joystick's triggers.
Definition: SDL3pp_joystick.h:2351
const char * GetJoystickNameForID(JoystickID instance_id)
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1159
void SetJoystickVirtualButton(JoystickParam joystick, int button, bool down)
Set the state of a button on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1559
int GetNumButtons()
Get the number of buttons on a joystick.
Definition: SDL3pp_joystick.h:2112
SDL_JoystickType JoystickType
An enum of some common joystick types.
Definition: SDL3pp_joystick.h:103
SDL_PowerState PowerState
The basic state for the system's power supply.
Definition: SDL3pp_power.h:38
SDL_FPoint FPointRaw
Alias to raw representation for FPoint.
Definition: SDL3pp_rect.h:28
SDL_SensorType SensorType
The different sensors defined by SDL.
Definition: SDL3pp_sensor.h:125
Uint16 crc16(Uint16 crc, const void *data, size_t len)
Calculate a CRC-16 value.
Definition: SDL3pp_stdinc.h:2262
::Uint32 Uint32
An unsigned 32-bit integer type.
Definition: SDL3pp_stdinc.h:341
::Uint64 Uint64
An unsigned 64-bit integer type.
Definition: SDL3pp_stdinc.h:371
::Uint8 Uint8
An unsigned 8-bit integer type.
Definition: SDL3pp_stdinc.h:289
::Sint16 Sint16
A signed 16-bit integer type.
Definition: SDL3pp_stdinc.h:302
::Uint16 Uint16
An unsigned 16-bit integer type.
Definition: SDL3pp_stdinc.h:315
Main include header for the SDL3pp library.
An GUID is a 128-bit identifier for an input device that identifies that device across runs of SDL pr...
Definition: SDL3pp_guid.h:44
Safely wrap Joystick for non owning parameters.
Definition: SDL3pp_joystick.h:60
constexpr JoystickParam(JoystickRaw value)
Constructs from JoystickRaw.
Definition: SDL3pp_joystick.h:64
JoystickRaw value
parameter's JoystickRaw
Definition: SDL3pp_joystick.h:61
constexpr auto operator<=>(const JoystickParam &other) const =default
Comparison.
constexpr JoystickParam(std::nullptr_t _=nullptr)
Constructs null/invalid.
Definition: SDL3pp_joystick.h:70
Semi-safe reference for Joystick.
Definition: SDL3pp_joystick.h:1054
JoystickRef(const JoystickRef &other)
Copy constructor.
Definition: SDL3pp_joystick.h:1068
JoystickRef(JoystickParam resource)
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:1062
~JoystickRef()
Destructor.
Definition: SDL3pp_joystick.h:1074
Semi-safe reference for Properties.
Definition: SDL3pp_properties.h:701