include/SDL_gamecontroller.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 07 Mar 2013 20:42:55 -0800
changeset 6978 e851407e9294
parent 6964 c8aa24f05042
child 7061 45df4552bdfe
permissions -rw-r--r--
Put the real SDL_AtomicCAS() and SDL_AtomicCASPtr() symbols into the library.
slouken@6690
     1
/*
slouken@6690
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@6690
     4
slouken@6690
     5
  This software is provided 'as-is', without any express or implied
slouken@6690
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@6690
     7
  arising from the use of this software.
slouken@6690
     8
slouken@6690
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@6690
    10
  including commercial applications, and to alter it and redistribute it
slouken@6690
    11
  freely, subject to the following restrictions:
slouken@6690
    12
slouken@6690
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@6690
    14
     claim that you wrote the original software. If you use this software
slouken@6690
    15
     in a product, an acknowledgment in the product documentation would be
slouken@6690
    16
     appreciated but is not required.
slouken@6690
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@6690
    18
     misrepresented as being the original software.
slouken@6690
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@6690
    20
*/
slouken@6690
    21
slouken@6690
    22
/**
slouken@6690
    23
 *  \file SDL_gamecontroller.h
jorgen@6873
    24
 *
slouken@6690
    25
 *  Include file for SDL game controller event handling
slouken@6690
    26
 */
slouken@6690
    27
slouken@6690
    28
#ifndef _SDL_gamecontroller_h
slouken@6690
    29
#define _SDL_gamecontroller_h
slouken@6690
    30
slouken@6690
    31
#include "SDL_stdinc.h"
slouken@6690
    32
#include "SDL_error.h"
slouken@6690
    33
#include "SDL_joystick.h"
slouken@6690
    34
slouken@6690
    35
#include "begin_code.h"
slouken@6690
    36
/* Set up for C function definitions, even when using C++ */
slouken@6690
    37
#ifdef __cplusplus
slouken@6690
    38
/* *INDENT-OFF* */
slouken@6690
    39
