zenilib  0.5.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
SDL_haptic.c File Reference
#include "SDL_config.h"
#include "SDL_syshaptic.h"
#include "SDL_haptic_c.h"
#include "../joystick/SDL_joystick_c.h"
#include "SDL_assert.h"

Go to the source code of this file.

Functions

void SDL_HapticClose (SDL_Haptic *haptic)
 Closes a Haptic device previously opened with SDL_HapticOpen(). More...
 
void SDL_HapticDestroyEffect (SDL_Haptic *haptic, int effect)
 Destroys a haptic effect on the device. More...
 
int SDL_HapticEffectSupported (SDL_Haptic *haptic, SDL_HapticEffect *effect)
 Checks to see if effect is supported by haptic. More...
 
int SDL_HapticGetEffectStatus (SDL_Haptic *haptic, int effect)
 Gets the status of the current effect on the haptic device. More...
 
int SDL_HapticIndex (SDL_Haptic *haptic)
 Gets the index of a haptic device. More...
 
int SDL_HapticInit (void)
 
const char * SDL_HapticName (int device_index)
 Get the implementation dependent name of a Haptic device. More...
 
int SDL_HapticNewEffect (SDL_Haptic *haptic, SDL_HapticEffect *effect)
 Creates a new haptic effect on the device. More...
 
int SDL_HapticNumAxes (SDL_Haptic *haptic)
 Gets the number of haptic axes the device has. More...
 
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...
 
SDL_HapticSDL_HapticOpen (int device_index)
 Opens a Haptic device for usage. More...
 
int SDL_HapticOpened (int device_index)
 Checks if the haptic device at index has been opened. More...
 
SDL_HapticSDL_HapticOpenFromJoystick (SDL_Joystick *joystick)
 Opens a Haptic device for usage from a Joystick device. More...
 
SDL_HapticSDL_HapticOpenFromMouse (void)
 Tries to open a haptic device from the current mouse. More...
 
int SDL_HapticPause (SDL_Haptic *haptic)
 Pauses a haptic device. More...
 
unsigned int SDL_HapticQuery (SDL_Haptic *haptic)
 Gets the haptic devices supported features in bitwise matter. More...
 
void SDL_HapticQuit (void)
 
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...
 
int SDL_HapticRumbleSupported (SDL_Haptic *haptic)
 Checks to see if rumble is supported on a haptic device. More...
 
int SDL_HapticRunEffect (SDL_Haptic *haptic, int effect, Uint32 iterations)
 Runs the haptic effect on its associated haptic device. More...
 
int SDL_HapticSetAutocenter (SDL_Haptic *haptic, int autocenter)
 Sets the global autocenter of the device. More...
 
int SDL_HapticSetGain (SDL_Haptic *haptic, int gain)
 Sets the global gain of the device. More...
 
int SDL_HapticStopAll (SDL_Haptic *haptic)
 Stops all the currently playing effects on a haptic device. More...
 
int SDL_HapticStopEffect (SDL_Haptic *haptic, int effect)
 Stops the haptic effect on its associated haptic device. More...
 
int SDL_HapticUnpause (SDL_Haptic *haptic)
 Unpauses a haptic device. More...
 
int SDL_HapticUpdateEffect (SDL_Haptic *haptic, int effect, SDL_HapticEffect *data)
 Updates the properties of an effect. More...
 
int SDL_JoystickIsHaptic (SDL_Joystick *joystick)
 Checks to see if a joystick has haptic features. More...
 
int SDL_MouseIsHaptic (void)
 Gets whether or not the current mouse has haptic capabilities. More...
 
int SDL_NumHaptics (void)
 Count the number of haptic devices attached to the system. More...
 
static int ValidEffect (SDL_Haptic *haptic, int effect)
 
static int ValidHaptic (SDL_Haptic *haptic)
 

Variables

SDL_Haptic ** SDL_haptics = NULL
 
Uint8 SDL_numhaptics = 0
 

Function Documentation

void SDL_HapticClose ( SDL_Haptic haptic)

Closes a Haptic device previously opened with SDL_HapticOpen().

Parameters
hapticHaptic device to close.

