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; }
103 SDL_JOYSTICK_TYPE_UNKNOWN;
106 SDL_JOYSTICK_TYPE_GAMEPAD;
109 SDL_JOYSTICK_TYPE_WHEEL;
112 SDL_JOYSTICK_TYPE_ARCADE_STICK;
115 SDL_JOYSTICK_TYPE_FLIGHT_STICK;
118 SDL_JOYSTICK_TYPE_DANCE_PAD;
121 SDL_JOYSTICK_TYPE_GUITAR;
124 SDL_JOYSTICK_TYPE_DRUM_KIT;
127 SDL_JOYSTICK_TYPE_ARCADE_PAD;
130 SDL_JOYSTICK_TYPE_THROTTLE;
133 SDL_JOYSTICK_TYPE_COUNT;
156 : m_joystickID(joystickID)
348 SDL_JOYSTICK_CONNECTION_INVALID;
351 SDL_JOYSTICK_CONNECTION_UNKNOWN;
354 SDL_JOYSTICK_CONNECTION_WIRED;
357 SDL_JOYSTICK_CONNECTION_WIRELESS;
408 : m_resource(resource)
439 : m_resource(
CheckError(SDL_OpenJoystick(instance_id)))
449 std::swap(m_resource, other.m_resource);
460 m_resource =
nullptr;
468 constexpr bool operator==(std::nullptr_t _)
const {
return !m_resource; }
471 constexpr explicit operator bool()
const {
return !!m_resource; }
917 void GetBall(
int ball,
int* dx,
int* dy);
965 Uint16 high_frequency_rumble,
1146 auto r =
reinterpret_cast<JoystickID*
>(SDL_GetJoysticks(&count));
1166 return SDL_GetJoystickNameForID(instance_id);
1190 return SDL_GetJoystickPathForID(instance_id);
1213 return SDL_GetJoystickPlayerIndexForID(instance_id);
1237 return SDL_GetJoystickGUIDForID(instance_id);
1262 return SDL_GetJoystickVendorForID(instance_id);
1287 return SDL_GetJoystickProductForID(instance_id);
1312 return SDL_GetJoystickProductVersionForID(instance_id);
1337 return SDL_GetJoystickTypeForID(instance_id);
1377 return {
CheckError(SDL_GetJoystickFromID(instance_id))};
1399 return {
CheckError(SDL_GetJoystickFromPlayerIndex(player_index))};
1448 return SDL_AttachVirtualJoystick(&desc);
1464 CheckError(SDL_DetachVirtualJoystick(instance_id));
1482 return SDL_IsJoystickVirtual(instance_id);
1514 CheckError(SDL_SetJoystickVirtualAxis(joystick, axis, value));
1544 CheckError(SDL_SetJoystickVirtualBall(joystick, ball, xrel, yrel));
1572 CheckError(SDL_SetJoystickVirtualButton(joystick, button, down));
1598 CheckError(SDL_SetJoystickVirtualHat(joystick, hat, value));
1635 joystick, touchpad, finger, down, p.x, p.y, pressure));
1645 m_resource, touchpad, finger, down, p, pressure);
1673 CheckError(SDL_SendJoystickVirtualSensorData(
1674 joystick, type, sensor_timestamp, data, num_values));
1683 m_resource, type, sensor_timestamp, data, num_values);
1710 return {
CheckError(SDL_GetJoystickProperties(joystick))};
1718namespace prop::JoystickCap {
1720constexpr auto MONO_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN;
1722constexpr auto RGB_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN;
1724constexpr auto PLAYER_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN;
1726constexpr auto RUMBLE_BOOLEAN = SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN;
1728constexpr auto TRIGGER_RUMBLE_BOOLEAN =
1729 SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN;
1746 return SDL_GetJoystickName(joystick);
1767 return SDL_GetJoystickPath(joystick);
1790 return SDL_GetJoystickPlayerIndex(joystick);
1812 CheckError(SDL_SetJoystickPlayerIndex(joystick, player_index));
1837 return SDL_GetJoystickGUID(joystick);
1856 return SDL_GetJoystickVendor(joystick);
1878 return SDL_GetJoystickProduct(joystick);
1900 return SDL_GetJoystickProductVersion(joystick);
1921 return SDL_GetJoystickFirmwareVersion(joystick);
1942 return SDL_GetJoystickSerial(joystick);
1962 return SDL_GetJoystickType(joystick);
1993 SDL_GetJoystickGUIDInfo(guid, vendor, product, version,
crc16);
2007 return SDL_JoystickConnected(joystick);
2023 return CheckError(SDL_GetJoystickID(joystick));
2048 return CheckError(SDL_GetNumJoystickAxes(joystick));
2077 return CheckError(SDL_GetNumJoystickBalls(joystick));
2101 return CheckError(SDL_GetNumJoystickHats(joystick));
2125 return CheckError(SDL_GetNumJoystickButtons(joystick));
2149 SDL_SetJoystickEventsEnabled(enabled);
2201 return SDL_GetJoystickAxis(joystick, axis);
2227 return SDL_GetJoystickAxisInitialState(joystick, axis, state);
2255 CheckError(SDL_GetJoystickBall(joystick, ball, dx, dy));
2278 return SDL_GetJoystickHat(joystick, hat);
2300 return SDL_GetJoystickButton(joystick, button);
2328 Uint16 low_frequency_rumble,
2329 Uint16 high_frequency_rumble,
2332 return SDL_RumbleJoystick(
2333 joystick, low_frequency_rumble, high_frequency_rumble, duration_ms);
2337 Uint16 high_frequency_rumble,
2341 m_resource, low_frequency_rumble, high_frequency_rumble, duration_ms);
2376 joystick, left_rumble, right_rumble, duration_ms));
2384 m_resource, left_rumble, right_rumble, duration_ms);
2409 CheckError(SDL_SetJoystickLED(joystick, red, green, blue));
2431 CheckError(SDL_SendJoystickEffect(joystick, data, size));
2464 return CheckError(SDL_GetJoystickConnectionState(joystick));
2493 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:146
constexpr JoystickID(JoystickIDRaw joystickID={})
Wraps JoystickID.
Definition: SDL3pp_joystick.h:155
The joystick structure used to identify an SDL joystick.
Definition: SDL3pp_joystick.h:393
Joystick & operator=(Joystick other)
Assignment operator.
Definition: SDL3pp_joystick.h:447
constexpr auto operator<=>(const Joystick &other) const =default
Comparison.
constexpr JoystickRaw get() const
Retrieves underlying JoystickRaw.
Definition: SDL3pp_joystick.h:454
constexpr Joystick(const Joystick &other)=delete
Copy constructor.
~Joystick()
Destructor.
Definition: SDL3pp_joystick.h:444
constexpr bool operator==(std::nullptr_t _) const
Comparison.
Definition: SDL3pp_joystick.h:468
constexpr Joystick()=default
Default ctor.
Joystick(JoystickID instance_id)
Open a joystick for use.
Definition: SDL3pp_joystick.h:438
constexpr Joystick(Joystick &&other)
Move constructor.
Definition: SDL3pp_joystick.h:416
constexpr JoystickRaw release()
Retrieves underlying JoystickRaw and clear this.
Definition: SDL3pp_joystick.h:457
constexpr Joystick(const JoystickRaw resource)
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:407
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:198
PropertiesRef GetJoystickProperties(JoystickParam joystick)
Get the properties associated with a joystick.
Definition: SDL3pp_joystick.h:1708
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:1211
constexpr JoystickType JOYSTICK_TYPE_COUNT
JOYSTICK_TYPE_COUNT.
Definition: SDL3pp_joystick.h:132
Uint16 GetProductVersion()
Get the product version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1903
constexpr Uint8 HAT_UP
UP.
Definition: SDL3pp_joystick.h:367
int GetJoystickPlayerIndexForID()
Get the player index of a joystick.
Definition: SDL3pp_joystick.h:1216
int GetPlayerIndex()
Get the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1793
bool IsJoystickVirtual()
Query whether or not a joystick is virtual.
Definition: SDL3pp_joystick.h:1485
Uint16 GetJoystickVendorForID()
Get the USB vendor ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1265
int GetNumJoystickBalls(JoystickParam joystick)
Get the number of trackballs on a joystick.
Definition: SDL3pp_joystick.h:2075
constexpr JoystickType JOYSTICK_TYPE_ARCADE_STICK
JOYSTICK_TYPE_ARCADE_STICK.
Definition: SDL3pp_joystick.h:111
bool HasJoystick()
Return whether a joystick is currently connected.
Definition: SDL3pp_joystick.h:1129
constexpr Uint8 HAT_LEFT
LEFT.
Definition: SDL3pp_joystick.h:373
Uint16 GetJoystickProductForID(JoystickID instance_id)
Get the USB product ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1285
Uint16 GetProduct()
Get the USB product ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1881
int GetNumBalls()
Get the number of trackballs on a joystick.
Definition: SDL3pp_joystick.h:2080
bool GetButton(int button)
Get the current state of a button on a joystick.
Definition: SDL3pp_joystick.h:2303
JoystickID AttachVirtualJoystick(const VirtualJoystickDesc &desc)
Attach a new virtual joystick.
Definition: SDL3pp_joystick.h:1446
Sint16 GetAxis(int axis)
Get the current state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2204
void SetJoystickLED(JoystickParam joystick, Uint8 red, Uint8 green, Uint8 blue)
Update a joystick's LED color.
Definition: SDL3pp_joystick.h:2404
Uint16 GetVendor()
Get the USB vendor ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1859
constexpr Uint8 HAT_DOWN
DOWN.
Definition: SDL3pp_joystick.h:371
SDL_VirtualJoystickTouchpadDesc VirtualJoystickTouchpadDesc
The structure that describes a virtual joystick touchpad.
Definition: SDL3pp_joystick.h:1409
constexpr JoystickType JOYSTICK_TYPE_DRUM_KIT
JOYSTICK_TYPE_DRUM_KIT.
Definition: SDL3pp_joystick.h:123
void SetJoystickVirtualHat(JoystickParam joystick, int hat, Uint8 value)
Set the state of a hat on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1596
void SetJoystickVirtualBall(JoystickParam joystick, int ball, Sint16 xrel, Sint16 yrel)
Generate ball motion on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1539
const char * GetJoystickName(JoystickParam joystick)
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1744
constexpr JoystickConnectionState JOYSTICK_CONNECTION_INVALID
JOYSTICK_CONNECTION_INVALID.
Definition: SDL3pp_joystick.h:347
constexpr JoystickConnectionState JOYSTICK_CONNECTION_UNKNOWN
JOYSTICK_CONNECTION_UNKNOWN.
Definition: SDL3pp_joystick.h:350
void SetJoystickVirtualAxis(JoystickParam joystick, int axis, Sint16 value)
Set the state of an axis on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1510
JoystickID GetJoystickID(JoystickParam joystick)
Get the instance ID of an opened joystick.
Definition: SDL3pp_joystick.h:2021
GUID GetGUID()
Get the implementation-dependent GUID for the joystick.
Definition: SDL3pp_joystick.h:1840
Uint16 GetJoystickVendor(JoystickParam joystick)
Get the USB vendor ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1854
int GetNumHats()
Get the number of POV hats on a joystick.
Definition: SDL3pp_joystick.h:2104
JoystickType GetJoystickTypeForID(JoystickID instance_id)
Get the type of a joystick, if available.
Definition: SDL3pp_joystick.h:1335
JoystickRef GetJoystickFromPlayerIndex(int player_index)
Get the Joystick associated with a player index.
Definition: SDL3pp_joystick.h:1397
Uint16 GetJoystickProductVersionForID()
Get the product version of a joystick, if available.
Definition: SDL3pp_joystick.h:1315
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:1667
const char * GetPath()
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1770
constexpr JoystickType JOYSTICK_TYPE_WHEEL
JOYSTICK_TYPE_WHEEL.
Definition: SDL3pp_joystick.h:108
bool RumbleJoystick(JoystickParam joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Start a rumble effect.
Definition: SDL3pp_joystick.h:2327
constexpr Uint8 HAT_RIGHTDOWN
RIGHTDOWN.
Definition: SDL3pp_joystick.h:377
void GetJoystickBall(JoystickParam joystick, int ball, int *dx, int *dy)
Get the ball axis change since the last poll.
Definition: SDL3pp_joystick.h:2253
void UpdateJoysticks()
Update the current state of the open joysticks.
Definition: SDL3pp_joystick.h:2175
Joystick OpenJoystick()
Open a joystick for use.
Definition: SDL3pp_joystick.h:1364
void SendEffect(const void *data, int size)
Send a joystick specific effect packet.
Definition: SDL3pp_joystick.h:2434
void SetJoystickPlayerIndex(JoystickParam joystick, int player_index)
Set the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1810
void UnlockJoysticks(void)
Unlocking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1118
void SetVirtualButton(int button, bool down)
Set the state of a button on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1575
int GetNumJoystickAxes(JoystickParam joystick)
Get the number of general axis controls on a joystick.
Definition: SDL3pp_joystick.h:2046
void DetachVirtualJoystick(JoystickID instance_id)
Detach a virtual joystick.
Definition: SDL3pp_joystick.h:1462
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:120
JoystickType GetJoystickTypeForID()
Get the type of a joystick, if available.
Definition: SDL3pp_joystick.h:1340
void SetVirtualBall(int ball, Sint16 xrel, Sint16 yrel)
Generate ball motion on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1547
int GetNumAxes()
Get the number of general axis controls on a joystick.
Definition: SDL3pp_joystick.h:2051
constexpr JoystickType JOYSTICK_TYPE_UNKNOWN
JOYSTICK_TYPE_UNKNOWN.
Definition: SDL3pp_joystick.h:102
void DetachVirtualJoystick()
Detach a virtual joystick.
Definition: SDL3pp_joystick.h:1467
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:1638
void SetLED(Uint8 red, Uint8 green, Uint8 blue)
Update a joystick's LED color.
Definition: SDL3pp_joystick.h:2412
void RumbleTriggers(Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
Start a rumble effect in the joystick's triggers.
Definition: SDL3pp_joystick.h:2379
Uint16 GetJoystickVendorForID(JoystickID instance_id)
Get the USB vendor ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1260
bool GetJoystickButton(JoystickParam joystick, int button)
Get the current state of a button on a joystick.
Definition: SDL3pp_joystick.h:2298
JoystickType GetJoystickType(JoystickParam joystick)
Get the type of an opened joystick.
Definition: SDL3pp_joystick.h:1960
void SetVirtualAxis(int axis, Sint16 value)
Set the state of an axis on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1517
constexpr Uint8 HAT_RIGHT
RIGHT.
Definition: SDL3pp_joystick.h:369
constexpr JoystickType JOYSTICK_TYPE_FLIGHT_STICK
JOYSTICK_TYPE_FLIGHT_STICK.
Definition: SDL3pp_joystick.h:114
constexpr JoystickType JOYSTICK_TYPE_GAMEPAD
JOYSTICK_TYPE_GAMEPAD.
Definition: SDL3pp_joystick.h:105
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:1627
constexpr JoystickType JOYSTICK_TYPE_DANCE_PAD
JOYSTICK_TYPE_DANCE_PAD.
Definition: SDL3pp_joystick.h:117
PropertiesRef GetProperties()
Get the properties associated with a joystick.
Definition: SDL3pp_joystick.h:1713
GUID GetJoystickGUIDForID()
Get the implementation-dependent GUID of a joystick.
Definition: SDL3pp_joystick.h:1240
Uint16 GetFirmwareVersion()
Get the firmware version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1924
constexpr Uint8 HAT_LEFTUP
LEFTUP.
Definition: SDL3pp_joystick.h:379
GUID GetJoystickGUID(JoystickParam joystick)
Get the implementation-dependent GUID for the joystick.
Definition: SDL3pp_joystick.h:1835
constexpr JoystickType JOYSTICK_TYPE_THROTTLE
JOYSTICK_TYPE_THROTTLE.
Definition: SDL3pp_joystick.h:129
const char * GetSerial()
Get the serial number of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1945
bool Rumble(Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Start a rumble effect.
Definition: SDL3pp_joystick.h:2336
void LockJoysticks(void)
Locking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1111
OwnArray< JoystickID > GetJoysticks()
Get a list of currently connected joysticks.
Definition: SDL3pp_joystick.h:1143
constexpr int JOYSTICK_AXIS_MAX
The largest value an Joystick's axis can report.
Definition: SDL3pp_joystick.h:1089
PowerState GetJoystickPowerInfo(JoystickParam joystick, int *percent)
Get the battery state of a joystick.
Definition: SDL3pp_joystick.h:2491
constexpr int JOYSTICK_AXIS_MIN
The smallest value an Joystick's axis can report.
Definition: SDL3pp_joystick.h:1100
int GetJoystickPlayerIndex(JoystickParam joystick)
Get the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1788
Uint16 GetJoystickProductVersionForID(JoystickID instance_id)
Get the product version of a joystick, if available.
Definition: SDL3pp_joystick.h:1310
void SetJoystickEventsEnabled(bool enabled)
Set the state of joystick event processing.
Definition: SDL3pp_joystick.h:2147
constexpr Uint8 HAT_RIGHTUP
RIGHTUP.
Definition: SDL3pp_joystick.h:375
bool Connected()
Get the status of a specified joystick.
Definition: SDL3pp_joystick.h:2010
GUID GetJoystickGUIDForID(JoystickID instance_id)
Get the implementation-dependent GUID of a joystick.
Definition: SDL3pp_joystick.h:1235
void SendJoystickEffect(JoystickParam joystick, const void *data, int size)
Send a joystick specific effect packet.
Definition: SDL3pp_joystick.h:2427
Uint16 GetJoystickFirmwareVersion(JoystickParam joystick)
Get the firmware version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1919
Uint8 GetJoystickHat(JoystickParam joystick, int hat)
Get the current state of a POV hat on a joystick.
Definition: SDL3pp_joystick.h:2276
constexpr Uint8 HAT_CENTERED
CENTERED.
Definition: SDL3pp_joystick.h:365
const char * GetJoystickPath(JoystickParam joystick)
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1765
Uint16 GetJoystickProduct(JoystickParam joystick)
Get the USB product ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1876
const char * GetJoystickSerial(JoystickParam joystick)
Get the serial number of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1940
JoystickType GetType()
Get the type of an opened joystick.
Definition: SDL3pp_joystick.h:1965
int GetNumJoystickButtons(JoystickParam joystick)
Get the number of buttons on a joystick.
Definition: SDL3pp_joystick.h:2123
int GetNumJoystickHats(JoystickParam joystick)
Get the number of POV hats on a joystick.
Definition: SDL3pp_joystick.h:2099
SDL_VirtualJoystickSensorDesc VirtualJoystickSensorDesc
The structure that describes a virtual joystick sensor.
Definition: SDL3pp_joystick.h:1418
SDL_JoystickConnectionState JoystickConnectionState
Possible connection states for a joystick device.
Definition: SDL3pp_joystick.h:345
bool GetJoystickAxisInitialState(JoystickParam joystick, int axis, Sint16 *state)
Get the initial state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2223
constexpr JoystickConnectionState JOYSTICK_CONNECTION_WIRELESS
JOYSTICK_CONNECTION_WIRELESS.
Definition: SDL3pp_joystick.h:356
bool JoystickConnected(JoystickParam joystick)
Get the status of a specified joystick.
Definition: SDL3pp_joystick.h:2005
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:1677
bool GetAxisInitialState(int axis, Sint16 *state)
Get the initial state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2230
JoystickRef GetJoystickFromID(JoystickID instance_id)
Get the Joystick associated with an instance ID, if it has been opened.
Definition: SDL3pp_joystick.h:1375
JoystickRef GetJoystickFromID()
Get the Joystick associated with an instance ID, if it has been opened.
Definition: SDL3pp_joystick.h:1380
void Close()
Close a joystick previously opened with JoystickID.OpenJoystick().
Definition: SDL3pp_joystick.h:2450
bool JoystickEventsEnabled()
Query the state of joystick event processing.
Definition: SDL3pp_joystick.h:2165
void CloseJoystick(JoystickRaw joystick)
Close a joystick previously opened with JoystickID.OpenJoystick().
Definition: SDL3pp_joystick.h:2448
SDL_VirtualJoystickDesc VirtualJoystickDesc
The structure that describes a virtual joystick.
Definition: SDL3pp_joystick.h:1433
const char * GetJoystickPathForID()
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1193
Uint8 HatState
Represents tbe HatState for a Joystick.
Definition: SDL3pp_joystick.h:363
void SetVirtualHat(int hat, Uint8 value)
Set the state of a hat on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1601
constexpr JoystickType JOYSTICK_TYPE_ARCADE_PAD
JOYSTICK_TYPE_ARCADE_PAD.
Definition: SDL3pp_joystick.h:126
JoystickConnectionState GetConnectionState()
Get the connection state of a joystick.
Definition: SDL3pp_joystick.h:2467
PowerState GetPowerInfo(int *percent)
Get the battery state of a joystick.
Definition: SDL3pp_joystick.h:2496
Sint16 GetJoystickAxis(JoystickParam joystick, int axis)
Get the current state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2199
bool IsJoystickVirtual(JoystickID instance_id)
Query whether or not a joystick is virtual.
Definition: SDL3pp_joystick.h:1480
JoystickID GetID()
Get the instance ID of an opened joystick.
Definition: SDL3pp_joystick.h:2026
constexpr JoystickConnectionState JOYSTICK_CONNECTION_WIRED
JOYSTICK_CONNECTION_WIRED.
Definition: SDL3pp_joystick.h:353
const char * GetJoystickNameForID()
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1169
const char * GetJoystickPathForID(JoystickID instance_id)
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1188
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:1987
constexpr Uint8 HAT_LEFTDOWN
LEFTDOWN.
Definition: SDL3pp_joystick.h:381
Joystick OpenJoystick(JoystickID instance_id)
Open a joystick for use.
Definition: SDL3pp_joystick.h:1359
Uint16 GetJoystickProductVersion(JoystickParam joystick)
Get the product version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:1898
const char * GetName()
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1749
Uint8 GetHat(int hat)
Get the current state of a POV hat on a joystick.
Definition: SDL3pp_joystick.h:2281
void SetPlayerIndex(int player_index)
Set the player index of an opened joystick.
Definition: SDL3pp_joystick.h:1815
JoystickConnectionState GetJoystickConnectionState(JoystickParam joystick)
Get the connection state of a joystick.
Definition: SDL3pp_joystick.h:2461
void GetBall(int ball, int *dx, int *dy)
Get the ball axis change since the last poll.
Definition: SDL3pp_joystick.h:2258
Uint16 GetJoystickProductForID()
Get the USB product ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1290
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:2370
const char * GetJoystickNameForID(JoystickID instance_id)
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1164
void SetJoystickVirtualButton(JoystickParam joystick, int button, bool down)
Set the state of a button on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1568
int GetNumButtons()
Get the number of buttons on a joystick.
Definition: SDL3pp_joystick.h:2128
SDL_JoystickType JoystickType
An enum of some common joystick types.
Definition: SDL3pp_joystick.h:100
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:25
SDL_SensorType SensorType
The different sensors defined by SDL.
Definition: SDL3pp_sensor.h:125
Uint16 Uint16
An unsigned 16-bit integer type.
Definition: SDL3pp_stdinc.h:291
Uint16 crc16(Uint16 crc, const void *data, size_t len)
Calculate a CRC-16 value.
Definition: SDL3pp_stdinc.h:2258
Uint32 Uint32
An unsigned 32-bit integer type.
Definition: SDL3pp_stdinc.h:325
Uint64 Uint64
An unsigned 64-bit integer type.
Definition: SDL3pp_stdinc.h:363
Uint8 Uint8
An unsigned 8-bit integer type.
Definition: SDL3pp_stdinc.h:257
Sint16 Sint16
A signed 16-bit integer type.
Definition: SDL3pp_stdinc.h:274
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:41
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:1059
JoystickRef(const JoystickRef &other)
Copy constructor.
Definition: SDL3pp_joystick.h:1073
JoystickRef(JoystickParam resource)
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:1067
~JoystickRef()
Destructor.
Definition: SDL3pp_joystick.h:1079
Semi-safe reference for Properties.
Definition: SDL3pp_properties.h:569