409 lines
14 KiB
C
409 lines
14 KiB
C
|
/*
|
||
|
|
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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \file SDL_joystick.h
|
||
|
|
*
|
||
|
|
* Include file for SDL joystick event handling
|
||
|
|
*
|
||
|
|
* The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick
|
||
|
|
* behind a device_index changing as joysticks are plugged and unplugged.
|
||
|
|
*
|
||
|
|
* The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
|
||
|
|
* then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
|
||
|
|
*
|
||
|
|
* The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
|
||
|
|
* the device (a X360 wired controller for example). This identifier is platform dependent.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef SDL_joystick_h_
|
||
|
|
#define SDL_joystick_h_
|
||
|
|
|
||
|
|
#include "SDL_stdinc.h"
|
||
|
|
#include "SDL_error.h"
|
||
|
|
|
||
|
|
#include "begin_code.h"
|
||
|
|
/* Set up for C function definitions, even when using C++ */
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \file SDL_joystick.h
|
||
|
|
*
|
||
|
|
* In order to use these functions, SDL_Init() must have been called
|
||
|
|
* with the ::SDL_INIT_JOYSTICK flag. This causes SDL to scan the system
|
||
|
|
* for joysticks, and load appropriate drivers.
|
||
|
|
*
|
||
|
|
* If you would like to receive joystick updates while the application
|
||
|
|
* is in the background, you should set the following hint before calling
|
||
|
|
* SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The joystick structure used to identify an SDL joystick
|
||
|
|
*/
|
||
|
|
struct _SDL_Joystick;
|
||
|
|
typedef struct _SDL_Joystick SDL_Joystick;
|
||
|
|
|
||
|
|
/* A structure that encodes the stable unique id for a joystick device */
|
||
|
|
typedef struct {
|
||
|
|
Uint8 data[16];
|
||
|
|
} SDL_JoystickGUID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This is a unique ID for a joystick for the time it is connected to the system,
|
||
|
|
* and is never reused for the lifetime of the application. If the joystick is
|
||
|
|
* disconnected and reconnected, it will get a new ID.
|
||
|
|
*
|
||
|
|
* The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
|
||
|
|
*/
|
||
|
|
typedef Sint32 SDL_JoystickID;
|
||
|
|
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
SDL_JOYSTICK_TYPE_UNKNOWN,
|
||
|
|
SDL_JOYSTICK_TYPE_GAMECONTROLLER,
|
||
|
|
SDL_JOYSTICK_TYPE_WHEEL,
|
||
|
|
SDL_JOYSTICK_TYPE_ARCADE_STICK,
|
||
|
|
SDL_JOYSTICK_TYPE_FLIGHT_STICK,
|
||
|
|
SDL_JOYSTICK_TYPE_DANCE_PAD,
|
||
|
|
SDL_JOYSTICK_TYPE_GUITAR,
|
||
|
|
SDL_JOYSTICK_TYPE_DRUM_KIT,
|
||
|
|
SDL_JOYSTICK_TYPE_ARCADE_PAD,
|
||
|
|
SDL_JOYSTICK_TYPE_THROTTLE
|
||
|
|
} SDL_JoystickType;
|
||
|
|
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
SDL_JOYSTICK_POWER_UNKNOWN = -1,
|
||
|
|
SDL_JOYSTICK_POWER_EMPTY, /* <= 5% */
|
||
|
|
SDL_JOYSTICK_POWER_LOW, /* <= 20% */
|
||
|
|
SDL_JOYSTICK_POWER_MEDIUM, /* <= 70% */
|
||
|
|
SDL_JOYSTICK_POWER_FULL, /* <= 100% */
|
||
|
|
SDL_JOYSTICK_POWER_WIRED,
|
||
|
|
SDL_JOYSTICK_POWER_MAX
|
||
|
|
} SDL_JoystickPowerLevel;
|
||
|
|
|
||
|
|
/* Function prototypes */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Locking for multi-threaded access to the joystick API
|
||
|
|
*
|
||
|
|
* If you are using the joystick API or handling events from multiple threads
|
||
|
|
* you should use these locking functions to protect access to the joysticks.
|
||
|
|
*
|
||
|
|
* In particular, you are guaranteed that the joystick list won't change, so
|
||
|
|
* the API functions that take a joystick index will be valid, and joystick
|
||
|
|
* and game controller events will not be delivered.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC void SDLCALL SDL_LockJoysticks(void);
|
||
|
|
extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Count the number of joysticks attached to the system right now
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the implementation dependent name of a joystick.
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
* If no name can be found, this function returns NULL.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the player index of a joystick, or -1 if it's not available
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the GUID for the joystick at this index
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the USB vendor ID of a joystick, if available.
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
* If the vendor ID isn't available this function returns 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the USB product ID of a joystick, if available.
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
* If the product ID isn't available this function returns 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the product version of a joystick, if available.
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
* If the product version isn't available this function returns 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the type of a joystick, if available.
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the instance ID of a joystick.
|
||
|
|
* This can be called before any joysticks are opened.
|
||
|
|
* If the index is out of range, this function will return -1.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Open a joystick for use.
|
||
|
|
* The index passed as an argument refers to the N'th joystick on the system.
|
||
|
|
* This index is not the value which will identify this joystick in future
|
||
|
|
* joystick events. The joystick's instance id (::SDL_JoystickID) will be used
|
||
|
|
* there instead.
|
||
|
|
*
|
||
|
|
* \return A joystick identifier, or NULL if an error occurred.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the SDL_Joystick associated with an instance id.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the name for this currently opened joystick.
|
||
|
|
* If no name can be found, this function returns NULL.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the player index of an opened joystick, or -1 if it's not available
|
||
|
|
*
|
||
|
|
* For XInput controllers this returns the XInput user index.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the GUID for this opened joystick
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the USB vendor ID of an opened joystick, if available.
|
||
|
|
* If the vendor ID isn't available this function returns 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the USB product ID of an opened joystick, if available.
|
||
|
|
* If the product ID isn't available this function returns 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the product version of an opened joystick, if available.
|
||
|
|
* If the product version isn't available this function returns 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the type of an opened joystick.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return a string representation for this guid. pszGUID must point to at least 33 bytes
|
||
|
|
* (32 for the string plus a NULL terminator).
|
||
|
|
*/
|
||
|
|
extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Convert a string into a joystick guid
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the instance ID of an opened joystick or -1 if the joystick is invalid.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the number of general axis controls on a joystick.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the number of trackballs on a joystick.
|
||
|
|
*
|
||
|
|
* Joystick trackballs have only relative motion events associated
|
||
|
|
* with them and their state cannot be polled.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the number of POV hats on a joystick.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the number of buttons on a joystick.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the current state of the open joysticks.
|
||
|
|
*
|
||
|
|
* This is called automatically by the event loop if any joystick
|
||
|
|
* events are enabled.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enable/disable joystick event polling.
|
||
|
|
*
|
||
|
|
* If joystick events are disabled, you must call SDL_JoystickUpdate()
|
||
|
|
* yourself and check the state of the joystick when you want joystick
|
||
|
|
* information.
|
||
|
|
*
|
||
|
|
* The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
|
||
|
|
|
||
|
|
#define SDL_JOYSTICK_AXIS_MAX 32767
|
||
|
|
#define SDL_JOYSTICK_AXIS_MIN -32768
|
||
|
|
/**
|
||
|
|
* Get the current state of an axis control on a joystick.
|
||
|
|
*
|
||
|
|
* The state is a value ranging from -32768 to 32767.
|
||
|
|
*
|
||
|
|
* The axis indices start at index 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
|
||
|
|
int axis);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the initial state of an axis control on a joystick.
|
||
|
|
*
|
||
|
|
* The state is a value ranging from -32768 to 32767.
|
||
|
|
*
|
||
|
|
* The axis indices start at index 0.
|
||
|
|
*
|
||
|
|
* \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
|
||
|
|
int axis, Sint16 *state);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \name Hat positions
|
||
|
|
*/
|
||
|
|
/* @{ */
|
||
|
|
#define SDL_HAT_CENTERED 0x00
|
||
|
|
#define SDL_HAT_UP 0x01
|
||
|
|
#define SDL_HAT_RIGHT 0x02
|
||
|
|
#define SDL_HAT_DOWN 0x04
|
||
|
|
#define SDL_HAT_LEFT 0x08
|
||
|
|
#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
|
||
|
|
#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
|
||
|
|
#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
|
||
|
|
#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
|
||
|
|
/* @} */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current state of a POV hat on a joystick.
|
||
|
|
*
|
||
|
|
* The hat indices start at index 0.
|
||
|
|
*
|
||
|
|
* \return The return value is one of the following positions:
|
||
|
|
* - ::SDL_HAT_CENTERED
|
||
|
|
* - ::SDL_HAT_UP
|
||
|
|
* - ::SDL_HAT_RIGHT
|
||
|
|
* - ::SDL_HAT_DOWN
|
||
|
|
* - ::SDL_HAT_LEFT
|
||
|
|
* - ::SDL_HAT_RIGHTUP
|
||
|
|
* - ::SDL_HAT_RIGHTDOWN
|
||
|
|
* - ::SDL_HAT_LEFTUP
|
||
|
|
* - ::SDL_HAT_LEFTDOWN
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
|
||
|
|
int hat);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the ball axis change since the last poll.
|
||
|
|
*
|
||
|
|
* \return 0, or -1 if you passed it invalid parameters.
|
||
|
|
*
|
||
|
|
* The ball indices start at index 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
|
||
|
|
int ball, int *dx, int *dy);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current state of a button on a joystick.
|
||
|
|
*
|
||
|
|
* The button indices start at index 0.
|
||
|
|
*/
|
||
|
|
extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
|
||
|
|
int button);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Trigger a rumble effect
|
||
|
|
* Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.
|
||
|
|
*
|
||
|
|
* \param joystick The joystick to vibrate
|
||
|
|
* \param low_frequency_rumble The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
|
||
|
|
* \param high_frequency_rumble The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
|
||
|
|
* \param duration_ms The duration of the rumble effect, in milliseconds
|
||
|
|
*
|
||
|
|
* \return 0, or -1 if rumble isn't supported on this joystick
|
||
|
|
*/
|
||
|
|
extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Close a joystick previously opened with SDL_JoystickOpen().
|
||
|
|
*/
|
||
|
|
extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the battery level of this joystick
|
||
|
|
*/
|
||
|
|
extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick * joystick);
|
||
|
|
|
||
|
|
/* Ends C function definitions when using C++ */
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
#include "close_code.h"
|
||
|
|
|
||
|
|
#endif /* SDL_joystick_h_ */
|
||
|
|
|
||
|
|
/* vi: set ts=4 sw=4 expandtab: */
|