SDL
2.0
|
#include "../SDL_internal.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 | |
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 |
void SDL_HapticClose | ( | SDL_Haptic * | haptic | ) |
Closes a haptic device previously opened with SDL_HapticOpen().
haptic | Haptic 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().
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.
haptic | Device to destroy the effect on. |
effect | Identifier of the effect to destroy. |
Definition at line 586 of file SDL_haptic.c.
References 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.
haptic | Haptic device to check on. |
effect | Effect to check to see if it is supported. |
Definition at line 456 of file SDL_haptic.c.
References SDL_FALSE, SDL_TRUE, SDL_HapticEffect::type, and ValidHaptic().
Referenced by 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.
haptic | Haptic device to query the effect status on. |
effect | Identifier of the effect to query its status. |
Definition at line 604 of file SDL_haptic.c.
References SDL_HAPTIC_STATUS, SDL_SetError, SDL_SYS_HapticGetEffectStatus(), ValidEffect(), and ValidHaptic().
int SDL_HapticIndex | ( | SDL_Haptic * | haptic | ) |
Gets the index of a haptic device.
haptic | Haptic device to get the index of. |
Definition at line 200 of file SDL_haptic.c.
References ValidHaptic().
int SDL_HapticInit | ( | void | ) |
Definition at line 35 of file SDL_haptic.c.
References 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.
device_index | Index of the device to get its name. |
Definition at line 93 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.
haptic | Haptic device to create the effect on. |
effect | Properties of the effect to create. |
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().
int SDL_HapticNumAxes | ( | SDL_Haptic * | haptic | ) |
Gets the number of haptic axes the device has.
Definition at line 443 of file SDL_haptic.c.
References 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().
haptic | The haptic device to query effect max. |
Definition at line 401 of file SDL_haptic.c.
References 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.
haptic | The haptic device to query maximum playing effects. |
Definition at line 415 of file SDL_haptic.c.
References ValidHaptic().
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().
device_index | Index of the device to open. |
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().
int SDL_HapticOpened | ( | int | device_index | ) |
Checks if the haptic device at index has been opened.
device_index | Index to check to see if it has been opened. |
Definition at line 169 of file SDL_haptic.c.
References SDL_haptics, SDL_NumHaptics(), and SDL_SetError.
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.
joystick | Joystick to create a haptic device from. |
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().
SDL_Haptic* SDL_HapticOpenFromMouse | ( | void | ) |
Tries to open a haptic device from the current mouse.
Definition at line 226 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.
haptic | Haptic device to pause. |
Definition at line 691 of file SDL_haptic.c.
References SDL_HAPTIC_PAUSE, SDL_SetError, SDL_SYS_HapticPause(), and ValidHaptic().
unsigned int SDL_HapticQuery | ( | SDL_Haptic * | haptic | ) |
Gets the haptic device's supported features in bitwise manner.
Example:
haptic | The haptic device to query. |
Definition at line 429 of file SDL_haptic.c.
References ValidHaptic().
Definition at line 390 of file SDL_haptic.c.
References NULL, SDL_assert, SDL_haptics, and SDL_SYS_HapticQuit().
Referenced by SDL_QuitSubSystem().
int SDL_HapticRumbleInit | ( | SDL_Haptic * | haptic | ) |
Initializes the haptic device for simple rumble playback.
haptic | Haptic device to initialize for simple rumble playback. |
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().
int SDL_HapticRumblePlay | ( | SDL_Haptic * | haptic, |
float | strength, | ||
Uint32 | length | ||
) |
Runs simple rumble on a haptic device.
haptic | Haptic device to play rumble effect on. |
strength | Strength of the rumble to play as a 0-1 float value. |
length | Length of the rumble to play in milliseconds. |
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().
int SDL_HapticRumbleStop | ( | SDL_Haptic * | haptic | ) |
Stops the simple rumble on a haptic device.
haptic | Haptic to stop the rumble on. |
Definition at line 836 of file SDL_haptic.c.
References SDL_HapticStopEffect(), SDL_SetError, and ValidHaptic().
int SDL_HapticRumbleSupported | ( | SDL_Haptic * | haptic | ) |
Checks to see if rumble is supported on a haptic device.
haptic | Haptic device to check to see if it supports rumble. |
Definition at line 738 of file SDL_haptic.c.
References SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_SINE, 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.
haptic | Haptic device to run the effect on. |
effect | Identifier of the haptic effect to run. |
iterations | Number of iterations to run the effect. Use SDL_HAPTIC_INFINITY for infinity. |
Definition at line 549 of file SDL_haptic.c.
References SDL_SYS_HapticRunEffect(), ValidEffect(), and ValidHaptic().
Referenced by 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.
haptic | Haptic device to set autocentering on. |
autocenter | Value to set autocenter to, 0 disables autocentering. |
Definition at line 666 of file SDL_haptic.c.
References SDL_HAPTIC_AUTOCENTER, SDL_SetError, SDL_SYS_HapticSetAutocenter(), 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.
haptic | Haptic device to set the gain on. |
gain | Value to set the gain to, should be between 0 and 100. |
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().
int SDL_HapticStopAll | ( | SDL_Haptic * | haptic | ) |
Stops all the currently playing effects on a haptic device.
haptic | Haptic device to stop. |
Definition at line 725 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.
haptic | Haptic device to stop the effect on. |
effect | Identifier of the effect to stop. |
Definition at line 568 of file SDL_haptic.c.
References 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().
haptic | Haptic device to unpause. |
Definition at line 708 of file SDL_haptic.c.
References SDL_HAPTIC_PAUSE, SDL_SYS_HapticUnpause(), and ValidHaptic().
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().
haptic | Haptic device that has the effect. |
effect | Identifier of the effect to update. |
data | New effect properties to use. |
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().
int SDL_JoystickIsHaptic | ( | SDL_Joystick * | joystick | ) |
Checks to see if a joystick has haptic features.
joystick | Joystick to test for haptic capabilities. |
Definition at line 245 of file SDL_haptic.c.
References SDL_FALSE, SDL_PrivateJoystickValid(), SDL_SYS_JoystickIsHaptic(), and SDL_TRUE.
int SDL_MouseIsHaptic | ( | void | ) |
Gets whether or not the current mouse has haptic capabilities.
Definition at line 214 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.
Definition at line 83 of file SDL_haptic.c.
References SDL_SYS_NumHaptics().
Referenced by SDL_HapticName(), SDL_HapticOpen(), SDL_HapticOpened(), and SDL_HapticOpenFromJoystick().
|
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().
|
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().
SDL_Haptic* SDL_haptics = NULL |
Definition at line 29 of file SDL_haptic.c.
Referenced by SDL_HapticClose(), SDL_HapticOpen(), SDL_HapticOpened(), SDL_HapticOpenFromJoystick(), SDL_HapticQuit(), and ValidHaptic().