107 #ifndef _SDL_haptic_h 108 #define _SDL_haptic_h 152 #define SDL_HAPTIC_CONSTANT (1u<<0) 161 #define SDL_HAPTIC_SINE (1u<<1) 172 #define SDL_HAPTIC_LEFTRIGHT (1u<<2) 184 #define SDL_HAPTIC_TRIANGLE (1u<<3) 193 #define SDL_HAPTIC_SAWTOOTHUP (1u<<4) 202 #define SDL_HAPTIC_SAWTOOTHDOWN (1u<<5) 211 #define SDL_HAPTIC_RAMP (1u<<6) 221 #define SDL_HAPTIC_SPRING (1u<<7) 231 #define SDL_HAPTIC_DAMPER (1u<<8) 241 #define SDL_HAPTIC_INERTIA (1u<<9) 251 #define SDL_HAPTIC_FRICTION (1u<<10) 258 #define SDL_HAPTIC_CUSTOM (1u<<11) 271 #define SDL_HAPTIC_GAIN (1u<<12) 280 #define SDL_HAPTIC_AUTOCENTER (1u<<13) 289 #define SDL_HAPTIC_STATUS (1u<<14) 297 #define SDL_HAPTIC_PAUSE (1u<<15) 310 #define SDL_HAPTIC_POLAR 0 317 #define SDL_HAPTIC_CARTESIAN 1 324 #define SDL_HAPTIC_SPHERICAL 2 339 #define SDL_HAPTIC_INFINITY 4294967295U 817 extern DECLSPEC
const char *SDLCALL
SDL_HapticName(
int device_index);
DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void)
Tries to open a haptic device from the current mouse.
DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index)
Opens a Haptic device for usage.
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:143
DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic *haptic)
Closes a Haptic device previously opened with SDL_HapticOpen().
SDL_HapticCustom custom
Definition: SDL_haptic.h:794
Uint16 interval
Definition: SDL_haptic.h:701
A structure containing a template for the SDL_HAPTIC_CUSTOM effect.
Definition: SDL_haptic.h:689
Sint16 level
Definition: SDL_haptic.h:470
Uint16 samples
Definition: SDL_haptic.h:706
Uint16 fade_level
Definition: SDL_haptic.h:648
struct SDL_HapticRamp SDL_HapticRamp
A structure containing a template for a Ramp effect.
DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic *haptic)
Gets the index of a haptic device.
Uint16 attack_length
Definition: SDL_haptic.h:559
Uint16 large_magnitude
Definition: SDL_haptic.h:672
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:159
struct _SDL_Haptic SDL_Haptic
The haptic structure used to identify an SDL haptic.
Definition: SDL_haptic.h:130
struct SDL_HapticPeriodic SDL_HapticPeriodic
A structure containing a template for a Periodic effect.
Uint16 fade_level
Definition: SDL_haptic.h:476
DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic *haptic)
Stops all the currently playing effects on a haptic device.
DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic *haptic, int effect)
Stops the haptic effect on its associated haptic device.
Uint8 type
Definition: SDL_haptic.h:439
Uint16 button
Definition: SDL_haptic.h:637
Sint32 dir[3]
Definition: SDL_haptic.h:440
uint16_t Uint16
An unsigned 16-bit integer type.
Definition: SDL_stdinc.h:151
Uint16 attack_level
Definition: SDL_haptic.h:560
Uint16 period
Definition: SDL_haptic.h:705
Uint16 small_magnitude
Definition: SDL_haptic.h:673
Uint16 fade_length
Definition: SDL_haptic.h:561
Uint16 attack_length
Definition: SDL_haptic.h:710
Uint16 attack_level
Definition: SDL_haptic.h:474
Uint16 delay
Definition: SDL_haptic.h:634
Uint16 delay
Definition: SDL_haptic.h:546
SDL_HapticConstant constant
Definition: SDL_haptic.h:789
Uint16 button
Definition: SDL_haptic.h:549
Uint16 type
Definition: SDL_haptic.h:458
SDL_HapticDirection direction
Definition: SDL_haptic.h:594
Uint16 button
Definition: SDL_haptic.h:466
DECLSPEC int SDLCALL SDL_HapticOpened(int device_index)
Checks if the haptic device at index has been opened.
Uint16 * data
Definition: SDL_haptic.h:707
Uint16 period
Definition: SDL_haptic.h:553
Uint32 length
Definition: SDL_haptic.h:462
DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic *haptic, int effect, SDL_HapticEffect *data)
Updates the properties of an effect.
A structure containing a template for a Constant effect.
Definition: SDL_haptic.h:455
DECLSPEC int SDLCALL SDL_HapticRumbleInit(SDL_Haptic *haptic)
Initializes the haptic device for simple rumble playback.
Uint16 button
Definition: SDL_haptic.h:700
Uint8 channels
Definition: SDL_haptic.h:704
Uint16 fade_length
Definition: SDL_haptic.h:712
DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic *haptic)
Returns the number of effects a haptic device can play at the same time.
struct SDL_HapticLeftRight SDL_HapticLeftRight
A structure containing a template for a Left/Right effect.
SDL_HapticDirection direction
Definition: SDL_haptic.h:693
DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic *haptic, SDL_HapticEffect *effect)
Creates a new haptic effect on the device.
SDL_HapticDirection direction
Definition: SDL_haptic.h:630
DECLSPEC int SDLCALL SDL_HapticRumblePlay(SDL_Haptic *haptic, float strength, Uint32 length)
Runs simple rumble on a haptic device.
Uint32 length
Definition: SDL_haptic.h:696
Uint16 button
Definition: SDL_haptic.h:601
SDL_HapticDirection direction
Definition: SDL_haptic.h:459
DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
Gets the status of the current effect on the haptic device.
Uint32 length
Definition: SDL_haptic.h:545
Uint16 delay
Definition: SDL_haptic.h:598
DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick *joystick)
Opens a Haptic device for usage from a Joystick device.
SDL_HapticCondition condition
Definition: SDL_haptic.h:791
Uint16 type
Definition: SDL_haptic.h:539
Sint16 end
Definition: SDL_haptic.h:642
DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic *haptic, int effect)
Destroys a haptic effect on the device.
int32_t Sint32
A signed 32-bit integer type.
Definition: SDL_stdinc.h:155
Uint16 fade_length
Definition: SDL_haptic.h:647
Uint16 type
Definition: SDL_haptic.h:629
Uint16 interval
Definition: SDL_haptic.h:467
A structure containing a template for a Periodic effect.
Definition: SDL_haptic.h:536
DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic *haptic, SDL_HapticEffect *effect)
Checks to see if effect is supported by haptic.
Uint16 type
Definition: SDL_haptic.h:666
Sint16 magnitude
Definition: SDL_haptic.h:554
Uint32 length
Definition: SDL_haptic.h:669
Uint16 fade_length
Definition: SDL_haptic.h:475
Uint16 fade_level
Definition: SDL_haptic.h:713
SDL_HapticDirection direction
Definition: SDL_haptic.h:542
DECLSPEC int SDLCALL SDL_MouseIsHaptic(void)
Gets whether or not the current mouse has haptic capabilities.
DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic *haptic, int effect, Uint32 iterations)
Runs the haptic effect on its associated haptic device.
Uint16 interval
Definition: SDL_haptic.h:638
The generic template for any haptic effect.
Definition: SDL_haptic.h:785
Sint16 offset
Definition: SDL_haptic.h:555
DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic *haptic, int autocenter)
Sets the global autocenter of the device.
A structure containing a template for a Condition effect.
Definition: SDL_haptic.h:589
DECLSPEC const char *SDLCALL SDL_HapticName(int device_index)
Get the implementation dependent name of a Haptic device.
DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic *haptic)
Gets the haptic device's supported features in bitwise manner.
struct SDL_HapticCondition SDL_HapticCondition
A structure containing a template for a Condition effect.
SDL_HapticLeftRight leftright
Definition: SDL_haptic.h:793
DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick *joystick)
Checks to see if a joystick has haptic features.
Uint16 delay
Definition: SDL_haptic.h:697
struct SDL_HapticConstant SDL_HapticConstant
A structure containing a template for a Constant effect.
Uint16 delay
Definition: SDL_haptic.h:463
Structure that represents a haptic direction.
Definition: SDL_haptic.h:437
DECLSPEC int SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *haptic)
Checks to see if rumble is supported on a haptic device.
struct SDL_HapticCustom SDL_HapticCustom
A structure containing a template for the SDL_HAPTIC_CUSTOM effect.
SDL_HapticRamp ramp
Definition: SDL_haptic.h:792
Uint16 type
Definition: SDL_haptic.h:788
DECLSPEC int SDLCALL SDL_HapticSetGain(SDL_Haptic *haptic, int gain)
Sets the global gain of the device.
A structure containing a template for a Ramp effect.
Definition: SDL_haptic.h:626
Uint16 fade_level
Definition: SDL_haptic.h:562
Uint16 attack_level
Definition: SDL_haptic.h:646
DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic *haptic)
Unpauses a haptic device.
SDL_HapticPeriodic periodic
Definition: SDL_haptic.h:790
Uint16 attack_length
Definition: SDL_haptic.h:645
DECLSPEC int SDLCALL SDL_HapticRumbleStop(SDL_Haptic *haptic)
Stops the simple rumble on a haptic device.
Uint32 length
Definition: SDL_haptic.h:633
DECLSPEC int SDLCALL SDL_NumHaptics(void)
Count the number of haptic devices attached to the system.
Uint16 type
Definition: SDL_haptic.h:592
int16_t Sint16
A signed 16-bit integer type.
Definition: SDL_stdinc.h:147
Sint16 start
Definition: SDL_haptic.h:641
Uint16 interval
Definition: SDL_haptic.h:602
DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic *haptic)
Returns the number of effects a haptic device can store.
struct SDL_HapticDirection SDL_HapticDirection
Structure that represents a haptic direction.
Uint16 type
Definition: SDL_haptic.h:692
Uint16 attack_length
Definition: SDL_haptic.h:473
Uint32 length
Definition: SDL_haptic.h:597
DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic *haptic)
Gets the number of haptic axes the device has.
Uint16 attack_level
Definition: SDL_haptic.h:711
Uint16 phase
Definition: SDL_haptic.h:556
DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic *haptic)
Pauses a haptic device.
A structure containing a template for a Left/Right effect.
Definition: SDL_haptic.h:663
union SDL_HapticEffect SDL_HapticEffect
The generic template for any haptic effect.
Uint16 interval
Definition: SDL_haptic.h:550