extern "C" {
slouken@6690
    40
/* *INDENT-ON* */
slouken@6690
    41
#endif
slouken@6690
    42
slouken@6690
    43
/**
slouken@6690
    44
 *  \file SDL_gamecontroller.h
slouken@6690
    45
 *
slouken@6690
    46
 *  In order to use these functions, SDL_Init() must have been called
slouken@6690
    47
 *  with the ::SDL_INIT_JOYSTICK flag.  This causes SDL to scan the system
slouken@6690
    48
 *  for game controllers, and load appropriate drivers.
slouken@6690
    49
 */
slouken@6690
    50
slouken@6690
    51
/* The gamecontroller structure used to identify an SDL game controller */
slouken@6690
    52
struct _SDL_GameController;
slouken@6690
    53
typedef struct _SDL_GameController SDL_GameController;
slouken@6690
    54
slouken@6690
    55
jorgen@6873
    56
typedef enum
slouken@6690
    57
{
slouken@6690
    58
	SDL_CONTROLLER_BINDTYPE_NONE = 0,
slouken@6690
    59
	SDL_CONTROLLER_BINDTYPE_BUTTON,
slouken@6690
    60
	SDL_CONTROLLER_BINDTYPE_AXIS,
slouken@6795
    61
	SDL_CONTROLLER_BINDTYPE_HAT
icculus@6917
    62
} SDL_GameControllerBindType;
icculus@6917
    63
slouken@6690
    64
/**
slouken@6932
    65
 *  Get the SDL joystick layer binding for this controller button/axis mapping
slouken@6690
    66
 */
slouken@6932
    67
typedef struct SDL_GameControllerButtonBind
slouken@6690
    68
{
slouken@6932
    69
	SDL_GameControllerBindType bindType;
slouken@6690
    70
	union
slouken@6690
    71
	{
slouken@6690
    72
		int button;
slouken@6690
    73
		int axis;
slouken@6932
    74
		struct {
slouken@6932
    75
            int hat;
slouken@6932
    76
            int hat_mask;
slouken@6932
    77
        } hat;
slouken@6932
    78
	} value;
slouken@6690
    79
slouken@6690
    80
} SDL_GameControllerButtonBind;
slouken@6690
    81
slouken@6690
    82
slouken@6690
    83
/**
slouken@6690
    84
 *  To count the number of game controllers in the system for the following:
slouken@6690
    85
 *	int nJoysticks = SDL_NumJoysticks();
slouken@6690
    86
 *	int nGameControllers = 0;
slouken@6690
    87
 *	for ( int i = 0; i < nJoysticks; i++ ) {
slouken@6690
    88
 *		if ( SDL_IsGameController(i) ) {
slouken@6690
    89
 *			nGameControllers++;
slouken@6690
    90
 *		}
slouken@6690
    91
 *  }
slouken@6690
    92
 *
urkle@6964
    93
 *  Using the SDL_HINT_GAMECONTROLLERCONFIG hint or the SDL_GameControllerAddMapping you can add support for controllers SDL is unaware of or cause an existing controller to have a different binding. The format is:
slouken@6690
    94
 *	guid,name,mappings
slouken@6690
    95
 *
slouken@6690
    96
 *  Where GUID is the string value from SDL_JoystickGetGUIDString(), name is the human readable string for the device and mappings are controller mappings to joystick ones.
slouken@6690
    97
 *  Under Windows there is a reserved GUID of "xinput" that covers any XInput devices.
jorgen@6873
    98
 *	The mapping format for joystick is:
slouken@6690
    99
 *		bX - a joystick button, index X
slouken@6690
   100
 *		hX.Y - hat X with value Y
slouken@6690
   101
 *		aX - axis X of the joystick
slouken@6690
   102
 *  Buttons can be used as a controller axis and vice versa.
slouken@6690
   103
 *
slouken@6690
   104
 *  This string shows an example of a valid mapping for a controller
slouken@6690
   105
 * 	"341a3608000000000000504944564944,Aferglow PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7",
slouken@6690
   106
 *
slouken@6690
   107
 */
slouken@6690
   108
urkle@6964
   109
/**
urkle@6964
   110
 *  Add or update an existing mapping configuration
urkle@6964
   111
 *
urkle@6964
   112
 * \return 1 if mapping is added, 0 if updated, -1 on error
urkle@6964
   113
 */
urkle@6964
   114
extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping( const char* mappingSring );
urkle@6964
   115
urkle@6964
   116
/**
urkle@6964
   117
 *  Get a mapping string for a GUID
urkle@6964
   118
 *
urkle@6964
   119
 *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
urkle@6964
   120
 */
urkle@6964
   121
extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID( SDL_JoystickGUID guid );
urkle@6964
   122
urkle@6964
   123
/**
urkle@6964
   124
 *  Get a mapping string for an open GameController
urkle@6964
   125
 *
urkle@6964
   126
 *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
urkle@6964
   127
 */
urkle@6964
   128
extern DECLSPEC char * SDLCALL SDL_GameControllerMapping( SDL_GameController * gamecontroller );
slouken@6690
   129
slouken@6690
   130
/**
slouken@6690
   131
 *  Is the joystick on this index supported by the game controller interface?
slouken@6690
   132
 */
jorgen@6871
   133
extern DECLSPEC SDL_bool SDLCALL SDL_IsGameController(int joystick_index);
slouken@6690
   134
slouken@6690
   135
slouken@6690
   136
/**
slouken@6690
   137
 *  Get the implementation dependent name of a game controller.
slouken@6690
   138
 *  This can be called before any controllers are opened.
slouken@6690
   139
 *  If no name can be found, this function returns NULL.
slouken@6690
   140
 */
slouken@6690
   141
extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_index);
slouken@6690
   142
slouken@6690
   143
/**
jorgen@6873
   144
 *  Open a game controller for use.
jorgen@6873
   145
 *  The index passed as an argument refers to the N'th game controller on the system.
slouken@6690
   146
 *  This index is the value which will identify this controller in future controller
slouken@6690
   147
 *  events.
jorgen@6873
   148
 *
slouken@6690
   149
 *  \return A controller identifier, or NULL if an error occurred.
slouken@6690
   150
 */
slouken@6690
   151
extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerOpen(int joystick_index);
slouken@6690
   152
slouken@6690
   153
/**
slouken@6690
   154
 *  Return the name for this currently opened controller
slouken@6690
   155
 */
