include/SDL_gamecontroller.h
author Gabriel Jacobo <gabomdq@gmail.com>
Tue, 03 Dec 2013 12:01:28 -0300
changeset 8046 e7c89b29932a
parent 8042 7863121cb7d5
child 8051 a6981e0b9fe2
permissions -rw-r--r--
Adds SDL_GameControllerAddMappingsFromRW, updates controllermap

SDL_GameControllerAddMappingsFromFile is now a convenience macro.

controllermap can now skip bindings by pressing space or clicking/touching the
screen.
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
extern "C" {
slouken@6690
    39
#endif
slouken@6690
    40
slouken@6690
    41
/**
slouken@6690
    42
 *  \file SDL_gamecontroller.h
slouken@6690
    43
 *
slouken@6690
    44
 *  In order to use these functions, SDL_Init() must have been called
slouken@6690
    45
 *  with the ::SDL_INIT_JOYSTICK flag.  This causes SDL to scan the system
slouken@6690
    46
 *  for game controllers, and load appropriate drivers.
slouken@7341
    47
 *
slouken@7341
    48
 *  If you would like to receive controller updates while the application
slouken@7341
    49
 *  is in the background, you should set the following hint before calling
slouken@7341
    50
 *  SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
slouken@6690
    51
 */
slouken@6690
    52
slouken@6690
    53
/* The gamecontroller structure used to identify an SDL game controller */
slouken@6690
    54
struct _SDL_GameController;
slouken@6690
    55
typedef struct _SDL_GameController SDL_GameController;
slouken@6690
    56
slouken@6690
    57
jorgen@6873
    58
typedef enum
slouken@6690
    59
{
slouken@7191
    60
    SDL_CONTROLLER_BINDTYPE_NONE = 0,
slouken@7191
    61
    SDL_CONTROLLER_BINDTYPE_BUTTON,
slouken@7191
    62
    SDL_CONTROLLER_BINDTYPE_AXIS,
slouken@7191
    63
    SDL_CONTROLLER_BINDTYPE_HAT
icculus@6917
    64
} SDL_GameControllerBindType;
icculus@6917
    65
slouken@6690
    66
/**
slouken@6932
    67
 *  Get the SDL joystick layer binding for this controller button/axis mapping
slouken@6690
    68
 */
slouken@6932
    69
typedef struct SDL_GameControllerButtonBind
slouken@6690
    70
{
slouken@7191
    71
    SDL_GameControllerBindType bindType;
slouken@7191
    72
    union
slouken@7191
    73
    {
slouken@7191
    74
        int button;
slouken@7191
    75
        int axis;
slouken@7191
    76
        struct {
slouken@6932
    77
            int hat;
slouken@6932
    78
            int hat_mask;
slouken@6932
    79
        } hat;
slouken@7191
    80
    } value;
slouken@6690
    81
slouken@6690
    82
} SDL_GameControllerButtonBind;
slouken@6690
    83
slouken@6690
    84
slouken@6690
    85
/**
slouken@6690
    86
 *  To count the number of game controllers in the system for the following:
slouken@7191
    87
 *  int nJoysticks = SDL_NumJoysticks();
slouken@7191
    88
 *  int nGameControllers = 0;
slouken@7191
    89
 *  for ( int i = 0; i < nJoysticks; i++ ) {
slouken@7191
    90
 *      if ( SDL_IsGameController(i) ) {
slouken@7191
    91
 *          nGameControllers++;
slouken@7191
    92
 *      }
slouken@6690
    93
 *  }
slouken@6690
    94
 *
urkle@6964
    95
 *  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@7191
    96
 *  guid,name,mappings
slouken@6690
    97
 *
slouken@6690
    98
 *  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
    99
 *  Under Windows there is a reserved GUID of "xinput" that covers any XInput devices.
slouken@7191
   100
 *  The mapping format for joystick is:
slouken@7191
   101
 *      bX - a joystick button, index X
slouken@7191
   102
 *      hX.Y - hat X with value Y
slouken@7191
   103
 *      aX - axis X of the joystick
slouken@6690
   104
 *  Buttons can be used as a controller axis and vice versa.
slouken@6690
   105
 *
slouken@6690
   106
 *  This string shows an example of a valid mapping for a controller
slouken@7191
   107
 *  "341a3608000000000000504944564944,Afterglow 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
   108
 *
slouken@6690
   109
 */
slouken@6690
   110
urkle@6964
   111
/**
gabomdq@8046
   112
 *  Load a set of mappings from a seekable SDL data stream (memory or file), filtered by the current SDL_GetPlatform()
gabomdq@8042
   113
 *  A community sourced database of controllers is available at https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt
gabomdq@8042
   114
 *
gabomdq@8046
   115
 *  If \c freerw is non-zero, the stream will be closed after being read.
gabomdq@8046
   116
 * 
gabomdq@8042
   117
 * \return number of mappings added, -1 on error
gabomdq@8042
   118
 */
gabomdq@8046
   119
extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW( SDL_RWops * rw, int freerw );
gabomdq@8046
   120
gabomdq@8046
   121
/**
gabomdq@8046
   122
 *  Load a set of mappings from a file, filtered by the current SDL_GetPlatform()
gabomdq@8046
   123
 *
gabomdq@8046
   124
 *  Convenience macro.
gabomdq@8046
   125
 */
gabomdq@8046
   126
#define SDL_GameControllerAddMappingsFromFile(file)   SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)
gabomdq@8042
   127
gabomdq@8042
   128
/**
urkle@6964
   129
 *  Add or update an existing mapping configuration
urkle@6964
   130
 *
urkle@6964
   131
 * \return 1 if mapping is added, 0 if updated, -1 on error
urkle@6964
   132
 */
icculus@7061
   133
extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping( const char* mappingString );
urkle@6964
   134
urkle@6964
   135
/**
urkle@6964
   136
 *  Get a mapping string for a GUID
urkle@6964
   137
 *
urkle@6964
   138
 *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
urkle@6964
   139
 */
urkle@6964
   140
extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID( SDL_JoystickGUID guid );
urkle@6964
   141
urkle@6964
   142
/**
urkle@6964
   143
 *  Get a mapping string for an open GameController
urkle@6964
   144
 *
urkle@6964
   145
 *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
urkle@6964
   146
 */
urkle@6964
   147
extern DECLSPEC char * SDLCALL SDL_GameControllerMapping( SDL_GameController * gamecontroller );
slouken@6690
   148
slouken@6690
   149
/**
slouken@6690
   150
 *  Is the joystick on this index supported by the game controller interface?
slouken@6690
   151
 */
jorgen@6871
   152
extern DECLSPEC SDL_bool SDLCALL SDL_IsGameController(int joystick_index);
slouken@6690
   153
slouken@6690
   154
slouken@6690
   155
/**
slouken@6690
   156
 *  Get the implementation dependent name of a game controller.
slouken@6690
   157
 *  This can be called before any controllers are opened.
slouken@6690
   158
 *  If no name can be found, this function returns NULL.
slouken@6690
   159
 */
slouken@6690
   160
extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_index);
slouken@6690
   161
