SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_joystick.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Data Structures | |
struct | SDL_HapticDirection |
struct | SDL_HapticConstant |
struct | SDL_HapticPeriodic |
struct | SDL_HapticCondition |
struct | SDL_HapticRamp |
struct | SDL_HapticLeftRight |
struct | SDL_HapticCustom |
union | SDL_HapticEffect |
Macros | |
Haptic effects | |
#define | SDL_HAPTIC_CONSTANT (1u<<0) |
#define | SDL_HAPTIC_SINE (1u<<1) |
#define | SDL_HAPTIC_SQUARE (1u<<2) |
#define | SDL_HAPTIC_TRIANGLE (1u<<3) |
#define | SDL_HAPTIC_SAWTOOTHUP (1u<<4) |
#define | SDL_HAPTIC_SAWTOOTHDOWN (1u<<5) |
#define | SDL_HAPTIC_RAMP (1u<<6) |
#define | SDL_HAPTIC_SPRING (1u<<7) |
#define | SDL_HAPTIC_DAMPER (1u<<8) |
#define | SDL_HAPTIC_INERTIA (1u<<9) |
#define | SDL_HAPTIC_FRICTION (1u<<10) |
#define | SDL_HAPTIC_LEFTRIGHT (1u<<11) |
#define | SDL_HAPTIC_RESERVED1 (1u<<12) |
#define | SDL_HAPTIC_RESERVED2 (1u<<13) |
#define | SDL_HAPTIC_RESERVED3 (1u<<14) |
#define | SDL_HAPTIC_CUSTOM (1u<<15) |
#define | SDL_HAPTIC_GAIN (1u<<16) |
#define | SDL_HAPTIC_AUTOCENTER (1u<<17) |
#define | SDL_HAPTIC_STATUS (1u<<18) |
#define | SDL_HAPTIC_PAUSE (1u<<19) |
Typedefs | |
typedef struct SDL_Haptic | SDL_Haptic |
#define SDL_HAPTIC_AUTOCENTER (1u<<17) |
Device can set autocenter.
Device supports setting autocenter.
Definition at line 343 of file SDL_haptic.h.
#define SDL_HAPTIC_CARTESIAN 1 |
Uses cartesian coordinates for the direction.
Definition at line 390 of file SDL_haptic.h.
#define SDL_HAPTIC_CONSTANT (1u<<0) |
Constant effect supported.
Constant haptic effect.
Definition at line 174 of file SDL_haptic.h.
#define SDL_HAPTIC_CUSTOM (1u<<15) |
Custom effect is supported.
User defined custom haptic effect.
Definition at line 317 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 264 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 288 of file SDL_haptic.h.
#define SDL_HAPTIC_GAIN (1u<<16) |
Device can set global gain.
Device supports setting the global gain.
Definition at line 332 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 276 of file SDL_haptic.h.
#define SDL_HAPTIC_INFINITY 4294967295U |
Used to play a device an infinite number of times.
Definition at line 428 of file SDL_haptic.h.
#define SDL_HAPTIC_LEFTRIGHT (1u<<11) |
Left/Right effect supported.
Haptic effect for direct control over high/low frequency motors.
Definition at line 299 of file SDL_haptic.h.
#define SDL_HAPTIC_PAUSE (1u<<19) |
Device can be paused.
Devices supports being paused.
Definition at line 366 of file SDL_haptic.h.
#define SDL_HAPTIC_POLAR 0 |
Uses polar coordinates for the direction.
Definition at line 381 of file SDL_haptic.h.
#define SDL_HAPTIC_RAMP (1u<<6) |
Ramp effect supported.
Ramp haptic effect.
Definition at line 240 of file SDL_haptic.h.
#define SDL_HAPTIC_RESERVED1 (1u<<12) |
Reserved for future use
Definition at line 306 of file SDL_haptic.h.
#define SDL_HAPTIC_RESERVED2 (1u<<13) |
Definition at line 307 of file SDL_haptic.h.
#define SDL_HAPTIC_RESERVED3 (1u<<14) |
Definition at line 308 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 229 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 218 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 185 of file SDL_haptic.h.
#define SDL_HAPTIC_SPHERICAL 2 |
Uses spherical coordinates for the direction.
Definition at line 399 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 252 of file SDL_haptic.h.
#define SDL_HAPTIC_SQUARE (1u<<2) |
Square wave effect supported.
Periodic haptic effect that simulates square waves.
Definition at line 196 of file SDL_haptic.h.
#define SDL_HAPTIC_STATUS (1u<<18) |
Device can be queried for effect status.
Device supports querying effect status.
Definition at line 354 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 411 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 207 of file SDL_haptic.h.
typedef struct SDL_Haptic SDL_Haptic |
The SDL haptic subsystem manages haptic (force feedback) devices.
The basic usage is as follows:
Simple rumble example:
Complete example:
Note that the SDL haptic subsystem is not thread-safe. The haptic structure used to identify an SDL haptic.
Definition at line 150 of file SDL_haptic.h.
typedef Uint32 SDL_HapticID |
This is a unique ID for a haptic device for the time it is connected to the system, and is never reused for the lifetime of the application.
If the haptic device is disconnected and reconnected, it will get a new ID.
The value 0 is an invalid ID.
Definition at line 925 of file SDL_haptic.h.
|
extern |
Close a haptic device previously opened with SDL_OpenHaptic().
haptic | the SDL_Haptic device to close. |
|
extern |
Create a new haptic effect on a specified device.
haptic | an SDL_Haptic device to create the effect on. |
effect | an SDL_HapticEffect structure containing the properties of the effect to create. |
|
extern |
Destroy 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 | the SDL_Haptic device to destroy the effect on. |
effect | the ID of the haptic effect to destroy. |
|
extern |
Get the status of the current effect on the specified haptic device.
Device must support the SDL_HAPTIC_STATUS feature.
haptic | the SDL_Haptic device to query for the effect status on. |
effect | the ID of the haptic effect to query its status. |
|
extern |
Get the haptic device's supported features in bitwise manner.
haptic | the SDL_Haptic device to query. |
|
extern |
Get the SDL_Haptic associated with an instance ID, if it has been opened.
instance_id | the instance ID to get the SDL_Haptic for. |
|
extern |
Get the instance ID of an opened haptic device.
haptic | the SDL_Haptic device to query. |
|
extern |
Get the implementation dependent name of a haptic device.
haptic | the SDL_Haptic obtained from SDL_OpenJoystick(). |
|
extern |
Get the implementation dependent name of a haptic device.
This can be called before any haptic devices are opened.
instance_id | the haptic device instance ID. |
|
extern |
Get a list of currently connected haptic devices.
count | a pointer filled in with the number of haptic devices returned, may be NULL. |
|
extern |
Get 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_GetMaxHapticEffects().
haptic | the SDL_Haptic device to query. |
|
extern |
Get 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.
haptic | the SDL_Haptic device to query maximum playing effects. |
|
extern |
Get the number of haptic axes the device has.
The number of haptic axes might be useful if working with the SDL_HapticDirection effect.
haptic | the SDL_Haptic device to query. |
|
extern |
Check to see if an effect is supported by a haptic device.
haptic | the SDL_Haptic device to query. |
effect | the desired effect to query. |
|
extern |
Check whether rumble is supported on a haptic device.
haptic | haptic device to check for rumble support. |
|
extern |
Initialize a haptic device for simple rumble playback.
haptic | the haptic device to initialize for simple rumble playback. |
|
extern |
Query if a joystick has haptic features.
joystick | the SDL_Joystick to test for haptic capabilities. |
|
extern |
Query whether or not the current mouse has haptic capabilities.
|
extern |
Open 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_SetHapticGain() and SDL_SetHapticAutocenter().
instance_id | the haptic device instance ID. |
|
extern |
Open 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 opened 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 | the SDL_Joystick to create a haptic device from. |
|
extern |
Try to open a haptic device from the current mouse.
|
extern |
Pause a haptic device.
Device must support the SDL_HAPTIC_PAUSE
feature. Call SDL_ResumeHaptic() 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 | the SDL_Haptic device to pause. |
|
extern |
Run a simple rumble effect on a haptic device.
haptic | the haptic device to play the 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. |
|
extern |
Resume a haptic device.
Call to unpause after SDL_PauseHaptic().
haptic | the SDL_Haptic device to unpause. |
|
extern |
Run the haptic effect on its associated haptic device.
To repeat the effect over and over indefinitely, set iterations
to SDL_HAPTIC_INFINITY
. (Repeats the envelope - attack and fade.) To make one instance of the effect last indefinitely (so the effect does not fade), set the effect's length
in its structure/union to SDL_HAPTIC_INFINITY
instead.
haptic | the SDL_Haptic device to run the effect on. |
effect | the ID of the haptic effect to run. |
iterations | the number of iterations to run the effect; use SDL_HAPTIC_INFINITY to repeat forever. |
|
extern |
Set 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 | the SDL_Haptic device to set autocentering on. |
autocenter | value to set autocenter to (0-100). |
|
extern |
Set the global gain of the specified haptic 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_SetHapticGain() will scale linearly using SDL_HAPTIC_GAIN_MAX
as the maximum.
haptic | the SDL_Haptic device to set the gain on. |
gain | value to set the gain to, should be between 0 and 100 (0 - 100). |
|
extern |
Stop the haptic effect on its associated haptic device.
haptic | the SDL_Haptic device to stop the effect on. |
effect | the ID of the haptic effect to stop. |
|
extern |
Stop all the currently playing effects on a haptic device.
haptic | the SDL_Haptic device to stop. |
|
extern |
Stop the simple rumble on a haptic device.
haptic | the haptic device to stop the rumble effect on. |
|
extern |
Update the properties of an effect.
Can be used dynamically, although behavior when dynamically changing direction may be strange. Specifically the effect may re-upload itself and start playing from the start. You also cannot change the type either when running SDL_UpdateHapticEffect().
haptic | the SDL_Haptic device that has the effect. |
effect | the identifier of the effect to update. |
data | an SDL_HapticEffect structure containing the new effect properties to use. |