Definition at line 339 of file SDL_haptic.c.

References _SDL_Haptic::effects, haptic_effect::hweffect, i, _SDL_Haptic::neffects, NULL, _SDL_Haptic::ref_count, SDL_free(), SDL_HapticDestroyEffect(), SDL_memcpy(), SDL_numhaptics, SDL_SYS_HapticClose(), and ValidHaptic().

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 576 of file SDL_haptic.c.

References _SDL_Haptic::effects, haptic_effect::hweffect, NULL, SDL_SYS_HapticDestroyEffect(), ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticClose().

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 446 of file SDL_haptic.c.

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

Referenced by Zeni::Controllers::device_added(), and SDL_HapticNewEffect().

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 594 of file SDL_haptic.c.

References _SDL_Haptic::effects, SDL_HAPTIC_STATUS, SDL_SetError(), SDL_SYS_HapticGetEffectStatus(), _SDL_Haptic::supported, ValidEffect(), and ValidHaptic().

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 203 of file SDL_haptic.c.

References _SDL_Haptic::index, and ValidHaptic().

int SDL_HapticInit ( void  )

Definition at line 36 of file SDL_haptic.c.

References NULL, SDL_malloc(), SDL_memset(), SDL_numhaptics, and SDL_SYS_HapticInit().

Referenced by SDL_InitSubSystem().

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 101 of file SDL_haptic.c.

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

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 id of the effect on success or -1 on error.
See Also
SDL_HapticUpdateEffect
SDL_HapticRunEffect
SDL_HapticDestroyEffect

Definition at line 461 of file SDL_haptic.c.

References haptic_effect::effect, _SDL_Haptic::effects, haptic_effect::hweffect, i, _SDL_Haptic::neffects, NULL, SDL_FALSE, SDL_HapticEffectSupported(), SDL_memcpy(), SDL_SetError(), SDL_SYS_HapticNewEffect(), and ValidHaptic().

Referenced by Zeni::Controllers::device_added(), and SDL_HapticRumbleInit().

int SDL_HapticNumAxes ( SDL_Haptic haptic)

Gets the number of haptic axes the device has.

See Also
SDL_HapticDirection

Definition at line 433 of file SDL_haptic.c.

References _SDL_Haptic::naxes, and ValidHaptic().

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 391 of file SDL_haptic.c.

References _SDL_Haptic::neffects, and ValidHaptic().

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 405 of file SDL_haptic.c.

References _SDL_Haptic::nplaying, and ValidHaptic().

SDL_Haptic* SDL_HapticOpen ( int  device_index)

Opens a Haptic device for usage.

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 116 of file SDL_haptic.c.

References i, _SDL_Haptic::index, NULL, _SDL_Haptic::ref_count, _SDL_Haptic::rumble_id, SDL_free(), SDL_HAPTIC_AUTOCENTER, SDL_HAPTIC_GAIN, SDL_HapticSetAutocenter(), SDL_HapticSetGain(), SDL_malloc(), SDL_memset(), SDL_numhaptics, SDL_OutOfMemory, SDL_SetError(), SDL_SYS_HapticOpen(), and _SDL_Haptic::supported.

Referenced by SDL_HapticOpenFromMouse().

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 177 of file SDL_haptic.c.

References i, SDL_numhaptics, and SDL_SetError().

SDL_Haptic* SDL_HapticOpenFromJoystick ( SDL_Joystick joystick)

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 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 272 of file SDL_haptic.c.

References i, NULL, _SDL_Haptic::ref_count, _SDL_Haptic::rumble_id, SDL_free(), SDL_malloc(), SDL_memset(), SDL_numhaptics, SDL_OutOfMemory, SDL_PrivateJoystickValid(), SDL_SetError(), SDL_SYS_HapticOpenFromJoystick(), SDL_SYS_JoystickIsHaptic(), and SDL_SYS_JoystickSameHaptic().

Referenced by Zeni::Controllers::device_added().

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 229 of file SDL_haptic.c.

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

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 681 of file SDL_haptic.c.