slouken@6690
   162
/**
jorgen@6873
   163
 *  Open a game controller for use.
jorgen@6873
   164
 *  The index passed as an argument refers to the N'th game controller on the system.
slouken@6690
   165
 *  This index is the value which will identify this controller in future controller
slouken@6690
   166
 *  events.
jorgen@6873
   167
 *
slouken@6690
   168
 *  \return A controller identifier, or NULL if an error occurred.
slouken@6690
   169
 */
slouken@6690
   170
extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerOpen(int joystick_index);
slouken@6690
   171
slouken@6690
   172
/**
slouken@6690
   173
 *  Return the name for this currently opened controller
slouken@6690
   174
 */
jorgen@6873
   175
extern DECLSPEC const char *SDLCALL SDL_GameControllerName(SDL_GameController *gamecontroller);
jorgen@6873
   176
slouken@6690
   177
/**
jorgen@6873
   178
 *  Returns SDL_TRUE if the controller has been opened and currently connected,
jorgen@6873
   179
 *  or SDL_FALSE if it has not.
slouken@6690
   180
 */
jorgen@6873
   181
extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerGetAttached(SDL_GameController *gamecontroller);
slouken@6690
   182
slouken@6690
   183
/**
slouken@6690
   184
 *  Get the underlying joystick object used by a controller
slouken@6690
   185
 */
