Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Latest commit

 

History

History
1127 lines (1019 loc) · 34.8 KB

SDL_haptic.h

File metadata and controls

1127 lines (1019 loc) · 34.8 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
*/
/**
Oct 19, 2009
Oct 19, 2009
24
25
26
27
28
29
30
* \file SDL_haptic.h
*
* \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
* devices.
*
* The basic usage is as follows:
* - Initialize the Subsystem (::SDL_INIT_HAPTIC).
31
* - Open a Haptic Device.
Oct 19, 2009
Oct 19, 2009
32
33
34
35
36
37
38
39
40
* - 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().
*
* \par Example:
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
* \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
* if ((SDL_HapticQuery(haptic) & SDL_HAPTIC_SINE)==0) {
* 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;
* effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
* effect.periodic.direction.dir[0] = 18000; // Force comes from south
* 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, 1 );
* 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
Jan 28, 2011
Jan 28, 2011
84
85
86
87
*
* You can also find out more information on my blog:
* http://bobbens.dyndns.org/journal/2010/sdl_haptic/
*
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
* \author Edgar Simo Serra
*/
#ifndef _SDL_haptic_h
#define _SDL_haptic_h
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_joystick.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif /* __cplusplus */
/**
Oct 19, 2009
Oct 19, 2009
107
108
109
110
111
112
113
* \typedef SDL_Haptic
*
* \brief The haptic structure used to identify an SDL haptic.
*
* \sa SDL_HapticOpen
* \sa SDL_HapticOpenFromJoystick
* \sa SDL_HapticClose
114
115
116
117
118
*/
struct _SDL_Haptic;
typedef struct _SDL_Haptic SDL_Haptic;
Oct 19, 2009
Oct 19, 2009
119
120
121
122
/**
* \name Haptic features
*
* Different haptic features a device can have.
Oct 19, 2009
Oct 19, 2009
124
125
/*@{*/
Oct 19, 2009
Oct 19, 2009
127
* \name Haptic effects
Oct 19, 2009
Oct 19, 2009
129
130
/*@{*/
Oct 19, 2009
Oct 19, 2009
132
* \brief Constant effect supported.
Oct 19, 2009
Oct 19, 2009
134
135
136
137
138
139
140
141
142
143
144
145
* Constant haptic effect.
*
* \sa SDL_HapticCondition
*/
#define SDL_HAPTIC_CONSTANT (1<<0)
/**
* \brief Sine wave effect supported.
*
* Periodic haptic effect that simulates sine waves.
*
* \sa SDL_HapticPeriodic
Oct 19, 2009
Oct 19, 2009
147
148
#define SDL_HAPTIC_SINE (1<<1)
Oct 19, 2009
Oct 19, 2009
150
151
152
* \brief Square wave effect supported.
*
* Periodic haptic effect that simulates square waves.
Oct 19, 2009
Oct 19, 2009
154
* \sa SDL_HapticPeriodic
Oct 19, 2009
Oct 19, 2009
156
157
#define SDL_HAPTIC_SQUARE (1<<2)
Oct 19, 2009
Oct 19, 2009
159
160
161
162
163
* \brief Triangle wave effect supported.
*
* Periodic haptic effect that simulates triangular waves.
*
* \sa SDL_HapticPeriodic
Oct 19, 2009
Oct 19, 2009
165
166
#define SDL_HAPTIC_TRIANGLE (1<<3)
Oct 19, 2009
Oct 19, 2009
168
169
170
171
172
* \brief Sawtoothup wave effect supported.
*
* Periodic haptic effect that simulates saw tooth up waves.
*
* \sa SDL_HapticPeriodic
Oct 19, 2009
Oct 19, 2009
174
175
#define SDL_HAPTIC_SAWTOOTHUP (1<<4)
Oct 19, 2009
Oct 19, 2009
177
178
179
180
181
* \brief Sawtoothdown wave effect supported.
*
* Periodic haptic effect that simulates saw tooth down waves.
*
* \sa SDL_HapticPeriodic
Oct 19, 2009
Oct 19, 2009
183
184
#define SDL_HAPTIC_SAWTOOTHDOWN (1<<5)
Oct 19, 2009
Oct 19, 2009
186
187
188
189
190
* \brief Ramp effect supported.
*
* Ramp haptic effect.
*
* \sa SDL_HapticRamp
Oct 19, 2009
Oct 19, 2009
192
193
#define SDL_HAPTIC_RAMP (1<<6)
Oct 19, 2009
Oct 19, 2009
195
196
197
198
* \brief Spring effect supported - uses axes position.
*
* Condition haptic effect that simulates a spring. Effect is based on the
* axes position.
Oct 19, 2009
Oct 19, 2009
200
* \sa SDL_HapticCondition
Oct 19, 2009
Oct 19, 2009
202
203
#define SDL_HAPTIC_SPRING (1<<7)
Oct 19, 2009
Oct 19, 2009
205
206
207
208
209
210
* \brief Damper effect supported - uses axes velocity.
*
* Condition haptic effect that simulates dampening. Effect is based on the
* axes velocity.
*
* \sa SDL_HapticCondition
Oct 19, 2009
Oct 19, 2009
212
213
#define SDL_HAPTIC_DAMPER (1<<8)
Oct 19, 2009
Oct 19, 2009
215
216
217
218
* \brief Inertia effect supported - uses axes acceleration.
*
* Condition haptic effect that simulates inertia. Effect is based on the axes
* acceleration.
Oct 19, 2009
Oct 19, 2009
220
* \sa SDL_HapticCondition
Oct 19, 2009
Oct 19, 2009
222
223
#define SDL_HAPTIC_INERTIA (1<<9)
Oct 19, 2009
Oct 19, 2009
225
226
227
228
229
230
* \brief Friction effect supported - uses axes movement.
*
* Condition haptic effect that simulates friction. Effect is based on the
* axes movement.
*
* \sa SDL_HapticCondition
Oct 19, 2009
Oct 19, 2009
232
233
#define SDL_HAPTIC_FRICTION (1<<10)
Oct 19, 2009
Oct 19, 2009
235
236
237
* \brief Custom effect is supported.
*
* User defined custom haptic effect.
Oct 19, 2009
Oct 19, 2009
239
240
241
242
243
244
#define SDL_HAPTIC_CUSTOM (1<<11)
/*@}*//*Haptic effects*/
/* These last few are features the device has, not effects */
Oct 19, 2009
Oct 19, 2009
246
247
248
249
250
* \brief Device can set global gain.
*
* Device supports setting the global gain.
*
* \sa SDL_HapticSetGain
Oct 19, 2009
Oct 19, 2009
252
253
#define SDL_HAPTIC_GAIN (1<<12)
Oct 19, 2009
Oct 19, 2009
255
256
257
258
259
* \brief Device can set autocenter.
*
* Device supports setting autocenter.
*
* \sa SDL_HapticSetAutocenter
Oct 19, 2009
Oct 19, 2009
261
262
#define SDL_HAPTIC_AUTOCENTER (1<<13)
Oct 19, 2009
Oct 19, 2009
264
265
266
267
268
* \brief Device can be queried for effect status.
*
* Device can be queried for effect status.
*
* \sa SDL_HapticGetEffectStatus
Oct 19, 2009
Oct 19, 2009
270
271
#define SDL_HAPTIC_STATUS (1<<14)
Oct 19, 2009
Oct 19, 2009
273
274
275
276
* \brief Device can be paused.
*
* \sa SDL_HapticPause
* \sa SDL_HapticUnpause
Oct 19, 2009
Oct 19, 2009
278
#define SDL_HAPTIC_PAUSE (1<<15)
Oct 19, 2009
Oct 19, 2009
281
282
/**
* \name Direction encodings
Oct 19, 2009
Oct 19, 2009
284
285
/*@{*/
Oct 19, 2009
Oct 19, 2009
287
288
289
* \brief Uses polar coordinates for the direction.
*
* \sa SDL_HapticDirection
290
291
*/
#define SDL_HAPTIC_POLAR 0
Oct 19, 2009
Oct 19, 2009
292
Oct 19, 2009
Oct 19, 2009
294
295
296
* \brief Uses cartesian coordinates for the direction.
*
* \sa SDL_HapticDirection
297
298
*/
#define SDL_HAPTIC_CARTESIAN 1
Oct 19, 2009
Oct 19, 2009
299
Oct 19, 2009
Oct 19, 2009
301
302
303
* \brief Uses spherical coordinates for the direction.
*
* \sa SDL_HapticDirection
304
305
306
*/
#define SDL_HAPTIC_SPHERICAL 2
Oct 19, 2009
Oct 19, 2009
307
308
309
/*@}*//*Direction encodings*/
/*@}*//*Haptic features*/
310
311
312
313
/*
* Misc defines.
*/
Oct 19, 2009
Oct 19, 2009
314
315
316
317
318
319
320
321
322
323
/**
* \brief Used to play a device an infinite number of times.
*
* \sa SDL_HapticRunEffect
*/
#define SDL_HAPTIC_INFINITY 4294967295U
/**
Oct 19, 2009
Oct 19, 2009
324
325
326
327
328
329
330
331
* \brief Structure that represents a haptic direction.
*
* Directions can be specified by:
* - ::SDL_HAPTIC_POLAR : Specified by polar coordinates.
* - ::SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
* - ::SDL_HAPTIC_SPHERICAL : Specified by spherical coordinates.
*
* Cardinal directions of the haptic device are relative to the positioning
332
333
* of the device. North is considered to be away from the user.
*
Oct 19, 2009
Oct 19, 2009
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
* The following diagram represents the cardinal directions:
* \verbatim
.--.
|__| .-------.
|=.| |.-----.|
|--| || ||
| | |'-----'|
|__|~')_____('
[ COMPUTER ]
North (0,-1)
^
|
|
(1,0) West <----[ HAPTIC ]----> East (-1,0)
|
|
v
South (0,1)
[ USER ]
\|||/
(o o)
---ooO-(_)-Ooo---
\endverbatim
*
* If type is ::SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
* degree starting north and turning clockwise. ::SDL_HAPTIC_POLAR only uses
* the first \c dir parameter. The cardinal directions would be:
365
366
367
368
* - North: 0 (0 degrees)
* - East: 9000 (90 degrees)
* - South: 18000 (180 degrees)
* - West: 27000 (270 degrees)
Oct 19, 2009
Oct 19, 2009
369
370
371
372
*
* 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 \c dir parameters. The cardinal directions would be:
373
374
375
376
* - North: 0,-1, 0
* - East: -1, 0, 0
* - South: 0, 1, 0
* - West: 1, 0, 0
Oct 19, 2009
Oct 19, 2009
377
*
378
* The Z axis represents the height of the effect if supported, otherwise
Oct 19, 2009
Oct 19, 2009
379
* it's unused. In cartesian encoding (1, 2) would be the same as (2, 4), you
380
* can use any multiple you want, only the direction matters.
Oct 19, 2009
Oct 19, 2009
381
382
383
384
385
386
*
* If type is ::SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations.
* The first two \c dir parameters are used. The \c dir parameters are as
* follows (all values are in hundredths of degrees):
* - Degrees from (1, 0) rotated towards (0, 1).
* - Degrees towards (0, 0, 1) (device needs at least 3 axes).
387
388
*
*
Oct 19, 2009
Oct 19, 2009
389
* Example of force coming from the south with all encodings (force coming
390
* from the south means the user will have to pull the stick to counteract):
Oct 19, 2009
Oct 19, 2009
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
* \code
* SDL_HapticDirection direction;
*
* // 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
* direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
* 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.
* \endcode
*
* \sa SDL_HAPTIC_POLAR
* \sa SDL_HAPTIC_CARTESIAN
* \sa SDL_HAPTIC_SPHERICAL
* \sa SDL_HapticEffect
* \sa SDL_HapticNumAxes
414
415
416
417
*/
typedef struct SDL_HapticDirection
{
Uint8 type; /**< The type of encoding. */
Nov 27, 2009
Nov 27, 2009
418
Sint32 dir[3]; /**< The encoded direction. */
419
420
421
422
} SDL_HapticDirection;
/**
Oct 19, 2009
Oct 19, 2009
423
424
425
426
427
* \brief A structure containing a template for a Constant effect.
*
* The struct is exclusive to the ::SDL_HAPTIC_CONSTANT effect.
*
* A constant effect applies a constant force in the specified direction
428
* to the joystick.
Oct 19, 2009
Oct 19, 2009
429
430
431
*
* \sa SDL_HAPTIC_CONSTANT
* \sa SDL_HapticEffect
432
433
434
435
*/
typedef struct SDL_HapticConstant
{
/* Header */
Oct 19, 2009
Oct 19, 2009
436
Uint16 type; /**< ::SDL_HAPTIC_CONSTANT */
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
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. */
/* Constant */
Sint16 level; /**< Strength of the constant effect. */
/* 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_HapticConstant;
Oct 19, 2009
Oct 19, 2009
456
Oct 19, 2009
Oct 19, 2009
458
459
460
461
462
463
464
465
466
467
* \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
*
* A periodic effect consists in a wave-shaped effect that repeats itself
468
469
* over time. The type determines the shape of the wave and the parameters
* determine the dimensions of the wave.
Oct 19, 2009
Oct 19, 2009
470
471
*
* Phase is given by hundredth of a cyle meaning that giving the phase a value
472
* of 9000 will displace it 25% of it's period. Here are sample values:
Oct 19, 2009
Oct 19, 2009
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
* - 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.
*
* Examples:
* \verbatim
SDL_HAPTIC_SINE
__ __ __ __
/ \ / \ / \ /
/ \__/ \__/ \__/
SDL_HAPTIC_SQUARE
__ __ __ __ __
| | | | | | | | | |
| |__| |__| |__| |__| |
SDL_HAPTIC_TRIANGLE
/\ /\ /\ /\ /\
/ \ / \ / \ / \ /
/ \/ \/ \/ \/
SDL_HAPTIC_SAWTOOTHUP
/| /| /| /| /| /| /|
/ | / | / | / | / | / | / |
/ |/ |/ |/ |/ |/ |/ |
SDL_HAPTIC_SAWTOOTHDOWN
\ |\ |\ |\ |\ |\ |\ |
\ | \ | \ | \ | \ | \ | \ |
\| \| \| \| \| \| \|
\endverbatim
*
* \sa SDL_HAPTIC_SINE
* \sa SDL_HAPTIC_SQUARE
* \sa SDL_HAPTIC_TRIANGLE
* \sa SDL_HAPTIC_SAWTOOTHUP
* \sa SDL_HAPTIC_SAWTOOTHDOWN
* \sa SDL_HapticEffect
513
514
515
516
*/
typedef struct SDL_HapticPeriodic
{
/* Header */
Oct 19, 2009
Oct 19, 2009
517
518
519
Uint16 type; /**< ::SDL_HAPTIC_SINE, ::SDL_HAPTIC_SQUARE,
::SDL_HAPTIC_TRIANGLE, ::SDL_HAPTIC_SAWTOOTHUP or
::SDL_HAPTIC_SAWTOOTHDOWN */
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
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. */
/* Periodic */
Uint16 period; /**< Period of the wave. */
Sint16 magnitude; /**< Peak value. */
Sint16 offset; /**< Mean value of the wave. */
Uint16 phase; /**< Horizontal shift given by hundredth of a cycle. */
/* 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_HapticPeriodic;
Oct 19, 2009
Oct 19, 2009
542
Oct 19, 2009
Oct 19, 2009
544
545
546
547
548
549
550
551
552
* \brief A structure containing a template for a Condition effect.
*
* The struct handles the following effects:
* - ::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.
*
* Direction is handled by condition internals instead of a direction member.
553
554
555
556
* 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
Oct 19, 2009
Oct 19, 2009
557
* refer to the ::SDL_HapticDirection diagram for which side is positive and
558
* which is negative.
Oct 19, 2009
Oct 19, 2009
559
560
561
562
563
564
565
*
* \sa SDL_HapticDirection
* \sa SDL_HAPTIC_SPRING
* \sa SDL_HAPTIC_DAMPER
* \sa SDL_HAPTIC_INERTIA
* \sa SDL_HAPTIC_FRICTION
* \sa SDL_HapticEffect
566
567
568
569
*/
typedef struct SDL_HapticCondition
{
/* Header */
Oct 19, 2009
Oct 19, 2009
570
571
Uint16 type; /**< ::SDL_HAPTIC_SPRING, ::SDL_HAPTIC_DAMPER,
::SDL_HAPTIC_INERTIA or ::SDL_HAPTIC_FRICTION */
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
SDL_HapticDirection direction; /**< Direction of the effect - Not used ATM. */
/* 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. */
/* Condition */
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. */
} SDL_HapticCondition;
Oct 19, 2009
Oct 19, 2009
590
Oct 19, 2009
Oct 19, 2009
592
593
594
595
596
* \brief A structure containing a template for a Ramp effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_RAMP effect.
*
* The ramp effect starts at start strength and ends at end strength.
597
598
599
* 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.
Oct 19, 2009
Oct 19, 2009
600
601
602
*
* \sa SDL_HAPTIC_RAMP
* \sa SDL_HapticEffect
603
604
605
606
*/
typedef struct SDL_HapticRamp
{
/* Header */
Oct 19, 2009
Oct 19, 2009
607
Uint16 type; /**< ::SDL_HAPTIC_RAMP */
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
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. */
/* Ramp */
Sint16 start; /**< Beginning strength level. */
Sint16 end; /**< Ending strength level. */
/* 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_HapticRamp;
Oct 19, 2009
Oct 19, 2009
628
Oct 19, 2009
Oct 19, 2009
630
631
632
* \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
633
634
* application can define it's exact shape. You will have to allocate the
* data yourself. Data should consist of channels * samples Uint16 samples.
Oct 19, 2009
Oct 19, 2009
635
636
*
* If channels is one, the effect is rotated using the defined direction.
637
* Otherwise it uses the samples in data for the different axes.
Oct 19, 2009
Oct 19, 2009
638
639
640
*
* \sa SDL_HAPTIC_CUSTOM
* \sa SDL_HapticEffect
641
642
643
644
*/
typedef struct SDL_HapticCustom
{
/* Header */
Oct 19, 2009
Oct 19, 2009
645
Uint16 type; /**< ::SDL_HAPTIC_CUSTOM */
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
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;
Oct 19, 2009
Oct 19, 2009
668
Oct 19, 2009
Oct 19, 2009
670
671
672
* \brief The generic template for any haptic effect.
*
* All values max at 32767 (0x7FFF). Signed values also can be negative.
673
* Time values unless specified otherwise are in milliseconds.
Oct 19, 2009
Oct 19, 2009
674
675
676
677
678
679
680
681
682
*
* You can also pass ::SDL_HAPTIC_INFINITY to length instead of a 0-32767
* value. Neither delay, interval, attack_length nor fade_length support
* ::SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends.
*
* Additionally, the ::SDL_HAPTIC_RAMP effect does not support a duration of
* ::SDL_HAPTIC_INFINITY.
*
* Button triggers may not be supported on all devices, it is advised to not
683
684
* use them if possible. Buttons start at index 1 instead of index 0 like
* they joystick.
Oct 19, 2009
Oct 19, 2009
685
686
*
* If both attack_length and fade_level are 0, the envelope is not used,
687
* otherwise both values are used.
Oct 19, 2009
Oct 19, 2009
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
*
* Common parts:
* \code
* // Replay - All effects have this
* Uint32 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.
*
* // Envelope - All effects except condition effects have this
* 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
*
*
* Here we have an example of a constant effect evolution in time:
* \verbatim
Strength
^
|
| effect level --> _________________
| / \
| / \
| / \
| / \
| attack_level --> | \
| | | <--- fade_level
|
+--------------------------------------------------> Time
[--] [---]
attack_length fade_length
[------------------][-----------------------]
delay length
\endverbatim
*
* Note either the attack_level or the fade_level may be above the actual
729
730
* effect level.
*
Oct 19, 2009
Oct 19, 2009
731
732
733
734
735
* \sa SDL_HapticConstant
* \sa SDL_HapticPeriodic
* \sa SDL_HapticCondition
* \sa SDL_HapticRamp
* \sa SDL_HapticCustom
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
*/
typedef union SDL_HapticEffect
{
/* Common for all force feedback effects */
Uint16 type; /**< Effect type. */
SDL_HapticConstant constant; /**< Constant effect. */
SDL_HapticPeriodic periodic; /**< Periodic effect. */
SDL_HapticCondition condition; /**< Condition effect. */
SDL_HapticRamp ramp; /**< Ramp effect. */
SDL_HapticCustom custom; /**< Custom effect. */
} SDL_HapticEffect;
/* Function prototypes */
/**
Oct 19, 2009
Oct 19, 2009
751
752
753
* \brief Count the number of joysticks attached to the system.
*
* \return Number of haptic devices detected on the system.
754
755
756
757
*/
extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
/**
Oct 19, 2009
Oct 19, 2009
758
759
760
761
762
763
764
765
766
* \brief Get the implementation dependent name of a Haptic device.
*
* This can be called before any joysticks are opened.
* If no name can be found, this function returns NULL.
*
* \param device_index Index of the device to get it's name.
* \return Name of the device or NULL on error.
*
* \sa SDL_NumHaptics
767
768
769
770
*/
extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
/**
Oct 19, 2009
Oct 19, 2009
771
772
773
774
* \brief Opens a Haptic device for usage.
*
* The index passed as an argument refers to the N'th Haptic device on this
* system.
Oct 19, 2009
Oct 19, 2009
776
* When opening a haptic device, it's gain will be set to maximum and
777
* autocenter will be disabled. To modify these values use
Oct 19, 2009
Oct 19, 2009
778
779
780
781
782
783
784
785
786
787
788
789
790
* SDL_HapticSetGain() and SDL_HapticSetAutocenter().
*
* \param device_index Index of the device to open.
* \return Device identifier or NULL on error.
*
* \sa SDL_HapticIndex
* \sa SDL_HapticOpenFromMouse
* \sa SDL_HapticOpenFromJoystick
* \sa SDL_HapticClose
* \sa SDL_HapticSetGain
* \sa SDL_HapticSetAutocenter
* \sa SDL_HapticPause
* \sa SDL_HapticStopAll
791
792
793
794
*/
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
/**
Oct 19, 2009
Oct 19, 2009
795
796
797
798
799
800
801
* \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
802
803
804
805
*/
extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index);
/**
Oct 19, 2009
Oct 19, 2009
806
807
808
809
810
811
812
* \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
* \sa SDL_HapticOpened
813
814
815
816
*/
extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic);
/**
Oct 19, 2009
Oct 19, 2009
817
818
819
820
821
* \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
822
823
824
825
*/
extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void);
/**
Oct 19, 2009
Oct 19, 2009
826
827
828
829
830
831
* \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
832
833
834
835
*/
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void);
/**
Oct 19, 2009
Oct 19, 2009
836
837
838
839
840
841
842
* \brief Checks to see if a joystick has haptic features.
*
* \param joystick Joystick to test for haptic capabilities.
* \return 1 if the joystick is haptic, 0 if it isn't
* or -1 if an error ocurred.
*
* \sa SDL_HapticOpenFromJoystick
843
844
845
846
*/
extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
/**
Oct 19, 2009
Oct 19, 2009
847
848
849
850
851
852
* \brief Opens a Haptic device for usage from a Joystick device.
*
* You must still close the haptic device seperately. It will not be closed
* with the joystick.
*
* When opening from a joystick you should first close the haptic device before
853
854
855
* closing the joystick device. If not, on some implementations the haptic
* device will also get unallocated and you'll be unable to use force feedback
* on that device.
Oct 19, 2009
Oct 19, 2009
856
857
858
859
860
861
*
* \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
862
863
864
865
866
*/
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick *
joystick);
/**
Oct 19, 2009
Oct 19, 2009
867
868
869
* \brief Closes a Haptic device previously opened with SDL_HapticOpen().
*
* \param haptic Haptic device to close.
870
871
872
873
*/
extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
/**
Oct 19, 2009
Oct 19, 2009
874
875
876
* \brief Returns the number of effects a haptic device can store.
*
* On some platforms this isn't fully supported, and therefore is an
877
* aproximation. Always check to see if your created effect was actually
Oct 19, 2009
Oct 19, 2009
878
879
880
881
882
883
884
885
* created and do not rely solely on SDL_HapticNumEffects().
*
* \param haptic The haptic device to query effect max.
* \return The number of effects the haptic device can store or
* -1 on error.
*
* \sa SDL_HapticNumEffectsPlaying
* \sa SDL_HapticQuery
886
887
888
889
*/
extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
/**
Oct 19, 2009
Oct 19, 2009
890
891
892
893
894
895
896
897
898
899
900
901
* \brief Returns the number of effects a haptic device can play at the same
* time.
*
* This is not supported on all platforms, but will always return a value.
* Added here for the sake of completness.
*
* \param haptic The haptic device to query maximum playing effects.
* \return The number of effects the haptic device can play at the same time
* or -1 on error.
*
* \sa SDL_HapticNumEffects
* \sa SDL_HapticQuery
902
903
904
905
*/
extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
/**
Oct 19, 2009
Oct 19, 2009
906
907
908
909
910
911
912
913
914
915
916
917
918
919
* \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).
*
* \sa SDL_HapticNumEffects
* \sa SDL_HapticEffectSupported
920
921
922
923
924
*/
extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic);
/**
Oct 19, 2009
Oct 19, 2009
925
926
927
* \brief Gets the number of haptic axes the device has.
*
* \sa SDL_HapticDirection
928
929
930
931
*/
extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic);
/**
Oct 19, 2009
Oct 19, 2009
932
933
934
935
936
937
938
939
* \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 1 if effect is supported, 0 if it isn't or -1 on error.
*
* \sa SDL_HapticQuery
* \sa SDL_HapticNewEffect
940
941
942
943
944
945
*/
extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic,
SDL_HapticEffect *
effect);
/**
Oct 19, 2009
Oct 19, 2009
946
947
948
949
950
951
952
953
954
* \brief Creates a new haptic effect on the device.
*
* \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
955
956
957
958
959
*/
extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic,
SDL_HapticEffect * effect);
/**
Oct 19, 2009
Oct 19, 2009
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
* \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 SDL_HapticUpdateEffect().
*
* \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
975
976
977
978
979
980
*/
extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic,
int effect,
SDL_HapticEffect * data);
/**
Oct 19, 2009
Oct 19, 2009
981
982
983
* \brief Runs the haptic effect on it's assosciated haptic device.
*
* If iterations are ::SDL_HAPTIC_INFINITY, it'll run the effect over and over
984
* repeating the envelope (attack and fade) every time. If you only want the
Oct 19, 2009
Oct 19, 2009
985
* effect to last forever, set ::SDL_HAPTIC_INFINITY in the effect's length
986
* parameter.
Oct 19, 2009
Oct 19, 2009
987
988
989
990
991
992
993
994
995
996
*
* \param haptic Haptic device to run the effect on.
* \param effect Identifier of the haptic effect to run.
* \param iterations Number of iterations to run the effect. Use
* ::SDL_HAPTIC_INFINITY for infinity.
* \return 0 on success or -1 on error.
*
* \sa SDL_HapticStopEffect
* \sa SDL_HapticDestroyEffect
* \sa SDL_HapticGetEffectStatus
997
998
999
1000
*/
extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic,
int effect,
Uint32 iterations);