2015-06-21 15:33:46 +00:00
|
|
|
/*
|
|
|
|
Simple DirectMedia Layer
|
2021-01-02 18:25:38 +00:00
|
|
|
Copyright (C) 1997-2021 Sam Lantinga <slouken@libsdl.org>
|
2015-06-21 15:33:46 +00:00
|
|
|
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
|
|
warranty. In no event will the authors be held liable for any damages
|
|
|
|
arising from the use of this software.
|
|
|
|
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
|
|
including commercial applications, and to alter it and redistribute it
|
|
|
|
freely, subject to the following restrictions:
|
|
|
|
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
|
|
claim that you wrote the original software. If you use this software
|
|
|
|
in a product, an acknowledgment in the product documentation would be
|
|
|
|
appreciated but is not required.
|
|
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
|
|
misrepresented as being the original software.
|
|
|
|
3. This notice may not be removed or altered from any source distribution.
|
|
|
|
*/
|
|
|
|
#include "../SDL_internal.h"
|
|
|
|
|
2016-11-21 05:34:54 +00:00
|
|
|
#ifndef SDL_sysjoystick_h_
|
|
|
|
#define SDL_sysjoystick_h_
|
2015-06-21 15:33:46 +00:00
|
|
|
|
|
|
|
/* This is the system specific header for the SDL joystick API */
|
|
|
|
#include "SDL_joystick.h"
|
|
|
|
#include "SDL_joystick_c.h"
|
|
|
|
|
|
|
|
/* The SDL joystick structure */
|
2016-12-23 01:33:45 +00:00
|
|
|
typedef struct _SDL_JoystickAxisInfo
|
|
|
|
{
|
2017-01-04 18:28:07 +00:00
|
|
|
Sint16 initial_value; /* Initial axis state */
|
|
|
|
Sint16 value; /* Current axis state */
|
2017-01-04 07:39:28 +00:00
|
|
|
Sint16 zero; /* Zero point on the axis (-32768 for triggers) */
|
|
|
|
SDL_bool has_initial_value; /* Whether we've seen a value on the axis yet */
|
2019-11-28 19:44:15 +00:00
|
|
|
SDL_bool has_second_value; /* Whether we've seen a second value on the axis yet */
|
2017-01-04 07:39:28 +00:00
|
|
|
SDL_bool sent_initial_value; /* Whether we've sent the initial axis value */
|
2016-12-23 01:33:45 +00:00
|
|
|
} SDL_JoystickAxisInfo;
|
|
|
|
|
2020-11-14 02:01:29 +00:00
|
|
|
typedef struct _SDL_JoystickTouchpadFingerInfo
|
|
|
|
{
|
|
|
|
Uint8 state;
|
|
|
|
float x;
|
|
|
|
float y;
|
|
|
|
float pressure;
|
|
|
|
} SDL_JoystickTouchpadFingerInfo;
|
|
|
|
|
|
|
|
typedef struct _SDL_JoystickTouchpadInfo
|
|
|
|
{
|
|
|
|
int nfingers;
|
|
|
|
SDL_JoystickTouchpadFingerInfo *fingers;
|
|
|
|
} SDL_JoystickTouchpadInfo;
|
|
|
|
|
2020-11-17 18:30:20 +00:00
|
|
|
typedef struct _SDL_JoystickSensorInfo
|
|
|
|
{
|
|
|
|
SDL_SensorType type;
|
|
|
|
SDL_bool enabled;
|
2021-07-29 13:43:39 +00:00
|
|
|
float rate;
|
2020-11-17 18:30:20 +00:00
|
|
|
float data[3]; /* If this needs to expand, update SDL_ControllerSensorEvent */
|
|
|
|
} SDL_JoystickSensorInfo;
|
|
|
|
|
2015-06-21 15:33:46 +00:00
|
|
|
struct _SDL_Joystick
|
|
|
|
{
|
|
|
|
SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
|
|
|
|
char *name; /* Joystick name - system dependent */
|
2020-11-17 01:36:47 +00:00
|
|
|
char *serial; /* Joystick serial */
|
2018-08-09 23:00:17 +00:00
|
|
|
SDL_JoystickGUID guid; /* Joystick guid */
|
2015-06-21 15:33:46 +00:00
|
|
|
|
|
|
|
int naxes; /* Number of axis controls on the joystick */
|
2016-12-23 01:33:45 +00:00
|
|
|
SDL_JoystickAxisInfo *axes;
|
2015-06-21 15:33:46 +00:00
|
|
|
|
|
|
|
int nhats; /* Number of hats on the joystick */
|
|
|
|
Uint8 *hats; /* Current hat states */
|
|
|
|
|
|
|
|
int nballs; /* Number of trackballs on the joystick */
|
|
|
|
struct balldelta {
|
|
|
|
int dx;
|
|
|
|
int dy;
|
|
|
|
} *balls; /* Current ball motion deltas */
|
|
|
|
|
|
|
|
int nbuttons; /* Number of buttons on the joystick */
|
|
|
|
Uint8 *buttons; /* Current button states */
|
|
|
|
|
2020-11-14 02:01:29 +00:00
|
|
|
int ntouchpads; /* Number of touchpads on the joystick */
|
|
|
|
SDL_JoystickTouchpadInfo *touchpads; /* Current touchpad states */
|
|
|
|
|
2020-11-17 18:30:20 +00:00
|
|
|
int nsensors; /* Number of sensors on the joystick */
|
|
|
|
int nsensors_enabled;
|
|
|
|
SDL_JoystickSensorInfo *sensors;
|
|
|
|
|
2020-02-04 20:48:53 +00:00
|
|
|
Uint16 low_frequency_rumble;
|
|
|
|
Uint16 high_frequency_rumble;
|
|
|
|
Uint32 rumble_expiration;
|
|
|
|
|
2020-11-12 02:57:37 +00:00
|
|
|
Uint16 left_trigger_rumble;
|
|
|
|
Uint16 right_trigger_rumble;
|
|
|
|
Uint32 trigger_rumble_expiration;
|
|
|
|
|
2020-04-30 15:57:29 +00:00
|
|
|
Uint8 led_red;
|
|
|
|
Uint8 led_green;
|
|
|
|
Uint8 led_blue;
|
2021-04-12 18:25:42 +00:00
|
|
|
Uint32 led_expiration;
|
2020-04-30 15:57:29 +00:00
|
|
|
|
2018-08-09 23:03:50 +00:00
|
|
|
SDL_bool attached;
|
2017-01-27 13:59:58 +00:00
|
|
|
SDL_bool is_game_controller;
|
2018-03-19 21:42:51 +00:00
|
|
|
SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
|
2015-09-30 22:39:30 +00:00
|
|
|
SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
|
2020-11-17 18:30:20 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
struct _SDL_JoystickDriver *driver;
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
struct joystick_hwdata *hwdata; /* Driver dependent information */
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
int ref_count; /* Reference count for multiple opens */
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
|
|
|
|
};
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
/* Device bus definitions */
|
|
|
|
#define SDL_HARDWARE_BUS_USB 0x03
|
|
|
|
#define SDL_HARDWARE_BUS_BLUETOOTH 0x05
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
/* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
|
|
|
|
#define MAKE_VIDPID(VID, PID) (((Uint32)(VID))<<16|(PID))
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
typedef struct _SDL_JoystickDriver
|
|
|
|
{
|
|
|
|
/* Function to scan the system for joysticks.
|
|
|
|
* Joystick 0 should be the system default joystick.
|
|
|
|
* This function should return 0, or -1 on an unrecoverable error.
|
|
|
|
*/
|
|
|
|
int (*Init)(void);
|
|
|
|
|
|
|
|
/* Function to return the number of joystick devices plugged in right now */
|
|
|
|
int (*GetCount)(void);
|
|
|
|
|
|
|
|
/* Function to cause any queued joystick insertions to be processed */
|
|
|
|
void (*Detect)(void);
|
|
|
|
|
|
|
|
/* Function to get the device-dependent name of a joystick */
|
|
|
|
const char *(*GetDeviceName)(int device_index);
|
|
|
|
|
2018-10-25 23:53:14 +00:00
|
|
|
/* Function to get the player index of a joystick */
|
|
|
|
int (*GetDevicePlayerIndex)(int device_index);
|
|
|
|
|
2019-12-21 04:12:03 +00:00
|
|
|
/* Function to get the player index of a joystick */
|
|
|
|
void (*SetDevicePlayerIndex)(int device_index, int player_index);
|
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
/* Function to return the stable GUID for a plugged in device */
|
|
|
|
SDL_JoystickGUID (*GetDeviceGUID)(int device_index);
|
|
|
|
|
|
|
|
/* Function to get the current instance id of the joystick located at device_index */
|
|
|
|
SDL_JoystickID (*GetDeviceInstanceID)(int device_index);
|
|
|
|
|
|
|
|
/* Function to open a joystick for use.
|
|
|
|
The joystick to open is specified by the device index.
|
|
|
|
This should fill the nbuttons and naxes fields of the joystick structure.
|
|
|
|
It returns 0, or -1 if there is an error.
|
|
|
|
*/
|
2020-11-17 01:36:47 +00:00
|
|
|
int (*Open)(SDL_Joystick *joystick, int device_index);
|
2018-08-09 23:00:17 +00:00
|
|
|
|
|
|
|
/* Rumble functionality */
|
2020-11-17 01:36:47 +00:00
|
|
|
int (*Rumble)(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble);
|
|
|
|
int (*RumbleTriggers)(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble);
|
2018-08-09 23:00:17 +00:00
|
|
|
|
2020-04-30 15:57:29 +00:00
|
|
|
/* LED functionality */
|
2020-11-17 01:36:47 +00:00
|
|
|
SDL_bool (*HasLED)(SDL_Joystick *joystick);
|
|
|
|
int (*SetLED)(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue);
|
2020-04-30 15:57:29 +00:00
|
|
|
|
2021-07-08 20:22:41 +00:00
|
|
|
/* General effects */
|
|
|
|
int (*SendEffect)(SDL_Joystick *joystick, const void *data, int size);
|
|
|
|
|
2020-11-17 18:30:20 +00:00
|
|
|
/* Sensor functionality */
|
|
|
|
int (*SetSensorsEnabled)(SDL_Joystick *joystick, SDL_bool enabled);
|
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
/* Function to update the state of a joystick - called as a device poll.
|
|
|
|
* This function shouldn't update the joystick structure directly,
|
|
|
|
* but instead should call SDL_PrivateJoystick*() to deliver events
|
|
|
|
* and update joystick device state.
|
|
|
|
*/
|
2020-11-17 01:36:47 +00:00
|
|
|
void (*Update)(SDL_Joystick *joystick);
|
2018-08-09 23:00:17 +00:00
|
|
|
|
|
|
|
/* Function to close a joystick after use */
|
2020-11-17 01:36:47 +00:00
|
|
|
void (*Close)(SDL_Joystick *joystick);
|
2018-08-09 23:00:17 +00:00
|
|
|
|
|
|
|
/* Function to perform any system-specific joystick related cleanup */
|
|
|
|
void (*Quit)(void);
|
|
|
|
|
2020-05-29 20:37:21 +00:00
|
|
|
/* Function to get the autodetected controller mapping; returns false if there isn't any. */
|
|
|
|
SDL_bool (*GetGamepadMapping)(int device_index, SDL_GamepadMapping * out);
|
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
} SDL_JoystickDriver;
|
|
|
|
|
2020-02-04 20:48:53 +00:00
|
|
|
/* Windows and Mac OSX has a limit of MAX_DWORD / 1000, Linux kernel has a limit of 0xFFFF */
|
|
|
|
#define SDL_MAX_RUMBLE_DURATION_MS 0xFFFF
|
|
|
|
|
2021-04-12 18:25:42 +00:00
|
|
|
#define SDL_LED_MIN_REPEAT_MS 5000
|
|
|
|
|
2018-08-09 23:00:17 +00:00
|
|
|
/* The available joystick drivers */
|
|
|
|
extern SDL_JoystickDriver SDL_ANDROID_JoystickDriver;
|
2018-08-10 18:42:40 +00:00
|
|
|
extern SDL_JoystickDriver SDL_BSD_JoystickDriver;
|
2018-08-09 23:00:17 +00:00
|
|
|
extern SDL_JoystickDriver SDL_DARWIN_JoystickDriver;
|
|
|
|
extern SDL_JoystickDriver SDL_DUMMY_JoystickDriver;
|
2018-08-10 18:32:30 +00:00
|
|
|
extern SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver;
|
2018-08-10 19:04:08 +00:00
|
|
|
extern SDL_JoystickDriver SDL_HAIKU_JoystickDriver;
|
2018-08-09 23:00:17 +00:00
|
|
|
extern SDL_JoystickDriver SDL_HIDAPI_JoystickDriver;
|
2020-03-16 19:23:38 +00:00
|
|
|
extern SDL_JoystickDriver SDL_RAWINPUT_JoystickDriver;
|
2018-08-09 23:00:17 +00:00
|
|
|
extern SDL_JoystickDriver SDL_IOS_JoystickDriver;
|
|
|
|
extern SDL_JoystickDriver SDL_LINUX_JoystickDriver;
|
Fixed bug 5028 - Virtual Joysticks (new joystick backend)
David Ludwig
I have created a new driver for SDL's Joystick and Game-Controller subsystem: a Virtual driver. This driver allows one to create a software-based joystick, which to SDL applications will look and react like a real joystick, but whose state can be set programmatically. A primary use case for this is to help enable developers to add touch-screen joysticks to their apps.
The driver comes with a set of new, public APIs, with functions to attach and detach joysticks, set virtual-joystick state, and to determine if a joystick is a virtual-one.
Use of virtual joysticks goes as such:
1. Attach one or more virtual joysticks by calling SDL_JoystickAttachVirtual. If successful, this returns the virtual-device's joystick-index.
2. Open the virtual joysticks (using indicies returned by SDL_JoystickAttachVirtual).
3. Call any of the SDL_JoystickSetVirtual* functions when joystick-state changes. Please note that virtual-joystick state will only get applied on the next call to SDL_JoystickUpdate, or when pumping or polling for SDL events (via SDL_PumpEvents or SDL_PollEvent).
Here is a listing of the new, public APIs, at present and subject to change:
------------------------------------------------------------
/**
* Attaches a new virtual joystick.
* Returns the joystick's device index, or -1 if an error occurred.
*/
extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtual(SDL_JoystickType type, int naxes, int nballs, int nbuttons, int nhats);
/**
* Detaches a virtual joystick
* Returns 0 on success, or -1 if an error occurred.
*/
extern DECLSPEC int SDLCALL SDL_JoystickDetachVirtual(int device_index);
/**
* Indicates whether or not a virtual-joystick is at a given device index.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index);
/**
* Set values on an opened, virtual-joystick's controls.
* Returns 0 on success, -1 on error.
*/
extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick * joystick, int axis, Sint16 value);
extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualBall(SDL_Joystick * joystick, int ball, Sint16 xrel, Sint16 yrel);
extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualButton(SDL_Joystick * joystick, int button, Uint8 value);
extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualHat(SDL_Joystick * joystick, int hat, Uint8 value);
------------------------------------------------------------
Miscellaneous notes on the initial patch, which are also subject to change:
1. no test code is present in SDL, yet. This should, perhaps, change. Initial development was done with an ImGui-based app, which potentially is too thick for use in SDL-official. If tests are to be added, what kind of tests? Automated? Graphical?
2. virtual game controllers can be created by calling SDL_JoystickAttachVirtual with a joystick-type of SDL_JOYSTICK_TYPE_GAME_CONTROLLER, with naxes (num axes) set to SDL_CONTROLLER_AXIS_MAX, and with nbuttons (num buttons) set to SDL_CONTROLLER_BUTTON_MAX. When updating their state, values of type SDL_GameControllerAxis or SDL_GameControllerButton can be casted to an int and used for the control-index (in calls to SDL_JoystickSetVirtual* functions).
3. virtual joysticks' guids are mostly all-zeros with the exception of the last two bytes, the first of which is a 'v', to indicate that the guid is a virtual one, and the second of which is a SDL_JoystickType that has been converted into a Uint8.
4. virtual joysticks are ONLY turned into virtual game-controllers if and when their joystick-type is set to SDL_JOYSTICK_TYPE_GAMECONTROLLER. This is controlled by having SDL's default list of game-controllers have a single entry for a virtual game controller (of guid, "00000000000000000000000000007601", which is subject to the guid-encoding described above).
5. regarding having to call SDL_JoystickUpdate, either directly or indirectly via SDL_PumpEvents or SDL_PollEvents, before new virtual-joystick state becomes active (as specified via SDL_JoystickSetVirtual* function-calls), this was done to match behavior found in SDL's other joystick drivers, almost all of which will only update SDL-state during SDL_JoystickUpdate.
6. the initial patch is based off of SDL 2.0.12
7. the virtual joystick subsystem is disabled by default. It should be possible to enable it by building with SDL_JOYSTICK_VIRTUAL=1
Questions, comments, suggestions, or bug reports very welcome!
2020-03-14 02:08:45 +00:00
|
|
|
extern SDL_JoystickDriver SDL_VIRTUAL_JoystickDriver;
|
2020-04-19 04:41:37 +00:00
|
|
|
extern SDL_JoystickDriver SDL_WGI_JoystickDriver;
|
2018-08-09 23:00:17 +00:00
|
|
|
extern SDL_JoystickDriver SDL_WINDOWS_JoystickDriver;
|
2021-01-23 14:30:50 +00:00
|
|
|
extern SDL_JoystickDriver SDL_WINMM_JoystickDriver;
|
2021-01-22 17:10:02 +00:00
|
|
|
extern SDL_JoystickDriver SDL_OS2_JoystickDriver;
|
2021-01-23 14:30:50 +00:00
|
|
|
extern SDL_JoystickDriver SDL_PSP_JoystickDriver;
|
2020-11-02 16:38:20 +00:00
|
|
|
extern SDL_JoystickDriver SDL_VITA_JoystickDriver;
|
2015-06-21 15:33:46 +00:00
|
|
|
|
2016-11-21 05:34:54 +00:00
|
|
|
#endif /* SDL_sysjoystick_h_ */
|
2015-06-21 15:33:46 +00:00
|
|
|
|
|
|
|
/* vi: set ts=4 sw=4 expandtab: */
|