jorgen@6873
   186
extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller);
slouken@6690
   187
slouken@6690
   188
/**
slouken@6690
   189
 *  Enable/disable controller event polling.
jorgen@6873
   190
 *
slouken@6690
   191
 *  If controller events are disabled, you must call SDL_GameControllerUpdate()
slouken@6690
   192
 *  yourself and check the state of the controller when you want controller
slouken@6690
   193
 *  information.
jorgen@6873
   194
 *
slouken@6690
   195
 *  The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
slouken@6690
   196
 */
slouken@6690
   197
extern DECLSPEC int SDLCALL SDL_GameControllerEventState(int state);
slouken@6690
   198
slouken@6690
   199
/**
icculus@6919
   200
 *  Update the current state of the open game controllers.
slouken@7191
   201
 *
icculus@6919
   202
 *  This is called automatically by the event loop if any game controller
icculus@6919
   203
 *  events are enabled.
icculus@6919
   204
 */
icculus@6919
   205
extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void);
icculus@6919
   206
icculus@6919
   207
icculus@6919
   208
/**
philipp@7174
   209
 *  The list of axes available from a controller
slouken@6690
   210
 */
jorgen@6873
   211
typedef enum
slouken@6690
   212
{
slouken@7191
   213
    SDL_CONTROLLER_AXIS_INVALID = -1,
slouken@7191
   214
    SDL_CONTROLLER_AXIS_LEFTX,
slouken@7191
   215
    SDL_CONTROLLER_AXIS_LEFTY,
slouken@7191
   216
    SDL_CONTROLLER_AXIS_RIGHTX,
slouken@7191
   217
    SDL_CONTROLLER_AXIS_RIGHTY,
slouken@7191
   218
    SDL_CONTROLLER_AXIS_TRIGGERLEFT,
slouken@7191
   219
    SDL_CONTROLLER_AXIS_TRIGGERRIGHT,
slouken@7191
   220
    SDL_CONTROLLER_AXIS_MAX
icculus@6917
   221
} SDL_GameControllerAxis;
slouken@6690
   222
slouken@6690
   223
/**
slouken@6690
   224
 *  turn this string into a axis mapping
slouken@6690
   225
 */
icculus@6917
   226
extern DECLSPEC SDL_GameControllerAxis SDLCALL SDL_GameControllerGetAxisFromString(const char *pchString);
slouken@6690
   227
slouken@6690
   228
/**
urkle@6964
   229
 *  turn this axis enum into a string mapping
urkle@6964
   230
 */
urkle@6964
   231
extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForAxis(SDL_GameControllerAxis axis);
urkle@6964
   232
urkle@6964
   233
/**
slouken@6932
   234
 *  Get the SDL joystick layer binding for this controller button mapping
slouken@6690
   235
 */
jorgen@6873
   236
extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
jorgen@6873
   237
SDL_GameControllerGetBindForAxis(SDL_GameController *gamecontroller,
icculus@6917
   238
                                 SDL_GameControllerAxis axis);
slouken@6690
   239
slouken@6690
   240
/**
slouken@6690
   241
 *  Get the current state of an axis control on a game controller.
jorgen@6873
   242
 *
slouken@6690
   243
 *  The state is a value ranging from -32768 to 32767.
jorgen@6873
   244
 *
slouken@6690
   245
 *  The axis indices start at index 0.
slouken@6690
   246
 */
jorgen@6873
   247
extern DECLSPEC Sint16 SDLCALL
jorgen@6873
   248
