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"
84 constexpr explicit operator bool()
const {
return !!
value; }
121 SDL_JOYSTICK_TYPE_UNKNOWN;
124 SDL_JOYSTICK_TYPE_GAMEPAD;
127 SDL_JOYSTICK_TYPE_WHEEL;
130 SDL_JOYSTICK_TYPE_ARCADE_STICK;
133 SDL_JOYSTICK_TYPE_FLIGHT_STICK;
136 SDL_JOYSTICK_TYPE_DANCE_PAD;
139 SDL_JOYSTICK_TYPE_GUITAR;
142 SDL_JOYSTICK_TYPE_DRUM_KIT;
145 SDL_JOYSTICK_TYPE_ARCADE_PAD;
148 SDL_JOYSTICK_TYPE_THROTTLE;
151 SDL_JOYSTICK_TYPE_COUNT;
174 : m_joystickID(joystickID)
389 SDL_JOYSTICK_CONNECTION_INVALID;
392 SDL_JOYSTICK_CONNECTION_UNKNOWN;
395 SDL_JOYSTICK_CONNECTION_WIRED;
398 SDL_JOYSTICK_CONNECTION_WIRELESS;
439 constexpr Joystick(std::nullptr_t =
nullptr) noexcept
452 : m_resource(resource)
487 : m_resource(
CheckError(SDL_OpenJoystick(instance_id)))
497 std::swap(m_resource, other.m_resource);
513 m_resource =
nullptr;
521 constexpr explicit operator bool() const noexcept {
return !!m_resource; }
1052 void GetBall(
int ball,
int* dx,
int* dy);
1106 Uint16 high_frequency_rumble,
1298 : m_lock(other.m_lock)
1318 std::swap(m_lock, other.m_lock);
1323 constexpr operator bool()
const {
return bool(m_lock); }
1370 if (!m_lock)
return;
1405 auto r =
reinterpret_cast<JoystickID*
>(SDL_GetJoysticks(&count));
1427 return SDL_GetJoystickNameForID(instance_id);
1453 return SDL_GetJoystickPathForID(instance_id);
1478 return SDL_GetJoystickPlayerIndexForID(instance_id);
1504 return SDL_GetJoystickGUIDForID(instance_id);
1531 return SDL_GetJoystickVendorForID(instance_id);
1558 return SDL_GetJoystickProductForID(instance_id);
1585 return SDL_GetJoystickProductVersionForID(instance_id);
1611 return SDL_GetJoystickTypeForID(instance_id);
1655 return {
CheckError(SDL_GetJoystickFromID(instance_id))};
1679 return {
CheckError(SDL_GetJoystickFromPlayerIndex(player_index))};
1747 return SDL_AttachVirtualJoystick(&desc);
1765 CheckError(SDL_DetachVirtualJoystick(instance_id));
1785 return SDL_IsJoystickVirtual(instance_id);
1824 CheckError(SDL_SetJoystickVirtualAxis(joystick, axis, value));
1861 CheckError(SDL_SetJoystickVirtualBall(joystick, ball, xrel, yrel));
1896 CheckError(SDL_SetJoystickVirtualButton(joystick, button, down));
1929 CheckError(SDL_SetJoystickVirtualHat(joystick, hat, value));
1972 joystick, touchpad, finger, down, p.x, p.y, pressure));
1982 m_resource, touchpad, finger, down, p, pressure);
2017 CheckError(SDL_SendJoystickVirtualSensorData(
2018 joystick, type, sensor_timestamp, data, num_values));
2027 m_resource, type, sensor_timestamp, data, num_values);
2056 return {
CheckError(SDL_GetJoystickProperties(joystick))};
2064namespace prop::JoystickCap {
2066constexpr auto MONO_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN;
2068constexpr auto RGB_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN;
2070constexpr auto PLAYER_LED_BOOLEAN = SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN;
2072constexpr auto RUMBLE_BOOLEAN = SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN;
2074constexpr auto TRIGGER_RUMBLE_BOOLEAN =
2075 SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN;
2094 return SDL_GetJoystickName(joystick);
2117 return SDL_GetJoystickPath(joystick);
2142 return SDL_GetJoystickPlayerIndex(joystick);
2166 CheckError(SDL_SetJoystickPlayerIndex(joystick, player_index));
2192 return SDL_GetJoystickGUID(joystick);
2213 return SDL_GetJoystickVendor(joystick);
2237 return SDL_GetJoystickProduct(joystick);
2261 return SDL_GetJoystickProductVersion(joystick);
2283 return SDL_GetJoystickFirmwareVersion(joystick);
2306 return SDL_GetJoystickSerial(joystick);
2328 return SDL_GetJoystickType(joystick);
2360 SDL_GetJoystickGUIDInfo(guid, vendor, product, version,
crc16);
2376 return SDL_JoystickConnected(joystick);
2394 return CheckError(SDL_GetJoystickID(joystick));
2421 return CheckError(SDL_GetNumJoystickAxes(joystick));
2452 return CheckError(SDL_GetNumJoystickBalls(joystick));
2478 return CheckError(SDL_GetNumJoystickHats(joystick));
2504 return CheckError(SDL_GetNumJoystickButtons(joystick));
2529 SDL_SetJoystickEventsEnabled(enabled);
2586 return SDL_GetJoystickAxis(joystick, axis);
2614 return SDL_GetJoystickAxisInitialState(joystick, axis, state);
2644 CheckError(SDL_GetJoystickBall(joystick, ball, dx, dy));
2669 return SDL_GetJoystickHat(joystick, hat);
2693 return SDL_GetJoystickButton(joystick, button);
2723 Uint16 low_frequency_rumble,
2724 Uint16 high_frequency_rumble,
2727 return SDL_RumbleJoystick(
2728 joystick, low_frequency_rumble, high_frequency_rumble, duration_ms);
2732 Uint16 high_frequency_rumble,
2736 m_resource, low_frequency_rumble, high_frequency_rumble, duration_ms);
2772 joystick, left_rumble, right_rumble, duration_ms));
2780 m_resource, left_rumble, right_rumble, duration_ms);
2807 CheckError(SDL_SetJoystickLED(joystick, red, green, blue));
2831 CheckError(SDL_SendJoystickEffect(joystick, data, size));
2868 return CheckError(SDL_GetJoystickConnectionState(joystick));
2898 return SDL_GetJoystickPowerInfo(joystick, percent);
Locking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1276
~JoystickApiLock()
Unlocking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1311
constexpr JoystickApiLock(JoystickApiLock &&other) noexcept
Move constructor.
Definition: SDL3pp_joystick.h:1297
JoystickApiLock & operator=(JoystickApiLock &&other) noexcept
Assignment operator.
Definition: SDL3pp_joystick.h:1316
JoystickApiLock(const JoystickApiLock &other)=delete
Copy constructor.
void release()
Releases the lock without unlocking.
Definition: SDL3pp_joystick.h:1336
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:164
constexpr JoystickID(JoystickIDRaw joystickID={}) noexcept
Wraps JoystickID.
Definition: SDL3pp_joystick.h:173
The joystick structure used to identify an SDL joystick.
Definition: SDL3pp_joystick.h:434
constexpr Joystick & operator=(const Joystick &other) noexcept=default
Assignment operator.
constexpr Joystick(std::nullptr_t=nullptr) noexcept
Default ctor.
Definition: SDL3pp_joystick.h:439
constexpr Joystick(const Joystick &other) noexcept=default
Copy constructor.
constexpr Joystick(const JoystickRaw resource) noexcept
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:451
constexpr auto operator<=>(const Joystick &other) const noexcept=default
Comparison.
~Joystick()
Destructor.
Definition: SDL3pp_joystick.h:492
constexpr JoystickRaw get() const noexcept
Retrieves underlying JoystickRaw.
Definition: SDL3pp_joystick.h:507
constexpr JoystickRaw release() noexcept
Retrieves underlying JoystickRaw and clear this.
Definition: SDL3pp_joystick.h:510
Joystick(JoystickID instance_id)
Open a joystick for use.
Definition: SDL3pp_joystick.h:486
constexpr Joystick & operator=(Joystick &&other) noexcept
Assignment operator.
Definition: SDL3pp_joystick.h:495
constexpr Joystick(Joystick &&other) noexcept
Move constructor.
Definition: SDL3pp_joystick.h:462
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:2054
SDL_Joystick * JoystickRaw
Alias to raw representation for Joystick.
Definition: SDL3pp_joystick.h:61
int GetJoystickPlayerIndexForID(JoystickID instance_id)
Get the player index of a joystick.
Definition: SDL3pp_joystick.h:1476
constexpr JoystickType JOYSTICK_TYPE_COUNT
JOYSTICK_TYPE_COUNT.
Definition: SDL3pp_joystick.h:150
Uint16 GetProductVersion()
Get the product version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2264
constexpr Uint8 HAT_UP
UP.
Definition: SDL3pp_joystick.h:408
int GetJoystickPlayerIndexForID()
Get the player index of a joystick.
Definition: SDL3pp_joystick.h:1481
int GetPlayerIndex()
Get the player index of an opened joystick.
Definition: SDL3pp_joystick.h:2145
void LockJoysticks()
Locking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1350
bool IsJoystickVirtual()
Query whether or not a joystick is virtual.
Definition: SDL3pp_joystick.h:1788
Uint16 GetJoystickVendorForID()
Get the USB vendor ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1534
int GetNumJoystickBalls(JoystickParam joystick)
Get the number of trackballs on a joystick.
Definition: SDL3pp_joystick.h:2450
constexpr JoystickType JOYSTICK_TYPE_ARCADE_STICK
JOYSTICK_TYPE_ARCADE_STICK.
Definition: SDL3pp_joystick.h:129
bool HasJoystick()
Return whether a joystick is currently connected.
Definition: SDL3pp_joystick.h:1386
constexpr Uint8 HAT_LEFT
LEFT.
Definition: SDL3pp_joystick.h:414
Uint16 GetJoystickProductForID(JoystickID instance_id)
Get the USB product ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1556
Uint16 GetProduct()
Get the USB product ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2240
int GetNumBalls()
Get the number of trackballs on a joystick.
Definition: SDL3pp_joystick.h:2455
bool GetButton(int button)
Get the current state of a button on a joystick.
Definition: SDL3pp_joystick.h:2696
JoystickID AttachVirtualJoystick(const VirtualJoystickDesc &desc)
Attach a new virtual joystick.
Definition: SDL3pp_joystick.h:1745
Sint16 GetAxis(int axis)
Get the current state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2589
void SetJoystickLED(JoystickParam joystick, Uint8 red, Uint8 green, Uint8 blue)
Update a joystick's LED color.
Definition: SDL3pp_joystick.h:2802
Uint16 GetVendor()
Get the USB vendor ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2216
constexpr Uint8 HAT_DOWN
DOWN.
Definition: SDL3pp_joystick.h:412
SDL_VirtualJoystickTouchpadDesc VirtualJoystickTouchpadDesc
The structure that describes a virtual joystick touchpad.
Definition: SDL3pp_joystick.h:1689
constexpr JoystickType JOYSTICK_TYPE_DRUM_KIT
JOYSTICK_TYPE_DRUM_KIT.
Definition: SDL3pp_joystick.h:141
void SetJoystickVirtualHat(JoystickParam joystick, int hat, Uint8 value)
Set the state of a hat on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1927
void SetJoystickVirtualBall(JoystickParam joystick, int ball, Sint16 xrel, Sint16 yrel)
Generate ball motion on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1856
const char * GetJoystickName(JoystickParam joystick)
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:2092
constexpr JoystickConnectionState JOYSTICK_CONNECTION_INVALID
JOYSTICK_CONNECTION_INVALID.
Definition: SDL3pp_joystick.h:388
constexpr JoystickConnectionState JOYSTICK_CONNECTION_UNKNOWN
JOYSTICK_CONNECTION_UNKNOWN.
Definition: SDL3pp_joystick.h:391
void SetJoystickVirtualAxis(JoystickParam joystick, int axis, Sint16 value)
Set the state of an axis on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1820
JoystickID GetJoystickID(JoystickParam joystick)
Get the instance ID of an opened joystick.
Definition: SDL3pp_joystick.h:2392
GUID GetGUID()
Get the implementation-dependent GUID for the joystick.
Definition: SDL3pp_joystick.h:2195
Uint16 GetJoystickVendor(JoystickParam joystick)
Get the USB vendor ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2211
int GetNumHats()
Get the number of POV hats on a joystick.
Definition: SDL3pp_joystick.h:2481
JoystickType GetJoystickTypeForID(JoystickID instance_id)
Get the type of a joystick, if available.
Definition: SDL3pp_joystick.h:1609
JoystickRef GetJoystickFromPlayerIndex(int player_index)
Get the Joystick associated with a player index.
Definition: SDL3pp_joystick.h:1677
Uint16 GetJoystickProductVersionForID()
Get the product version of a joystick, if available.
Definition: SDL3pp_joystick.h:1588
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:2011
const char * GetPath()
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:2120
constexpr JoystickType JOYSTICK_TYPE_WHEEL
JOYSTICK_TYPE_WHEEL.
Definition: SDL3pp_joystick.h:126
bool RumbleJoystick(JoystickParam joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Start a rumble effect.
Definition: SDL3pp_joystick.h:2722
constexpr Uint8 HAT_RIGHTDOWN
RIGHTDOWN.
Definition: SDL3pp_joystick.h:418
void GetJoystickBall(JoystickParam joystick, int ball, int *dx, int *dy)
Get the ball axis change since the last poll.
Definition: SDL3pp_joystick.h:2642
void UpdateJoysticks()
Update the current state of the open joysticks.
Definition: SDL3pp_joystick.h:2558
Joystick OpenJoystick()
Open a joystick for use.
Definition: SDL3pp_joystick.h:1640
void SendEffect(const void *data, int size)
Send a joystick specific effect packet.
Definition: SDL3pp_joystick.h:2834
void SetJoystickPlayerIndex(JoystickParam joystick, int player_index)
Set the player index of an opened joystick.
Definition: SDL3pp_joystick.h:2164
void SetVirtualButton(int button, bool down)
Set the state of a button on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1899
int GetNumJoystickAxes(JoystickParam joystick)
Get the number of general axis controls on a joystick.
Definition: SDL3pp_joystick.h:2419
void DetachVirtualJoystick(JoystickID instance_id)
Detach a virtual joystick.
Definition: SDL3pp_joystick.h:1763
SDL_JoystickID JoystickIDRaw
Alias to raw representation for JoystickID.
Definition: SDL3pp_joystick.h:94
constexpr JoystickType JOYSTICK_TYPE_GUITAR
JOYSTICK_TYPE_GUITAR.
Definition: SDL3pp_joystick.h:138
JoystickType GetJoystickTypeForID()
Get the type of a joystick, if available.
Definition: SDL3pp_joystick.h:1614
void SetVirtualBall(int ball, Sint16 xrel, Sint16 yrel)
Generate ball motion on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1864
int GetNumAxes()
Get the number of general axis controls on a joystick.
Definition: SDL3pp_joystick.h:2424
constexpr JoystickType JOYSTICK_TYPE_UNKNOWN
JOYSTICK_TYPE_UNKNOWN.
Definition: SDL3pp_joystick.h:120
void DetachVirtualJoystick()
Detach a virtual joystick.
Definition: SDL3pp_joystick.h:1768
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:1975
void SetLED(Uint8 red, Uint8 green, Uint8 blue)
Update a joystick's LED color.
Definition: SDL3pp_joystick.h:2810
void RumbleTriggers(Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
Start a rumble effect in the joystick's triggers.
Definition: SDL3pp_joystick.h:2775
Uint16 GetJoystickVendorForID(JoystickID instance_id)
Get the USB vendor ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1529
bool GetJoystickButton(JoystickParam joystick, int button)
Get the current state of a button on a joystick.
Definition: SDL3pp_joystick.h:2691
JoystickType GetJoystickType(JoystickParam joystick)
Get the type of an opened joystick.
Definition: SDL3pp_joystick.h:2326
void SetVirtualAxis(int axis, Sint16 value)
Set the state of an axis on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1827
constexpr Uint8 HAT_RIGHT
RIGHT.
Definition: SDL3pp_joystick.h:410
constexpr JoystickType JOYSTICK_TYPE_FLIGHT_STICK
JOYSTICK_TYPE_FLIGHT_STICK.
Definition: SDL3pp_joystick.h:132
constexpr JoystickType JOYSTICK_TYPE_GAMEPAD
JOYSTICK_TYPE_GAMEPAD.
Definition: SDL3pp_joystick.h:123
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:1964
constexpr JoystickType JOYSTICK_TYPE_DANCE_PAD
JOYSTICK_TYPE_DANCE_PAD.
Definition: SDL3pp_joystick.h:135
void UnlockJoysticks()
Unlocking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1366
PropertiesRef GetProperties()
Get the properties associated with a joystick.
Definition: SDL3pp_joystick.h:2059
GUID GetJoystickGUIDForID()
Get the implementation-dependent GUID of a joystick.
Definition: SDL3pp_joystick.h:1507
Uint16 GetFirmwareVersion()
Get the firmware version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2286
constexpr Uint8 HAT_LEFTUP
LEFTUP.
Definition: SDL3pp_joystick.h:420
GUID GetJoystickGUID(JoystickParam joystick)
Get the implementation-dependent GUID for the joystick.
Definition: SDL3pp_joystick.h:2190
constexpr JoystickType JOYSTICK_TYPE_THROTTLE
JOYSTICK_TYPE_THROTTLE.
Definition: SDL3pp_joystick.h:147
const char * GetSerial()
Get the serial number of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2309
bool Rumble(Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Start a rumble effect.
Definition: SDL3pp_joystick.h:2731
OwnArray< JoystickID > GetJoysticks()
Get a list of currently connected joysticks.
Definition: SDL3pp_joystick.h:1402
constexpr int JOYSTICK_AXIS_MAX
The largest value an Joystick's axis can report.
Definition: SDL3pp_joystick.h:1251
PowerState GetJoystickPowerInfo(JoystickParam joystick, int *percent)
Get the battery state of a joystick.
Definition: SDL3pp_joystick.h:2896
constexpr int JOYSTICK_AXIS_MIN
The smallest value an Joystick's axis can report.
Definition: SDL3pp_joystick.h:1262
int GetJoystickPlayerIndex(JoystickParam joystick)
Get the player index of an opened joystick.
Definition: SDL3pp_joystick.h:2140
Uint16 GetJoystickProductVersionForID(JoystickID instance_id)
Get the product version of a joystick, if available.
Definition: SDL3pp_joystick.h:1583
void SetJoystickEventsEnabled(bool enabled)
Set the state of joystick event processing.
Definition: SDL3pp_joystick.h:2527
constexpr Uint8 HAT_RIGHTUP
RIGHTUP.
Definition: SDL3pp_joystick.h:416
bool Connected()
Get the status of a specified joystick.
Definition: SDL3pp_joystick.h:2379
GUID GetJoystickGUIDForID(JoystickID instance_id)
Get the implementation-dependent GUID of a joystick.
Definition: SDL3pp_joystick.h:1502
void SendJoystickEffect(JoystickParam joystick, const void *data, int size)
Send a joystick specific effect packet.
Definition: SDL3pp_joystick.h:2827
Uint16 GetJoystickFirmwareVersion(JoystickParam joystick)
Get the firmware version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2281
Uint8 GetJoystickHat(JoystickParam joystick, int hat)
Get the current state of a POV hat on a joystick.
Definition: SDL3pp_joystick.h:2667
constexpr Uint8 HAT_CENTERED
CENTERED.
Definition: SDL3pp_joystick.h:406
const char * GetJoystickPath(JoystickParam joystick)
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:2115
Uint16 GetJoystickProduct(JoystickParam joystick)
Get the USB product ID of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2235
const char * GetJoystickSerial(JoystickParam joystick)
Get the serial number of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2304
JoystickType GetType()
Get the type of an opened joystick.
Definition: SDL3pp_joystick.h:2331
int GetNumJoystickButtons(JoystickParam joystick)
Get the number of buttons on a joystick.
Definition: SDL3pp_joystick.h:2502
int GetNumJoystickHats(JoystickParam joystick)
Get the number of POV hats on a joystick.
Definition: SDL3pp_joystick.h:2476
SDL_VirtualJoystickSensorDesc VirtualJoystickSensorDesc
The structure that describes a virtual joystick sensor.
Definition: SDL3pp_joystick.h:1698
SDL_JoystickConnectionState JoystickConnectionState
Possible connection states for a joystick device.
Definition: SDL3pp_joystick.h:386
bool GetJoystickAxisInitialState(JoystickParam joystick, int axis, Sint16 *state)
Get the initial state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2610
constexpr JoystickConnectionState JOYSTICK_CONNECTION_WIRELESS
JOYSTICK_CONNECTION_WIRELESS.
Definition: SDL3pp_joystick.h:397
bool JoystickConnected(JoystickParam joystick)
Get the status of a specified joystick.
Definition: SDL3pp_joystick.h:2374
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:2021
bool GetAxisInitialState(int axis, Sint16 *state)
Get the initial state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2617
JoystickRef GetJoystickFromID(JoystickID instance_id)
Get the Joystick associated with an instance ID, if it has been opened.
Definition: SDL3pp_joystick.h:1653
JoystickRef GetJoystickFromID()
Get the Joystick associated with an instance ID, if it has been opened.
Definition: SDL3pp_joystick.h:1658
void Close()
Close a joystick previously opened with JoystickID.OpenJoystick().
Definition: SDL3pp_joystick.h:2852
bool JoystickEventsEnabled()
Query the state of joystick event processing.
Definition: SDL3pp_joystick.h:2546
void reset()
Unlocking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1368
void CloseJoystick(JoystickRaw joystick)
Close a joystick previously opened with JoystickID.OpenJoystick().
Definition: SDL3pp_joystick.h:2850
SDL_VirtualJoystickDesc VirtualJoystickDesc
The structure that describes a virtual joystick.
Definition: SDL3pp_joystick.h:1713
const char * GetJoystickPathForID()
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1456
Uint8 HatState
Represents tbe HatState for a Joystick.
Definition: SDL3pp_joystick.h:404
void SetVirtualHat(int hat, Uint8 value)
Set the state of a hat on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1932
constexpr JoystickType JOYSTICK_TYPE_ARCADE_PAD
JOYSTICK_TYPE_ARCADE_PAD.
Definition: SDL3pp_joystick.h:144
JoystickConnectionState GetConnectionState()
Get the connection state of a joystick.
Definition: SDL3pp_joystick.h:2871
PowerState GetPowerInfo(int *percent)
Get the battery state of a joystick.
Definition: SDL3pp_joystick.h:2901
Sint16 GetJoystickAxis(JoystickParam joystick, int axis)
Get the current state of an axis control on a joystick.
Definition: SDL3pp_joystick.h:2584
bool IsJoystickVirtual(JoystickID instance_id)
Query whether or not a joystick is virtual.
Definition: SDL3pp_joystick.h:1783
JoystickID GetID()
Get the instance ID of an opened joystick.
Definition: SDL3pp_joystick.h:2397
constexpr JoystickConnectionState JOYSTICK_CONNECTION_WIRED
JOYSTICK_CONNECTION_WIRED.
Definition: SDL3pp_joystick.h:394
const char * GetJoystickNameForID()
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1430
const char * GetJoystickPathForID(JoystickID instance_id)
Get the implementation dependent path of a joystick.
Definition: SDL3pp_joystick.h:1451
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:2354
constexpr Uint8 HAT_LEFTDOWN
LEFTDOWN.
Definition: SDL3pp_joystick.h:422
Joystick OpenJoystick(JoystickID instance_id)
Open a joystick for use.
Definition: SDL3pp_joystick.h:1635
Uint16 GetJoystickProductVersion(JoystickParam joystick)
Get the product version of an opened joystick, if available.
Definition: SDL3pp_joystick.h:2259
const char * GetName()
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:2097
Uint8 GetHat(int hat)
Get the current state of a POV hat on a joystick.
Definition: SDL3pp_joystick.h:2672
void SetPlayerIndex(int player_index)
Set the player index of an opened joystick.
Definition: SDL3pp_joystick.h:2169
JoystickConnectionState GetJoystickConnectionState(JoystickParam joystick)
Get the connection state of a joystick.
Definition: SDL3pp_joystick.h:2865
void GetBall(int ball, int *dx, int *dy)
Get the ball axis change since the last poll.
Definition: SDL3pp_joystick.h:2647
Uint16 GetJoystickProductForID()
Get the USB product ID of a joystick, if available.
Definition: SDL3pp_joystick.h:1561
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:2766
const char * GetJoystickNameForID(JoystickID instance_id)
Get the implementation dependent name of a joystick.
Definition: SDL3pp_joystick.h:1425
void SetJoystickVirtualButton(JoystickParam joystick, int button, bool down)
Set the state of a button on an opened virtual joystick.
Definition: SDL3pp_joystick.h:1892
JoystickApiLock()
Locking for atomic access to the joystick API.
Definition: SDL3pp_joystick.h:1352
int GetNumButtons()
Get the number of buttons on a joystick.
Definition: SDL3pp_joystick.h:2507
SDL_JoystickType JoystickType
An enum of some common joystick types.
Definition: SDL3pp_joystick.h:118
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:2282
::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:68
constexpr JoystickParam(JoystickRaw value)
Constructs from JoystickRaw.
Definition: SDL3pp_joystick.h:72
JoystickRaw value
parameter's JoystickRaw
Definition: SDL3pp_joystick.h:69
constexpr auto operator<=>(const JoystickParam &other) const =default
Comparison.
constexpr JoystickParam(std::nullptr_t=nullptr)
Constructs null/invalid.
Definition: SDL3pp_joystick.h:78
Semi-safe reference for Joystick.
Definition: SDL3pp_joystick.h:1210
constexpr JoystickRef(const JoystickRef &other) noexcept=default
Copy constructor.
JoystickRef(JoystickParam resource) noexcept
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:1220
JoystickRef(JoystickRaw resource) noexcept
Constructs from JoystickParam.
Definition: SDL3pp_joystick.h:1232
~JoystickRef()
Destructor.
Definition: SDL3pp_joystick.h:1241
Semi-safe reference for Properties.
Definition: SDL3pp_properties.h:716