This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_joystick.h
209 lines (177 loc) · 5.9 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2009 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
14
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
23
/**
24
25
26
* \file SDL_joystick.h
*
* Include file for SDL joystick event handling
27
*/
28
29
30
31
#ifndef _SDL_joystick_h
#define _SDL_joystick_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
35
36
37
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
38
/* *INDENT-OFF* */
39
extern "C" {
40
/* *INDENT-ON* */
41
42
#endif
43
44
45
46
47
48
49
/**
* \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.
*/
50
51
52
53
54
55
56
/* The joystick structure used to identify an SDL joystick */
struct _SDL_Joystick;
typedef struct _SDL_Joystick SDL_Joystick;
/* Function prototypes */
57
58
/**
* Count the number of joysticks attached to the system
59
*/
60
extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
61
62
63
64
65
/**
* 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.
66
*/
67
extern DECLSPEC const char *SDLCALL SDL_JoystickName(int device_index);
68
69
70
71
72
73
74
75
/**
* Open a joystick for use.
* The index passed as an argument refers tothe N'th joystick on the system.
* This index is the value which will identify this joystick in future joystick
* events.
*
* \return A joystick identifier, or NULL if an error occurred.
76
*/
77
extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
78
79
80
/**
* Returns 1 if the joystick has been opened, or 0 if it has not.
81
*/
82
extern DECLSPEC int SDLCALL SDL_JoystickOpened(int device_index);
83
84
85
/**
* Get the device index of an opened joystick.
86
*/
87
extern DECLSPEC int SDLCALL SDL_JoystickIndex(SDL_Joystick * joystick);
88
89
90
/**
* Get the number of general axis controls on a joystick.
91
*/
92
extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
93
94
95
96
97
98
/**
* Get the number of trackballs on a joystick.
*
* Joystick trackballs have only relative motion events associated
* with them and their state cannot be polled.
99
*/
100
extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
101
102
103
/**
* Get the number of POV hats on a joystick.
104
*/
105
extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
106
107
108
/**
* Get the number of buttons on a joystick.
109
*/
110
extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
111
112
113
114
115
116
/**
* Update the current state of the open joysticks.
*
* This is called automatically by the event loop if any joystick
* events are enabled.
117
*/
118
extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
119
120
121
122
123
124
125
126
127
/**
* 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.
128
*/
129
extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
130
131
132
133
134
135
136
/**
* 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.
137
*/
138
139
extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
int axis);
140
141
142
/**
* \name Hat positions
143
*/
144
/*@{*/
145
146
147
148
149
150
151
152
153
#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)
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*@}*/
/**
* 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
171
*/
172
173
extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
int hat);
174
175
176
177
178
179
180
/**
* 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.
181
*/
182
183
extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
int ball, int *dx, int *dy);
184
185
186
187
188
/**
* Get the current state of a button on a joystick.
*
* The button indices start at index 0.
189
*/
190
191
extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
int button);
192
193
194
/**
* Close a joystick previously opened with SDL_JoystickOpen().
195
*/
196
extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
197
198
199
200
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
201
/* *INDENT-OFF* */
202
}
203
/* *INDENT-ON* */
204
205
206
207
#endif
#include "close_code.h"
#endif /* _SDL_joystick_h */
208
209
/* vi: set ts=4 sw=4 expandtab: */