SDL  2.0
SDL_hidapijoystick_c.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../../SDL_internal.h"
22 
23 #ifndef SDL_JOYSTICK_HIDAPI_H
24 #define SDL_JOYSTICK_HIDAPI_H
25 
26 #include "../../hidapi/hidapi/hidapi.h"
27 
28 /* This is the full set of HIDAPI drivers available */
29 #define SDL_JOYSTICK_HIDAPI_PS4
30 #define SDL_JOYSTICK_HIDAPI_SWITCH
31 #define SDL_JOYSTICK_HIDAPI_XBOX360
32 #define SDL_JOYSTICK_HIDAPI_XBOXONE
33 
34 #ifdef __WINDOWS__
35 /* On Windows, Xbox One controllers are handled by the Xbox 360 driver */
36 #undef SDL_JOYSTICK_HIDAPI_XBOXONE
37 /* It turns out HIDAPI for Xbox controllers doesn't allow background input */
38 #undef SDL_JOYSTICK_HIDAPI_XBOX360
39 #endif
40 
41 #ifdef __MACOSX__
42 /* On Mac OS X, Xbox One controllers are handled by the Xbox 360 driver */
43 #undef SDL_JOYSTICK_HIDAPI_XBOXONE
44 #endif
45 
47 {
48  const char *hint;
50  SDL_bool (*IsSupportedDevice)(Uint16 vendor_id, Uint16 product_id, Uint16 version, int interface_number);
51  const char *(*GetDeviceName)(Uint16 vendor_id, Uint16 product_id);
52  SDL_bool (*Init)(SDL_Joystick *joystick, hid_device *dev, Uint16 vendor_id, Uint16 product_id, void **context);
53  int (*Rumble)(SDL_Joystick *joystick, hid_device *dev, void *context, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
54  SDL_bool (*Update)(SDL_Joystick *joystick, hid_device *dev, void *context);
55  void (*Quit)(SDL_Joystick *joystick, hid_device *dev, void *context);
56 
57 } SDL_HIDAPI_DeviceDriver;
58 
59 /* HIDAPI device support */
60 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverPS4;
61 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSteam;
62 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSwitch;
63 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXbox360;
64 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXboxOne;
65 
66 /* Return true if a HID device is present and supported as a joystick */
67 extern SDL_bool HIDAPI_IsDevicePresent(Uint16 vendor_id, Uint16 product_id, Uint16 version);
68 
69 /* Return the name of an Xbox 360 or Xbox One controller */
70 extern const char *HIDAPI_XboxControllerName(Uint16 vendor_id, Uint16 product_id);
71 
72 #endif /* SDL_JOYSTICK_HIDAPI_H */
73 
74 /* vi: set ts=4 sw=4 expandtab: */
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
SDL_HIDAPI_DriverPS4
SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverPS4
_SDL_HIDAPI_DeviceDriver::Init
SDL_bool(* Init)(SDL_Joystick *joystick, hid_device *dev, Uint16 vendor_id, Uint16 product_id, void **context)
Definition: SDL_hidapijoystick_c.h:52
_SDL_HIDAPI_DeviceDriver
Definition: SDL_hidapijoystick_c.h:46
_SDL_HIDAPI_DeviceDriver::Quit
void(* Quit)(SDL_Joystick *joystick, hid_device *dev, void *context)
Definition: SDL_hidapijoystick_c.h:55
_SDL_HIDAPI_DeviceDriver::Update
SDL_bool(* Update)(SDL_Joystick *joystick, hid_device *dev, void *context)
Definition: SDL_hidapijoystick_c.h:54
SDL_HIDAPI_DriverSwitch
SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSwitch
_SDL_HIDAPI_DeviceDriver::hint
const char * hint
Definition: SDL_hidapijoystick_c.h:48
SDL_HIDAPI_DriverXbox360
SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXbox360
context
static screen_context_t context
Definition: video.c:25
HIDAPI_XboxControllerName
const char * HIDAPI_XboxControllerName(Uint16 vendor_id, Uint16 product_id)
_SDL_HIDAPI_DeviceDriver::IsSupportedDevice
SDL_bool(* IsSupportedDevice)(Uint16 vendor_id, Uint16 product_id, Uint16 version, int interface_number)
Definition: SDL_hidapijoystick_c.h:50
_SDL_HIDAPI_DeviceDriver::Rumble
int(* Rumble)(SDL_Joystick *joystick, hid_device *dev, void *context, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Definition: SDL_hidapijoystick_c.h:53
Uint16
uint16_t Uint16
Definition: SDL_stdinc.h:191
SDL_HIDAPI_DriverXboxOne
SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXboxOne
SDL_HIDAPI_DriverSteam
SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSteam
HIDAPI_IsDevicePresent
SDL_bool HIDAPI_IsDevicePresent(Uint16 vendor_id, Uint16 product_id, Uint16 version)
hid_device
struct hid_device_ hid_device
Definition: hidapi.h:50
void
const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char const char const SDL_SCANF_FORMAT_STRING char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
Definition: SDL_dynapi_procs.h:89
_SDL_HIDAPI_DeviceDriver::enabled
SDL_bool enabled
Definition: SDL_hidapijoystick_c.h:49
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:161