This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_syshaptic.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/*
SDL - Simple DirectMedia Layer
Copyright (C) 2008 Edgar Simo
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
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
Lesser General Public License for more details.
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
Sam Lantinga
slouken@libsdl.org
*/
#include "SDL_config.h"
#include "SDL_haptic.h"
28
29
30
31
32
33
34
35
36
struct haptic_effect
{
SDL_HapticEffect effect; /* The current event */
struct haptic_hweffect *hweffect; /* The hardware behind the event */
};
/*
* The real SDL_Haptic event.
*/
37
38
struct _SDL_Haptic
{
39
40
Uint8 index; /* Stores index it is attached to */
const char* name; /* Stores the name of the device */
42
43
44
struct haptic_effect *effects; /* Allocated effects */
int neffects; /* Maximum amount of effects */
unsigned int supported; /* Supported effects */
46
47
struct haptic_hwdata *hwdata; /* Driver dependent */
int ref_count; /* Count for multiple opens */
50
51
52
53
54
/*
* Scans the system for haptic devices.
*
* Returns 0 on success, -1 on error.
*/
55
extern int SDL_SYS_HapticInit(void);
56
57
58
59
/*
* Gets the device dependent name of the haptic device
*/
60
extern const char * SDL_SYS_HapticName(int index);
61
62
63
64
65
66
67
/*
* Opens the haptic device for usage. The haptic device should have
* the index value set previously.
*
* Returns 0 on success, -1 on error.
*/
68
extern int SDL_SYS_HapticOpen(SDL_Haptic * haptic);
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*
* Checks to see if the joystick has haptic capabilities.
*
* Returns >0 if haptic capabilities are detected, 0 if haptic
* capabilities aren't detected and -1 on error.
*/
extern int SDL_JoystickIsHaptic(SDL_Joystick * joystick);
/*
* Opens the haptic device for usage using the same device as
* the joystick.
*
* Returns 0 on success, -1 on error.
*/
extern int SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic,
SDL_Joystick * joystick);
/*
* Checks to see if haptic device and joystick device are the same.
*
* Returns 1 if they are the same, 0 if they aren't.
*/
extern int SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic,
SDL_Joystick * joystick);
/*
* Closes a haptic device after usage.
*/
98
extern void SDL_SYS_HapticClose(SDL_Haptic * haptic);
99
100
101
102
/*
* Performs a cleanup on the haptic subsystem.
*/
103
extern void SDL_SYS_HapticQuit(void);
104
105
106
107
108
109
110
/*
* Creates a new haptic effect on the haptic device using base
* as a template for the effect.
*
* Returns 0 on success, -1 on error.
*/
111
extern int SDL_SYS_HapticNewEffect(SDL_Haptic * haptic,
112
113
114
115
116
117
118
119
120
struct haptic_effect * effect,
SDL_HapticEffect * base);
/*
* Updates the haptic effect on the haptic device using data
* as a template.
*
* Returns 0 on success, -1 on error.
*/
121
extern int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
122
123
124
125
126
127
128
129
struct haptic_effect * effect,
SDL_HapticEffect * data);
/*
* Runs the effect on the haptic device.
*
* Returns 0 on success, -1 on error.
*/
130
extern int SDL_SYS_HapticRunEffect(SDL_Haptic * haptic,
131
132
133
134
135
136
137
struct haptic_effect * effect);
/*
* Stops the effect on the haptic device.
*
* Returns 0 on success, -1 on error.
*/
138
extern int SDL_SYS_HapticStopEffect(SDL_Haptic * haptic,
139
140
141
142
143
struct haptic_effect * effect);
/*
* Cleanups up the effect on the haptic device.
*/
144
extern void SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic,
145
146
147
148
149
150
151
struct haptic_effect * effect);
/*
* Sets the global gain of the haptic device.
*
* Returns 0 on success, -1 on error.
*/
152
extern int SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain);
153
154
155
156
157
158
159
160
/*
* Sets the autocenter feature of the haptic device.
*
* Returns 0 on success, -1 on error.
*/
extern int SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic,
int autocenter);