SDL
2.0
|
The SDL haptic subsystem allows you to control haptic (force feedback) devices. More...
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_joystick.h"
#include "begin_code.h"
#include "close_code.h"
Go to the source code of this file.
Data Structures | |
struct | SDL_HapticDirection |
Structure that represents a haptic direction. More... | |
struct | SDL_HapticConstant |
A structure containing a template for a Constant effect. More... | |
struct | SDL_HapticPeriodic |
A structure containing a template for a Periodic effect. More... | |
struct | SDL_HapticCondition |
A structure containing a template for a Condition effect. More... | |
struct | SDL_HapticRamp |
A structure containing a template for a Ramp effect. More... | |
struct | SDL_HapticLeftRight |
A structure containing a template for a Left/Right effect. More... | |
struct | SDL_HapticCustom |
A structure containing a template for the SDL_HAPTIC_CUSTOM effect. More... | |
union | SDL_HapticEffect |
The generic template for any haptic effect. More... | |
Macros | |
Haptic effects | |
#define | SDL_HAPTIC_CONSTANT (1u<<0) |
Constant effect supported. More... | |
#define | SDL_HAPTIC_SINE (1u<<1) |
Sine wave effect supported. More... | |
#define | SDL_HAPTIC_LEFTRIGHT (1u<<2) |
Left/Right effect supported. More... | |
#define | SDL_HAPTIC_TRIANGLE (1u<<3) |
Triangle wave effect supported. More... | |
#define | SDL_HAPTIC_SAWTOOTHUP (1u<<4) |
Sawtoothup wave effect supported. More... | |
#define | SDL_HAPTIC_SAWTOOTHDOWN (1u<<5) |
Sawtoothdown wave effect supported. More... | |
#define | SDL_HAPTIC_RAMP (1u<<6) |
Ramp effect supported. More... | |
#define | SDL_HAPTIC_SPRING (1u<<7) |
Spring effect supported - uses axes position. More... | |
#define | SDL_HAPTIC_DAMPER (1u<<8) |
Damper effect supported - uses axes velocity. More... | |
#define | SDL_HAPTIC_INERTIA (1u<<9) |
Inertia effect supported - uses axes acceleration. More... | |
#define | SDL_HAPTIC_FRICTION (1u<<10) |
Friction effect supported - uses axes movement. More... | |
#define | SDL_HAPTIC_CUSTOM (1u<<11) |
Custom effect is supported. More... | |
#define | SDL_HAPTIC_GAIN (1u<<12) |
Device can set global gain. More... | |
#define | SDL_HAPTIC_AUTOCENTER (1u<<13) |
Device can set autocenter. More... | |
#define | SDL_HAPTIC_STATUS (1u<<14) |
Device can be queried for effect status. More... | |
#define | SDL_HAPTIC_PAUSE (1u<<15) |
Device can be paused. More... | |
Typedefs | |
typedef struct _SDL_Haptic | SDL_Haptic |
The haptic structure used to identify an SDL haptic. More... | |
Direction encodings | |
#define | SDL_HAPTIC_POLAR 0 |
Uses polar coordinates for the direction. More... | |
#define | SDL_HAPTIC_CARTESIAN 1 |
Uses cartesian coordinates for the direction. More... | |
#define | SDL_HAPTIC_SPHERICAL 2 |
Uses spherical coordinates for the direction. More... | |
#define | SDL_HAPTIC_STEERING_AXIS 3 |
Use this value to play an effect on the steering wheel axis. This provides better compatibility across platforms and devices as SDL will guess the correct axis. More... | |
#define | SDL_HAPTIC_INFINITY 4294967295U |
Used to play a device an infinite number of times. More... | |
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... | |
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... | |
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... | |
The SDL haptic subsystem allows you to control haptic (force feedback) devices.
The basic usage is as follows:
Definition in file SDL_haptic.h.
#define SDL_HAPTIC_AUTOCENTER (1u<<13) |
Device can set autocenter.
Device supports setting autocenter.
Definition at line 291 of file SDL_haptic.h.
#define SDL_HAPTIC_CARTESIAN 1 |
Uses cartesian coordinates for the direction.
Definition at line 330 of file SDL_haptic.h.
#define SDL_HAPTIC_CONSTANT (1u<<0) |
Constant effect supported.
Constant haptic effect.
Definition at line 163 of file SDL_haptic.h.
#define SDL_HAPTIC_CUSTOM (1u<<11) |
Custom effect is supported.
User defined custom haptic effect.
Definition at line 269 of file SDL_haptic.h.
#define SDL_HAPTIC_DAMPER (1u<<8) |
Damper effect supported - uses axes velocity.
Condition haptic effect that simulates dampening. Effect is based on the axes velocity.
Definition at line 242 of file SDL_haptic.h.
#define SDL_HAPTIC_FRICTION (1u<<10) |
Friction effect supported - uses axes movement.
Condition haptic effect that simulates friction. Effect is based on the axes movement.
Definition at line 262 of file SDL_haptic.h.
#define SDL_HAPTIC_GAIN (1u<<12) |
Device can set global gain.
Device supports setting the global gain.
Definition at line 282 of file SDL_haptic.h.
#define SDL_HAPTIC_INERTIA (1u<<9) |
Inertia effect supported - uses axes acceleration.
Condition haptic effect that simulates inertia. Effect is based on the axes acceleration.
Definition at line 252 of file SDL_haptic.h.
#define SDL_HAPTIC_INFINITY 4294967295U |
Used to play a device an infinite number of times.
Definition at line 360 of file SDL_haptic.h.
#define SDL_HAPTIC_LEFTRIGHT (1u<<2) |
Left/Right effect supported.
Haptic effect for direct control over high/low frequency motors.
Definition at line 183 of file SDL_haptic.h.
#define SDL_HAPTIC_PAUSE (1u<<15) |
Device can be paused.
Devices supports being paused.
Definition at line 310 of file SDL_haptic.h.
#define SDL_HAPTIC_POLAR 0 |
Uses polar coordinates for the direction.
Definition at line 323 of file SDL_haptic.h.
#define SDL_HAPTIC_RAMP (1u<<6) |
Ramp effect supported.
Ramp haptic effect.
Definition at line 222 of file SDL_haptic.h.
#define SDL_HAPTIC_SAWTOOTHDOWN (1u<<5) |
Sawtoothdown wave effect supported.
Periodic haptic effect that simulates saw tooth down waves.
Definition at line 213 of file SDL_haptic.h.
#define SDL_HAPTIC_SAWTOOTHUP (1u<<4) |
Sawtoothup wave effect supported.
Periodic haptic effect that simulates saw tooth up waves.
Definition at line 204 of file SDL_haptic.h.
#define SDL_HAPTIC_SINE (1u<<1) |
Sine wave effect supported.
Periodic haptic effect that simulates sine waves.
Definition at line 172 of file SDL_haptic.h.
#define SDL_HAPTIC_SPHERICAL 2 |
Uses spherical coordinates for the direction.
Definition at line 337 of file SDL_haptic.h.
#define SDL_HAPTIC_SPRING (1u<<7) |
Spring effect supported - uses axes position.
Condition haptic effect that simulates a spring. Effect is based on the axes position.
Definition at line 232 of file SDL_haptic.h.
#define SDL_HAPTIC_STATUS (1u<<14) |
Device can be queried for effect status.
Device supports querying effect status.
Definition at line 300 of file SDL_haptic.h.
#define SDL_HAPTIC_STEERING_AXIS 3 |
Use this value to play an effect on the steering wheel axis. This provides better compatibility across platforms and devices as SDL will guess the correct axis.
Definition at line 345 of file SDL_haptic.h.
#define SDL_HAPTIC_TRIANGLE (1u<<3) |
Triangle wave effect supported.
Periodic haptic effect that simulates triangular waves.
Definition at line 195 of file SDL_haptic.h.
The haptic structure used to identify an SDL haptic.
Definition at line 1 of file SDL_haptic.h.
void SDL_HapticClose | ( | SDL_Haptic * | haptic | ) |
Closes a haptic device previously opened with SDL_HapticOpen().
haptic | Haptic device to close. |
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. |
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. |
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. |
int SDL_HapticIndex | ( | SDL_Haptic * | haptic | ) |
Gets the index of a haptic device.
haptic | Haptic device to get the index of. |
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. |
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. |
int SDL_HapticNumAxes | ( | SDL_Haptic * | haptic | ) |
Gets the number of haptic axes the device has.
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. |
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. |
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. |
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. |
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. |
SDL_Haptic* SDL_HapticOpenFromMouse | ( | void | ) |
Tries to open a haptic device from the current mouse.
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. |
unsigned int SDL_HapticQuery | ( | SDL_Haptic * | haptic | ) |
Gets the haptic device's supported features in bitwise manner.
Example:
haptic | The haptic device to query. |
int SDL_HapticRumbleInit | ( | SDL_Haptic * | haptic | ) |
Initializes the haptic device for simple rumble playback.
haptic | Haptic device to initialize for simple rumble playback. |
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. |
int SDL_HapticRumbleStop | ( | SDL_Haptic * | haptic | ) |
Stops the simple rumble on a haptic device.
haptic | Haptic to stop the rumble on. |
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. |
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. |
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. |
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. |
int SDL_HapticStopAll | ( | SDL_Haptic * | haptic | ) |
Stops all the currently playing effects on a haptic device.
haptic | Haptic device to stop. |
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. |
int SDL_HapticUnpause | ( | SDL_Haptic * | haptic | ) |
Unpauses a haptic device.
Call to unpause after SDL_HapticPause().
haptic | Haptic device to unpause. |
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. |
int SDL_JoystickIsHaptic | ( | SDL_Joystick * | joystick | ) |
Checks to see if a joystick has haptic features.
joystick | Joystick to test for haptic capabilities. |
int SDL_MouseIsHaptic | ( | void | ) |
Gets whether or not the current mouse has haptic capabilities.
int SDL_NumHaptics | ( | void | ) |
Count the number of haptic devices attached to the system.