jorgen@6873
   156
extern DECLSPEC const char *SDLCALL SDL_GameControllerName(SDL_GameController *gamecontroller);
jorgen@6873
   157
slouken@6690
   158
/**
jorgen@6873
   159
 *  Returns SDL_TRUE if the controller has been opened and currently connected,
jorgen@6873
   160
 *  or SDL_FALSE if it has not.
slouken@6690
   161
 */
jorgen@6873
   162
extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerGetAttached(SDL_GameController *gamecontroller);
slouken@6690
   163
slouken@6690
   164
/**
slouken@6690
   165
 *  Get the underlying joystick object used by a controller
slouken@6690
   166
 */
jorgen@6873
   167
extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller);
slouken@6690
   168
slouken@6690
   169
/**
slouken@6690
   170
 *  Enable/disable controller event polling.
jorgen@6873
   171
 *
slouken@6690
   172
 *  If controller events are disabled, you must call SDL_GameControllerUpdate()
slouken@6690
   173
 *  yourself and check the state of the controller when you want controller
slouken@6690
   174
 *  information.
jorgen@6873
   175
 *
slouken@6690
   176
 *  The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
slouken@6690
   177
 */
slouken@6690
   178
extern DECLSPEC int SDLCALL SDL_GameControllerEventState(int state);
slouken@6690
   179
slouken@6690
   180
/**
icculus@6919
   181
 *  Update the current state of the open game controllers.
icculus@6919
   182
 *  
icculus@6919
   183
 *  This is called automatically by the event loop if any game controller
icculus@6919
   184
 *  events are enabled.
icculus@6919
   185
 */
icculus@6919
   186
extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void);
icculus@6919
   187
icculus@6919
   188
icculus@6919
   189
/**
slouken@6690
   190
 *  The list of axii available from a controller
slouken@6690
   191
 */
jorgen@6873
   192
typedef enum
slouken@6690
   193
{
slouken@6690
   194
	SDL_CONTROLLER_AXIS_INVALID = -1,
slouken@6690
   195
	SDL_CONTROLLER_AXIS_LEFTX,
slouken@6690
   196
	SDL_CONTROLLER_AXIS_LEFTY,
slouken@6690
   197
	SDL_CONTROLLER_AXIS_RIGHTX,
slouken@6690
   198
	SDL_CONTROLLER_AXIS_RIGHTY,
slouken@6690
   199
	SDL_CONTROLLER_AXIS_TRIGGERLEFT,
slouken@6690
   200
	SDL_CONTROLLER_AXIS_TRIGGERRIGHT,
slouken@6690
   201
	SDL_CONTROLLER_AXIS_MAX
icculus@6917
   202
} SDL_GameControllerAxis;
slouken@6690
   203
slouken@6690
   204
/**
slouken@6690
   205
 *  turn this string into a axis mapping
slouken@6690
   206
 */
icculus@6917
   207
extern DECLSPEC SDL_GameControllerAxis SDLCALL SDL_GameControllerGetAxisFromString(const char *pchString);
slouken@6690
   208
slouken@6690
   209
/**
urkle@6964
   210
 *  turn this axis enum into a string mapping
urkle@6964
   211
 */
urkle@6964
   212
extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForAxis(SDL_GameControllerAxis axis);
urkle@6964
   213
urkle@6964
   214
/**
slouken@6932
   215
 *  Get the SDL joystick layer binding for this controller button mapping
slouken@6690
   216
 */
jorgen@6873
   217
extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
jorgen@6873
   218
SDL_GameControllerGetBindForAxis(SDL_GameController *gamecontroller,
icculus@6917
   219
                                 SDL_GameControllerAxis axis);
slouken@6690
   220
slouken@6690
   221
/**
slouken@6690
   222
 *  Get the current state of an axis control on a game controller.
jorgen@6873
   223
 *
slouken@6690
   224
 *  The state is a value ranging from -32768 to 32767.
jorgen@6873
   225
 *
slouken@6690
   226
 *  The axis indices start at index 0.
slouken@6690
   227
 */
jorgen@6873
   228
extern DECLSPEC Sint16 SDLCALL
jorgen@6873
   229
