2
Simple DirectMedia Layer
3
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
5
This software is provided 'as-is', without any express or implied
6
warranty. In no event will the authors be held liable for any damages
7
arising from the use of this software.
9
Permission is granted to anyone to use this software for any purpose,
10
including commercial applications, and to alter it and redistribute it
11
freely, subject to the following restrictions:
13
1. The origin of this software must not be misrepresented; you must not
14
claim that you wrote the original software. If you use this software
15
in a product, an acknowledgment in the product documentation would be
16
appreciated but is not required.
17
2. Altered source versions must be plainly marked as such, and must not be
18
misrepresented as being the original software.
19
3. This notice may not be removed or altered from any source distribution.
25
* \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
28
* The basic usage is as follows:
29
* - Initialize the Subsystem (::SDL_INIT_HAPTIC).
30
* - Open a Haptic Device.
31
* - SDL_HapticOpen() to open from index.
32
* - SDL_HapticOpenFromJoystick() to open from an existing joystick.
33
* - Create an effect (::SDL_HapticEffect).
34
* - Upload the effect with SDL_HapticNewEffect().
35
* - Run the effect with SDL_HapticRunEffect().
36
* - (optional) Free the effect with SDL_HapticDestroyEffect().
37
* - Close the haptic device with SDL_HapticClose().
39
* \par Simple rumble example:
44
* haptic = SDL_HapticOpen( 0 );
48
* // Initialize simple rumble
49
* if (SDL_HapticRumbleInit( haptic ) != 0)
52
* // Play effect at 50% strength for 2 seconds
53
* if (SDL_HapticRumblePlay( haptic, 0.5, 2000 ) != 0)
58
* SDL_HapticClose( haptic );
61
* \par Complete example:
63
* int test_haptic( SDL_Joystick * joystick ) {
65
* SDL_HapticEffect effect;
69
* haptic = SDL_HapticOpenFromJoystick( joystick );
70
* if (haptic == NULL) return -1; // Most likely joystick isn't haptic
72
* // See if it can do sine waves
73
* if ((SDL_HapticQuery(haptic) & SDL_HAPTIC_SINE)==0) {
74
* SDL_HapticClose(haptic); // No sine effect
78
* // Create the effect
79
* memset( &effect, 0, sizeof(SDL_HapticEffect) ); // 0 is safe default
80
* effect.type = SDL_HAPTIC_SINE;
81
* effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
82
* effect.periodic.direction.dir[0] = 18000; // Force comes from south
83
* effect.periodic.period = 1000; // 1000 ms
84
* effect.periodic.magnitude = 20000; // 20000/32767 strength
85
* effect.periodic.length = 5000; // 5 seconds long
86
* effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
87
* effect.periodic.fade_length = 1000; // Takes 1 second to fade away
89
* // Upload the effect
90
* effect_id = SDL_HapticNewEffect( haptic, &effect );
93
* SDL_HapticRunEffect( haptic, effect_id, 1 );
94
* SDL_Delay( 5000); // Wait for the effect to finish
96
* // We destroy the effect, although closing the device also does this
97
* SDL_HapticDestroyEffect( haptic, effect_id );
100
* SDL_HapticClose(haptic);
102
* return 0; // Success
106
* You can also find out more information on my blog:
107
* http://bobbens.dyndns.org/journal/2010/sdl_haptic/
109
* \author Edgar Simo Serra
112
#ifndef _SDL_haptic_h
113
#define _SDL_haptic_h
115
#include "SDL_stdinc.h"
116
#include "SDL_error.h"
117
#include "SDL_joystick.h"
119
#include "begin_code.h"
120
/* Set up for C function definitions, even when using C++ */
125
#endif /* __cplusplus */
128
* \typedef SDL_Haptic
130
* \brief The haptic structure used to identify an SDL haptic.
133
* \sa SDL_HapticOpenFromJoystick
134
* \sa SDL_HapticClose
137
typedef struct _SDL_Haptic SDL_Haptic;
141
* \name Haptic features
143
* Different haptic features a device can have.
148
* \name Haptic effects
153
* \brief Constant effect supported.
155
* Constant haptic effect.
157
* \sa SDL_HapticCondition
159
#define SDL_HAPTIC_CONSTANT (1<<0)
162
* \brief Sine wave effect supported.
164
* Periodic haptic effect that simulates sine waves.
166
* \sa SDL_HapticPeriodic
168
#define SDL_HAPTIC_SINE (1<<1)
171
* \brief Square wave effect supported.
173
* Periodic haptic effect that simulates square waves.
175
* \sa SDL_HapticPeriodic
177
#define SDL_HAPTIC_SQUARE (1<<2)
180
* \brief Triangle wave effect supported.
182
* Periodic haptic effect that simulates triangular waves.
184
* \sa SDL_HapticPeriodic
186
#define SDL_HAPTIC_TRIANGLE (1<<3)
189
* \brief Sawtoothup wave effect supported.
191
* Periodic haptic effect that simulates saw tooth up waves.
193
* \sa SDL_HapticPeriodic
195
#define SDL_HAPTIC_SAWTOOTHUP (1<<4)
198
* \brief Sawtoothdown wave effect supported.
200
* Periodic haptic effect that simulates saw tooth down waves.
202
* \sa SDL_HapticPeriodic
204
#define SDL_HAPTIC_SAWTOOTHDOWN (1<<5)
207
* \brief Ramp effect supported.
209
* Ramp haptic effect.
213
#define SDL_HAPTIC_RAMP (1<<6)
216
* \brief Spring effect supported - uses axes position.
218
* Condition haptic effect that simulates a spring. Effect is based on the
221
* \sa SDL_HapticCondition
223
#define SDL_HAPTIC_SPRING (1<<7)
226
* \brief Damper effect supported - uses axes velocity.
228
* Condition haptic effect that simulates dampening. Effect is based on the
231
* \sa SDL_HapticCondition
233
#define SDL_HAPTIC_DAMPER (1<<8)
236
* \brief Inertia effect supported - uses axes acceleration.
238
* Condition haptic effect that simulates inertia. Effect is based on the axes
241
* \sa SDL_HapticCondition
243
#define SDL_HAPTIC_INERTIA (1<<9)
246
* \brief Friction effect supported - uses axes movement.
248
* Condition haptic effect that simulates friction. Effect is based on the
251
* \sa SDL_HapticCondition
253
#define SDL_HAPTIC_FRICTION (1<<10)
256
* \brief Custom effect is supported.
258
* User defined custom haptic effect.
260
#define SDL_HAPTIC_CUSTOM (1<<11)
262
/*@}*//*Haptic effects*/
264
/* These last few are features the device has, not effects */
267
* \brief Device can set global gain.
269
* Device supports setting the global gain.
271
* \sa SDL_HapticSetGain
273
#define SDL_HAPTIC_GAIN (1<<12)
276
* \brief Device can set autocenter.
278
* Device supports setting autocenter.
280
* \sa SDL_HapticSetAutocenter
282
#define SDL_HAPTIC_AUTOCENTER (1<<13)
285
* \brief Device can be queried for effect status.
287
* Device can be queried for effect status.
289
* \sa SDL_HapticGetEffectStatus
291
#define SDL_HAPTIC_STATUS (1<<14)
294
* \brief Device can be paused.
296
* \sa SDL_HapticPause
297
* \sa SDL_HapticUnpause
299
#define SDL_HAPTIC_PAUSE (1<<15)
303
* \name Direction encodings
308
* \brief Uses polar coordinates for the direction.
310
* \sa SDL_HapticDirection
312
#define SDL_HAPTIC_POLAR 0
315
* \brief Uses cartesian coordinates for the direction.
317
* \sa SDL_HapticDirection
319
#define SDL_HAPTIC_CARTESIAN 1
322
* \brief Uses spherical coordinates for the direction.
324
* \sa SDL_HapticDirection
326
#define SDL_HAPTIC_SPHERICAL 2
328
/*@}*//*Direction encodings*/
330
/*@}*//*Haptic features*/
337
* \brief Used to play a device an infinite number of times.
339
* \sa SDL_HapticRunEffect
341
#define SDL_HAPTIC_INFINITY 4294967295U
345
* \brief Structure that represents a haptic direction.
347
* Directions can be specified by:
348
* - ::SDL_HAPTIC_POLAR : Specified by polar coordinates.
349
* - ::SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
350
* - ::SDL_HAPTIC_SPHERICAL : Specified by spherical coordinates.
352
* Cardinal directions of the haptic device are relative to the positioning
353
* of the device. North is considered to be away from the user.
355
* The following diagram represents the cardinal directions:
370
(1,0) West <----[ HAPTIC ]----> East (-1,0)
383
* If type is ::SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
384
* degree starting north and turning clockwise. ::SDL_HAPTIC_POLAR only uses
385
* the first \c dir parameter. The cardinal directions would be:
386
* - North: 0 (0 degrees)
387
* - East: 9000 (90 degrees)
388
* - South: 18000 (180 degrees)
389
* - West: 27000 (270 degrees)
391
* If type is ::SDL_HAPTIC_CARTESIAN, direction is encoded by three positions
392
* (X axis, Y axis and Z axis (with 3 axes)). ::SDL_HAPTIC_CARTESIAN uses
393
* the first three \c dir parameters. The cardinal directions would be:
399
* The Z axis represents the height of the effect if supported, otherwise
400
* it's unused. In cartesian encoding (1, 2) would be the same as (2, 4), you
401
* can use any multiple you want, only the direction matters.
403
* If type is ::SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations.
404
* The first two \c dir parameters are used. The \c dir parameters are as
405
* follows (all values are in hundredths of degrees):
406
* - Degrees from (1, 0) rotated towards (0, 1).
407
* - Degrees towards (0, 0, 1) (device needs at least 3 axes).
410
* Example of force coming from the south with all encodings (force coming
411
* from the south means the user will have to pull the stick to counteract):
413
* SDL_HapticDirection direction;
415
* // Cartesian directions
416
* direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding.
417
* direction.dir[0] = 0; // X position
418
* direction.dir[1] = 1; // Y position
419
* // Assuming the device has 2 axes, we don't need to specify third parameter.
421
* // Polar directions
422
* direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
423
* direction.dir[0] = 18000; // Polar only uses first parameter
425
* // Spherical coordinates
426
* direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding
427
* direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
430
* \sa SDL_HAPTIC_POLAR
431
* \sa SDL_HAPTIC_CARTESIAN
432
* \sa SDL_HAPTIC_SPHERICAL
433
* \sa SDL_HapticEffect
434
* \sa SDL_HapticNumAxes
436
typedef struct SDL_HapticDirection
438
Uint8 type; /**< The type of encoding. */
439
Sint32 dir[3]; /**< The encoded direction. */
440
} SDL_HapticDirection;
444
* \brief A structure containing a template for a Constant effect.
446
* The struct is exclusive to the ::SDL_HAPTIC_CONSTANT effect.
448
* A constant effect applies a constant force in the specified direction
451
* \sa SDL_HAPTIC_CONSTANT
452
* \sa SDL_HapticEffect
454
typedef struct SDL_HapticConstant
457
Uint16 type; /**< ::SDL_HAPTIC_CONSTANT */
458
SDL_HapticDirection direction; /**< Direction of the effect. */
461
Uint32 length; /**< Duration of the effect. */
462
Uint16 delay; /**< Delay before starting the effect. */
465
Uint16 button; /**< Button that triggers the effect. */
466
Uint16 interval; /**< How soon it can be triggered again after button. */
469
Sint16 level; /**< Strength of the constant effect. */
472
Uint16 attack_length; /**< Duration of the attack. */
473
Uint16 attack_level; /**< Level at the start of the attack. */
474
Uint16 fade_length; /**< Duration of the fade. */
475
Uint16 fade_level; /**< Level at the end of the fade. */
476
} SDL_HapticConstant;
479
* \brief A structure containing a template for a Periodic effect.
481
* The struct handles the following effects:
482
* - ::SDL_HAPTIC_SINE
483
* - ::SDL_HAPTIC_SQUARE
484
* - ::SDL_HAPTIC_TRIANGLE
485
* - ::SDL_HAPTIC_SAWTOOTHUP
486
* - ::SDL_HAPTIC_SAWTOOTHDOWN
488
* A periodic effect consists in a wave-shaped effect that repeats itself
489
* over time. The type determines the shape of the wave and the parameters
490
* determine the dimensions of the wave.
492
* Phase is given by hundredth of a cyle meaning that giving the phase a value
493
* of 9000 will displace it 25% of it's period. Here are sample values:
494
* - 0: No phase displacement.
495
* - 9000: Displaced 25% of it's period.
496
* - 18000: Displaced 50% of it's period.
497
* - 27000: Displaced 75% of it's period.
498
* - 36000: Displaced 100% of it's period, same as 0, but 0 is preffered.
510
| |__| |__| |__| |__| |
517
SDL_HAPTIC_SAWTOOTHUP
519
/ | / | / | / | / | / | / |
520
/ |/ |/ |/ |/ |/ |/ |
522
SDL_HAPTIC_SAWTOOTHDOWN
523
\ |\ |\ |\ |\ |\ |\ |
524
\ | \ | \ | \ | \ | \ | \ |
528
* \sa SDL_HAPTIC_SINE
529
* \sa SDL_HAPTIC_SQUARE
530
* \sa SDL_HAPTIC_TRIANGLE
531
* \sa SDL_HAPTIC_SAWTOOTHUP
532
* \sa SDL_HAPTIC_SAWTOOTHDOWN
533
* \sa SDL_HapticEffect
535
typedef struct SDL_HapticPeriodic
538
Uint16 type; /**< ::SDL_HAPTIC_SINE, ::SDL_HAPTIC_SQUARE,
539
::SDL_HAPTIC_TRIANGLE, ::SDL_HAPTIC_SAWTOOTHUP or
540
::SDL_HAPTIC_SAWTOOTHDOWN */
541
SDL_HapticDirection direction; /**< Direction of the effect. */
544
Uint32 length; /**< Duration of the effect. */
545
Uint16 delay; /**< Delay before starting the effect. */
548
Uint16 button; /**< Button that triggers the effect. */
549
Uint16 interval; /**< How soon it can be triggered again after button. */
552
Uint16 period; /**< Period of the wave. */
553
Sint16 magnitude; /**< Peak value. */
554
Sint16 offset; /**< Mean value of the wave. */
555
Uint16 phase; /**< Horizontal shift given by hundredth of a cycle. */
558
Uint16 attack_length; /**< Duration of the attack. */
559
Uint16 attack_level; /**< Level at the start of the attack. */
560
Uint16 fade_length; /**< Duration of the fade. */
561
Uint16 fade_level; /**< Level at the end of the fade. */
562
} SDL_HapticPeriodic;
565
* \brief A structure containing a template for a Condition effect.
567
* The struct handles the following effects:
568
* - ::SDL_HAPTIC_SPRING: Effect based on axes position.
569
* - ::SDL_HAPTIC_DAMPER: Effect based on axes velocity.
570
* - ::SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
571
* - ::SDL_HAPTIC_FRICTION: Effect based on axes movement.
573
* Direction is handled by condition internals instead of a direction member.
574
* The condition effect specific members have three parameters. The first
575
* refers to the X axis, the second refers to the Y axis and the third
576
* refers to the Z axis. The right terms refer to the positive side of the
577
* axis and the left terms refer to the negative side of the axis. Please
578
* refer to the ::SDL_HapticDirection diagram for which side is positive and
581
* \sa SDL_HapticDirection
582
* \sa SDL_HAPTIC_SPRING
583
* \sa SDL_HAPTIC_DAMPER
584
* \sa SDL_HAPTIC_INERTIA
585
* \sa SDL_HAPTIC_FRICTION
586
* \sa SDL_HapticEffect
588
typedef struct SDL_HapticCondition
591
Uint16 type; /**< ::SDL_HAPTIC_SPRING, ::SDL_HAPTIC_DAMPER,
592
::SDL_HAPTIC_INERTIA or ::SDL_HAPTIC_FRICTION */
593
SDL_HapticDirection direction; /**< Direction of the effect - Not used ATM. */
596
Uint32 length; /**< Duration of the effect. */
597
Uint16 delay; /**< Delay before starting the effect. */
600
Uint16 button; /**< Button that triggers the effect. */
601
Uint16 interval; /**< How soon it can be triggered again after button. */
604
Uint16 right_sat[3]; /**< Level when joystick is to the positive side. */
605
Uint16 left_sat[3]; /**< Level when joystick is to the negative side. */
606
Sint16 right_coeff[3]; /**< How fast to increase the force towards the positive side. */
607
Sint16 left_coeff[3]; /**< How fast to increase the force towards the negative side. */
608
Uint16 deadband[3]; /**< Size of the dead zone. */
609
Sint16 center[3]; /**< Position of the dead zone. */
610
} SDL_HapticCondition;
613
* \brief A structure containing a template for a Ramp effect.
615
* This struct is exclusively for the ::SDL_HAPTIC_RAMP effect.
617
* The ramp effect starts at start strength and ends at end strength.
618
* It augments in linear fashion. If you use attack and fade with a ramp
619
* they effects get added to the ramp effect making the effect become
620
* quadratic instead of linear.
622
* \sa SDL_HAPTIC_RAMP
623
* \sa SDL_HapticEffect
625
typedef struct SDL_HapticRamp
628
Uint16 type; /**< ::SDL_HAPTIC_RAMP */
629
SDL_HapticDirection direction; /**< Direction of the effect. */
632
Uint32 length; /**< Duration of the effect. */
633
Uint16 delay; /**< Delay before starting the effect. */
636
Uint16 button; /**< Button that triggers the effect. */
637
Uint16 interval; /**< How soon it can be triggered again after button. */
640
Sint16 start; /**< Beginning strength level. */
641
Sint16 end; /**< Ending strength level. */
644
Uint16 attack_length; /**< Duration of the attack. */
645
Uint16 attack_level; /**< Level at the start of the attack. */
646
Uint16 fade_length; /**< Duration of the fade. */
647
Uint16 fade_level; /**< Level at the end of the fade. */
651
* \brief A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
653
* A custom force feedback effect is much like a periodic effect, where the
654
* application can define it's exact shape. You will have to allocate the
655
* data yourself. Data should consist of channels * samples Uint16 samples.
657
* If channels is one, the effect is rotated using the defined direction.
658
* Otherwise it uses the samples in data for the different axes.
660
* \sa SDL_HAPTIC_CUSTOM
661
* \sa SDL_HapticEffect
663
typedef struct SDL_HapticCustom
666
Uint16 type; /**< ::SDL_HAPTIC_CUSTOM */
667
SDL_HapticDirection direction; /**< Direction of the effect. */
670
Uint32 length; /**< Duration of the effect. */
671
Uint16 delay; /**< Delay before starting the effect. */
674
Uint16 button; /**< Button that triggers the effect. */
675
Uint16 interval; /**< How soon it can be triggered again after button. */
678
Uint8 channels; /**< Axes to use, minimum of one. */
679
Uint16 period; /**< Sample periods. */
680
Uint16 samples; /**< Amount of samples. */
681
Uint16 *data; /**< Should contain channels*samples items. */
684
Uint16 attack_length; /**< Duration of the attack. */
685
Uint16 attack_level; /**< Level at the start of the attack. */
686
Uint16 fade_length; /**< Duration of the fade. */
687
Uint16 fade_level; /**< Level at the end of the fade. */
691
* \brief The generic template for any haptic effect.
693
* All values max at 32767 (0x7FFF). Signed values also can be negative.
694
* Time values unless specified otherwise are in milliseconds.
696
* You can also pass ::SDL_HAPTIC_INFINITY to length instead of a 0-32767
697
* value. Neither delay, interval, attack_length nor fade_length support
698
* ::SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends.
700
* Additionally, the ::SDL_HAPTIC_RAMP effect does not support a duration of
701
* ::SDL_HAPTIC_INFINITY.
703
* Button triggers may not be supported on all devices, it is advised to not
704
* use them if possible. Buttons start at index 1 instead of index 0 like
707
* If both attack_length and fade_level are 0, the envelope is not used,
708
* otherwise both values are used.
712
* // Replay - All effects have this
713
* Uint32 length; // Duration of effect (ms).
714
* Uint16 delay; // Delay before starting effect.
716
* // Trigger - All effects have this
717
* Uint16 button; // Button that triggers effect.
718
* Uint16 interval; // How soon before effect can be triggered again.
720
* // Envelope - All effects except condition effects have this
721
* Uint16 attack_length; // Duration of the attack (ms).
722
* Uint16 attack_level; // Level at the start of the attack.
723
* Uint16 fade_length; // Duration of the fade out (ms).
724
* Uint16 fade_level; // Level at the end of the fade.
728
* Here we have an example of a constant effect evolution in time:
733
| effect level --> _________________
738
| attack_level --> | \
739
| | | <--- fade_level
741
+--------------------------------------------------> Time
743
attack_length fade_length
745
[------------------][-----------------------]
749
* Note either the attack_level or the fade_level may be above the actual
752
* \sa SDL_HapticConstant
753
* \sa SDL_HapticPeriodic
754
* \sa SDL_HapticCondition
756
* \sa SDL_HapticCustom
758
typedef union SDL_HapticEffect
760
/* Common for all force feedback effects */
761
Uint16 type; /**< Effect type. */
762
SDL_HapticConstant constant; /**< Constant effect. */
763
SDL_HapticPeriodic periodic; /**< Periodic effect. */
764
SDL_HapticCondition condition; /**< Condition effect. */
765
SDL_HapticRamp ramp; /**< Ramp effect. */
766
SDL_HapticCustom custom; /**< Custom effect. */
770
/* Function prototypes */
772
* \brief Count the number of joysticks attached to the system.
774
* \return Number of haptic devices detected on the system.
776
extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
779
* \brief Get the implementation dependent name of a Haptic device.
781
* This can be called before any joysticks are opened.
782
* If no name can be found, this function returns NULL.
784
* \param device_index Index of the device to get it's name.
785
* \return Name of the device or NULL on error.
789
extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
792
* \brief Opens a Haptic device for usage.
794
* The index passed as an argument refers to the N'th Haptic device on this
797
* When opening a haptic device, it's gain will be set to maximum and
798
* autocenter will be disabled. To modify these values use
799
* SDL_HapticSetGain() and SDL_HapticSetAutocenter().
801
* \param device_index Index of the device to open.
802
* \return Device identifier or NULL on error.
804
* \sa SDL_HapticIndex
805
* \sa SDL_HapticOpenFromMouse
806
* \sa SDL_HapticOpenFromJoystick
807
* \sa SDL_HapticClose
808
* \sa SDL_HapticSetGain
809
* \sa SDL_HapticSetAutocenter
810
* \sa SDL_HapticPause
811
* \sa SDL_HapticStopAll
813
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
816
* \brief Checks if the haptic device at index has been opened.
818
* \param device_index Index to check to see if it has been opened.
819
* \return 1 if it has been opened or 0 if it hasn't.
822
* \sa SDL_HapticIndex
824
extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index);
827
* \brief Gets the index of a haptic device.
829
* \param haptic Haptic device to get the index of.
830
* \return The index of the haptic device or -1 on error.
833
* \sa SDL_HapticOpened
835
extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic);
838
* \brief Gets whether or not the current mouse has haptic capabilities.
840
* \return SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
842
* \sa SDL_HapticOpenFromMouse
844
extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void);
847
* \brief Tries to open a haptic device from the current mouse.
849
* \return The haptic device identifier or NULL on error.
851
* \sa SDL_MouseIsHaptic
854
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void);
857
* \brief Checks to see if a joystick has haptic features.
859
* \param joystick Joystick to test for haptic capabilities.
860
* \return 1 if the joystick is haptic, 0 if it isn't
861
* or -1 if an error ocurred.
863
* \sa SDL_HapticOpenFromJoystick
865
extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
868
* \brief Opens a Haptic device for usage from a Joystick device.
870
* You must still close the haptic device seperately. It will not be closed
873
* When opening from a joystick you should first close the haptic device before
874
* closing the joystick device. If not, on some implementations the haptic
875
* device will also get unallocated and you'll be unable to use force feedback
878
* \param joystick Joystick to create a haptic device from.
879
* \return A valid haptic device identifier on success or NULL on error.
882
* \sa SDL_HapticClose
884
extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick *
888
* \brief Closes a Haptic device previously opened with SDL_HapticOpen().
890
* \param haptic Haptic device to close.
892
extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
895
* \brief Returns the number of effects a haptic device can store.
897
* On some platforms this isn't fully supported, and therefore is an
898
* aproximation. Always check to see if your created effect was actually
899
* created and do not rely solely on SDL_HapticNumEffects().
901
* \param haptic The haptic device to query effect max.
902
* \return The number of effects the haptic device can store or
905
* \sa SDL_HapticNumEffectsPlaying
906
* \sa SDL_HapticQuery
908
extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
911
* \brief Returns the number of effects a haptic device can play at the same
914
* This is not supported on all platforms, but will always return a value.
915
* Added here for the sake of completness.
917
* \param haptic The haptic device to query maximum playing effects.
918
* \return The number of effects the haptic device can play at the same time
921
* \sa SDL_HapticNumEffects
922
* \sa SDL_HapticQuery
924
extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
927
* \brief Gets the haptic devices supported features in bitwise matter.
931
* if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
932
* printf("We have constant haptic effect!");
936
* \param haptic The haptic device to query.
937
* \return Haptic features in bitwise manner (OR'd).
939
* \sa SDL_HapticNumEffects
940
* \sa SDL_HapticEffectSupported
942
extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic);
946
* \brief Gets the number of haptic axes the device has.
948
* \sa SDL_HapticDirection
950
extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic);
953
* \brief Checks to see if effect is supported by haptic.
955
* \param haptic Haptic device to check on.
956
* \param effect Effect to check to see if it is supported.
957
* \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or -1 on error.
959
* \sa SDL_HapticQuery
960
* \sa SDL_HapticNewEffect
962
extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic,
967
* \brief Creates a new haptic effect on the device.
969
* \param haptic Haptic device to create the effect on.
970
* \param effect Properties of the effect to create.
971
* \return The id of the effect on success or -1 on error.
973
* \sa SDL_HapticUpdateEffect
974
* \sa SDL_HapticRunEffect
975
* \sa SDL_HapticDestroyEffect
977
extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic,
978
SDL_HapticEffect * effect);
981
* \brief Updates the properties of an effect.
983
* Can be used dynamically, although behaviour when dynamically changing
984
* direction may be strange. Specifically the effect may reupload itself
985
* and start playing from the start. You cannot change the type either when
986
* running SDL_HapticUpdateEffect().
988
* \param haptic Haptic device that has the effect.
989
* \param effect Effect to update.
990
* \param data New effect properties to use.
991
* \return The id of the effect on success or -1 on error.
993
* \sa SDL_HapticNewEffect
994
* \sa SDL_HapticRunEffect
995
* \sa SDL_HapticDestroyEffect
997
extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic,
999
SDL_HapticEffect * data);
1002
* \brief Runs the haptic effect on it's assosciated haptic device.
1004
* If iterations are ::SDL_HAPTIC_INFINITY, it'll run the effect over and over
1005
* repeating the envelope (attack and fade) every time. If you only want the
1006
* effect to last forever, set ::SDL_HAPTIC_INFINITY in the effect's length
1009
* \param haptic Haptic device to run the effect on.
1010
* \param effect Identifier of the haptic effect to run.
1011
* \param iterations Number of iterations to run the effect. Use
1012
* ::SDL_HAPTIC_INFINITY for infinity.
1013
* \return 0 on success or -1 on error.
1015
* \sa SDL_HapticStopEffect
1016
* \sa SDL_HapticDestroyEffect
1017
* \sa SDL_HapticGetEffectStatus
1019
extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic,
1024
* \brief Stops the haptic effect on it's assosciated haptic device.
1026
* \param haptic Haptic device to stop the effect on.
1027
* \param effect Identifier of the effect to stop.
1028
* \return 0 on success or -1 on error.
1030
* \sa SDL_HapticRunEffect
1031
* \sa SDL_HapticDestroyEffect
1033
extern DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic * haptic,
1037
* \brief Destroys a haptic effect on the device.
1039
* This will stop the effect if it's running. Effects are automatically
1040
* destroyed when the device is closed.
1042
* \param haptic Device to destroy the effect on.
1043
* \param effect Identifier of the effect to destroy.
1045
* \sa SDL_HapticNewEffect
1047
extern DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic * haptic,
1051
* \brief Gets the status of the current effect on the haptic device.
1053
* Device must support the ::SDL_HAPTIC_STATUS feature.
1055
* \param haptic Haptic device to query the effect status on.
1056
* \param effect Identifier of the effect to query it's status.
1057
* \return 0 if it isn't playing, ::SDL_HAPTIC_PLAYING if it is playing
1060
* \sa SDL_HapticRunEffect
1061
* \sa SDL_HapticStopEffect
1063
extern DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic * haptic,
1067
* \brief Sets the global gain of the device.
1069
* Device must support the ::SDL_HAPTIC_GAIN feature.
1071
* The user may specify the maxmimum gain by setting the environment variable
1072
* ::SDL_HAPTIC_GAIN_MAX which should be between 0 and 100. All calls to
1073
* SDL_HapticSetGain() will scale linearly using ::SDL_HAPTIC_GAIN_MAX as the
1076
* \param haptic Haptic device to set the gain on.
1077
* \param gain Value to set the gain to, should be between 0 and 100.
1078
* \return 0 on success or -1 on error.
1080
* \sa SDL_HapticQuery
1082
extern DECLSPEC int SDLCALL SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
1085
* \brief Sets the global autocenter of the device.
1087
* Autocenter should be between 0 and 100. Setting it to 0 will disable
1090
* Device must support the ::SDL_HAPTIC_AUTOCENTER feature.
1092
* \param haptic Haptic device to set autocentering on.
1093
* \param autocenter Value to set autocenter to, 0 disables autocentering.
1094
* \return 0 on success or -1 on error.
1096
* \sa SDL_HapticQuery
1098
extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic,
1102
* \brief Pauses a haptic device.
1104
* Device must support the ::SDL_HAPTIC_PAUSE feature. Call
1105
* SDL_HapticUnpause() to resume playback.
1107
* Do not modify the effects nor add new ones while the device is paused.
1108
* That can cause all sorts of weird errors.
1110
* \param haptic Haptic device to pause.
1111
* \return 0 on success or -1 on error.
1113
* \sa SDL_HapticUnpause
1115
extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic);
1118
* \brief Unpauses a haptic device.
1120
* Call to unpause after SDL_HapticPause().
1122
* \param haptic Haptic device to pause.
1123
* \return 0 on success or -1 on error.
1125
* \sa SDL_HapticPause
1127
extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
1130
* \brief Stops all the currently playing effects on a haptic device.
1132
* \param haptic Haptic device to stop.
1133
* \return 0 on success or -1 on error.
1135
extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic);
1138
* \brief Checks to see if rumble is supported on a haptic device..
1140
* \param haptic Haptic device to check to see if it supports rumble.
1141
* \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or -1 on error.
1143
* \sa SDL_HapticRumbleInit
1144
* \sa SDL_HapticRumblePlay
1145
* \sa SDL_HapticRumbleStop
1147
extern DECLSPEC int SDLCALL SDL_HapticRumbleSupported(SDL_Haptic * haptic);
1150
* \brief Initializes the haptic device for simple rumble playback.
1152
* \param haptic Haptic device to initialize for simple rumble playback.
1153
* \return 0 on success or -1 on error.
1155
* \sa SDL_HapticOpen
1156
* \sa SDL_HapticRumbleSupported
1157
* \sa SDL_HapticRumblePlay
1158
* \sa SDL_HapticRumbleStop
1160
extern DECLSPEC int SDLCALL SDL_HapticRumbleInit(SDL_Haptic * haptic);
1163
* \brief Runs simple rumble on a haptic device
1165
* \param haptic Haptic device to play rumble effect on.
1166
* \param strength Strength of the rumble to play as a 0-1 float value.
1167
* \param length Length of the rumble to play in miliseconds.
1168
* \return 0 on success or -1 on error.
1170
* \sa SDL_HapticRumbleSupported
1171
* \sa SDL_HapticRumbleInit
1172
* \sa SDL_HapticRumbleStop
1174
extern DECLSPEC int SDLCALL SDL_HapticRumblePlay(SDL_Haptic * haptic, float strength, Uint32 length );
1177
* \brief Stops the simple rumble on a haptic device.
1179
* \param haptic Haptic to stop the rumble on.
1180
* \return 0 on success or -1 on error.
1182
* \sa SDL_HapticRumbleSupported
1183
* \sa SDL_HapticRumbleInit
1184
* \sa SDL_HapticRumblePlay
1186
extern DECLSPEC int SDLCALL SDL_HapticRumbleStop(SDL_Haptic * haptic);
1190
/* Ends C function definitions when using C++ */
1196
#include "close_code.h"
1198
#endif /* _SDL_haptic_h */
1200
/* vi: set ts=4 sw=4 expandtab: */
added
removed
system/include/SDL/SDL_haptic.h
