This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_haptic.h
1072 lines (1003 loc) · 33.4 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
* 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
73
* SDL_HapticRunEffect( haptic, effect_id, 1 );
74
75
76
77
78
79
80
81
82
83
84
85
86
* 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
/**
* \def SDL_HAPTIC_CUSTOM
*
215
* \brief User defined custom haptic effect.
216
*/
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
/*
* 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
264
/**
265
* \def SDL_HAPTIC_SPHERICAL
266
267
268
269
270
271
*
* \brief Uses spherical coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_SPHERICAL 2
272
273
274
275
276
277
278
279
280
281
282
283
/*
* Misc defines.
*/
/**
* \def SDL_HAPTIC_INFINITY
*
* \brief Used to play a device an infinite number of times.
*
* \sa SDL_HapticRunEffect
*/
284
#define SDL_HAPTIC_INFINITY 4294967295U
285
286
287
288
289
290
291
292
/**
* \struct SDL_HapticDirection
*
* \brief Structure that represents a haptic direction.
*
* Directions can be specified by:
293
294
* - SDL_HAPTIC_POLAR : Specified by polar coordinates.
* - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
295
* - SDL_HAPTIC_SPHERICAL : Specified by spherical coordinates.
296
297
298
299
300
301
*
* 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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
* .--.
* |__| .-------.
* |=.| |.-----.|
* |--| || ||
* | | |'-----'|
* |__|~')_____('
* [ COMPUTER ]
*
*
* North (0,-1)
* ^
* |
* |
* (1,0) West <----[ HAPTIC ]----> East (-1,0)
* |
* |
* v
* South (0,1)
*
*
* [ USER ]
* \|||/
* (o o)
* ---ooO-(_)-Ooo---
326
327
328
* \endcode
*
* If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
329
330
* degree starting north and turning clockwise. SDL_HAPTIC_POLAR only uses
* the first dir parameter. The cardinal directions would be:
331
* - North: 0 (0 degrees)
332
* - East: 9000 (90 degrees)
333
* - South: 18000 (180 degrees)
334
* - West: 27000 (270 degrees)
335
*
336
337
338
339
340
341
342
343
344
345
346
347
348
* If type is SDL_HAPTIC_CARTESIAN, direction is encoded by three positions
* (X axis, Y axis and Z axis (with 3 axes)). SDL_HAPTIC_CARTESIAN uses
* the first three dir parameters. The cardinal directions would be:
* - North: 0,-1, 0
* - East: -1, 0, 0
* - South: 0, 1, 0
* - West: 1, 0, 0
* The Z axis represents the height of the effect if supported, otherwise
* it's unused. In cartesian encoding (1,2) would be the same as (2,4), you
* can use any multiple you want, only the direction matters.
*
* If type is SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations.
* The first two dir parameters are used. The dir parameters are as follows
349
350
351
352
* (all values are in hundredths of degrees):
* 1) Degrees from (1, 0) rotated towards (0, 1).
* 2) Degrees towards (0, 0, 1) (device needs at least 3 axes).
*
353
*
354
355
* Example of force coming from the south with all encodings (force coming
* from the south means the user will have to pull the stick to counteract):
356
357
358
* \code
* SDL_HapticDirection direction;
*
359
360
361
362
363
364
365
* // Cartesian directions
* direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding.
* direction.dir[0] = 0; // X position
* direction.dir[1] = 1; // Y position
* // Assuming the device has 2 axes, we don't need to specify third parameter.
*
* // Polar directions
366
* direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
367
368
369
370
371
* direction.dir[0] = 18000; // Polar only uses first parameter
*
* // Spherical coordinates
* direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding
* direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
372
373
374
375
* \endcode
*
* \sa SDL_HAPTIC_POLAR
* \sa SDL_HAPTIC_CARTESIAN
376
* \sa SDL_HAPTIC_SPHERICAL
377
* \sa SDL_HapticEffect
378
* \sa SDL_HapticNumAxes
379
380
381
*/
typedef struct SDL_HapticDirection {
Uint8 type; /**< The type of encoding. */
382
Uint16 dir[3]; /**< The encoded direction. */
383
384
385
} SDL_HapticDirection;
386
387
/**
* \struct SDL_HapticConstant
388
*
389
* \brief A structure containing a template for a Constant effect.
390
*
391
* The struct is exclusive to the SDL_HAPTIC_CONSTANT effect.
392
*
393
394
395
* A constant effect applies a constant force in the specified direction
* to the joystick.
*
396
397
* \sa SDL_HAPTIC_CONSTANT
* \sa SDL_HapticEffect
398
*/
399
400
typedef struct SDL_HapticConstant {
/* Header */
401
Uint16 type; /**< SDL_HAPTIC_CONSTANT */
402
SDL_HapticDirection direction; /**< Direction of the effect. */
403
404
/* Replay */
405
Uint32 length; /**< Duration of the effect. */
406
Uint16 delay; /**< Delay before starting the effect. */
407
408
/* Trigger */
409
410
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
411
412
/* Constant */
413
Sint16 level; /**< Strength of the constant effect. */
414
415
/* Envelope */
416
417
418
419
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. */
420
} SDL_HapticConstant;
421
422
423
424
425
426
427
428
429
430
431
432
/**
* \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
*
433
434
435
436
* 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.
*
437
438
439
440
441
442
443
444
* Phase is given by hundredth of a cyle meaning that giving the phase a value
* of 9000 will displace it 25% of it's period. Here are sample values:
* - 0: No phase displacement.
* - 9000: Displaced 25% of it's period.
* - 18000: Displaced 50% of it's period.
* - 27000: Displaced 75% of it's period.
* - 36000: Displaced 100% of it's period, same as 0, but 0 is preffered.
*
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
* Examples:
* \code
* SDL_HAPTIC_SINE
* __ __ __ __
* / \ / \ / \ /
* / \__/ \__/ \__/
*
* SDL_HAPTIC_SQUARE
* __ __ __ __ __
* | | | | | | | | | |
* | |__| |__| |__| |__| |
*
* SDL_HAPTIC_TRIANGLE
* /\ /\ /\ /\ /\
* / \ / \ / \ / \ /
* / \/ \/ \/ \/
*
* SDL_HAPTIC_SAWTOOTHUP
463
464
465
* /| /| /| /| /| /| /|
* / | / | / | / | / | / | / |
* / |/ |/ |/ |/ |/ |/ |
466
467
*
* SDL_HAPTIC_SAWTOOTHDOWN
468
469
470
* \ |\ |\ |\ |\ |\ |\ |
* \ | \ | \ | \ | \ | \ | \ |
* \| \| \| \| \| \| \|
471
472
* \endcode
*
473
474
475
476
* \sa SDL_HAPTIC_SINE
* \sa SDL_HAPTIC_SQUARE
* \sa SDL_HAPTIC_TRIANGLE
* \sa SDL_HAPTIC_SAWTOOTHUP
477
* \sa SDL_HAPTIC_SAWTOOTHDOWN
478
479
* \sa SDL_HapticEffect
*/
480
481
typedef struct SDL_HapticPeriodic {
/* Header */
482
483
484
Uint16 type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE,
SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
SDL_HAPTIC_SAWTOOTHDOWN */
485
SDL_HapticDirection direction; /**< Direction of the effect. */
486
487
/* Replay */
488
Uint32 length; /**< Duration of the effect. */
489
Uint16 delay; /**< Delay before starting the effect. */
490
491
/* Trigger */
492
493
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
494
495
/* Periodic */
496
497
498
Uint16 period; /**< Period of the wave. */
Sint16 magnitude; /**< Peak value. */
Sint16 offset; /**< Mean value of the wave. */
499
Uint16 phase; /**< Horizontal shift given by hundredth of a cycle. */
500
501
/* Envelope */
502
503
504
505
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. */
506
} SDL_HapticPeriodic;
507
508
509
510
511
512
/**
* \struct SDL_HapticCondition
*
* \brief A structure containing a template for a Condition effect.
*
* The struct handles the following effects:
513
514
515
516
* - 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.
517
*
518
* Direction is handled by condition internals instead of a direction member.
519
520
521
522
523
524
* The condition effect specific members have three parameters. The first
* refers to the X axis, the second refers to the Y axis and the third
* refers to the Z 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.
525
*
526
* \sa SDL_HapticDirection
527
528
529
530
531
532
* \sa SDL_HAPTIC_SPRING
* \sa SDL_HAPTIC_DAMPER
* \sa SDL_HAPTIC_INERTIA
* \sa SDL_HAPTIC_FRICTION
* \sa SDL_HapticEffect
*/
533
534
typedef struct SDL_HapticCondition {
/* Header */
535
536
Uint16 type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
537
SDL_HapticDirection direction; /**< Direction of the effect - Not used ATM. */
538
539
/* Replay */
540
Uint32 length; /**< Duration of the effect. */
541
Uint16 delay; /**< Delay before starting the effect. */
542
543
/* Trigger */
544
545
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
546
547
/* Condition */
548
549
550
551
552
553
Uint16 right_sat[3]; /**< Level when joystick is to the positive side. */
Uint16 left_sat[3]; /**< Level when joystick is to the negative side. */
Sint16 right_coeff[3]; /**< How fast to increase the force towards the positive side. */
Sint16 left_coeff[3]; /**< How fast to increase the force towards the negative side. */
Uint16 deadband[3]; /**< Size of the dead zone. */
Sint16 center[3]; /**< Position of the dead zone. */
554
} SDL_HapticCondition;
555
556
557
558
559
560
561
/**
* \struct SDL_HapticRamp
*
* \brief A structure containing a template for a Ramp effect.
*
* This struct is exclusively for the SDL_HAPTIC_RAMP effect.
*
562
563
564
565
566
* 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.
*
567
568
569
* \sa SDL_HAPTIC_RAMP
* \sa SDL_HapticEffect
*/
570
571
typedef struct SDL_HapticRamp {
/* Header */
572
Uint16 type; /**< SDL_HAPTIC_RAMP */
573
SDL_HapticDirection direction; /**< Direction of the effect. */
574
575
/* Replay */
576
Uint32 length; /**< Duration of the effect. */
577
Uint16 delay; /**< Delay before starting the effect. */
578
579
/* Trigger */
580
581
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
582
583
/* Ramp */
584
585
Sint16 start; /**< Beginning strength level. */
Sint16 end; /**< Ending strength level. */
586
587
/* Envelope */
588
589
590
591
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. */
592
} SDL_HapticRamp;
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
/**
* \struct SDL_HapticCustom
*
* \brief A structure containing a template for the SDL_HAPTIC_CUSTOM effect.
*
* A custom force feedback effect is much like a periodic effect, where the
* application can define it's exact shape. You will have to allocate the
* data yourself. Data should consist of channels * samples Uint16 samples.
*
* If channels is one, the effect is rotated using the defined direction.
* Otherwise it uses the samples in data for the different axes.
*
* \sa SDL_HAPTIC_CUSTOM
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticCustom {
/* Header */
Uint16 type; /**< SDL_HAPTIC_CUSTOM */
SDL_HapticDirection direction; /**< Direction of the effect. */
/* Replay */
Uint32 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
/* Trigger */
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
/* Custom */
Uint8 channels; /**< Axes to use, minimum of one. */
Uint16 period; /**< Sample periods. */
Uint16 samples; /**< Amount of samples. */
Uint16 *data; /**< Should contain channels*samples items. */
/* Envelope */
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. */
} SDL_HapticCustom;
633
/**
634
635
636
637
* \union SDL_HapticEffect
*
* \brief The generic template for any haptic effect.
*
638
* All values max at 32767 (0x7FFF). Signed values also can be negative.
639
* Time values unless specified otherwise are in milliseconds.
640
*
641
642
* You can also pass SDL_HAPTIC_INFINITY to length instead of a 0-32767 value.
* Neither delay, interval, attack_length nor fade_length support
643
* SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends.
644
*
645
646
647
* Additionally, the SDL_HAPTIC_RAMP effect does not support a duration of
* SDL_HAPTIC_INFINITY.
*
648
649
650
651
* Button triggers may not be supported on all devices, it is advised to not
* use them if possible. Buttons start at index 1 instead of index 0 like
* they joystick.
*
652
653
654
* If both attack_length and fade_level are 0, the envelope is not used,
* otherwise both values are used.
*
655
* Common parts:
656
657
* \code
* // Replay - All effects have this
658
* Uint32 length; // Duration of effect (ms).
659
660
661
662
663
664
* 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.
*
665
* // Envelope - All effects except condition effects have this
666
667
668
669
670
* 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
671
672
*
*
673
* Here we have an example of a constant effect evolution in time:
674
675
676
677
678
*
* \code
* Strength
* ^
* |
679
* | effect level --> _________________
680
681
682
683
684
685
686
687
688
689
690
691
692
693
* | / \
* | / \
* | / \
* | / \
* | attack_level --> | \
* | | | <--- fade_level
* |
* +--------------------------------------------------> Time
* [--] [---]
* attack_length fade_length
*
* [------------------][-----------------------]
* delay length
* \endcode
694
*
695
696
697
* Note either the attack_level or the fade_level may be above the actual
* effect level.
*
698
699
700
* \sa SDL_HapticConstant
* \sa SDL_HapticPeriodic
* \sa SDL_HapticCondition
701
* \sa SDL_HapticRamp
702
* \sa SDL_HapticCustom
703
*/
704
705
typedef union SDL_HapticEffect {
/* Common for all force feedback effects */
706
707
708
Uint16 type; /**< Effect type. */
SDL_HapticConstant constant; /**< Constant effect. */
SDL_HapticPeriodic periodic; /**< Periodic effect. */
709
SDL_HapticCondition condition; /**< Condition effect. */
710
SDL_HapticRamp ramp; /**< Ramp effect. */
711
SDL_HapticCustom custom; /**< Custom effect. */
712
713
} SDL_HapticEffect;
714
715
/* Function prototypes */
716
/**
717
718
719
720
721
* \fn int SDL_NumHaptics(void)
*
* \brief Count the number of joysticks attached to the system.
*
* \return Number of haptic devices detected on the system.
722
723
724
*/
extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
725
/**
726
727
728
* \fn const char * SDL_HapticName(int device_index)
*
* \brief Get the implementation dependent name of a Haptic device.
729
730
* This can be called before any joysticks are opened.
* If no name can be found, this function returns NULL.
731
732
733
734
735
*
* \param device_index Index of the device to get it's name.
* \return Name of the device or NULL on error.
*
* \sa SDL_NumHaptics
736
737
738
*/
extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
739
/**
740
* \fn SDL_Haptic * SDL_HapticOpen(int device_index)
741
742
*
* \brief Opens a Haptic device for usage - the index passed as an
743
744
* argument refers to the N'th Haptic device on this system.
*
745
746
747
* 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
748
749
750
751
*
* \param device_index Index of the device to open.
* \return Device identifier or NULL on error.
*
752
* \sa SDL_HapticIndex
753
* \sa SDL_HapticOpenFromMouse
754
755
* \sa SDL_HapticOpenFromJoystick
* \sa SDL_HapticClose
756
757
* \sa SDL_HapticSetGain
* \sa SDL_HapticSetAutocenter
758
*/
759
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
760
761
762
763
764
765
766
767
768
769
770
771
/**
* \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
*/
772
extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index);
773
774
775
776
777
778
779
780
781
782
/**
* \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
783
* \sa SDL_HapticOpened
784
*/
785
extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic);
786
787
788
789
790
791
792
793
794
795
/**
* \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
*/
796
extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void);
797
798
799
800
801
802
803
804
805
806
807
/**
* \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
*/
808
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void);
809
810
811
/**
* \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
812
813
814
815
816
817
*
* \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.
818
*
819
* \sa SDL_HapticOpenFromJoystick
820
*/
821
extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
822
823
/**
824
* \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
825
*
826
827
828
829
830
831
832
833
* \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
834
*/
835
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);
836
837
/**
838
839
840
841
842
* \fn void SDL_HapticClose(SDL_Haptic * haptic)
*
* \brief Closes a Haptic device previously opened with SDL_HapticOpen.
*
* \param haptic Haptic device to close.
843
*/
844
extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
845
846
/**
847
848
849
850
851
852
853
854
* \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.
*
855
* \sa SDL_HapticNumEffectsPlaying
856
* \sa SDL_HapticQuery
857
*/
858
extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
859
860
861
862
863
864
865
866
867
868
869
870
871
/**
* \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
*/
872
extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
873
874
/**
875
* \fn unsigned int SDL_HapticQuery(SDL_Haptic * haptic)
876
877
878
879
880
881
882
883
884
885
886
887
888
*
* \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).
889
*
890
891
* \sa SDL_HapticNumEffects
* \sa SDL_HapticEffectSupported
892
*/
893
894
895
896
897
898
899
900
901
902
903
extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic);
/**
* \fn int SDL_HapticNumAxes(SDL_Haptic * haptic)
*
* \brief Gets the number of haptic axes the device has.
*
* \sa SDL_HapticDirection
*/
extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic);
904
905
/**
906
* \fn int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
907
*
908
909
910
911
912
913
914
915
916
* \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
917
*/
918
extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);
919
920
/**
921
922
923
* \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
*
* \brief Creates a new haptic effect on the device.
924
*
925
926
927
928
929
930
931
* \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
932
*/
933
extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
934
935
/**
936
937
* \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
*
938
939
940
941
942
943
* \brief Updates the properties of an effect.
*
* Can be used dynamically, although behaviour when 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.
944
*
945
946
947
948
949
950
951
952
* \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
953
*/
954
extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
955
956
/**
957
* \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations)
958
*
959
960
* \brief Runs the haptic effect on it's assosciated haptic device.
*
961
962
963
964
965
* If iterations are SDL_HAPTIC_INFINITY, it'll run the effect over and over
* repeating the envelope (attack and fade) every time. If you only want the
* effect to last forever, set SDL_HAPTIC_INFINITY in the effect's length
* parameter.
*
966
967
* \param haptic Haptic device to run the effect on.
* \param effect Identifier of the haptic effect to run.
968
969
* \param iterations Number of iterations to run the effect. Use
* SDL_HAPTIC_INFINITY for infinity.
970
971
972
973
974
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticStopEffect
* \sa SDL_HapticDestroyEffect
* \sa SDL_HapticGetEffectStatus
975
*/
976
extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations);
977
978
/**
979
980
981
* \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
*
* \brief Stops the haptic effect on it's assosciated haptic device.
982
*
983
* \param haptic Haptic device to stop the effect on.
984
* \param effect Identifier of the effect to stop.
985
986
987
988
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticRunEffect
* \sa SDL_HapticDestroyEffect
989
*/
990
extern DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
991
992
/**
993
994
995
996
997
998
999
1000
* \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.