SDL_GameControllerGetAxis(SDL_GameController *gamecontroller,
icculus@6917
   230
                          SDL_GameControllerAxis axis);
slouken@6690
   231
slouken@6690
   232
/**
slouken@6690
   233
 *  The list of buttons available from a controller
slouken@6690
   234
 */
slouken@6690
   235
typedef enum
slouken@6690
   236
{
slouken@6690
   237
	SDL_CONTROLLER_BUTTON_INVALID = -1,
slouken@6690
   238
	SDL_CONTROLLER_BUTTON_A,
slouken@6690
   239
	SDL_CONTROLLER_BUTTON_B,
slouken@6690
   240
	SDL_CONTROLLER_BUTTON_X,
slouken@6690
   241
	SDL_CONTROLLER_BUTTON_Y,
slouken@6690
   242
	SDL_CONTROLLER_BUTTON_BACK,
slouken@6690
   243
	SDL_CONTROLLER_BUTTON_GUIDE,
slouken@6690
   244
	SDL_CONTROLLER_BUTTON_START,
slouken@6690
   245
	SDL_CONTROLLER_BUTTON_LEFTSTICK,
slouken@6690
   246
	SDL_CONTROLLER_BUTTON_RIGHTSTICK,
slouken@6690
   247
	SDL_CONTROLLER_BUTTON_LEFTSHOULDER,
slouken@6690
   248
	SDL_CONTROLLER_BUTTON_RIGHTSHOULDER,
slouken@6690
   249
	SDL_CONTROLLER_BUTTON_DPAD_UP,
slouken@6690
   250
	SDL_CONTROLLER_BUTTON_DPAD_DOWN,
slouken@6690
   251
	SDL_CONTROLLER_BUTTON_DPAD_LEFT,
slouken@6690
   252
	SDL_CONTROLLER_BUTTON_DPAD_RIGHT,
slouken@6690
   253
	SDL_CONTROLLER_BUTTON_MAX
icculus@6917
   254
} SDL_GameControllerButton;
slouken@6690
   255
slouken@6690
   256
/**
slouken@6690
   257
 *  turn this string into a button mapping
slouken@6690
   258
 */
icculus@6917
   259
extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFromString(const char *pchString);
slouken@6690
   260
urkle@6964
   261
/**
urkle@6964
   262
 *  turn this button enum into a string mapping
urkle@6964
   263
 */
urkle@6964
   264
extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForButton(SDL_GameControllerButton button);
slouken@6690
   265
slouken@6690
   266
/**
slouken@6932
   267
 *  Get the SDL joystick layer binding for this controller button mapping
slouken@6690
   268
 */
jorgen@6873
   269
extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
jorgen@6873
   270
SDL_GameControllerGetBindForButton(SDL_GameController *gamecontroller,
icculus@6917
   271
                                   SDL_GameControllerButton button);
slouken@6690
   272
slouken@6690
   273
slouken@6690
   274
/**
slouken@6690
   275
 *  Get the current state of a button on a game controller.
jorgen@6873
   276
 *
slouken@6690
   277
 *  The button indices start at index 0.
slouken@6690
   278
 */
jorgen@6873
   279
extern DECLSPEC Uint8 SDLCALL SDL_GameControllerGetButton(SDL_GameController *gamecontroller,
icculus@6917
   280
                                                          SDL_GameControllerButton button);
slouken@6690
   281
slouken@6690
   282
/**
slouken@6690
   283
 *  Close a controller previously opened with SDL_GameControllerOpen().
slouken@6690
   284
 */
jorgen@6873
   285
extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecontroller);
slouken@6690
   286
slouken@6690
   287
slouken@6690
   288
/* Ends C function definitions when using C++ */
slouken@6690
   289
#ifdef __cplusplus
slouken@6690
   290
/* *INDENT-OFF* */
slouken@6690
   291
}
slouken@6690
   292
/* *INDENT-ON* */
slouken@6690
   293
#endif
slouken@6690
   294
#include "close_code.h"
slouken@6690
   295
slouken@6690
   296
#endif /* _SDL_gamecontroller_h */
slouken@6690
   297
slouken@6690
   298
/* vi: set ts=4 sw=4 expandtab: */