include/SDL_joystick.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 18 May 2013 14:17:52 -0700
changeset 7191 75360622e65f
parent 6974 11a03a79dfe8
child 7341 675c85d46f30
permissions -rw-r--r--
File style cleanup for the SDL 2.0 release
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
slouken@0
    21
slouken@1895
    22
/**
slouken@3407
    23
 *  \file SDL_joystick.h
slouken@7191
    24
 *
slouken@3407
    25
 *  Include file for SDL joystick event handling
slouken@6690
    26
 *
slouken@6690
    27
 * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks, with the exact joystick
slouken@6690
    28
 *   behind a device_index changing as joysticks are plugged and unplugged.
slouken@6690
    29
 *
slouken@6690
    30
 * The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
slouken@6690
    31
 *   then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
slouken@6690
    32
 *
slouken@7191
    33
 * The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
slouken@6690
    34
 *   the device (a X360 wired controller for example). This identifier is platform dependent.
slouken@6690
    35
 *
slouken@6690
    36
 *
slouken@1895
    37
 */
slouken@0
    38
slouken@0
    39
#ifndef _SDL_joystick_h
slouken@0
    40
#define _SDL_joystick_h
slouken@0
    41
slouken@1356
    42
#include "SDL_stdinc.h"
slouken@1358
    43
#include "SDL_error.h"
slouken@0
    44
slouken@0
    45
#include "begin_code.h"
slouken@0
    46
/* Set up for C function definitions, even when using C++ */
slouken@0
    47
#ifdef __cplusplus
slouken@0
    48
extern "C" {
slouken@0
    49
#endif
slouken@0
    50
slouken@3407
    51
/**
slouken@3407
    52
 *  \file SDL_joystick.h
slouken@3407
    53
 *
slouken@3407
    54
 *  In order to use these functions, SDL_Init() must have been called
slouken@3407
    55
 *  with the ::SDL_INIT_JOYSTICK flag.  This causes SDL to scan the system
slouken@3407
    56
 *  for joysticks, and load appropriate drivers.
slouken@3407
    57
 */
slouken@0
    58
slouken@0
    59
/* The joystick structure used to identify an SDL joystick */
slouken@0
    60
struct _SDL_Joystick;
slouken@0
    61
typedef struct _SDL_Joystick SDL_Joystick;
slouken@0
    62
slouken@6707
    63
/* A structure that encodes the stable unique id for a joystick device */
slouken@6707
    64
typedef struct {
slouken@7191
    65
    Uint8 data[16];
slouken@6738
    66
} SDL_JoystickGUID;
slouken@6707
    67
slouken@6974
    68
typedef Sint32 SDL_JoystickID;
slouken@6707
    69
slouken@6707
    70
slouken@0
    71
/* Function prototypes */
slouken@3407
    72
/**
slouken@6690
    73
 *  Count the number of joysticks attached to the system right now
slouken@0
    74
 */
slouken@337
    75
extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
slouken@0
    76
slouken@3407
    77
/**
slouken@3407
    78
 *  Get the implementation dependent name of a joystick.
slouken@3407
    79
 *  This can be called before any joysticks are opened.
slouken@3407
    80
 *  If no name can be found, this function returns NULL.
slouken@0
    81
 */
slouken@6690
    82
extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
slouken@0
    83
slouken@3407
    84
/**
slouken@7191
    85
 *  Open a joystick for use.
slouken@7191
    86
 *  The index passed as an argument refers tothe N'th joystick on the system.
slouken@3407
    87
 *  This index is the value which will identify this joystick in future joystick
slouken@3407
    88
 *  events.
slouken@7191
    89
 *
slouken@3407
    90
 *  \return A joystick identifier, or NULL if an error occurred.
slouken@0
    91
 */
slouken@1895
    92
extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
slouken@0
    93
slouken@3407
    94
/**
slouken@6690
    95
 *  Return the name for this currently opened joystick.
slouken@6690
    96
 *  If no name can be found, this function returns NULL.
slouken@0
    97
 */
slouken@6690
    98
extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
slouken@7191
    99
slouken@6690
   100
/**
slouken@6690
   101
 *  Return the GUID for the joystick at this index
slouken@6690
   102
 */
slouken@6738
   103
extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
slouken@6690
   104
slouken@6690
   105
/**
slouken@6690
   106
 *  Return the GUID for this opened joystick
slouken@6690
   107
 */
slouken@6738
   108
extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
slouken@6690
   109
slouken@6690
   110
/**
icculus@6746
   111
 *  Return a string representation for this guid. pszGUID must point to at least 33 bytes
icculus@6746
   112
 *  (32 for the string plus a NULL terminator).
slouken@6690
   113
 */
slouken@6738
   114
extern DECLSPEC void SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
slouken@6690
   115
slouken@6690
   116
/**
slouken@6690
   117
 *  convert a string into a joystick formatted guid
slouken@6690
   118
 */
slouken@6738
   119
extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
slouken@6690
   120
slouken@6707
   121
/**
slouken@6707
   122
 *  Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
slouken@6707
   123
 */
slouken@6707
   124
extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
slouken@6690
   125
slouken@6690
   126
/**
slouken@6974
   127
 *  Get the instance ID of an opened joystick or -1 if the joystick is invalid.
slouken@0
   128
 */
slouken@6690
   129
extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
slouken@0
   130
slouken@3407
   131
/**
slouken@3407
   132
 *  Get the number of general axis controls on a joystick.
slouken@0
   133
 */
slouken@1895
   134
extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
slouken@0
   135
slouken@3407
   136
/**
slouken@3407
   137
 *  Get the number of trackballs on a joystick.
slouken@7191
   138
 *
slouken@3407
   139
 *  Joystick trackballs have only relative motion events associated
slouken@3407
   140
 *  with them and their state cannot be polled.
slouken@0
   141
 */
slouken@1895
   142
extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
slouken@0
   143
slouken@3407
   144
/**
slouken@3407
   145
 *  Get the number of POV hats on a joystick.
slouken@0
   146
 */
slouken@1895
   147
extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
slouken@0
   148
slouken@3407
   149
/**
slouken@3407
   150
 *  Get the number of buttons on a joystick.
slouken@0
   151
 */
slouken@1895
   152
extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
slouken@0
   153
slouken@3407
   154
/**
slouken@3407
   155
 *  Update the current state of the open joysticks.
slouken@7191
   156
 *
slouken@3407
   157
 *  This is called automatically by the event loop if any joystick
slouken@3407
   158
 *  events are enabled.
slouken@0
   159
 */
slouken@337
   160
extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
slouken@0
   161
slouken@3407
   162
/**
slouken@3407
   163
 *  Enable/disable joystick event polling.
slouken@7191
   164
 *
slouken@3407
   165
 *  If joystick events are disabled, you must call SDL_JoystickUpdate()
slouken@3407
   166
 *  yourself and check the state of the joystick when you want joystick
slouken@3407
   167
 *  information.
slouken@7191
   168
 *
slouken@3407
   169
 *  The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
slouken@0
   170
 */
slouken@337
   171
extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
slouken@0
   172
slouken@3407
   173
/**
slouken@3407
   174
 *  Get the current state of an axis control on a joystick.
slouken@7191
   175
 *
slouken@3407
   176
 *  The state is a value ranging from -32768 to 32767.
slouken@7191
   177
 *
slouken@3407
   178
 *  The axis indices start at index 0.
slouken@0
   179
 */
slouken@1895
   180
extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
slouken@1895
   181
                                                   int axis);
