This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_haptic.h
941 lines (880 loc) · 28.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*
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
*/
/**
24
* \file SDL_haptic.h
25
*
26
* \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
* devices.
*
* The basic usage is as follows:
* - Initialize the Subsystem (SDL_INIT_HAPTIC).
* - Open a Haptic Device.
* - SDL_HapticOpen(...) to open from index.
* - SDL_HapticOpenFromJoystick(...) to open from an existing joystick.
* - Create an effect (SDL_HapticEffect).
* - Upload the effect with SDL_HapticNewEffect(...).
* - Run the effect with SDL_HapticRunEffect(...).
* - (optional) Free the effect with SDL_HapticDestroyEffect(...).
* - Close the haptic device with SDL_HapticClose(...).
*
* Example:
*
* \code
* int test_haptic( SDL_Joystick * joystick ) {
* SDL_Haptic *haptic;
* SDL_HapticEffect effect;
* int effect_id;
*
* // Open the device
* haptic = SDL_HapticOpenFromJoystick( joystick );
* if (haptic == NULL) return -1; // Most likely joystick isn't haptic
*
* // See if it can do sine waves
53
* if ((SDL_HapticQuery(haptic) & SDL_HAPTIC_SINE)==0) {
54
55
56
57
58
59
60
* SDL_HapticClose(haptic); // No sine effect
* return -1;
* }
*
* // Create the effect
* memset( &effect, 0, sizeof(SDL_HapticEffect) ); // 0 is safe default
* effect.type = SDL_HAPTIC_SINE;
61
* effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
62
* effect.periodic.direction.dir[0] = 18000; // Force comes from south
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
* effect.periodic.period = 1000; // 1000 ms
* effect.periodic.magnitude = 20000; // 20000/32767 strength
* effect.periodic.length = 5000; // 5 seconds long
* effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
* effect.periodic.fade_length = 1000; // Takes 1 second to fade away
*
* // Upload the effect
* effect_id = SDL_HapticNewEffect( haptic, &effect );
*
* // Test the effect
* SDL_HapticRunEffect( haptic, effect_id );
* SDL_Delay( 5000); // Wait for the effect to finish
*
* // We destroy the effect, although closing the device also does this
* SDL_HapticDestroyEffect( haptic, effect_id );
*
* // Close the device
* SDL_HapticClose(haptic);
*
* return 0; // Success
* }
* \endcode
*
* \author Edgar Simo Serra
87
88
89
90
91
92
93
*/
#ifndef _SDL_haptic_h
#define _SDL_haptic_h
#include "SDL_stdinc.h"
#include "SDL_error.h"
94
#include "SDL_joystick.h"
95
96
97
98
99
100
101
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
102
#endif /* __cplusplus */
103
104
/**
105
* \typedef SDL_Haptic
106
107
108
109
110
111
112
*
* \brief The haptic structure used to identify an SDL haptic.
*
* \sa SDL_HapticOpen
* \sa SDL_HapticOpenFromJoystick
* \sa SDL_HapticClose
*/
113
114
115
116
struct _SDL_Haptic;
typedef struct _SDL_Haptic SDL_Haptic;
117
118
119
/*
* Different haptic features a device can have.
*/
120
121
122
123
124
125
126
/**
* \def SDL_HAPTIC_CONSTANT
*
* \brief Constant haptic effect.
*
* \sa SDL_HapticCondition
*/
127
#define SDL_HAPTIC_CONSTANT (1<<0) /* Constant effect supported */
128
129
130
131
132
133
134
/**
* \def SDL_HAPTIC_SINE
*
* \brief Periodic haptic effect that simulates sine waves.
*
* \sa SDL_HapticPeriodic
*/
135
#define SDL_HAPTIC_SINE (1<<1) /* Sine wave effect supported */
136
137
138
139
/**
* \def SDL_HAPTIC_SQUARE
*
* \brief Periodic haptic effect that simulates square waves.
140
*
141
142
* \sa SDL_HapticPeriodic
*/
143
#define SDL_HAPTIC_SQUARE (1<<2) /* Square wave effect supported */
144
145
146
147
148
149
150
/**
* \def SDL_HAPTIC_TRIANGLE
*
* \brief Periodic haptic effect that simulates triangular waves.
*
* \sa SDL_HapticPeriodic
*/
151
#define SDL_HAPTIC_TRIANGLE (1<<3) /* Triangle wave effect supported */
152
153
154
155
156
157
158
/**
* \def SDL_HAPTIC_SAWTOOTHUP
*
* \brief Periodic haptic effect that simulates saw tooth up waves.
*
* \sa SDL_HapticPeriodic
*/
159
#define SDL_HAPTIC_SAWTOOTHUP (1<<4) /* Sawtoothup wave effect supported */
160
161
162
163
164
165
166
/**
* \def SDL_HAPTIC_SAWTOOTHDOWN
*
* \brief Periodic haptic effect that simulates saw tooth down waves.
*
* \sa SDL_HapticPeriodic
*/
167
#define SDL_HAPTIC_SAWTOOTHDOWN (1<<5) /* Sawtoothdown wave effect supported */
168
169
170
171
172
173
174
/**
* \def SDL_HAPTIC_RAMP
*
* \brief Ramp haptic effect.
*
* \sa SDL_HapticRamp
*/
175
#define SDL_HAPTIC_RAMP (1<<6) /* Ramp effect supported */
176
177
178
179
180
181
182
183
/**
* \def SDL_HAPTIC_SPRING
*
* \brief Condition haptic effect that simulates a spring. Effect is based on the
* axes position.
*
* \sa SDL_HapticCondition
*/
184
#define SDL_HAPTIC_SPRING (1<<7) /* Spring effect supported - uses axes position */
185
186
187
188
189
190
191
192
/**
* \def SDL_HAPTIC_DAMPER
*
* \brief Condition haptic effect that simulates dampening. Effect is based on the
* axes velocity.
*
* \sa SDL_HapticCondition
*/
193
#define SDL_HAPTIC_DAMPER (1<<8) /* Damper effect supported - uses axes velocity */
194
195
196
197
198
199
200
201
/**
* \def SDL_HAPTIC_INERTIA
*
* \brief Condition haptic effect that simulates inertia. Effect is based on the axes
* acceleration.
*
* \sa SDL_HapticCondition
*/
202
#define SDL_HAPTIC_INERTIA (1<<9) /* Inertia effect supported - uses axes acceleration */
203
204
205
206
207
208
209
210
/**
* \def SDL_HAPTIC_FRICTION
*
* \brief Condition haptic effect that simulates friction. Effect is based on the axes
* movement.
*
* \sa SDL_HapticCondition
*/
211
#define SDL_HAPTIC_FRICTION (1<<10) /* Friction effect supported - uses axes movement */
212
213
214
215
216
/**
* \def SDL_HAPTIC_CUSTOM
*
* \brief User defined custom haptic effect. TODO.
*/
217
#define SDL_HAPTIC_CUSTOM (1<<11) /* Custom effect is supported */
218
/* These last two are features the device has, not effects */
219
220
221
222
223
224
225
/**
* \def SDL_HAPTIC_GAIN
*
* \brief Device supports setting the global gain.
*
* \sa SDL_HapticSetGain
*/
226
#define SDL_HAPTIC_GAIN (1<<12) /* Device can set global gain */
227
228
229
230
231
232
233
/**
* \def SDL_HAPTIC_AUTOCENTER
*
* \brief Device supports setting autocenter.
*
* \sa SDL_HapticSetAutocenter
*/
234
#define SDL_HAPTIC_AUTOCENTER (1<<13) /* Device can set autocenter */
235
236
237
238
239
240
241
/**
* \def SDL_HAPTIC_STATUS
*
* \brief Device can be queried for effect status.
*
* \sa SDL_HapticGetEffectStatus
*/
242
#define SDL_HAPTIC_STATUS (1<<14) /* Device can be queried for effect status */
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/*
* Direction encodings
*/
/**
* \def SDL_HAPTIC_POLAR
*
* \brief Uses polar coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_POLAR 0
/**
* \def SDL_HAPTIC_CARTESIAN
*
* \brief Uses cartesian coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_CARTESIAN 1
/**
* \struct SDL_HapticDirection
*
* \brief Structure that represents a haptic direction.
*
* Directions can be specified by:
272
273
* - SDL_HAPTIC_POLAR : Specified by polar coordinates.
* - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
*
* Cardinal directions of the haptic device are relative to the positioning
* of the device. North is considered to be away from the user.
*
* The following diagram represents the cardinal directions:
* \code
* .--.
* |__| .-------.
* |=.| |.-----.|
* |--| || ||
* | | |'-----'|
* |__|~')_____('
* [ COMPUTER ]
*
*
* North (-1)
* ^
* |
* |
293
* (1) West <----[ HAPTIC ]----> East (-1)
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
* |
* |
* v
* South (1)
*
*
* [ USER ]
* \|||/
* (o o)
* ---ooO-(_)-Ooo---
* \endcode
*
* If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
* degree starting north and turning clockwise. The cardinal directions would be:
* - North: 0 (0 degrees)
309
* - East: 9000 (90 degrees)
310
* - South: 18000 (180 degrees)
311
* - West: 27000 (270 degrees)
312
313
314
315
*
* If type is SDL_HAPTIC_CARTESIAN, direction is encoded by position.
* The cardinal directions would be:
* - North: 0,-1
316
* - East: -1, 0
317
* - South: 0, 1
318
* - West: 1, 0
319
320
321
322
323
324
325
*
*
* Example:
* \code
* SDL_HapticDirection direction;
*
* direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
326
* direction.dir = 18000; // Force comes from the south meaning the user will
327
328
329
330
331
332
333
334
335
336
337
338
339
* // have to pull the stick to counteract.
* \endcode
*
* \sa SDL_HAPTIC_POLAR
* \sa SDL_HAPTIC_CARTESIAN
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticDirection {
Uint8 type; /**< The type of encoding. */
Uint16 dir[2]; /**< The encoded direction. */
} SDL_HapticDirection;
340
341
/**
* \struct SDL_HapticConstant
342
*
343
* \brief A structure containing a template for a Constant effect.
344
*
345
* The struct is exclusive to the SDL_HAPTIC_CONSTANT effect.
346
*
347
348
349
* A constant effect applies a constant force in the specified direction
* to the joystick.
*
350
351
* \sa SDL_HAPTIC_CONSTANT
* \sa SDL_HapticEffect
352
*/
353
354
typedef struct SDL_HapticConstant {
/* Header */
355
Uint16 type; /**< SDL_HAPTIC_CONSTANT */
356
SDL_HapticDirection direction; /**< Direction of the effect. */
357
358
/* Replay */
359
360
Uint16 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
361
362
/* Trigger */
363
364
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
365
366
/* Constant */
367
Sint16 level; /**< Strength of the constant effect. */
368
369
/* Envelope */
370
371
372
373
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
374
} SDL_HapticConstant;
375
376
377
378
379
380
381
382
383
384
385
386
/**
* \struct SDL_HapticPeriodic
*
* \brief A structure containing a template for a Periodic effect.
*
* The struct handles the following effects:
* - SDL_HAPTIC_SINE
* - SDL_HAPTIC_SQUARE
* - SDL_HAPTIC_TRIANGLE
* - SDL_HAPTIC_SAWTOOTHUP
* - SDL_HAPTIC_SAWTOOTHDOWN
*
387
388
389
390
* A periodic effect consists in a wave-shaped effect that repeats itself
* over time. The type determines the shape of the wave and the parameters
* determine the dimensions of the wave.
*
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
* Examples:
* \code
* SDL_HAPTIC_SINE
* __ __ __ __
* / \ / \ / \ /
* / \__/ \__/ \__/
*
* SDL_HAPTIC_SQUARE
* __ __ __ __ __
* | | | | | | | | | |
* | |__| |__| |__| |__| |
*
* SDL_HAPTIC_TRIANGLE
* /\ /\ /\ /\ /\
* / \ / \ / \ / \ /
* / \/ \/ \/ \/
*
* SDL_HAPTIC_SAWTOOTHUP
409
410
411
* /| /| /| /| /| /| /|
* / | / | / | / | / | / | / |
* / |/ |/ |/ |/ |/ |/ |
412
413
*
* SDL_HAPTIC_SAWTOOTHDOWN
414
415
416
* \ |\ |\ |\ |\ |\ |\ |
* \ | \ | \ | \ | \ | \ | \ |
* \| \| \| \| \| \| \|
417
418
* \endcode
*
419
420
421
422
* \sa SDL_HAPTIC_SINE
* \sa SDL_HAPTIC_SQUARE
* \sa SDL_HAPTIC_TRIANGLE
* \sa SDL_HAPTIC_SAWTOOTHUP
423
* \sa SDL_HAPTIC_SAWTOOTHDOWN
424
425
* \sa SDL_HapticEffect
*/
426
427
typedef struct SDL_HapticPeriodic {
/* Header */
428
429
430
Uint16 type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE,
SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
SDL_HAPTIC_SAWTOOTHDOWN */
431
SDL_HapticDirection direction; /**< Direction of the effect. */
432
433
/* Replay */
434
435
Uint16 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
436
437
/* Trigger */
438
439
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
440
441
/* Periodic */
442
443
444
445
Uint16 period; /**< Period of the wave. */
Sint16 magnitude; /**< Peak value. */
Sint16 offset; /**< Mean value of the wave. */
Uint16 phase; /**< Horizontal shift. */
446
447
/* Envelope */
448
449
450
451
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
452
} SDL_HapticPeriodic;
453
454
455
456
457
458
/**
* \struct SDL_HapticCondition
*
* \brief A structure containing a template for a Condition effect.
*
* The struct handles the following effects:
459
460
461
462
* - SDL_HAPTIC_SPRING: Effect based on axes position.
* - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
* - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
* - SDL_HAPTIC_FRICTION: Effect based on axes movement.
463
*
464
465
466
467
468
469
470
* Direction is handled by condition internals instead of a direction member.
* The condition effect specific members have two parameters. The first
* refers to the X axis, the second refers to the Y axis. The right terms
* refer to the positive side of the axis and the left terms refer to the
* negative side of the axis. Please refer to the SDL_HapticDirection
* diagram for which side is positive and which is negative.
*
471
* \sa SDL_HapticDirection
472
473
474
475
476
477
* \sa SDL_HAPTIC_SPRING
* \sa SDL_HAPTIC_DAMPER
* \sa SDL_HAPTIC_INERTIA
* \sa SDL_HAPTIC_FRICTION
* \sa SDL_HapticEffect
*/
478
479
typedef struct SDL_HapticCondition {
/* Header */
480
481
Uint16 type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
482
483
/* Replay */
484
485
Uint16 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
486
487
/* Trigger */
488
489
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
490
491
/* Condition */
492
493
494
495
Uint16 right_sat[2]; /**< Level when joystick is to the positive side. */
Uint16 left_sat[2]; /**< Level when joystick is to the negative side. */
Sint16 right_coeff[2]; /**< How fast to increase the force towards the positive side. */
Sint16 left_coeff[2]; /**< How fast to increase the force towards the negative side. */
496
497
Uint16 deadband[2]; /**< Size of the dead zone. */
Sint16 center[2]; /**< Position of the dead zone. */
498
} SDL_HapticCondition;
499
500
501
502
503
504
505
/**
* \struct SDL_HapticRamp
*
* \brief A structure containing a template for a Ramp effect.
*
* This struct is exclusively for the SDL_HAPTIC_RAMP effect.
*
506
507
508
509
510
* The ramp effect starts at start strength and ends at end strength.
* It augments in linear fashion. If you use attack and fade with a ramp
* they effects get added to the ramp effect making the effect become
* quadratic instead of linear.
*
511
512
513
* \sa SDL_HAPTIC_RAMP
* \sa SDL_HapticEffect
*/
514
515
typedef struct SDL_HapticRamp {
/* Header */
516
Uint16 type; /**< SDL_HAPTIC_RAMP */
517
SDL_HapticDirection direction; /**< Direction of the effect. */
518
519
/* Replay */
520
521
Uint16 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
522
523
/* Trigger */
524
525
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
526
527
/* Ramp */
528
529
Sint16 start; /**< Beginning strength level. */
Sint16 end; /**< Ending strength level. */
530
531
/* Envelope */
532
533
534
535
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
536
} SDL_HapticRamp;
537
/**
538
539
540
541
* \union SDL_HapticEffect
*
* \brief The generic template for any haptic effect.
*
542
* All values max at 32767 (0x7FFF). Signed values also can be negative.
543
* Time values unless specified otherwise are in milliseconds.
544
545
*
* Common parts:
546
547
548
549
550
551
552
553
554
* \code
* // Replay - All effects have this
* Uint16 length; // Duration of effect (ms).
* Uint16 delay; // Delay before starting effect.
*
* // Trigger - All effects have this
* Uint16 button; // Button that triggers effect.
* Uint16 interval; // How soon before effect can be triggered again.
*
555
* // Envelope - All effects except condition effects have this
556
557
558
559
560
* Uint16 attack_length; // Duration of the attack (ms).
* Uint16 attack_level; // Level at the start of the attack.
* Uint16 fade_length; // Duration of the fade out (ms).
* Uint16 fade_level; // Level at the end of the fade.
* \endcode
561
562
*
*
563
* Here we have an example of a constant effect evolution in time:
564
565
566
567
568
*
* \code
* Strength
* ^
* |
569
* | effect level --> _________________
570
571
572
573
574
575
576
577
578
579
580
581
582
583
* | / \
* | / \
* | / \
* | / \
* | attack_level --> | \
* | | | <--- fade_level
* |
* +--------------------------------------------------> Time
* [--] [---]
* attack_length fade_length
*
* [------------------][-----------------------]
* delay length
* \endcode
584
*
585
586
587
* Note either the attack_level or the fade_level may be above the actual
* effect level.
*
588
589
590
* \sa SDL_HapticConstant
* \sa SDL_HapticPeriodic
* \sa SDL_HapticCondition
591
* \sa SDL_HapticRamp
592
*/
593
594
typedef union SDL_HapticEffect {
/* Common for all force feedback effects */
595
596
597
Uint16 type; /**< Effect type. */
SDL_HapticConstant constant; /**< Constant effect. */
SDL_HapticPeriodic periodic; /**< Periodic effect. */
598
SDL_HapticCondition condition; /**< Condition effect. */
599
SDL_HapticRamp ramp; /**< Ramp effect. */
600
601
} SDL_HapticEffect;
602
603
/* Function prototypes */
604
/**
605
606
607
608
609
* \fn int SDL_NumHaptics(void)
*
* \brief Count the number of joysticks attached to the system.
*
* \return Number of haptic devices detected on the system.
610
611
612
*/
extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
613
/**
614
615
616
* \fn const char * SDL_HapticName(int device_index)
*
* \brief Get the implementation dependent name of a Haptic device.
617
618
* This can be called before any joysticks are opened.
* If no name can be found, this function returns NULL.
619
620
621
622
623
*
* \param device_index Index of the device to get it's name.
* \return Name of the device or NULL on error.
*
* \sa SDL_NumHaptics
624
625
626
*/
extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
627
/**
628
* \fn SDL_Haptic * SDL_HapticOpen(int device_index)
629
630
*
* \brief Opens a Haptic device for usage - the index passed as an
631
632
* argument refers to the N'th Haptic device on this system.
*
633
634
635
* When opening a haptic device, it's gain will be set to maximum and
* autocenter will be disabled. To modify these values use
* SDL_HapticSetGain and SDL_HapticSetAutocenter
636
637
638
639
*
* \param device_index Index of the device to open.
* \return Device identifier or NULL on error.
*
640
* \sa SDL_HapticIndex
641
* \sa SDL_HapticOpenFromMouse
642
643
* \sa SDL_HapticOpenFromJoystick
* \sa SDL_HapticClose
644
645
* \sa SDL_HapticSetGain
* \sa SDL_HapticSetAutocenter
646
647
648
*/
extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
649
650
651
652
653
654
655
656
657
658
659
660
/**
* \fn int SDL_HapticOpened(int device_index)
*
* \brief Checks if the haptic device at index has been opened.
*
* \param device_index Index to check to see if it has been opened.
* \return 1 if it has been opened or 0 if it hasn't.
*
* \sa SDL_HapticOpen
* \sa SDL_HapticIndex
*/
extern DECLSPEC int SDL_HapticOpened(int device_index);
661
662
663
664
665
666
667
668
669
670
/**
* \fn int SDL_HapticIndex(SDL_Haptic * haptic)
*
* \brief Gets the index of a haptic device.
*
* \param haptic Haptic device to get the index of.
* \return The index of the haptic device or -1 on error.
*
* \sa SDL_HapticOpen
671
* \sa SDL_HapticOpened
672
673
674
*/
extern DECLSPEC int SDL_HapticIndex(SDL_Haptic * haptic);
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
/**
* \fn int SDL_MouseIsHaptic(void)
*
* \brief Gets whether or not the current mouse has haptic capabilities.
*
* \return SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
*
* \sa SDL_HapticOpenFromMouse
*/
extern DECLSPEC SDL_MouseIsHaptic(void);
/**
* \fn SDL_Haptic * SDL_HapticOpenFromMouse(void)
*
* \brief Tries to open a haptic device from the current mouse.
*
* \return The haptic device identifier or NULL on error.
*
* \sa SDL_MouseIsHaptic
* \sa SDL_HapticOpen
*/
extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromMouse(void);
698
699
/**
* \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
700
701
702
703
704
705
*
* \brief Checks to see if a joystick has haptic features.
*
* \param joystick Joystick to test for haptic capabilities.
* \return SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't
* or -1 if an error ocurred.
706
*
707
* \sa SDL_HapticOpenFromJoystick
708
709
710
*/
extern DECLSPEC int SDL_JoystickIsHaptic(SDL_Joystick * joystick);
711
/**
712
* \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
713
*
714
715
716
717
718
719
720
721
* \brief Opens a Haptic device for usage from a Joystick device. Still has
* to be closed seperately to the joystick.
*
* \param joystick Joystick to create a haptic device from.
* \return A valid haptic device identifier on success or NULL on error.
*
* \sa SDL_HapticOpen
* \sa SDL_HapticClose
722
723
724
*/
extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);
725
/**
726
727
728
729
730
* \fn void SDL_HapticClose(SDL_Haptic * haptic)
*
* \brief Closes a Haptic device previously opened with SDL_HapticOpen.
*
* \param haptic Haptic device to close.
731
732
733
*/
extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
734
/**
735
736
737
738
739
740
741
742
* \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
*
* \brief Returns the number of effects a haptic device can store.
*
* \param haptic The haptic device to query effect max.
* \return The number of effects the haptic device can store or
* -1 on error.
*
743
* \sa SDL_HapticNumEffectsPlaying
744
* \sa SDL_HapticQuery
745
746
747
*/
extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
748
749
750
751
752
753
754
755
756
757
758
759
760
761
/**
* \fn int SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic)
*
* \brief Returns the number of effects a haptic device can play at the same time.
*
* \param haptic The haptic device to query maximum playing effect.s
* \return The number of effects the haptic device can play at the same time
* or -1 on error.
*
* \sa SDL_HapticNumEffects
* \sa SDL_HapticQuery
*/
extern DECLSPEC int SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
762
/**
763
* \fn unsigned int SDL_HapticQuery(SDL_Haptic * haptic)
764
765
766
767
768
769
770
771
772
773
774
775
776
*
* \brief Gets the haptic devices supported features in bitwise matter.
*
* Example:
* \code
* if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
* printf("We have constant haptic effect!");
* }
* \endcode
*
*
* \param haptic The haptic device to query.
* \return Haptic features in bitwise manner (OR'd).
777
*
778
779
* \sa SDL_HapticNumEffects
* \sa SDL_HapticEffectSupported
780
*/
781
extern DECLSPEC unsigned int SDL_HapticQuery(SDL_Haptic * haptic);
782
783
/**
784
* \fn int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
785
*
786
787
788
789
790
791
792
793
794
* \brief Checks to see if effect is supported by haptic.
*
* \param haptic Haptic device to check on.
* \param effect Effect to check to see if it is supported.
* \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or
* -1 on error.
*
* \sa SDL_HapticQuery
* \sa SDL_HapticNewEffect
795
796
797
*/
extern DECLSPEC int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);
798
/**
799
800
801
* \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
*
* \brief Creates a new haptic effect on the device.
802
*
803
804
805
806
807
808
809
* \param haptic Haptic device to create the effect on.
* \param effect Properties of the effect to create.
* \return The id of the effect on success or -1 on error.
*
* \sa SDL_HapticUpdateEffect
* \sa SDL_HapticRunEffect
* \sa SDL_HapticDestroyEffect
810
811
812
*/
extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
813
/**
814
815
816
* \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
*
* \brief Updates an effect. Can be used dynamically, although behaviour when
817
818
819
820
* dynamically changing direction may be strange. Specifically the effect
* may reupload itself and start playing from the start. You cannot change
* the type either when running UpdateEffect.
*
821
822
823
824
825
826
827
828
* \param haptic Haptic device that has the effect.
* \param effect Effect to update.
* \param data New effect properties to use.
* \return The id of the effect on success or -1 on error.
*
* \sa SDL_HapticNewEffect
* \sa SDL_HapticRunEffect
* \sa SDL_HapticDestroyEffect
829
830
831
*/
extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
832
/**
833
* \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect)
834
*
835
836
837
838
839
840
841
842
843
* \brief Runs the haptic effect on it's assosciated haptic device.
*
* \param haptic Haptic device to run the effect on.
* \param effect Identifier of the haptic effect to run.
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticStopEffect
* \sa SDL_HapticDestroyEffect
* \sa SDL_HapticGetEffectStatus
844
845
846
*/
extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
847
/**
848
849
850
* \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
*
* \brief Stops the haptic effect on it's assosciated haptic device.
851
*
852
* \param haptic Haptic device to stop the effect on.
853
* \param effect Identifier of the effect to stop.
854
855
856
857
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticRunEffect
* \sa SDL_HapticDestroyEffect
858
859
860
*/
extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
861
/**
862
863
864
865
866
867
868
869
870
871
* \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
*
* \brief Destroys a haptic effect on the device. This will stop the effect
* if it's running. Effects are automatically destroyed when the device is
* closed.
*
* \param haptic Device to destroy the effect on.
* \param effect Identifier of the effect to destroy.
*
* \sa SDL_HapticNewEffect
872
873
874
*/
extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
875
/**
876
877
878
* \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
*
* \brief Gets the status of the current effect on the haptic device.
879
*
880
881
882
883
884
885
886
887
888
* Device must support the SDL_HAPTIC_STATUS feature.
*
* \param haptic Haptic device to query the effect status on.
* \param effect Identifier of the effect to query it's status.
* \return 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing
* or -1 on error.
*
* \sa SDL_HapticRunEffect
* \sa SDL_HapticStopEffect
889
890
891
*/
extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
892
/**
893
894
895
* \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
*
* \brief Sets the global gain of the device. Gain should be between 0 and 100.
896
*
897
898
* Device must support the SDL_HAPTIC_GAIN feature.
*
899
900
901
902
903
* The user may specify the maxmimum gain by setting the environment variable
* SDL_HAPTIC_GAIN_MAX which should be between 0 and 100. All calls to
* SDL_HapticSetGain will scale linearly using SDL_HAPTIC_GAIN_MAX as the
* maximum.
*
904
905
906
907
908
* \param haptic Haptic device to set the gain on.
* \param gain Value to set the gain to, should be between 0 and 100.
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticQuery
909
910
911
*/
extern DECLSPEC int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
912
/**
913
914
915
* \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
*
* \brief Sets the global autocenter of the device. Autocenter should be between
916
917
* 0 and 100. Setting it to 0 will disable autocentering.
*
918
919
920
921
922
923
924
* Device must support the SDL_HAPTIC_AUTOCENTER feature.
*
* \param haptic Haptic device to set autocentering on.
* \param autocenter Value to set autocenter to, 0 disables autocentering.
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticQuery
925
926
927
*/
extern DECLSPEC int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
928
929
930
931
932
933
934
935
936
937
938
939
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif
#include "close_code.h"
#endif /* _SDL_haptic_h */
/* vi: set ts=4 sw=4 expandtab: */