References SDL_HAPTIC_PAUSE, SDL_SetError(), SDL_SYS_HapticPause(), _SDL_Haptic::supported, and ValidHaptic().

unsigned int SDL_HapticQuery ( SDL_Haptic haptic)

Gets the haptic devices supported features in bitwise matter.

Example:

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

Definition at line 419 of file SDL_haptic.c.

References _SDL_Haptic::supported, and ValidHaptic().

void SDL_HapticQuit ( void  )

Definition at line 379 of file SDL_haptic.c.

References NULL, SDL_free(), SDL_numhaptics, and SDL_SYS_HapticQuit().

Referenced by SDL_QuitSubSystem().

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 783 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_Haptic::rumble_effect, _SDL_Haptic::rumble_id, SDL_assert, SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_SINE, SDL_HapticRunEffect(), SDL_HapticUpdateEffect(), SDL_SetError(), SDL_HapticLeftRight::small_magnitude, SDL_HapticEffect::type, and ValidHaptic().

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 826 of file SDL_haptic.c.

References _SDL_Haptic::rumble_id, SDL_HapticStopEffect(), SDL_SetError(), and ValidHaptic().

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 728 of file SDL_haptic.c.

References SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_SINE, _SDL_Haptic::supported, and ValidHaptic().

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 539 of file SDL_haptic.c.

References _SDL_Haptic::effects, SDL_SYS_HapticRunEffect(), ValidEffect(), and ValidHaptic().

Referenced by Zeni::Controllers::device_added(), and SDL_HapticRumblePlay().

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 656 of file SDL_haptic.c.

References SDL_HAPTIC_AUTOCENTER, SDL_SetError(), SDL_SYS_HapticSetAutocenter(), _SDL_Haptic::supported, and ValidHaptic().

Referenced by SDL_HapticOpen().

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 611 of file SDL_haptic.c.

References env, NULL, SDL_atoi(), SDL_getenv(), SDL_HAPTIC_GAIN, SDL_SetError(), SDL_SYS_HapticSetGain(), _SDL_Haptic::supported, and ValidHaptic().

Referenced by SDL_HapticOpen().

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 715 of file SDL_haptic.c.

References SDL_SYS_HapticStopAll(), and ValidHaptic().

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 558 of file SDL_haptic.c.

References _SDL_Haptic::effects, SDL_SYS_HapticStopEffect(), ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticRumbleStop().

int SDL_HapticUnpause ( SDL_Haptic haptic)

Unpauses a haptic device.

Call to unpause after SDL_HapticPause().

Parameters
hapticHaptic device to pause.
Returns
0 on success or -1 on error.
See Also
SDL_HapticPause

Definition at line 698 of file SDL_haptic.c.

References SDL_HAPTIC_PAUSE, SDL_SYS_HapticUnpause(), _SDL_Haptic::supported, and ValidHaptic().

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

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().

Parameters
hapticHaptic device that has the effect.
effectEffect 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 511 of file SDL_haptic.c.

References haptic_effect::effect, _SDL_Haptic::effects, SDL_memcpy(), SDL_SetError(), SDL_SYS_HapticUpdateEffect(), SDL_HapticEffect::type, ValidEffect(), and ValidHaptic().

Referenced by SDL_HapticRumblePlay(), and Zeni::Controllers::set_vibration().

int SDL_JoystickIsHaptic ( SDL_Joystick joystick)

Checks to see if a joystick has haptic features.

Parameters
joystickJoystick to test for haptic capabilities.
Returns
1 if the joystick is haptic, 0 if it isn't or -1 if an error ocurred.
See Also
SDL_HapticOpenFromJoystick

Definition at line 248 of file SDL_haptic.c.

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

Referenced by Zeni::Controllers::device_added().

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 217 of file SDL_haptic.c.

References SDL_FALSE, SDL_SYS_HapticMouse(), and SDL_TRUE.

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 91 of file SDL_haptic.c.

References SDL_numhaptics.

static int ValidEffect ( SDL_Haptic haptic,
int  effect 
)
static

Variable Documentation

SDL_Haptic** SDL_haptics = NULL

Definition at line 29 of file SDL_haptic.c.