SDL  2.0
SDL_haptic.c File Reference
#include "../SDL_internal.h"
#include "SDL_syshaptic.h"
#include "SDL_haptic_c.h"
#include "../joystick/SDL_joystick_c.h"
#include "SDL_assert.h"
+ Include dependency graph for SDL_haptic.c:

Go to the source code of this file.

Functions

int SDL_HapticInit (void)
 
static int ValidHaptic (SDL_Haptic *haptic)
 
int SDL_NumHaptics (void)
 Count the number of haptic devices attached to the system. More...
 
const char * SDL_HapticName (int device_index)
 Get the implementation dependent name of a haptic device. More...
 
SDL_Haptic * SDL_HapticOpen (int device_index)
 Opens a haptic device for use. More...
 
int SDL_HapticOpened (int device_index)
 Checks if the haptic device at index has been opened. More...
 
int SDL_HapticIndex (SDL_Haptic *haptic)
 Gets the index of a haptic device. More...
 
int SDL_MouseIsHaptic (void)
 Gets whether or not the current mouse has haptic capabilities. More...
 
SDL_Haptic * SDL_HapticOpenFromMouse (void)
 Tries to open a haptic device from the current mouse. More...
 
int SDL_JoystickIsHaptic (SDL_Joystick *joystick)
 Checks to see if a joystick has haptic features. More...
 
SDL_Haptic * SDL_HapticOpenFromJoystick (SDL_Joystick *joystick)
 Opens a haptic device for use from a joystick device. More...
 
void SDL_HapticClose (SDL_Haptic *haptic)
 Closes a haptic device previously opened with SDL_HapticOpen(). More...
 
void SDL_HapticQuit (void)
 
int SDL_HapticNumEffects (SDL_Haptic *haptic)
 Returns the number of effects a haptic device can store. More...
 
int SDL_HapticNumEffectsPlaying (SDL_Haptic *haptic)
 Returns the number of effects a haptic device can play at the same time. More...
 
unsigned int SDL_HapticQuery (SDL_Haptic *haptic)
 Gets the haptic device's supported features in bitwise manner. More...
 
int SDL_HapticNumAxes (SDL_Haptic *haptic)
 Gets the number of haptic axes the device has. More...
 
int SDL_HapticEffectSupported (SDL_Haptic *haptic, SDL_HapticEffect *effect)
 Checks to see if effect is supported by haptic. More...
 
int SDL_HapticNewEffect (SDL_Haptic *haptic, SDL_HapticEffect *effect)
 Creates a new haptic effect on the device. More...
 
static int ValidEffect (SDL_Haptic *haptic, int effect)
 
int SDL_HapticUpdateEffect (SDL_Haptic *haptic, int effect, SDL_HapticEffect *data)
 Updates the properties of an effect. More...
 
int SDL_HapticRunEffect (SDL_Haptic *haptic, int effect, Uint32 iterations)
 Runs the haptic effect on its associated haptic device. More...
 
int SDL_HapticStopEffect (SDL_Haptic *haptic, int effect)
 Stops the haptic effect on its associated haptic device. More...
 
void SDL_HapticDestroyEffect (SDL_Haptic *haptic, int effect)
 Destroys a haptic effect on the device. More...
 
int SDL_HapticGetEffectStatus (SDL_Haptic *haptic, int effect)
 Gets the status of the current effect on the haptic device. More...
 
int SDL_HapticSetGain (SDL_Haptic *haptic, int gain)
 Sets the global gain of the device. More...
 
int SDL_HapticSetAutocenter (SDL_Haptic *haptic, int autocenter)
 Sets the global autocenter of the device. More...
 
int SDL_HapticPause (SDL_Haptic *haptic)
 Pauses a haptic device. More...
 
int SDL_HapticUnpause (SDL_Haptic *haptic)
 Unpauses a haptic device. More...
 
int SDL_HapticStopAll (SDL_Haptic *haptic)
 Stops all the currently playing effects on a haptic device. More...
 
int SDL_HapticRumbleSupported (SDL_Haptic *haptic)
 Checks to see if rumble is supported on a haptic device. More...
 
int SDL_HapticRumbleInit (SDL_Haptic *haptic)
 Initializes the haptic device for simple rumble playback. More...
 
int SDL_HapticRumblePlay (SDL_Haptic *haptic, float strength, Uint32 length)
 Runs simple rumble on a haptic device. More...
 
int SDL_HapticRumbleStop (SDL_Haptic *haptic)
 Stops the simple rumble on a haptic device. More...
 

Variables

SDL_Haptic * SDL_haptics = NULL
 

Function Documentation

◆ SDL_HapticClose()

void SDL_HapticClose ( SDL_Haptic *  haptic)

Closes a haptic device previously opened with SDL_HapticOpen().

Parameters
hapticHaptic device to close.

Definition at line 335 of file SDL_haptic.c.

References i, NULL, SDL_free, SDL_HapticDestroyEffect(), SDL_haptics, SDL_SYS_HapticClose(), and ValidHaptic().

336 {
337  int i;
338  SDL_Haptic *hapticlist;
339  SDL_Haptic *hapticlistprev;
340 
341  /* Must be valid */
342  if (!ValidHaptic(haptic)) {
343  return;
344  }
345 
346  /* Check if it's still in use */
347  if (--haptic->ref_count > 0) {
348  return;
349  }
350 
351  /* Close it, properly removing effects if needed */
352  for (i = 0; i < haptic->neffects; i++) {
353  if (haptic->effects[i].hweffect != NULL) {
355  }
356  }
358 
359  /* Remove from the list */
360  hapticlist = SDL_haptics;
361  hapticlistprev = NULL;
362  while ( hapticlist )
363  {
364  if (haptic == hapticlist)
365  {
366  if ( hapticlistprev )
367  {
368  /* unlink this entry */
369  hapticlistprev->next = hapticlist->next;
370  }
371  else
372  {
373  SDL_haptics = haptic->next;
374  }
375 
376  break;
377  }
378  hapticlistprev = hapticlist;
379  hapticlist = hapticlist->next;
380  }
381 
382  /* Free */
383  SDL_free(haptic);
384 }
#define SDL_free
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:164
static SDL_Haptic * haptic
Definition: testhaptic.c:25
void SDL_SYS_HapticClose(SDL_Haptic *haptic)
void SDL_HapticDestroyEffect(SDL_Haptic *haptic, int effect)
Destroys a haptic effect on the device.
Definition: SDL_haptic.c:586
SDL_Haptic * SDL_haptics
Definition: SDL_haptic.c:29