slouken@0
   182
slouken@3407
   183
/**
slouken@3407
   184
 *  \name Hat positions
slouken@0
   185
 */
slouken@3407
   186
/*@{*/
slouken@7191
   187
#define SDL_HAT_CENTERED    0x00
slouken@7191
   188
#define SDL_HAT_UP      0x01
slouken@7191
   189
#define SDL_HAT_RIGHT       0x02
slouken@7191
   190
#define SDL_HAT_DOWN        0x04
slouken@7191
   191
#define SDL_HAT_LEFT        0x08
slouken@7191
   192
#define SDL_HAT_RIGHTUP     (SDL_HAT_RIGHT|SDL_HAT_UP)
slouken@7191
   193
#define SDL_HAT_RIGHTDOWN   (SDL_HAT_RIGHT|SDL_HAT_DOWN)
slouken@7191
   194
#define SDL_HAT_LEFTUP      (SDL_HAT_LEFT|SDL_HAT_UP)
slouken@7191
   195
#define SDL_HAT_LEFTDOWN    (SDL_HAT_LEFT|SDL_HAT_DOWN)
slouken@3407
   196
/*@}*/
slouken@3407
   197
slouken@3407
   198
/**
slouken@3407
   199
 *  Get the current state of a POV hat on a joystick.
slouken@3407
   200
 *
slouken@3407
   201
 *  The hat indices start at index 0.
slouken@7191
   202
 *
slouken@3407
   203
 *  \return The return value is one of the following positions:
slouken@3407
   204
 *           - ::SDL_HAT_CENTERED
slouken@3407
   205
 *           - ::SDL_HAT_UP
slouken@3407
   206
 *           - ::SDL_HAT_RIGHT
slouken@3407
   207
 *           - ::SDL_HAT_DOWN
slouken@3407
   208
 *           - ::SDL_HAT_LEFT
slouken@3407
   209
 *           - ::SDL_HAT_RIGHTUP
slouken@3407
   210
 *           - ::SDL_HAT_RIGHTDOWN
slouken@3407
   211
 *           - ::SDL_HAT_LEFTUP
slouken@3407
   212
 *           - ::SDL_HAT_LEFTDOWN
slouken@0
   213
 */
slouken@1895
   214
extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
slouken@1895
   215
                                                 int hat);
slouken@0
   216
slouken@3407
   217
/**
slouken@3407
   218
 *  Get the ball axis change since the last poll.
slouken@7191
   219
 *
slouken@3407
   220
 *  \return 0, or -1 if you passed it invalid parameters.
slouken@7191
   221
 *
slouken@3407
   222
 *  The ball indices start at index 0.
slouken@0
   223
 */
slouken@1895
   224
extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
slouken@1895
   225
                                                int ball, int *dx, int *dy);
slouken@0
   226
slouken@3407
   227
/**
slouken@3407
   228
 *  Get the current state of a button on a joystick.
slouken@7191
   229
 *
slouken@3407
   230
 *  The button indices start at index 0.
slouken@0
   231
 */
slouken@1895
   232
extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
slouken@1895
   233
                                                    int button);
slouken@0
   234
slouken@3407
   235
/**
slouken@3407
   236
 *  Close a joystick previously opened with SDL_JoystickOpen().
slouken@0
   237
 */
slouken@1895
   238
extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
slouken@0
   239
slouken@0
   240
slouken@0
   241
/* Ends C function definitions when using C++ */
slouken@0
   242
#ifdef __cplusplus
slouken@0
   243
}
slouken@0
   244
#endif
slouken@0
   245
#include "close_code.h"
slouken@0
   246
slouken@0
   247
#endif /* _SDL_joystick_h */
slouken@1895
   248
slouken@1895
   249
/* vi: set ts=4 sw=4 expandtab: */