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