◆ SDL_HapticDestroyEffect()

void SDL_HapticDestroyEffect ( SDL_Haptic *  haptic,
int  effect 
)

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.

Parameters
hapticDevice to destroy the effect on.
effectIdentifier of the effect to destroy.
See also
SDL_HapticNewEffect

Definition at line 586 of file SDL_haptic.c.

References NULL, SDL_SYS_HapticDestroyEffect(), ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticClose().

587 {
588  if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
589  return;
590  }
591 
592  /* Not allocated */
593  if (haptic->effects[effect].hweffect == NULL) {
594  return;
595  }
596 
597  SDL_SYS_HapticDestroyEffect(haptic, &haptic->effects[effect]);
598 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
void SDL_SYS_HapticDestroyEffect(SDL_Haptic *haptic, struct haptic_effect *effect)
#define NULL
Definition: begin_code.h:164
static SDL_Haptic * haptic
Definition: testhaptic.c:25
static int ValidEffect(SDL_Haptic *haptic, int effect)
Definition: SDL_haptic.c:508

◆ SDL_HapticEffectSupported()

int SDL_HapticEffectSupported ( SDL_Haptic *  haptic,
SDL_HapticEffect effect 
)

Checks to see if effect is supported by haptic.

Parameters
hapticHaptic device to check on.
effectEffect to check to see if it is supported.
Returns
SDL_TRUE if effect is supported, SDL_FALSE if it isn't or -1 on error.
See also
SDL_HapticQuery
SDL_HapticNewEffect

Definition at line 456 of file SDL_haptic.c.

References SDL_FALSE, SDL_TRUE, SDL_HapticEffect::type, and ValidHaptic().

Referenced by SDL_HapticNewEffect().

457 {
458  if (!ValidHaptic(haptic)) {
459  return -1;
460  }
461 
462  if ((haptic->supported & effect->type) != 0)
463  return SDL_TRUE;
464  return SDL_FALSE;
465 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticGetEffectStatus()

int SDL_HapticGetEffectStatus ( SDL_Haptic *  haptic,
int  effect 
)

Gets the status of the current effect on the haptic device.

Device must support the SDL_HAPTIC_STATUS feature.

Parameters
hapticHaptic device to query the effect status on.
effectIdentifier of the effect to query its status.
Returns
0 if it isn't playing, 1 if it is playing or -1 on error.
See also
SDL_HapticRunEffect
SDL_HapticStopEffect

Definition at line 604 of file SDL_haptic.c.

References SDL_HAPTIC_STATUS, SDL_SetError, SDL_SYS_HapticGetEffectStatus(), ValidEffect(), and ValidHaptic().

605 {
606  if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
607  return -1;
608  }
609 
610  if ((haptic->supported & SDL_HAPTIC_STATUS) == 0) {
611  return SDL_SetError("Haptic: Device does not support status queries.");
612  }
613 
614  return SDL_SYS_HapticGetEffectStatus(haptic, &haptic->effects[effect]);
615 }
int SDL_SYS_HapticGetEffectStatus(SDL_Haptic *haptic, struct haptic_effect *effect)
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
#define SDL_HAPTIC_STATUS
Device can be queried for effect status.
Definition: SDL_haptic.h:289
static int ValidEffect(SDL_Haptic *haptic, int effect)
Definition: SDL_haptic.c:508

◆ SDL_HapticIndex()

int SDL_HapticIndex ( SDL_Haptic *  haptic)

Gets the index of a haptic device.

Parameters
hapticHaptic device to get the index of.
Returns
The index of the haptic device or -1 on error.
See also
SDL_HapticOpen
SDL_HapticOpened

Definition at line 200 of file SDL_haptic.c.

References ValidHaptic().