SDL_GameControllerGetAxis(SDL_GameController *gamecontroller,
icculus@6917
   249
                          SDL_GameControllerAxis axis);
slouken@6690
   250
slouken@6690
   251
/**
slouken@6690
   252
 *  The list of buttons available from a controller
slouken@6690
   253
 */
slouken@6690
   254
typedef enum
slouken@6690
   255
{
slouken@7191
   256
    SDL_CONTROLLER_BUTTON_INVALID = -1,
slouken@7191
   257
    SDL_CONTROLLER_BUTTON_A,
slouken@7191
   258
    SDL_CONTROLLER_BUTTON_B,
slouken@7191
   259
    SDL_CONTROLLER_BUTTON_X,
slouken@7191
   260
    SDL_CONTROLLER_BUTTON_Y,
slouken@7191
   261
    SDL_CONTROLLER_BUTTON_BACK,
slouken@7191
   262
    SDL_CONTROLLER_BUTTON_GUIDE,
slouken@7191
   263
    SDL_CONTROLLER_BUTTON_START,
slouken@7191
   264
    SDL_CONTROLLER_BUTTON_LEFTSTICK,
slouken@7191
   265
    SDL_CONTROLLER_BUTTON_RIGHTSTICK,
slouken@7191
   266
    SDL_CONTROLLER_BUTTON_LEFTSHOULDER,
slouken@7191
   267
    SDL_CONTROLLER_BUTTON_RIGHTSHOULDER,
slouken@7191
   268
    SDL_CONTROLLER_BUTTON_DPAD_UP,
slouken@7191
   269
    SDL_CONTROLLER_BUTTON_DPAD_DOWN,
slouken@7191
   270
    SDL_CONTROLLER_BUTTON_DPAD_LEFT,
slouken@7191
   271
    SDL_CONTROLLER_BUTTON_DPAD_RIGHT,
slouken@7191
   272
    SDL_CONTROLLER_BUTTON_MAX
icculus@6917
   273
} SDL_GameControllerButton;
slouken@6690
   274
slouken@6690
   275
/**
slouken@6690
   276
 *  turn this string into a button mapping
slouken@6690
   277
 */
icculus@6917
   278
extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFromString(const char *pchString);
slouken@6690
   279
urkle@6964
   280
/**
urkle@6964
   281
 *  turn this button enum into a string mapping
urkle@6964
   282
 */
urkle@6964
   283
extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForButton(SDL_GameControllerButton button);
slouken@6690
   284
slouken@6690
   285
/**
slouken@6932
   286
 *  Get the SDL joystick layer binding for this controller button mapping
slouken@6690
   287
 */
jorgen@6873
   288
extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
jorgen@6873
   289
SDL_GameControllerGetBindForButton(SDL_GameController *gamecontroller,
icculus@6917
   290
                                   SDL_GameControllerButton button);
slouken@6690
   291
slouken@6690
   292
slouken@6690
   293
/**
slouken@6690
   294
 *  Get the current state of a button on a game controller.
jorgen@6873
   295
 *
slouken@6690
   296
 *  The button indices start at index 0.
slouken@6690
   297
 */
jorgen@6873
   298
extern DECLSPEC Uint8 SDLCALL SDL_GameControllerGetButton(SDL_GameController *gamecontroller,
icculus@6917
   299
                                                          SDL_GameControllerButton button);
slouken@6690
   300
slouken@6690
   301
/**
slouken@6690
   302
 *  Close a controller previously opened with SDL_GameControllerOpen().
slouken@6690
   303
 */
jorgen@6873
   304
extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecontroller);
slouken@6690
   305
slouken@6690
   306
slouken@6690
   307
/* Ends C function definitions when using C++ */
slouken@6690
   308
#ifdef __cplusplus
slouken@6690
   309
}
slouken@6690
   310
#endif
slouken@6690
   311
#include "close_code.h"
slouken@6690
   312
slouken@6690
   313
#endif /* _SDL_gamecontroller_h */
slouken@6690
   314
slouken@6690
   315
/* vi: set ts=4 sw=4 expandtab: */