SDL_sysjoystick.h
Go to the documentation of this file.
/*
Simple DirectMedia Layer
Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
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"
#ifndef SDL_sysjoystick_h_
#define SDL_sysjoystick_h_
/* This is the system specific header for the SDL joystick API */
#include "SDL_joystick.h"
#include "SDL_joystick_c.h"
/* The SDL joystick structure */
typedef struct _SDL_JoystickAxisInfo
{
Sint16 initial_value; /* Initial axis state */
Sint16 value; /* Current axis state */
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 */
SDL_bool sent_initial_value; /* Whether we've sent the initial axis value */
} SDL_JoystickAxisInfo;
struct _SDL_Joystick
{
SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
char *name; /* Joystick name - system dependent */
int player_index; /* Joystick player index, or -1 if unavailable */
SDL_JoystickGUID guid; /* Joystick guid */
int naxes; /* Number of axis controls on the joystick */
SDL_JoystickAxisInfo *axes;
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 */
SDL_bool attached;
SDL_bool is_game_controller;
SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
SDL_bool force_recentering; /* SDL_TRUE if this device needs to have its state reset to 0 */
SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
struct _SDL_JoystickDriver *driver;
struct joystick_hwdata *hwdata; /* Driver dependent information */
int ref_count; /* Reference count for multiple opens */
struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
};
#if defined(__IPHONEOS__) || defined(__ANDROID__)
#define HAVE_STEAMCONTROLLERS
#define USE_STEAMCONTROLLER_HIDAPI
#elif defined(__LINUX__)
#define HAVE_STEAMCONTROLLERS
#define USE_STEAMCONTROLLER_LINUX
#endif
/* Device bus definitions */
#define SDL_HARDWARE_BUS_USB 0x03
#define SDL_HARDWARE_BUS_BLUETOOTH 0x05
/* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
#define MAKE_VIDPID(VID, PID) (((Uint32)(VID))<<16|(PID))
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);
/* Function to get the player index of a joystick */
int (*GetDevicePlayerIndex)(int device_index);
/* 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.
*/
int (*Open)(SDL_Joystick * joystick, int device_index);
/* Rumble functionality */
int (*Rumble)(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
/* 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.
*/
void (*Update)(SDL_Joystick * joystick);
/* Function to close a joystick after use */
void (*Close)(SDL_Joystick * joystick);
/* Function to perform any system-specific joystick related cleanup */
void (*Quit)(void);
} SDL_JoystickDriver;
/* The available joystick drivers */
extern SDL_JoystickDriver SDL_ANDROID_JoystickDriver;
extern SDL_JoystickDriver SDL_BSD_JoystickDriver;
extern SDL_JoystickDriver SDL_DARWIN_JoystickDriver;
extern SDL_JoystickDriver SDL_DUMMY_JoystickDriver;
extern SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver;
extern SDL_JoystickDriver SDL_HAIKU_JoystickDriver;
extern SDL_JoystickDriver SDL_HIDAPI_JoystickDriver;
extern SDL_JoystickDriver SDL_IOS_JoystickDriver;
extern SDL_JoystickDriver SDL_LINUX_JoystickDriver;
extern SDL_JoystickDriver SDL_WINDOWS_JoystickDriver;
#endif /* SDL_sysjoystick_h_ */
/* vi: set ts=4 sw=4 expandtab: */
_SDL_JoystickAxisInfo::has_initial_value
SDL_bool has_initial_value
Definition: SDL_sysjoystick.h:37
_SDL_JoystickDriver::Rumble
int(* Rumble)(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
Definition: SDL_sysjoystick.h:126
_SDL_JoystickDriver::Init
int(* Init)(void)
Definition: SDL_sysjoystick.h:98
_SDL_Joystick::balldelta::dx
int dx
Definition: SDL_sysjoystick.h:56
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
_SDL_Joystick::buttons
Uint8 * buttons
Definition: SDL_sysjoystick.h:61
_SDL_Joystick::hwdata
struct joystick_hwdata * hwdata
Definition: SDL_sysjoystick.h:70
SDL_joystick_c.h
_SDL_Joystick::ref_count
int ref_count
Definition: SDL_sysjoystick.h:72
SDL_joystick.h
_SDL_JoystickAxisInfo::sent_initial_value
SDL_bool sent_initial_value
Definition: SDL_sysjoystick.h:38
_SDL_JoystickDriver::GetDeviceGUID
SDL_JoystickGUID(* GetDeviceGUID)(int device_index)
Definition: SDL_sysjoystick.h:113
SDL_BSD_JoystickDriver
SDL_JoystickDriver SDL_BSD_JoystickDriver
_SDL_Joystick::nballs
int nballs
Definition: SDL_sysjoystick.h:54
SDL_JoystickPowerLevel
SDL_JoystickPowerLevel
Definition: SDL_joystick.h:97
_SDL_Joystick::axes
SDL_JoystickAxisInfo * axes
Definition: SDL_sysjoystick.h:49
_SDL_Joystick::guid
SDL_JoystickGUID guid
Definition: SDL_sysjoystick.h:46
_SDL_Joystick::player_index
int player_index
Definition: SDL_sysjoystick.h:45
_SDL_Joystick::nbuttons
int nbuttons
Definition: SDL_sysjoystick.h:60
_SDL_Joystick::epowerlevel
SDL_JoystickPowerLevel epowerlevel
Definition: SDL_sysjoystick.h:67
_SDL_Joystick::balls
struct _SDL_Joystick::balldelta * balls
_SDL_Joystick::naxes
int naxes
Definition: SDL_sysjoystick.h:48
_SDL_JoystickDriver::GetCount
int(* GetCount)(void)
Definition: SDL_sysjoystick.h:101
_SDL_Joystick::attached
SDL_bool attached
Definition: SDL_sysjoystick.h:63
_SDL_JoystickDriver::Close
void(* Close)(SDL_Joystick *joystick)
Definition: SDL_sysjoystick.h:136
_SDL_Joystick::force_recentering
SDL_bool force_recentering
Definition: SDL_sysjoystick.h:66
SDL_JoystickID
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
Sint16
int16_t Sint16
Definition: SDL_stdinc.h:185
_SDL_JoystickAxisInfo
Definition: SDL_sysjoystick.h:32
_SDL_JoystickDriver::GetDevicePlayerIndex
int(* GetDevicePlayerIndex)(int device_index)
Definition: SDL_sysjoystick.h:110
_SDL_Joystick
Definition: SDL_sysjoystick.h:41
_SDL_JoystickAxisInfo::zero
Sint16 zero
Definition: SDL_sysjoystick.h:36
SDL_HAIKU_JoystickDriver
SDL_JoystickDriver SDL_HAIKU_JoystickDriver
SDL_DARWIN_JoystickDriver
SDL_JoystickDriver SDL_DARWIN_JoystickDriver
_SDL_Joystick::is_game_controller
SDL_bool is_game_controller
Definition: SDL_sysjoystick.h:64
SDL_DUMMY_JoystickDriver
SDL_JoystickDriver SDL_DUMMY_JoystickDriver
Uint16
uint16_t Uint16
Definition: SDL_stdinc.h:191
_SDL_JoystickDriver::Detect
void(* Detect)(void)
Definition: SDL_sysjoystick.h:104
_SDL_JoystickDriver
Definition: SDL_sysjoystick.h:92
SDL_WINDOWS_JoystickDriver
SDL_JoystickDriver SDL_WINDOWS_JoystickDriver
_SDL_JoystickDriver::Open
int(* Open)(SDL_Joystick *joystick, int device_index)
Definition: SDL_sysjoystick.h:123
_SDL_JoystickAxisInfo::initial_value
Sint16 initial_value
Definition: SDL_sysjoystick.h:34
_SDL_Joystick::instance_id
SDL_JoystickID instance_id
Definition: SDL_sysjoystick.h:43
_SDL_Joystick::balldelta
Definition: SDL_sysjoystick.h:55
_SDL_JoystickDriver::Quit
void(* Quit)(void)
Definition: SDL_sysjoystick.h:139
_SDL_JoystickDriver::Update
void(* Update)(SDL_Joystick *joystick)
Definition: SDL_sysjoystick.h:133
SDL_IOS_JoystickDriver
SDL_JoystickDriver SDL_IOS_JoystickDriver
Definition: SDL_sysjoystick.m:868
_SDL_Joystick::nhats
int nhats
Definition: SDL_sysjoystick.h:51
_SDL_JoystickDriver::GetDeviceInstanceID
SDL_JoystickID(* GetDeviceInstanceID)(int device_index)
Definition: SDL_sysjoystick.h:116
_SDL_Joystick::name
char * name
Definition: SDL_sysjoystick.h:44
_SDL_Joystick::delayed_guide_button
SDL_bool delayed_guide_button
Definition: SDL_sysjoystick.h:65
_SDL_Joystick::driver
struct _SDL_JoystickDriver * driver
Definition: SDL_sysjoystick.h:68
SDL_LINUX_JoystickDriver
SDL_JoystickDriver SDL_LINUX_JoystickDriver
_SDL_Joystick::balldelta::dy
int dy
Definition: SDL_sysjoystick.h:57
_SDL_Joystick::next
struct _SDL_Joystick * next
Definition: SDL_sysjoystick.h:74
_SDL_Joystick::hats
Uint8 * hats
Definition: SDL_sysjoystick.h:52
_SDL_JoystickAxisInfo::value
Sint16 value
Definition: SDL_sysjoystick.h:35
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_JoystickGUID
Definition: SDL_joystick.h:70
SDL_EMSCRIPTEN_JoystickDriver
SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver
SDL_HIDAPI_JoystickDriver
SDL_JoystickDriver SDL_HIDAPI_JoystickDriver
joystick_hwdata
Definition: SDL_sysjoystick_c.h:46
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:161
SDL_ANDROID_JoystickDriver
SDL_JoystickDriver SDL_ANDROID_JoystickDriver
Uint8
uint8_t Uint8
Definition: SDL_stdinc.h:179