201 {
202  if (!ValidHaptic(haptic)) {
203  return -1;
204  }
205 
206  return haptic->index;
207 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticInit()

int SDL_HapticInit ( void  )

Definition at line 35 of file SDL_haptic.c.

References SDL_SYS_HapticInit().

Referenced by SDL_InitSubSystem().

36 {
37  int status;
38 
39  status = SDL_SYS_HapticInit();
40  if (status >= 0) {
41  status = 0;
42  }
43 
44  return status;
45 }
int SDL_SYS_HapticInit(void)

◆ SDL_HapticName()

const char* SDL_HapticName ( int  device_index)

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.

Parameters
device_indexIndex of the device to get its name.
Returns
Name of the device or NULL on error.
See also
SDL_NumHaptics

Definition at line 93 of file SDL_haptic.c.

References NULL, SDL_NumHaptics(), SDL_SetError, and SDL_SYS_HapticName().

94 {
95  if ((device_index < 0) || (device_index >= SDL_NumHaptics())) {
96  SDL_SetError("Haptic: There are %d haptic devices available",
97  SDL_NumHaptics());
98  return NULL;
99  }
100  return SDL_SYS_HapticName(device_index);
101 }
const char * SDL_SYS_HapticName(int index)
int SDL_NumHaptics(void)
Count the number of haptic devices attached to the system.
Definition: SDL_haptic.c:83
#define NULL
Definition: begin_code.h:164
#define SDL_SetError

◆ SDL_HapticNewEffect()

int SDL_HapticNewEffect ( SDL_Haptic *  haptic,
SDL_HapticEffect effect 
)

Creates a new haptic effect on the device.

Parameters
hapticHaptic device to create the effect on.
effectProperties of the effect to create.
Returns
The identifier of the effect on success or -1 on error.
See also
SDL_HapticUpdateEffect
SDL_HapticRunEffect
SDL_HapticDestroyEffect

Definition at line 471 of file SDL_haptic.c.

References i, NULL, SDL_FALSE, SDL_HapticEffectSupported(), SDL_memcpy, SDL_SetError, SDL_SYS_HapticNewEffect(), and ValidHaptic().

Referenced by SDL_HapticRumbleInit().

472 {
473  int i;
474 
475  /* Check for device validity. */
476  if (!ValidHaptic(haptic)) {
477  return -1;
478  }
479 
480  /* Check to see if effect is supported */
481  if (SDL_HapticEffectSupported(haptic, effect) == SDL_FALSE) {
482  return SDL_SetError("Haptic: Effect not supported by haptic device.");
483  }
484 
485  /* See if there's a free slot */
486  for (i = 0; i < haptic->neffects; i++) {
487  if (haptic->effects[i].hweffect == NULL) {
488 
489  /* Now let the backend create the real effect */
490  if (SDL_SYS_HapticNewEffect(haptic, &haptic->effects[i], effect)
491  != 0) {
492  return -1; /* Backend failed to create effect */
493  }
494 
495  SDL_memcpy(&haptic->effects[i].effect, effect,
496  sizeof(SDL_HapticEffect));
497  return i;
498  }
499  }
500 
501  return SDL_SetError("Haptic: Device has no free space left.");
502 }
#define SDL_memcpy
int SDL_HapticEffectSupported(SDL_Haptic *haptic, SDL_HapticEffect *effect)
Checks to see if effect is supported by haptic.
Definition: SDL_haptic.c:456
The generic template for any haptic effect.
Definition: SDL_haptic.h:789
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:164
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
int SDL_SYS_HapticNewEffect(SDL_Haptic *haptic, struct haptic_effect *effect, SDL_HapticEffect *base)

◆ SDL_HapticNumAxes()

int SDL_HapticNumAxes ( SDL_Haptic *  haptic)

Gets the number of haptic axes the device has.

See also
SDL_HapticDirection

Definition at line 443 of file SDL_haptic.c.

References ValidHaptic().

444 {
445  if (!ValidHaptic(haptic)) {
446  return -1;
447  }
448 
449  return haptic->naxes;
450 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticNumEffects()

int SDL_HapticNumEffects ( SDL_Haptic *  haptic)

Returns the number of effects a haptic device can store.

On some platforms this isn't fully supported, and therefore is an approximation. Always check to see if your created effect was actually created and do not rely solely on SDL_HapticNumEffects().

Parameters
hapticThe haptic device to query effect max.
Returns
The number of effects the haptic device can store or -1 on error.
See also
SDL_HapticNumEffectsPlaying
SDL_HapticQuery

Definition at line 401 of file SDL_haptic.c.

References ValidHaptic().

402 {
403  if (!ValidHaptic(haptic)) {
404  return -1;
405  }
406 
407  return haptic->neffects;
408 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticNumEffectsPlaying()

int SDL_HapticNumEffectsPlaying ( SDL_Haptic *  haptic)

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 completeness.

Parameters
hapticThe haptic device to query maximum playing effects.
Returns
The number of effects the haptic device can play at the same time or -1 on error.
See also
SDL_HapticNumEffects
SDL_HapticQuery

Definition at line 415 of file SDL_haptic.c.

References ValidHaptic().

416 {
417  if (!ValidHaptic(haptic)) {
418  return -1;
419  }
420 
421  return haptic->nplaying;
422 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticOpen()

SDL_Haptic* SDL_HapticOpen ( int  device_index)

Opens a haptic device for use.

The index passed as an argument refers to the N'th haptic device on this system.

When opening a haptic device, its gain will be set to maximum and autocenter will be disabled. To modify these values use SDL_HapticSetGain() and SDL_HapticSetAutocenter().

Parameters
device_indexIndex of the device to open.
Returns
Device identifier or NULL on error.
See also
SDL_HapticIndex
SDL_HapticOpenFromMouse
SDL_HapticOpenFromJoystick
SDL_HapticClose
SDL_HapticSetGain
SDL_HapticSetAutocenter
SDL_HapticPause
SDL_HapticStopAll

Definition at line 108 of file SDL_haptic.c.

References haptic, NULL, SDL_free, SDL_HAPTIC_AUTOCENTER, SDL_HAPTIC_GAIN, SDL_haptics, SDL_HapticSetAutocenter(), SDL_HapticSetGain(), SDL_malloc, SDL_memset, SDL_NumHaptics(), SDL_OutOfMemory, SDL_SetError, and SDL_SYS_HapticOpen().

Referenced by SDL_HapticOpenFromMouse().

109 {
110  SDL_Haptic *haptic;
111  SDL_Haptic *hapticlist;
112 
113  if ((device_index < 0) || (device_index >= SDL_NumHaptics())) {
114  SDL_SetError("Haptic: There are %d haptic devices available",
115  SDL_NumHaptics());
116  return NULL;
117  }
118 
119  hapticlist = SDL_haptics;
120  /* If the haptic is already open, return it
121  * TODO: Should we create haptic instance IDs like the Joystick API?
122  */
123  while ( hapticlist )
124  {
125  if (device_index == hapticlist->index) {
126  haptic = hapticlist;
127  ++haptic->ref_count;
128  return haptic;
129  }
130  hapticlist = hapticlist->next;
131  }
132 
133  /* Create the haptic device */
134  haptic = (SDL_Haptic *) SDL_malloc((sizeof *haptic));
135  if (haptic == NULL) {
136  SDL_OutOfMemory();
137  return NULL;
138  }
139 
140  /* Initialize the haptic device */
141  SDL_memset(haptic, 0, (sizeof *haptic));
142  haptic->rumble_id = -1;
143  haptic->index = device_index;
144  if (SDL_SYS_HapticOpen(haptic) < 0) {
145  SDL_free(haptic);
146  return NULL;
147  }
148 
149  /* Add haptic to list */
150  ++haptic->ref_count;
151  /* Link the haptic in the list */
152  haptic->next = SDL_haptics;
154 
155  /* Disable autocenter and set gain to max. */
156  if (haptic->supported & SDL_HAPTIC_GAIN)
157  SDL_HapticSetGain(haptic, 100);
158  if (haptic->supported & SDL_HAPTIC_AUTOCENTER)
159  SDL_HapticSetAutocenter(haptic, 0);
160 
161  return haptic;
162 }
#define SDL_HAPTIC_AUTOCENTER
Device can set autocenter.
Definition: SDL_haptic.h:280
#define SDL_HAPTIC_GAIN
Device can set global gain.
Definition: SDL_haptic.h:271
int SDL_SYS_HapticOpen(SDL_Haptic *haptic)
int SDL_HapticSetGain(SDL_Haptic *haptic, int gain)
Sets the global gain of the device.
Definition: SDL_haptic.c:621
#define SDL_free
int SDL_NumHaptics(void)
Count the number of haptic devices attached to the system.
Definition: SDL_haptic.c:83
int SDL_HapticSetAutocenter(SDL_Haptic *haptic, int autocenter)
Sets the global autocenter of the device.
Definition: SDL_haptic.c:666
#define NULL
Definition: begin_code.h:164
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
#define SDL_malloc
#define SDL_memset
SDL_Haptic * SDL_haptics
Definition: SDL_haptic.c:29

◆ SDL_HapticOpened()

int SDL_HapticOpened ( int  device_index)

Checks if the haptic device at index has been opened.

Parameters
device_indexIndex to check to see if it has been opened.
Returns
1 if it has been opened or 0 if it hasn't.
See also
SDL_HapticOpen
SDL_HapticIndex

Definition at line 169 of file SDL_haptic.c.

References SDL_haptics, SDL_NumHaptics(), and SDL_SetError.

170 {
171  int opened;
172  SDL_Haptic *hapticlist;
173 
174  /* Make sure it's valid. */
175  if ((device_index < 0) || (device_index >= SDL_NumHaptics())) {
176  SDL_SetError("Haptic: There are %d haptic devices available",
177  SDL_NumHaptics());
178  return 0;
179  }
180 
181  opened = 0;
182  hapticlist = SDL_haptics;
183  /* TODO Should this use an instance ID? */
184  while ( hapticlist )
185  {
186  if (hapticlist->index == (Uint8) device_index) {
187  opened = 1;
188  break;
189  }
190  hapticlist = hapticlist->next;
191  }
192  return opened;
193 }
uint8_t Uint8
Definition: SDL_stdinc.h:157
int SDL_NumHaptics(void)
Count the number of haptic devices attached to the system.
Definition: SDL_haptic.c:83
#define SDL_SetError
SDL_Haptic * SDL_haptics
Definition: SDL_haptic.c:29

◆ SDL_HapticOpenFromJoystick()

SDL_Haptic* SDL_HapticOpenFromJoystick ( SDL_Joystick *  joystick)

Opens a haptic device for use from a joystick device.

You must still close the haptic device separately. It will not be closed with the joystick.

When opening from a joystick you should first close the haptic device before 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.

Parameters
joystickJoystick to create a haptic device from.
Returns
A valid haptic device identifier on success or NULL on error.
See also
SDL_HapticOpen
SDL_HapticClose

Definition at line 269 of file SDL_haptic.c.

References haptic, NULL, SDL_free, SDL_haptics, SDL_malloc, SDL_memset, SDL_NumHaptics(), SDL_OutOfMemory, SDL_PrivateJoystickValid(), SDL_SetError, SDL_SYS_HapticOpenFromJoystick(), SDL_SYS_JoystickIsHaptic(), and SDL_SYS_JoystickSameHaptic().

270 {
271  SDL_Haptic *haptic;
272  SDL_Haptic *hapticlist;
273 
274  /* Make sure there is room. */
275  if (SDL_NumHaptics() <= 0) {
276  SDL_SetError("Haptic: There are %d haptic devices available",
277  SDL_NumHaptics());
278  return NULL;
279  }
280 
281  /* Must be a valid joystick */
282  if (!SDL_PrivateJoystickValid(joystick)) {
283  SDL_SetError("Haptic: Joystick isn't valid.");
284  return NULL;
285  }
286 
287  /* Joystick must be haptic */
288  if (SDL_SYS_JoystickIsHaptic(joystick) <= 0) {
289  SDL_SetError("Haptic: Joystick isn't a haptic device.");
290  return NULL;
291  }
292 
293  hapticlist = SDL_haptics;
294  /* Check to see if joystick's haptic is already open */
295  while ( hapticlist )
296  {
297  if (SDL_SYS_JoystickSameHaptic(hapticlist, joystick)) {
298  haptic = hapticlist;
299  ++haptic->ref_count;
300  return haptic;
301  }
302  hapticlist = hapticlist->next;
303  }
304 
305  /* Create the haptic device */
306  haptic = (SDL_Haptic *) SDL_malloc((sizeof *haptic));
307  if (haptic == NULL) {
308  SDL_OutOfMemory();
309  return NULL;
310  }
311 
312  /* Initialize the haptic device */
313  SDL_memset(haptic, 0, sizeof(SDL_Haptic));
314  haptic->rumble_id = -1;
315  if (SDL_SYS_HapticOpenFromJoystick(haptic, joystick) < 0) {
316  SDL_SetError("Haptic: SDL_SYS_HapticOpenFromJoystick failed.");
317  SDL_free(haptic);
318  return NULL;
319  }
320 
321  /* Add haptic to list */
322  ++haptic->ref_count;
323  /* Link the haptic in the list */
324  haptic->next = SDL_haptics;
326 
327  return haptic;
328 }
int SDL_SYS_HapticOpenFromJoystick(SDL_Haptic *haptic, SDL_Joystick *joystick)
int SDL_PrivateJoystickValid(SDL_Joystick *joystick)
Definition: SDL_joystick.c:259
int SDL_SYS_JoystickSameHaptic(SDL_Haptic *haptic, SDL_Joystick *joystick)
#define SDL_free
int SDL_NumHaptics(void)
Count the number of haptic devices attached to the system.
Definition: SDL_haptic.c:83
int SDL_SYS_JoystickIsHaptic(SDL_Joystick *joystick)
#define NULL
Definition: begin_code.h:164
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
#define SDL_malloc
#define SDL_memset
SDL_Haptic * SDL_haptics
Definition: SDL_haptic.c:29

◆ SDL_HapticOpenFromMouse()

SDL_Haptic* SDL_HapticOpenFromMouse ( void  )

Tries to open a haptic device from the current mouse.

Returns
The haptic device identifier or NULL on error.
See also
SDL_MouseIsHaptic
SDL_HapticOpen

Definition at line 226 of file SDL_haptic.c.

References NULL, SDL_HapticOpen(), SDL_SetError, and SDL_SYS_HapticMouse().

227 {
228  int device_index;
229 
230  device_index = SDL_SYS_HapticMouse();
231 
232  if (device_index < 0) {
233  SDL_SetError("Haptic: Mouse isn't a haptic device.");
234  return NULL;
235  }
236 
237  return SDL_HapticOpen(device_index);
238 }
int SDL_SYS_HapticMouse(void)
SDL_Haptic * SDL_HapticOpen(int device_index)
Opens a haptic device for use.
Definition: SDL_haptic.c:108
#define NULL
Definition: begin_code.h:164
#define SDL_SetError

◆ SDL_HapticPause()

int SDL_HapticPause ( SDL_Haptic *  haptic)

Pauses a haptic device.

Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_HapticUnpause() to resume playback.

Do not modify the effects nor add new ones while the device is paused. That can cause all sorts of weird errors.

Parameters
hapticHaptic device to pause.
Returns
0 on success or -1 on error.
See also
SDL_HapticUnpause

Definition at line 691 of file SDL_haptic.c.

References SDL_HAPTIC_PAUSE, SDL_SetError, SDL_SYS_HapticPause(), and ValidHaptic().

692 {
693  if (!ValidHaptic(haptic)) {
694  return -1;
695  }
696 
697  if ((haptic->supported & SDL_HAPTIC_PAUSE) == 0) {
698  return SDL_SetError("Haptic: Device does not support setting pausing.");
699  }
700 
701  return SDL_SYS_HapticPause(haptic);
702 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
#define SDL_HAPTIC_PAUSE
Device can be paused.
Definition: SDL_haptic.h:299
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
int SDL_SYS_HapticPause(SDL_Haptic *haptic)

◆ SDL_HapticQuery()

unsigned int SDL_HapticQuery ( SDL_Haptic *  haptic)

Gets the haptic device's supported features in bitwise manner.

Example:

printf("We have constant haptic effect!\n");
}
Parameters
hapticThe haptic device to query.
Returns
Haptic features in bitwise manner (OR'd).
See also
SDL_HapticNumEffects
SDL_HapticEffectSupported

Definition at line 429 of file SDL_haptic.c.

References ValidHaptic().

430 {
431  if (!ValidHaptic(haptic)) {
432  return 0; /* same as if no effects were supported */
433  }
434 
435  return haptic->supported;
436 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticQuit()

void SDL_HapticQuit ( void  )

Definition at line 390 of file SDL_haptic.c.

References NULL, SDL_assert, SDL_haptics, and SDL_SYS_HapticQuit().

Referenced by SDL_QuitSubSystem().

391 {
394  SDL_haptics = NULL;
395 }
#define SDL_assert(condition)
Definition: SDL_assert.h:169
#define NULL
Definition: begin_code.h:164
void SDL_SYS_HapticQuit(void)
SDL_Haptic * SDL_haptics
Definition: SDL_haptic.c:29

◆ SDL_HapticRumbleInit()

int SDL_HapticRumbleInit ( SDL_Haptic *  haptic)

Initializes the haptic device for simple rumble playback.

Parameters
hapticHaptic device to initialize for simple rumble playback.
Returns
0 on success or -1 on error.
See also
SDL_HapticOpen
SDL_HapticRumbleSupported
SDL_HapticRumblePlay
SDL_HapticRumbleStop

Definition at line 752 of file SDL_haptic.c.

References SDL_HapticPeriodic::attack_length, SDL_HapticPeriodic::fade_length, SDL_HapticLeftRight::large_magnitude, SDL_HapticEffect::leftright, SDL_HapticPeriodic::length, SDL_HapticLeftRight::length, SDL_HapticPeriodic::magnitude, SDL_HapticPeriodic::period, SDL_HapticEffect::periodic, SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_SINE, SDL_HapticNewEffect(), SDL_SetError, SDL_zerop, SDL_HapticLeftRight::small_magnitude, SDL_HapticEffect::type, and ValidHaptic().

753 {
754  SDL_HapticEffect *efx = &haptic->rumble_effect;
755 
756  if (!ValidHaptic(haptic)) {
757  return -1;
758  }
759 
760  /* Already allocated. */
761  if (haptic->rumble_id >= 0) {
762  return 0;
763  }
764 
765  SDL_zerop(efx);
766  if (haptic->supported & SDL_HAPTIC_SINE) {
767  efx->type = SDL_HAPTIC_SINE;
768  efx->periodic.period = 1000;
769  efx->periodic.magnitude = 0x4000;
770  efx->periodic.length = 5000;
771  efx->periodic.attack_length = 0;
772  efx->periodic.fade_length = 0;
773  } else if (haptic->supported & SDL_HAPTIC_LEFTRIGHT) { /* XInput? */
774  efx->type = SDL_HAPTIC_LEFTRIGHT;
775  efx->leftright.length = 5000;
776  efx->leftright.large_magnitude = 0x4000;
777  efx->leftright.small_magnitude = 0x4000;
778  } else {
779  return SDL_SetError("Device doesn't support rumble");
780  }
781 
782  haptic->rumble_id = SDL_HapticNewEffect(haptic, &haptic->rumble_effect);
783  if (haptic->rumble_id >= 0) {
784  return 0;
785  }
786  return -1;
787 }
int SDL_HapticNewEffect(SDL_Haptic *haptic, SDL_HapticEffect *effect)
Creates a new haptic effect on the device.
Definition: SDL_haptic.c:471
#define SDL_HAPTIC_SINE
Sine wave effect supported.
Definition: SDL_haptic.h:161
#define SDL_zerop(x)
Definition: SDL_stdinc.h:417
The generic template for any haptic effect.
Definition: SDL_haptic.h:789
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
SDL_HapticLeftRight leftright
Definition: SDL_haptic.h:797
#define SDL_HAPTIC_LEFTRIGHT
Left/Right effect supported.
Definition: SDL_haptic.h:172
SDL_HapticPeriodic periodic
Definition: SDL_haptic.h:794

◆ SDL_HapticRumblePlay()

int SDL_HapticRumblePlay ( SDL_Haptic *  haptic,
float  strength,
Uint32  length 
)

Runs simple rumble on a haptic device.

Parameters
hapticHaptic device to play rumble effect on.
strengthStrength of the rumble to play as a 0-1 float value.
lengthLength of the rumble to play in milliseconds.
Returns
0 on success or -1 on error.
See also
SDL_HapticRumbleSupported
SDL_HapticRumbleInit
SDL_HapticRumbleStop

Definition at line 793 of file SDL_haptic.c.

References SDL_HapticLeftRight::large_magnitude, SDL_HapticEffect::leftright, SDL_HapticPeriodic::length, SDL_HapticLeftRight::length, SDL_HapticPeriodic::magnitude, SDL_HapticEffect::periodic, SDL_assert, SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_SINE, SDL_HapticRunEffect(), SDL_HapticUpdateEffect(), SDL_SetError, SDL_HapticLeftRight::small_magnitude, SDL_HapticEffect::type, and ValidHaptic().

794 {
795  SDL_HapticEffect *efx;
796  Sint16 magnitude;
797 
798  if (!ValidHaptic(haptic)) {
799  return -1;
800  }
801 
802  if (haptic->rumble_id < 0) {
803  return SDL_SetError("Haptic: Rumble effect not initialized on haptic device");
804  }
805 
806  /* Clamp strength. */
807  if (strength > 1.0f) {
808  strength = 1.0f;
809  } else if (strength < 0.0f) {
810  strength = 0.0f;
811  }
812  magnitude = (Sint16)(32767.0f*strength);
813 
814  efx = &haptic->rumble_effect;
815  if (efx->type == SDL_HAPTIC_SINE) {
816  efx->periodic.magnitude = magnitude;
817  efx->periodic.length = length;
818  } else if (efx->type == SDL_HAPTIC_LEFTRIGHT) {
819  efx->leftright.small_magnitude = efx->leftright.large_magnitude = magnitude;
820  efx->leftright.length = length;
821  } else {
822  SDL_assert(0 && "This should have been caught elsewhere");
823  }
824 
825  if (SDL_HapticUpdateEffect(haptic, haptic->rumble_id, &haptic->rumble_effect) < 0) {
826  return -1;
827  }
828 
829  return SDL_HapticRunEffect(haptic, haptic->rumble_id, 1);
830 }
GLfloat f
#define SDL_HAPTIC_SINE
Sine wave effect supported.
Definition: SDL_haptic.h:161
The generic template for any haptic effect.
Definition: SDL_haptic.h:789
int SDL_HapticRunEffect(SDL_Haptic *haptic, int effect, Uint32 iterations)
Runs the haptic effect on its associated haptic device.
Definition: SDL_haptic.c:549
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
#define SDL_assert(condition)
Definition: SDL_assert.h:169
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
SDL_HapticLeftRight leftright
Definition: SDL_haptic.h:797
int SDL_HapticUpdateEffect(SDL_Haptic *haptic, int effect, SDL_HapticEffect *data)
Updates the properties of an effect.
Definition: SDL_haptic.c:521
GLuint GLsizei GLsizei * length
#define SDL_HAPTIC_LEFTRIGHT
Left/Right effect supported.
Definition: SDL_haptic.h:172
SDL_HapticPeriodic periodic
Definition: SDL_haptic.h:794
int16_t Sint16
Definition: SDL_stdinc.h:163

◆ SDL_HapticRumbleStop()

int SDL_HapticRumbleStop ( SDL_Haptic *  haptic)

Stops the simple rumble on a haptic device.

Parameters
hapticHaptic to stop the rumble on.
Returns
0 on success or -1 on error.
See also
SDL_HapticRumbleSupported
SDL_HapticRumbleInit
SDL_HapticRumblePlay

Definition at line 836 of file SDL_haptic.c.

References SDL_HapticStopEffect(), SDL_SetError, and ValidHaptic().

837 {
838  if (!ValidHaptic(haptic)) {
839  return -1;
840  }
841 
842  if (haptic->rumble_id < 0) {
843  return SDL_SetError("Haptic: Rumble effect not initialized on haptic device");
844  }
845 
846  return SDL_HapticStopEffect(haptic, haptic->rumble_id);
847 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
int SDL_HapticStopEffect(SDL_Haptic *haptic, int effect)
Stops the haptic effect on its associated haptic device.
Definition: SDL_haptic.c:568

◆ SDL_HapticRumbleSupported()

int SDL_HapticRumbleSupported ( SDL_Haptic *  haptic)

Checks to see if rumble is supported on a haptic device.

Parameters
hapticHaptic device to check to see if it supports rumble.
Returns
SDL_TRUE if effect is supported, SDL_FALSE if it isn't or -1 on error.
See also
SDL_HapticRumbleInit
SDL_HapticRumblePlay
SDL_HapticRumbleStop

Definition at line 738 of file SDL_haptic.c.

References SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_SINE, and ValidHaptic().

739 {
740  if (!ValidHaptic(haptic)) {
741  return -1;
742  }
743 
744  /* Most things can use SINE, but XInput only has LEFTRIGHT. */
745  return ((haptic->supported & (SDL_HAPTIC_SINE|SDL_HAPTIC_LEFTRIGHT)) != 0);
746 }
#define SDL_HAPTIC_SINE
Sine wave effect supported.
Definition: SDL_haptic.h:161
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_HAPTIC_LEFTRIGHT
Left/Right effect supported.
Definition: SDL_haptic.h:172

◆ SDL_HapticRunEffect()

int SDL_HapticRunEffect ( SDL_Haptic *  haptic,
int  effect,
Uint32  iterations 
)

Runs the haptic effect on its associated haptic device.

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.

Parameters
hapticHaptic device to run the effect on.
effectIdentifier of the haptic effect to run.
iterationsNumber of iterations to run the effect. Use SDL_HAPTIC_INFINITY for infinity.
Returns
0 on success or -1 on error.
See also
SDL_HapticStopEffect
SDL_HapticDestroyEffect
SDL_HapticGetEffectStatus

Definition at line 549 of file SDL_haptic.c.

References SDL_SYS_HapticRunEffect(), ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticRumblePlay().

550 {
551  if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
552  return -1;
553  }
554 
555  /* Run the effect */
556  if (SDL_SYS_HapticRunEffect(haptic, &haptic->effects[effect], iterations)
557  < 0) {
558  return -1;
559  }
560 
561  return 0;
562 }
static int iterations
Definition: testsprite2.c:43
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
static int ValidEffect(SDL_Haptic *haptic, int effect)
Definition: SDL_haptic.c:508
int SDL_SYS_HapticRunEffect(SDL_Haptic *haptic, struct haptic_effect *effect, Uint32 iterations)

◆ SDL_HapticSetAutocenter()

int SDL_HapticSetAutocenter ( SDL_Haptic *  haptic,
int  autocenter 
)

Sets the global autocenter of the device.

Autocenter should be between 0 and 100. Setting it to 0 will disable autocentering.

Device must support the SDL_HAPTIC_AUTOCENTER feature.

Parameters
hapticHaptic device to set autocentering on.
autocenterValue to set autocenter to, 0 disables autocentering.
Returns
0 on success or -1 on error.
See also
SDL_HapticQuery

Definition at line 666 of file SDL_haptic.c.

References SDL_HAPTIC_AUTOCENTER, SDL_SetError, SDL_SYS_HapticSetAutocenter(), and ValidHaptic().

Referenced by SDL_HapticOpen().

667 {
668  if (!ValidHaptic(haptic)) {
669  return -1;
670  }
671 
672  if ((haptic->supported & SDL_HAPTIC_AUTOCENTER) == 0) {
673  return SDL_SetError("Haptic: Device does not support setting autocenter.");
674  }
675 
676  if ((autocenter < 0) || (autocenter > 100)) {
677  return SDL_SetError("Haptic: Autocenter must be between 0 and 100.");
678  }
679 
680  if (SDL_SYS_HapticSetAutocenter(haptic, autocenter) < 0) {
681  return -1;
682  }
683 
684  return 0;
685 }
#define SDL_HAPTIC_AUTOCENTER
Device can set autocenter.
Definition: SDL_haptic.h:280
int SDL_SYS_HapticSetAutocenter(SDL_Haptic *haptic, int autocenter)
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError

◆ SDL_HapticSetGain()

int SDL_HapticSetGain ( SDL_Haptic *  haptic,
int  gain 
)

Sets the global gain of the device.

Device must support the SDL_HAPTIC_GAIN feature.

The user may specify the maximum gain by setting the environment variable SDL_HAPTIC_GAIN_MAX which should be between 0 and 100. All calls to SDL_HapticSetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the maximum.

Parameters
hapticHaptic device to set the gain on.
gainValue to set the gain to, should be between 0 and 100.
Returns
0 on success or -1 on error.
See also
SDL_HapticQuery

Definition at line 621 of file SDL_haptic.c.

References NULL, SDL_atoi, SDL_getenv, SDL_HAPTIC_GAIN, SDL_SetError, SDL_SYS_HapticSetGain(), and ValidHaptic().

Referenced by SDL_HapticOpen().

622 {
623  const char *env;
624  int real_gain, max_gain;
625 
626  if (!ValidHaptic(haptic)) {
627  return -1;
628  }
629 
630  if ((haptic->supported & SDL_HAPTIC_GAIN) == 0) {
631  return SDL_SetError("Haptic: Device does not support setting gain.");
632  }
633 
634  if ((gain < 0) || (gain > 100)) {
635  return SDL_SetError("Haptic: Gain must be between 0 and 100.");
636  }
637 
638  /* We use the envvar to get the maximum gain. */
639  env = SDL_getenv("SDL_HAPTIC_GAIN_MAX");
640  if (env != NULL) {
641  max_gain = SDL_atoi(env);
642 
643  /* Check for sanity. */
644  if (max_gain < 0)
645  max_gain = 0;
646  else if (max_gain > 100)
647  max_gain = 100;
648 
649  /* We'll scale it linearly with SDL_HAPTIC_GAIN_MAX */
650  real_gain = (gain * max_gain) / 100;
651  } else {
652  real_gain = gain;
653  }
654 
655  if (SDL_SYS_HapticSetGain(haptic, real_gain) < 0) {
656  return -1;
657  }
658 
659  return 0;
660 }
#define SDL_HAPTIC_GAIN
Device can set global gain.
Definition: SDL_haptic.h:271
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
#define SDL_atoi
#define SDL_getenv
#define NULL
Definition: begin_code.h:164
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
int SDL_SYS_HapticSetGain(SDL_Haptic *haptic, int gain)

◆ SDL_HapticStopAll()

int SDL_HapticStopAll ( SDL_Haptic *  haptic)

Stops all the currently playing effects on a haptic device.

Parameters
hapticHaptic device to stop.
Returns
0 on success or -1 on error.

Definition at line 725 of file SDL_haptic.c.

References SDL_SYS_HapticStopAll(), and ValidHaptic().

726 {
727  if (!ValidHaptic(haptic)) {
728  return -1;
729  }
730 
732 }
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
int SDL_SYS_HapticStopAll(SDL_Haptic *haptic)

◆ SDL_HapticStopEffect()

int SDL_HapticStopEffect ( SDL_Haptic *  haptic,
int  effect 
)

Stops the haptic effect on its associated haptic device.

Parameters
hapticHaptic device to stop the effect on.
effectIdentifier of the effect to stop.
Returns
0 on success or -1 on error.
See also
SDL_HapticRunEffect
SDL_HapticDestroyEffect

Definition at line 568 of file SDL_haptic.c.

References SDL_SYS_HapticStopEffect(), ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticRumbleStop().

569 {
570  if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
571  return -1;
572  }
573 
574  /* Stop the effect */
575  if (SDL_SYS_HapticStopEffect(haptic, &haptic->effects[effect]) < 0) {
576  return -1;
577  }
578 
579  return 0;
580 }
int SDL_SYS_HapticStopEffect(SDL_Haptic *haptic, struct haptic_effect *effect)
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
static SDL_Haptic * haptic
Definition: testhaptic.c:25
static int ValidEffect(SDL_Haptic *haptic, int effect)
Definition: SDL_haptic.c:508

◆ SDL_HapticUnpause()

int SDL_HapticUnpause ( SDL_Haptic *  haptic)

Unpauses a haptic device.

Call to unpause after SDL_HapticPause().

Parameters
hapticHaptic device to unpause.
Returns
0 on success or -1 on error.
See also
SDL_HapticPause

Definition at line 708 of file SDL_haptic.c.

References SDL_HAPTIC_PAUSE, SDL_SYS_HapticUnpause(), and ValidHaptic().

709 {
710  if (!ValidHaptic(haptic)) {
711  return -1;
712  }
713 
714  if ((haptic->supported & SDL_HAPTIC_PAUSE) == 0) {
715  return 0; /* Not going to be paused, so we pretend it's unpaused. */
716  }
717 
719 }
int SDL_SYS_HapticUnpause(SDL_Haptic *haptic)
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
#define SDL_HAPTIC_PAUSE
Device can be paused.
Definition: SDL_haptic.h:299
static SDL_Haptic * haptic
Definition: testhaptic.c:25

◆ SDL_HapticUpdateEffect()

int SDL_HapticUpdateEffect ( SDL_Haptic *  haptic,
int  effect,
SDL_HapticEffect data 
)

Updates the properties of an effect.

Can be used dynamically, although behavior 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().

Parameters
hapticHaptic device that has the effect.
effectIdentifier of the effect to update.
dataNew effect properties to use.
Returns
0 on success or -1 on error.
See also
SDL_HapticNewEffect
SDL_HapticRunEffect
SDL_HapticDestroyEffect

Definition at line 521 of file SDL_haptic.c.

References SDL_memcpy, SDL_SetError, SDL_SYS_HapticUpdateEffect(), SDL_HapticEffect::type, ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticRumblePlay().

523 {
524  if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
525  return -1;
526  }
527 
528  /* Can't change type dynamically. */
529  if (data->type != haptic->effects[effect].effect.type) {
530  return SDL_SetError("Haptic: Updating effect type is illegal.");
531  }
532 
533  /* Updates the effect */
534  if (SDL_SYS_HapticUpdateEffect(haptic, &haptic->effects[effect], data) <
535  0) {
536  return -1;
537  }
538 
539  SDL_memcpy(&haptic->effects[effect].effect, data,
540  sizeof(SDL_HapticEffect));
541  return 0;
542 }
#define SDL_memcpy
The generic template for any haptic effect.
Definition: SDL_haptic.h:789
static int ValidHaptic(SDL_Haptic *haptic)
Definition: SDL_haptic.c:52
int SDL_SYS_HapticUpdateEffect(SDL_Haptic *haptic, struct haptic_effect *effect, SDL_HapticEffect *data)
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
static int ValidEffect(SDL_Haptic *haptic, int effect)
Definition: SDL_haptic.c:508

◆ SDL_JoystickIsHaptic()

int SDL_JoystickIsHaptic ( SDL_Joystick *  joystick)

Checks to see if a joystick has haptic features.

Parameters
joystickJoystick to test for haptic capabilities.
Returns
SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't or -1 if an error occurred.
See also
SDL_HapticOpenFromJoystick

Definition at line 245 of file SDL_haptic.c.

References SDL_FALSE, SDL_PrivateJoystickValid(), SDL_SYS_JoystickIsHaptic(), and SDL_TRUE.

246 {
247  int ret;
248 
249  /* Must be a valid joystick */
250  if (!SDL_PrivateJoystickValid(joystick)) {
251  return -1;
252  }
253 
254  ret = SDL_SYS_JoystickIsHaptic(joystick);
255 
256  if (ret > 0)
257  return SDL_TRUE;
258  else if (ret == 0)
259  return SDL_FALSE;
260  else
261  return -1;
262 }
int SDL_PrivateJoystickValid(SDL_Joystick *joystick)
Definition: SDL_joystick.c:259
int SDL_SYS_JoystickIsHaptic(SDL_Joystick *joystick)

◆ SDL_MouseIsHaptic()

int SDL_MouseIsHaptic ( void  )

Gets whether or not the current mouse has haptic capabilities.

Returns
SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
See also
SDL_HapticOpenFromMouse

Definition at line 214 of file SDL_haptic.c.

References SDL_FALSE, SDL_SYS_HapticMouse(), and SDL_TRUE.

215 {
216  if (SDL_SYS_HapticMouse() < 0)
217  return SDL_FALSE;
218  return SDL_TRUE;
219 }
int SDL_SYS_HapticMouse(void)

◆ SDL_NumHaptics()

int SDL_NumHaptics ( void  )

Count the number of haptic devices attached to the system.

Returns
Number of haptic devices detected on the system.

Definition at line 83 of file SDL_haptic.c.

References SDL_SYS_NumHaptics().

Referenced by SDL_HapticName(), SDL_HapticOpen(), SDL_HapticOpened(), and SDL_HapticOpenFromJoystick().

84 {
85  return SDL_SYS_NumHaptics();
86 }
int SDL_SYS_NumHaptics(void)

◆ ValidEffect()

static int ValidEffect ( SDL_Haptic *  haptic,
int  effect 
)
static

Definition at line 508 of file SDL_haptic.c.

References SDL_SetError.

Referenced by SDL_HapticDestroyEffect(), SDL_HapticGetEffectStatus(), SDL_HapticRunEffect(), SDL_HapticStopEffect(), and SDL_HapticUpdateEffect().

509 {
510  if ((effect < 0) || (effect >= haptic->neffects)) {
511  SDL_SetError("Haptic: Invalid effect identifier.");
512  return 0;
513  }
514  return 1;
515 }
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError

◆ ValidHaptic()

static int ValidHaptic ( SDL_Haptic *  haptic)
static

Definition at line 52 of file SDL_haptic.c.

References NULL, SDL_haptics, and SDL_SetError.

Referenced by SDL_HapticClose(), SDL_HapticDestroyEffect(), SDL_HapticEffectSupported(), SDL_HapticGetEffectStatus(), SDL_HapticIndex(), SDL_HapticNewEffect(), SDL_HapticNumAxes(), SDL_HapticNumEffects(), SDL_HapticNumEffectsPlaying(), SDL_HapticPause(), SDL_HapticQuery(), SDL_HapticRumbleInit(), SDL_HapticRumblePlay(), SDL_HapticRumbleStop(), SDL_HapticRumbleSupported(), SDL_HapticRunEffect(), SDL_HapticSetAutocenter(), SDL_HapticSetGain(), SDL_HapticStopAll(), SDL_HapticStopEffect(), SDL_HapticUnpause(), and SDL_HapticUpdateEffect().

53 {
54  int valid;
55  SDL_Haptic *hapticlist;
56 
57  valid = 0;
58  if (haptic != NULL) {
59  hapticlist = SDL_haptics;
60  while ( hapticlist )
61  {
62  if (hapticlist == haptic) {
63  valid = 1;
64  break;
65  }
66  hapticlist = hapticlist->next;
67  }
68  }
69 
70  /* Create the error here. */
71  if (valid == 0) {
72  SDL_SetError("Haptic: Invalid haptic device identifier");
73  }
74 
75  return valid;
76 }
#define NULL
Definition: begin_code.h:164
static SDL_Haptic * haptic
Definition: testhaptic.c:25
#define SDL_SetError
SDL_Haptic * SDL_haptics
Definition: SDL_haptic.c:29

Variable Documentation

◆ SDL_haptics

SDL_Haptic* SDL_haptics = NULL