The SDL haptic subsystem manages haptic (force feedback) devices. More...

Classes
struct	SDL::Haptic
	The haptic structure used to identify an SDL haptic. More...

Typedefs
using	SDL::HapticRaw = SDL_Haptic*
	Alias to raw representation for Haptic.
using	SDL::HapticRef = ResourceRef<Haptic>
	Reference for Haptic.
using	SDL::HapticDirection = SDL_HapticDirection
	Structure that represents a haptic direction.
using	SDL::HapticConstant = SDL_HapticConstant
	A structure containing a template for a Constant effect.
using	SDL::HapticPeriodic = SDL_HapticPeriodic
	A structure containing a template for a Periodic effect.
using	SDL::HapticCondition = SDL_HapticCondition
	A structure containing a template for a Condition effect.
using	SDL::HapticRamp = SDL_HapticRamp
	A structure containing a template for a Ramp effect.
using	SDL::HapticLeftRight = SDL_HapticLeftRight
	A structure containing a template for a Left/Right effect.
using	SDL::HapticCustom = SDL_HapticCustom
	A structure containing a template for the HAPTIC_CUSTOM effect.
using	SDL::HapticEffect = SDL_HapticEffect
	The generic template for any haptic effect.
using	SDL::HapticID = 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.

Functions
OwnArray< HapticID >	SDL::GetHaptics ()
	Get a list of currently connected haptic devices.
const char *	SDL::GetHapticNameForID (HapticID instance_id)
	Get the implementation dependent name of a haptic device.
Haptic	SDL::OpenHaptic (HapticID instance_id)
	Open a haptic device for use.
HapticRef	SDL::GetHapticFromID (HapticID instance_id)
	Get the Haptic associated with an instance ID, if it has been opened.
HapticID	SDL::GetHapticID (HapticRef haptic)
	Get the instance ID of an opened haptic device.
const char *	SDL::GetHapticName (HapticRef haptic)
	Get the implementation dependent name of a haptic device.
bool	SDL::IsMouseHaptic ()
	Query whether or not the current mouse has haptic capabilities.
Haptic	SDL::OpenHapticFromMouse ()
	Try to open a haptic device from the current mouse.
bool	SDL::IsJoystickHaptic (JoystickRef joystick)
	Query if a joystick has haptic features.
Haptic	SDL::OpenHapticFromJoystick (JoystickRef joystick)
	Open a haptic device for use from a joystick device.
void	SDL::CloseHaptic (HapticRaw haptic)
	Close a haptic device previously opened with OpenHaptic().
int	SDL::GetMaxHapticEffects (HapticRef haptic)
	Get the number of effects a haptic device can store.
int	SDL::GetMaxHapticEffectsPlaying (HapticRef haptic)
	Get the number of effects a haptic device can play at the same time.
Uint32	SDL::GetHapticFeatures (HapticRef haptic)
	Get the haptic device's supported features in bitwise manner.
int	SDL::GetNumHapticAxes (HapticRef haptic)
	Get the number of haptic axes the device has.
bool	SDL::HapticEffectSupported (HapticRef haptic, const HapticEffect &effect)
	Check to see if an effect is supported by a haptic device.
HapticEffectID	SDL::CreateHapticEffect (HapticRef haptic, const HapticEffect &effect)
	Create a new haptic effect on a specified device.
void	SDL::UpdateHapticEffect (HapticRef haptic, HapticEffectID effect, const HapticEffect &data)
	Update the properties of an effect.
void	SDL::RunHapticEffect (HapticRef haptic, HapticEffectID effect, Uint32 iterations)
	Run the haptic effect on its associated haptic device.
void	SDL::StopHapticEffect (HapticRef haptic, HapticEffectID effect)
	Stop the haptic effect on its associated haptic device.
void	SDL::DestroyHapticEffect (HapticRef haptic, HapticEffectID effect)
	Destroy a haptic effect on the device.
bool	SDL::GetHapticEffectStatus (HapticRef haptic, HapticEffectID effect)
	Get the status of the current effect on the specified haptic device.
void	SDL::SetHapticGain (HapticRef haptic, int gain)
	Set the global gain of the specified haptic device.
void	SDL::SetHapticAutocenter (HapticRef haptic, int autocenter)
	Set the global autocenter of the device.
void	SDL::PauseHaptic (HapticRef haptic)
	Pause a haptic device.
void	SDL::ResumeHaptic (HapticRef haptic)
	Resume a haptic device.
void	SDL::StopHapticEffects (HapticRef haptic)
	Stop all the currently playing effects on a haptic device.
bool	SDL::HapticRumbleSupported (HapticRef haptic)
	Check whether rumble is supported on a haptic device.
void	SDL::InitHapticRumble (HapticRef haptic)
	Initialize a haptic device for simple rumble playback.
void	SDL::PlayHapticRumble (HapticRef haptic, float strength, Uint32 length)
	Run a simple rumble effect on a haptic device.
void	SDL::StopHapticRumble (HapticRef haptic)
	Stop the simple rumble on a haptic device.
	SDL::Haptic::Haptic (HapticID instance_id)
	Open a haptic device for use.
	SDL::Haptic::Haptic (JoystickRef joystick)
	Open a haptic device for use from a joystick device.
HapticID	SDL::Haptic::GetID ()
	Get the instance ID of an opened haptic device.
const char *	SDL::Haptic::GetName ()
	Get the implementation dependent name of a haptic device.
static Haptic	SDL::Haptic::OpenFromMouse ()
	Try to open a haptic device from the current mouse.
void	SDL::Haptic::Close ()
	Close a haptic device previously opened with OpenHaptic().
int	SDL::Haptic::GetMaxEffects ()
	Get the number of effects a haptic device can store.
int	SDL::Haptic::GetMaxEffectsPlaying ()
	Get the number of effects a haptic device can play at the same time.
Uint32	SDL::Haptic::GetFeatures ()
	Get the haptic device's supported features in bitwise manner.
int	SDL::Haptic::GetNumAxes ()
	Get the number of haptic axes the device has.
bool	SDL::Haptic::EffectSupported (const HapticEffect &effect)
	Check to see if an effect is supported by a haptic device.
HapticEffectID	SDL::Haptic::CreateEffect (const HapticEffect &effect)
	Create a new haptic effect on a specified device.
void	SDL::Haptic::UpdateEffect (HapticEffectID effect, const HapticEffect &data)
	Update the properties of an effect.
void	SDL::Haptic::RunEffect (HapticEffectID effect, Uint32 iterations)
	Run the haptic effect on its associated haptic device.
void	SDL::Haptic::StopEffect (HapticEffectID effect)
	Stop the haptic effect on its associated haptic device.
void	SDL::Haptic::DestroyEffect (HapticEffectID effect)
	Destroy a haptic effect on the device.
bool	SDL::Haptic::GetEffectStatus (HapticEffectID effect)
	Get the status of the current effect on the specified haptic device.
void	SDL::Haptic::SetGain (int gain)
	Set the global gain of the specified haptic device.
void	SDL::Haptic::SetAutocenter (int autocenter)
	Set the global autocenter of the device.
void	SDL::Haptic::Pause ()
	Pause a haptic device.
void	SDL::Haptic::Resume ()
	Resume a haptic device.
void	SDL::Haptic::StopEffects ()
	Stop all the currently playing effects on a haptic device.
bool	SDL::Haptic::RumbleSupported ()
	Check whether rumble is supported on a haptic device.
void	SDL::Haptic::InitRumble ()
	Initialize a haptic device for simple rumble playback.
void	SDL::Haptic::PlayRumble (float strength, Uint32 length)
	Run a simple rumble effect on a haptic device.
void	SDL::Haptic::StopRumble ()
	Stop the simple rumble on a haptic device.

Variables
constexpr Uint32	SDL::HAPTIC_INFINITY = SDL_HAPTIC_INFINITY
	Used to play a device an infinite number of times.

Haptic effects
using	SDL::HapticEffectID = int
	ID for haptic effects.
using	SDL::HapticEffectType = Uint32
	Type of haptic effect.
constexpr HapticEffectType	SDL::HAPTIC_CONSTANT = SDL_HAPTIC_CONSTANT
	Constant effect supported.
constexpr HapticEffectType	SDL::HAPTIC_SINE = SDL_HAPTIC_SINE
	Sine wave effect supported.
constexpr HapticEffectType	SDL::HAPTIC_SQUARE = SDL_HAPTIC_SQUARE
	Square wave effect supported.
constexpr HapticEffectType	SDL::HAPTIC_TRIANGLE = SDL_HAPTIC_TRIANGLE
	Triangle wave effect supported.
constexpr HapticEffectType	SDL::HAPTIC_SAWTOOTHUP = SDL_HAPTIC_SAWTOOTHUP
	Sawtoothup wave effect supported.
constexpr HapticEffectType	SDL::HAPTIC_SAWTOOTHDOWN = SDL_HAPTIC_SAWTOOTHDOWN
	Sawtoothdown wave effect supported.
constexpr HapticEffectType	SDL::HAPTIC_RAMP = SDL_HAPTIC_RAMP
	Ramp effect supported.
constexpr HapticEffectType	SDL::HAPTIC_SPRING = SDL_HAPTIC_SPRING
	Spring effect supported - uses axes position.
constexpr HapticEffectType	SDL::HAPTIC_DAMPER = SDL_HAPTIC_DAMPER
	Damper effect supported - uses axes velocity.
constexpr HapticEffectType	SDL::HAPTIC_INERTIA = SDL_HAPTIC_INERTIA
	Inertia effect supported - uses axes acceleration.
constexpr HapticEffectType	SDL::HAPTIC_FRICTION = SDL_HAPTIC_FRICTION
	Friction effect supported - uses axes movement.
constexpr HapticEffectType	SDL::HAPTIC_LEFTRIGHT = SDL_HAPTIC_LEFTRIGHT
	Left/Right effect supported.
constexpr HapticEffectType	SDL::HAPTIC_RESERVED1 = SDL_HAPTIC_RESERVED1
	Reserved for future use.
constexpr HapticEffectType	SDL::HAPTIC_RESERVED2 = SDL_HAPTIC_RESERVED2
	Reserved for future use.
constexpr HapticEffectType	SDL::HAPTIC_RESERVED3 = SDL_HAPTIC_RESERVED3
	Reserved for future use.
constexpr HapticEffectType	SDL::HAPTIC_CUSTOM = SDL_HAPTIC_CUSTOM
	Custom effect is supported.
constexpr HapticEffectType	SDL::HAPTIC_GAIN = SDL_HAPTIC_GAIN
	Device can set global gain.
constexpr HapticEffectType	SDL::HAPTIC_AUTOCENTER = SDL_HAPTIC_AUTOCENTER
	Device can set autocenter.
constexpr HapticEffectType	SDL::HAPTIC_STATUS = SDL_HAPTIC_STATUS
	Device can be queried for effect status.
constexpr HapticEffectType	SDL::HAPTIC_PAUSE = SDL_HAPTIC_PAUSE
	Device can be paused.

Direction encodings
using	SDL::HapticDirectionType = Uint8
	Type of coordinates used for haptic direction.
constexpr HapticDirectionType	SDL::HAPTIC_POLAR = SDL_HAPTIC_POLAR
	Uses polar coordinates for the direction.
constexpr HapticDirectionType	SDL::HAPTIC_CARTESIAN = SDL_HAPTIC_CARTESIAN
	Uses cartesian coordinates for the direction.
constexpr HapticDirectionType	SDL::HAPTIC_SPHERICAL = SDL_HAPTIC_SPHERICAL
	Uses spherical coordinates for the direction.
constexpr HapticDirectionType	SDL::HAPTIC_STEERING_AXIS = SDL_HAPTIC_STEERING_AXIS
	Use this value to play an effect on the steering wheel axis.

Detailed Description

The SDL haptic subsystem manages haptic (force feedback) devices.

The basic usage is as follows:

Initialize the subsystem (INIT_HAPTIC).
Open a haptic device.
OpenHaptic() to open from index.
OpenHapticFromJoystick() to open from an existing joystick.
Create an effect (HapticEffect).
Upload the effect with Haptic.CreateEffect().
Run the effect with Haptic.RunEffect().
(optional) Free the effect with Haptic.DestroyEffect().
Close the haptic device with Haptic.Close().

Simple rumble example:

Haptic *haptic = nullptr;
 
// Open the device
HapticID *haptics = GetHaptics(nullptr);
if (haptics) {
    haptic = OpenHaptic(haptics[0]);
    free(haptics);
}
if (haptic == nullptr)
   return;
 
// Initialize simple rumble
if (!Haptic.InitRumble(haptic))
   return;
 
// Play effect at 50% strength for 2 seconds
if (!Haptic.PlayRumble(haptic, 0.5, 2000))
   return;
Delay(2000);
 
// Clean up
Haptic.Close(haptic);

Complete example:

bool test_haptic(Joystick *joystick)
{
   Haptic *haptic;
   HapticEffect effect;
   HapticEffectID effect_id;
 
   // Open the device
   haptic = OpenHapticFromJoystick(joystick);
   if (haptic == nullptr) return false; // Most likely joystick isn't haptic
 
   // See if it can do sine waves
   if ((Haptic.GetFeatures(haptic) & HAPTIC_SINE)==0) {
      Haptic.Close(haptic); // No sine effect
      return false;
   }
 
   // Create the effect
   memset(&effect, 0, sizeof(HapticEffect)); // 0 is safe default
   effect.type = HAPTIC_SINE;
   effect.periodic.direction.type = HAPTIC_POLAR; // Polar coordinates
   effect.periodic.direction.dir[0] = 18000; // Force comes from south
   effect.periodic.period = 1000; // 1000 ms
   effect.periodic.magnitude = 20000; // 20000/32767 strength
   effect.periodic.length = 5000; // 5 seconds long
   effect.periodic.attack_length = 1000; // Takes 1 second to get max
strength effect.periodic.fade_length = 1000; // Takes 1 second to fade away
 
   // Upload the effect
   effect_id = Haptic.CreateEffect(haptic, &effect);
 
   // Test the effect
   Haptic.RunEffect(haptic, effect_id, 1);
   Delay(5000); // Wait for the effect to finish
 
   // We destroy the effect, although closing the device also does this
   Haptic.DestroyEffect(haptic, effect_id);
 
   // Close the device
   Haptic.Close(haptic);
 
   return true; // Success
}

Note that the SDL haptic subsystem is not thread-safe.

Typedef Documentation

◆ HapticCondition

using SDL::HapticCondition = SDL_HapticCondition

A structure containing a template for a Condition effect.

The struct handles the following effects:

HAPTIC_SPRING: Effect based on axes position.
HAPTIC_DAMPER: Effect based on axes velocity.
HAPTIC_INERTIA: Effect based on axes acceleration.
HAPTIC_FRICTION: Effect based on axes movement.

Direction is handled by condition internals instead of a direction member. The condition effect specific members have three parameters. The first refers to the X axis, the second refers to the Y axis and the third refers to the Z axis. The right terms refer to the positive side of the axis and the left terms refer to the negative side of the axis. Please refer to the HapticDirection diagram for which side is positive and which is negative.

Since: This struct is available since SDL 3.2.0.

See also: HapticDirection; HAPTIC_SPRING; HAPTIC_DAMPER; HAPTIC_INERTIA; HAPTIC_FRICTION; HapticEffect

◆ HapticConstant

using SDL::HapticConstant = SDL_HapticConstant

A structure containing a template for a Constant effect.

This struct is exclusively for the HAPTIC_CONSTANT effect.

A constant effect applies a constant force in the specified direction to the joystick.

Since: This struct is available since SDL 3.2.0.

See also: HAPTIC_CONSTANT; HapticEffect

◆ HapticCustom

using SDL::HapticCustom = SDL_HapticCustom

A structure containing a template for the HAPTIC_CUSTOM effect.

This struct is exclusively for the HAPTIC_CUSTOM effect.

A custom force feedback effect is much like a periodic effect, where the application can define its exact shape. You will have to allocate the data yourself. Data should consist of channels * samples Uint16 samples.

If channels is one, the effect is rotated using the defined direction. Otherwise it uses the samples in data for the different axes.

Since: This struct is available since SDL 3.2.0.

See also: HAPTIC_CUSTOM; HapticEffect

◆ HapticDirection

using SDL::HapticDirection = SDL_HapticDirection

Structure that represents a haptic direction.

This is the direction where the force comes from, instead of the direction in which the force is exerted.

Directions can be specified by:

HAPTIC_POLAR : Specified by polar coordinates.
HAPTIC_CARTESIAN : Specified by cartesian coordinates.
HAPTIC_SPHERICAL : Specified by spherical coordinates.

Cardinal directions of the haptic device are relative to the positioning of the device. North is considered to be away from the user.

The following diagram represents the cardinal directions:

              .--.
              |__| .-------.
              |=.| |.-----.|
              |--| ||     ||
              |  | |'-----'|
              |__|~')_____('
                [ COMPUTER ]
 
 
                  North (0,-1)
                      ^
                      |
                      |
(-1,0)  West <----[ HAPTIC ]----> East (1,0)
                      |
                      |
                      v
                   South (0,1)
 
 
                   [ USER ]
                     \|||/
                     (o o)
               ---ooO-(_)-Ooo---

If type is HAPTIC_POLAR, direction is encoded by hundredths of a degree starting north and turning clockwise. HAPTIC_POLAR only uses the first dir parameter. The cardinal directions would be:

North: 0 (0 degrees)
East: 9000 (90 degrees)
South: 18000 (180 degrees)
West: 27000 (270 degrees)

If type is HAPTIC_CARTESIAN, direction is encoded by three positions (X axis, Y axis and Z axis (with 3 axes)). HAPTIC_CARTESIAN uses the first three dir parameters. The cardinal directions would be:

North: 0,-1, 0
East: 1, 0, 0
South: 0, 1, 0
West: -1, 0, 0

The Z axis represents the height of the effect if supported, otherwise it's unused. In cartesian encoding (1, 2) would be the same as (2, 4), you can use any multiple you want, only the direction matters.

If type is HAPTIC_SPHERICAL, direction is encoded by two rotations. The first two dir parameters are used. The dir parameters are as follows (all values are in hundredths of degrees):

Degrees from (1, 0) rotated towards (0, 1).
Degrees towards (0, 0, 1) (device needs at least 3 axes).

Example of force coming from the south with all encodings (force coming from the south means the user will have to pull the stick to counteract):

 HapticDirection direction;
 
 // Cartesian directions
 direction.type = HAPTIC_CARTESIAN; // Using cartesian direction encoding.
 direction.dir[0] = 0; // X position
 direction.dir[1] = 1; // Y position
 // Assuming the device has 2 axes, we don't need to specify third parameter.
 
 // Polar directions
 direction.type = HAPTIC_POLAR; // We'll be using polar direction encoding.
 direction.dir[0] = 18000; // Polar only uses first parameter
 
 // Spherical coordinates
 direction.type = HAPTIC_SPHERICAL; // Spherical encoding
 direction.dir[0] = 9000; // Since we only have two axes we don't need more
parameters.

Since: This struct is available since SDL 3.2.0.

See also: HAPTIC_POLAR; HAPTIC_CARTESIAN; HAPTIC_SPHERICAL; HAPTIC_STEERING_AXIS; HapticEffect; Haptic.GetNumAxes

◆ HapticEffect

using SDL::HapticEffect = SDL_HapticEffect

The generic template for any haptic effect.

All values max at 32767 (0x7FFF). Signed values also can be negative. Time values unless specified otherwise are in milliseconds.

You can also pass HAPTIC_INFINITY to length instead of a 0-32767 value. Neither delay, interval, attack_length nor fade_length support HAPTIC_INFINITY. Fade will also not be used since effect never ends.

Additionally, the HAPTIC_RAMP effect does not support a duration of HAPTIC_INFINITY.

Button triggers may not be supported on all devices, it is advised to not use them if possible. Buttons start at index 1 instead of index 0 like the joystick.

If both attack_length and fade_level are 0, the envelope is not used, otherwise both values are used.

Common parts:

// Replay - All effects have this
Uint32 length;        // Duration of effect (ms).
Uint16 delay;         // Delay before starting effect.
 
// Trigger - All effects have this
Uint16 button;        // Button that triggers effect.
Uint16 interval;      // How soon before effect can be triggered again.
 
// Envelope - All effects except condition effects have this
Uint16 attack_length; // Duration of the attack (ms).
Uint16 attack_level;  // Level at the start of the attack.
Uint16 fade_length;   // Duration of the fade out (ms).
Uint16 fade_level;    // Level at the end of the fade.

Here we have an example of a constant effect evolution in time:

Strength
^
|
|    effect level -->  _________________
|                     /                 \
|                    /                   \
|                   /                     \
|                  /                       \
| attack_level --> |                        \
|                  |                        |  <---  fade_level
|
+--------------------------------------------------> Time
                   [--]                 [---]
                   attack_length        fade_length
 
[------------------][-----------------------]
delay               length

Note either the attack_level or the fade_level may be above the actual effect level.

Since: This struct is available since SDL 3.2.0.

See also: HapticConstant; HapticPeriodic; HapticCondition; HapticRamp; HapticLeftRight; HapticCustom

◆ HapticEffectID

using SDL::HapticEffectID = int

ID for haptic effects.

This is -1 if the ID is invalid.

See also: Haptic.CreateEffect

◆ HapticID

using SDL::HapticID = 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.

Since: This datatype is available since SDL 3.2.0.

◆ HapticLeftRight

using SDL::HapticLeftRight = SDL_HapticLeftRight

A structure containing a template for a Left/Right effect.

This struct is exclusively for the HAPTIC_LEFTRIGHT effect.

The Left/Right effect is used to explicitly control the large and small motors, commonly found in modern game controllers. The small (right) motor is high frequency, and the large (left) motor is low frequency.

Since: This struct is available since SDL 3.2.0.

See also: HAPTIC_LEFTRIGHT; HapticEffect

◆ HapticPeriodic

using SDL::HapticPeriodic = SDL_HapticPeriodic

A structure containing a template for a Periodic effect.

The struct handles the following effects:

HAPTIC_SINE
HAPTIC_SQUARE
HAPTIC_TRIANGLE
HAPTIC_SAWTOOTHUP
HAPTIC_SAWTOOTHDOWN

A periodic effect consists in a wave-shaped effect that repeats itself over time. The type determines the shape of the wave and the parameters determine the dimensions of the wave.

Phase is given by hundredth of a degree meaning that giving the phase a value of 9000 will displace it 25% of its period. Here are sample values:

0: No phase displacement.
9000: Displaced 25% of its period.
18000: Displaced 50% of its period.
27000: Displaced 75% of its period.
36000: Displaced 100% of its period, same as 0, but 0 is preferred.

Examples:

HAPTIC_SINE
  __      __      __      __
 /  \    /  \    /  \    /
/    @__/    @__/    @__/
 
HAPTIC_SQUARE
 __    __    __    __    __
|  |  |  |  |  |  |  |  |  |
|  |__|  |__|  |__|  |__|  |
 
HAPTIC_TRIANGLE
  /\    /\    /\    /\    /\
 /  \  /  \  /  \  /  \  /
/    \/    \/    \/    \/
 
HAPTIC_SAWTOOTHUP
  /|  /|  /|  /|  /|  /|  /|
 / | / | / | / | / | / | / |
/  |/  |/  |/  |/  |/  |/  |
 
HAPTIC_SAWTOOTHDOWN
\  |\  |\  |\  |\  |\  |\  |
 \ | \ | \ | \ | \ | \ | \ |
  \|  \|  \|  \|  \|  \|  \|

Since: This struct is available since SDL 3.2.0.

See also: HAPTIC_SINE; HAPTIC_SQUARE; HAPTIC_TRIANGLE; HAPTIC_SAWTOOTHUP; HAPTIC_SAWTOOTHDOWN; HapticEffect

◆ HapticRamp

using SDL::HapticRamp = SDL_HapticRamp

A structure containing a template for a Ramp effect.

This struct is exclusively for the HAPTIC_RAMP effect.

The ramp effect starts at start strength and ends at end strength. It augments in linear fashion. If you use attack and fade with a ramp the effects get added to the ramp effect making the effect become quadratic instead of linear.

Since: This struct is available since SDL 3.2.0.

See also: HAPTIC_RAMP; HapticEffect

◆ HapticRef

using SDL::HapticRef = ResourceRef<Haptic>

Reference for Haptic.

This does not take ownership!

Function Documentation

◆ Close()

void SDL::Haptic::Close ( )

inline

Close a haptic device previously opened with OpenHaptic().

Since: This function is available since SDL 3.2.0.

See also: OpenHaptic

◆ CloseHaptic()

void SDL::CloseHaptic ( HapticRaw haptic )

inline

Close a haptic device previously opened with OpenHaptic().

Parameters

haptic the Haptic device to close.

Since: This function is available since SDL 3.2.0.

See also: OpenHaptic

◆ CreateEffect()

HapticEffectID SDL::Haptic::CreateEffect ( const HapticEffect & effect )

inline

Create a new haptic effect on a specified device.

Parameters

effect an HapticEffect structure containing the properties of the effect to create.

Returns: the ID of the effect on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.DestroyEffect; Haptic.RunEffect; Haptic.UpdateEffect

◆ CreateHapticEffect()

HapticEffectID SDL::CreateHapticEffect	(	HapticRef	haptic,
		const HapticEffect &	effect )

inline

Create a new haptic effect on a specified device.

Parameters

haptic	an Haptic device to create the effect on.
effect	an HapticEffect structure containing the properties of the effect to create.

Returns: the ID of the effect on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.DestroyEffect; Haptic.RunEffect; Haptic.UpdateEffect

◆ DestroyEffect()

void SDL::Haptic::DestroyEffect ( HapticEffectID effect )

inline

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.

Parameters

effect the ID of the haptic effect to destroy.

Since: This function is available since SDL 3.2.0.

See also: Haptic.CreateEffect

◆ DestroyHapticEffect()

void SDL::DestroyHapticEffect	(	HapticRef	haptic,
		HapticEffectID	effect )

inline

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.

Parameters

haptic	the Haptic device to destroy the effect on.
effect	the ID of the haptic effect to destroy.

Since: This function is available since SDL 3.2.0.

See also: Haptic.CreateEffect

◆ EffectSupported()

bool SDL::Haptic::EffectSupported ( const HapticEffect & effect )

inline

Check to see if an effect is supported by a haptic device.

Parameters

effect the desired effect to query.

Returns: true if the effect is supported or false if it isn't.

Since: This function is available since SDL 3.2.0.

See also: Haptic.CreateEffect; Haptic.GetFeatures

◆ GetEffectStatus()

bool SDL::Haptic::GetEffectStatus ( HapticEffectID effect )

inline

Get the status of the current effect on the specified haptic device.

Device must support the HAPTIC_STATUS feature.

Parameters

effect the ID of the haptic effect to query its status.

Returns: true if it is playing, false if it isn't playing or haptic status isn't supported.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetFeatures

◆ GetFeatures()

Uint32 SDL::Haptic::GetFeatures ( )

inline

Get the haptic device's supported features in bitwise manner.

Returns: a list of supported haptic features in bitwise manner (OR'd) on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.EffectSupported; Haptic.GetMaxEffects

◆ GetHapticEffectStatus()

bool SDL::GetHapticEffectStatus	(	HapticRef	haptic,
		HapticEffectID	effect )

inline

Get the status of the current effect on the specified haptic device.

Device must support the HAPTIC_STATUS feature.

Parameters

haptic	the Haptic device to query for the effect status on.
effect	the ID of the haptic effect to query its status.

Returns: true if it is playing, false if it isn't playing or haptic status isn't supported.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetFeatures

◆ GetHapticFeatures()

Uint32 SDL::GetHapticFeatures ( HapticRef haptic )

inline

Get the haptic device's supported features in bitwise manner.

Parameters

haptic the Haptic device to query.

Returns: a list of supported haptic features in bitwise manner (OR'd) on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.EffectSupported; Haptic.GetMaxEffects

◆ GetHapticFromID()

HapticRef SDL::GetHapticFromID ( HapticID instance_id )

inline

Get the Haptic associated with an instance ID, if it has been opened.

Parameters

instance_id the instance ID to get the Haptic for.

Returns: an Haptic on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

◆ GetHapticID()

HapticID SDL::GetHapticID ( HapticRef haptic )

inline

Get the instance ID of an opened haptic device.

Parameters

haptic the Haptic device to query.

Returns: the instance ID of the specified haptic device on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

◆ GetHapticName()

const char * SDL::GetHapticName ( HapticRef haptic )

inline

Get the implementation dependent name of a haptic device.

Parameters

haptic the Haptic obtained from JoystickID.OpenJoystick().

Returns: the name of the selected haptic device. If no name can be found, this function returns nullptr; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: GetHapticNameForID

◆ GetHapticNameForID()

const char * SDL::GetHapticNameForID ( HapticID instance_id )

inline

Get the implementation dependent name of a haptic device.

This can be called before any haptic devices are opened.

Parameters

instance_id the haptic device instance ID.

Returns: the name of the selected haptic device. If no name can be found, this function returns nullptr; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetName; OpenHaptic

◆ GetHaptics()

OwnArray< HapticID > SDL::GetHaptics ( )

inline

Get a list of currently connected haptic devices.

Returns: a 0 terminated array of haptic device instance IDs or nullptr on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: OpenHaptic

◆ GetID()

HapticID SDL::Haptic::GetID ( )

inline

Get the instance ID of an opened haptic device.

Returns: the instance ID of the specified haptic device on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

◆ GetMaxEffects()

int SDL::Haptic::GetMaxEffects ( )

inline

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

Returns: the number of effects the haptic device can store or a negative error code on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetMaxEffectsPlaying; Haptic.GetFeatures

◆ GetMaxEffectsPlaying()

int SDL::Haptic::GetMaxEffectsPlaying ( )

inline

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.

Returns: the number of effects the haptic device can play at the same time or -1 on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetMaxEffects; Haptic.GetFeatures

◆ GetMaxHapticEffects()

int SDL::GetMaxHapticEffects ( HapticRef haptic )

inline

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

Parameters

haptic the Haptic device to query.

Returns: the number of effects the haptic device can store or a negative error code on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetMaxEffectsPlaying; Haptic.GetFeatures

◆ GetMaxHapticEffectsPlaying()

int SDL::GetMaxHapticEffectsPlaying ( HapticRef haptic )

inline

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.

Parameters

haptic the Haptic device to query maximum playing effects.

Returns: the number of effects the haptic device can play at the same time or -1 on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetMaxEffects; Haptic.GetFeatures

◆ GetName()

const char * SDL::Haptic::GetName ( )

inline

Get the implementation dependent name of a haptic device.

Returns: the name of the selected haptic device. If no name can be found, this function returns nullptr; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: GetHapticNameForID

◆ GetNumAxes()

int SDL::Haptic::GetNumAxes ( )

inline

Get the number of haptic axes the device has.

The number of haptic axes might be useful if working with the HapticDirection effect.

Returns: the number of axes on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

◆ GetNumHapticAxes()

int SDL::GetNumHapticAxes ( HapticRef haptic )

inline

Get the number of haptic axes the device has.

The number of haptic axes might be useful if working with the HapticDirection effect.

Parameters

haptic the Haptic device to query.

Returns: the number of axes on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

◆ Haptic() [1/2]

SDL::Haptic::Haptic ( HapticID instance_id )

inline

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 Haptic.SetGain() and Haptic.SetAutocenter().

Parameters

instance_id the haptic device instance ID.

Postcondition: the device identifier or nullptr on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Close; GetHaptics; OpenHapticFromJoystick; Haptic.OpenFromMouse; Haptic.SetAutocenter; Haptic.SetGain

◆ Haptic() [2/2]

SDL::Haptic::Haptic ( JoystickRef joystick )

inline

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.

Parameters

joystick the Joystick to create a haptic device from.

Postcondition: a valid haptic device identifier on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Close; IsJoystickHaptic

◆ HapticEffectSupported()

bool SDL::HapticEffectSupported	(	HapticRef	haptic,
		const HapticEffect &	effect )

inline

Check to see if an effect is supported by a haptic device.

Parameters

haptic	the Haptic device to query.
effect	the desired effect to query.

Returns: true if the effect is supported or false if it isn't.

Since: This function is available since SDL 3.2.0.

See also: Haptic.CreateEffect; Haptic.GetFeatures

◆ HapticRumbleSupported()

bool SDL::HapticRumbleSupported ( HapticRef haptic )

inline

Check whether rumble is supported on a haptic device.

Parameters

haptic haptic device to check for rumble support.

Returns: true if the effect is supported or false if it isn't.

Since: This function is available since SDL 3.2.0.

See also: Haptic.InitRumble

◆ InitHapticRumble()

void SDL::InitHapticRumble ( HapticRef haptic )

inline

Initialize a haptic device for simple rumble playback.

Parameters

haptic the haptic device to initialize for simple rumble playback.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.PlayRumble; Haptic.StopRumble; Haptic.RumbleSupported

◆ InitRumble()

void SDL::Haptic::InitRumble ( )

inline

Initialize a haptic device for simple rumble playback.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.PlayRumble; Haptic.StopRumble; Haptic.RumbleSupported

◆ IsJoystickHaptic()

bool SDL::IsJoystickHaptic ( JoystickRef joystick )

inline

Query if a joystick has haptic features.

Parameters

joystick the Joystick to test for haptic capabilities.

Returns: true if the joystick is haptic or false if it isn't.

Since: This function is available since SDL 3.2.0.

See also: OpenHapticFromJoystick

◆ IsMouseHaptic()

bool SDL::IsMouseHaptic ( )

inline

Query whether or not the current mouse has haptic capabilities.

Returns: true if the mouse is haptic or false if it isn't.

Since: This function is available since SDL 3.2.0.

See also: Haptic.OpenFromMouse

◆ OpenFromMouse()

Haptic SDL::Haptic::OpenFromMouse ( )

inlinestatic

Try to open a haptic device from the current mouse.

Returns: the haptic device identifier or nullptr on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Close; IsMouseHaptic

◆ OpenHaptic()

Haptic SDL::OpenHaptic ( HapticID instance_id )

inline

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 Haptic.SetGain() and Haptic.SetAutocenter().

Parameters

instance_id the haptic device instance ID.

Returns: the device identifier or nullptr on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Close; GetHaptics; OpenHapticFromJoystick; Haptic.OpenFromMouse; Haptic.SetAutocenter; Haptic.SetGain

◆ OpenHapticFromJoystick()

Haptic SDL::OpenHapticFromJoystick ( JoystickRef joystick )

inline

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.

Parameters

joystick the Joystick to create a haptic device from.

Returns: a valid haptic device identifier on success.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Close; IsJoystickHaptic

◆ OpenHapticFromMouse()

Haptic SDL::OpenHapticFromMouse ( )

inline

Try to open a haptic device from the current mouse.

Returns: the haptic device identifier or nullptr on failure; call GetError() for more information.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Close; IsMouseHaptic

◆ Pause()

void SDL::Haptic::Pause ( )

inline

Pause a haptic device.

Device must support the HAPTIC_PAUSE feature. Call Haptic.Resume() 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.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Resume

◆ PauseHaptic()

void SDL::PauseHaptic ( HapticRef haptic )

inline

Pause a haptic device.

Device must support the HAPTIC_PAUSE feature. Call Haptic.Resume() 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

haptic the Haptic device to pause.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Resume

◆ PlayHapticRumble()

void SDL::PlayHapticRumble	(	HapticRef	haptic,
		float	strength,
		Uint32	length )

inline

Run a simple rumble effect on a haptic device.

Parameters

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.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.InitRumble; Haptic.StopRumble

◆ PlayRumble()

void SDL::Haptic::PlayRumble	(	float	strength,
		Uint32	length )

inline

Run a simple rumble effect on a haptic device.

Parameters

strength	strength of the rumble to play as a 0-1 float value.
length	length of the rumble to play in milliseconds.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.InitRumble; Haptic.StopRumble

◆ Resume()

void SDL::Haptic::Resume ( )

inline

Resume a haptic device.

Call to unpause after Haptic.Pause().

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Pause

◆ ResumeHaptic()

void SDL::ResumeHaptic ( HapticRef haptic )

inline

Resume a haptic device.

Call to unpause after Haptic.Pause().

Parameters

haptic the Haptic device to unpause.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.Pause

◆ RumbleSupported()

bool SDL::Haptic::RumbleSupported ( )

inline

Check whether rumble is supported on a haptic device.

Returns: true if the effect is supported or false if it isn't.

Since: This function is available since SDL 3.2.0.

See also: Haptic.InitRumble

◆ RunEffect()

void SDL::Haptic::RunEffect	(	HapticEffectID	effect,
		Uint32	iterations )

inline

Run the haptic effect on its associated haptic device.

To repeat the effect over and over indefinitely, set iterations to 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 HAPTIC_INFINITY instead.

Parameters

effect	the ID of the haptic effect to run.
iterations	the number of iterations to run the effect; use HAPTIC_INFINITY to repeat forever.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetEffectStatus; Haptic.StopEffect; Haptic.StopEffects

◆ RunHapticEffect()

void SDL::RunHapticEffect	(	HapticRef	haptic,
		HapticEffectID	effect,
		Uint32	iterations )

inline

Run the haptic effect on its associated haptic device.

To repeat the effect over and over indefinitely, set iterations to 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 HAPTIC_INFINITY instead.

Parameters

haptic	the 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 HAPTIC_INFINITY to repeat forever.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetEffectStatus; Haptic.StopEffect; Haptic.StopEffects

◆ SetAutocenter()

void SDL::Haptic::SetAutocenter ( int autocenter )

inline

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 HAPTIC_AUTOCENTER feature.

Parameters

autocenter value to set autocenter to (0-100).

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetFeatures

◆ SetGain()

void SDL::Haptic::SetGain ( int gain )

inline

Set the global gain of the specified haptic device.

Device must support the 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 Haptic.SetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the maximum.

Parameters

gain	value to set the gain to, should be between 0 and 100 (0 - 100).

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetFeatures

◆ SetHapticAutocenter()

void SDL::SetHapticAutocenter	(	HapticRef	haptic,
		int	autocenter )

inline

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 HAPTIC_AUTOCENTER feature.

Parameters

haptic	the Haptic device to set autocentering on.
autocenter	value to set autocenter to (0-100).

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetFeatures

◆ SetHapticGain()

void SDL::SetHapticGain	(	HapticRef	haptic,
		int	gain )

inline

Set the global gain of the specified haptic device.

Device must support the 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 Haptic.SetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the maximum.

Parameters

haptic	the Haptic device to set the gain on.
gain	value to set the gain to, should be between 0 and 100 (0 - 100).

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.GetFeatures

◆ StopEffect()

void SDL::Haptic::StopEffect ( HapticEffectID effect )

inline

Stop the haptic effect on its associated haptic device.

Parameters

effect the ID of the haptic effect to stop.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.RunEffect; Haptic.StopEffects

◆ StopEffects()

void SDL::Haptic::StopEffects ( )

inline

Stop all the currently playing effects on a haptic device.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.RunEffect; Haptic.StopEffect

◆ StopHapticEffect()

void SDL::StopHapticEffect	(	HapticRef	haptic,
		HapticEffectID	effect )

inline

Stop the haptic effect on its associated haptic device.

Parameters

haptic	the Haptic device to stop the effect on.
effect	the ID of the haptic effect to stop.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.RunEffect; Haptic.StopEffects

◆ StopHapticEffects()

void SDL::StopHapticEffects ( HapticRef haptic )

inline

Stop all the currently playing effects on a haptic device.

Parameters

haptic the Haptic device to stop.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.RunEffect; Haptic.StopEffect

◆ StopHapticRumble()

void SDL::StopHapticRumble ( HapticRef haptic )

inline

Stop the simple rumble on a haptic device.

Parameters

haptic the haptic device to stop the rumble effect on.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.PlayRumble

◆ StopRumble()

void SDL::Haptic::StopRumble ( )

inline

Stop the simple rumble on a haptic device.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.PlayRumble

◆ UpdateEffect()

void SDL::Haptic::UpdateEffect	(	HapticEffectID	effect,
		const HapticEffect &	data )

inline

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

Parameters

effect	the identifier of the effect to update.
data	an HapticEffect structure containing the new effect properties to use.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.CreateEffect; Haptic.RunEffect

◆ UpdateHapticEffect()

void SDL::UpdateHapticEffect	(	HapticRef	haptic,
		HapticEffectID	effect,
		const HapticEffect &	data )

inline

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

Parameters

haptic	the Haptic device that has the effect.
effect	the identifier of the effect to update.
data	an HapticEffect structure containing the new effect properties to use.

Exceptions

Error on failure.

Since: This function is available since SDL 3.2.0.

See also: Haptic.CreateEffect; Haptic.RunEffect

Variable Documentation

◆ HAPTIC_AUTOCENTER

HapticEffectType SDL::HAPTIC_AUTOCENTER = SDL_HAPTIC_AUTOCENTER

constexpr

Device can set autocenter.

Device supports setting autocenter.

Since: This constant is available since SDL 3.2.0.

See also: Haptic.SetAutocenter

◆ HAPTIC_CARTESIAN

HapticDirectionType SDL::HAPTIC_CARTESIAN = SDL_HAPTIC_CARTESIAN

constexpr

Uses cartesian coordinates for the direction.

Since: This constant is available since SDL 3.2.0.

See also: HapticDirection

◆ HAPTIC_CONSTANT

HapticEffectType SDL::HAPTIC_CONSTANT = SDL_HAPTIC_CONSTANT

constexpr

Constant effect supported.

Constant haptic effect.

Since: This constant is available since SDL 3.2.0.

See also: HapticCondition

◆ HAPTIC_CUSTOM

HapticEffectType SDL::HAPTIC_CUSTOM = SDL_HAPTIC_CUSTOM

constexpr

Custom effect is supported.

User defined custom haptic effect.

Since: This constant is available since SDL 3.2.0.

◆ HAPTIC_DAMPER

HapticEffectType SDL::HAPTIC_DAMPER = SDL_HAPTIC_DAMPER

constexpr

Damper effect supported - uses axes velocity.

Condition haptic effect that simulates dampening. Effect is based on the axes velocity.

Since: This constant is available since SDL 3.2.0.

See also: HapticCondition

◆ HAPTIC_FRICTION

HapticEffectType SDL::HAPTIC_FRICTION = SDL_HAPTIC_FRICTION

constexpr

Friction effect supported - uses axes movement.

Condition haptic effect that simulates friction. Effect is based on the axes movement.

Since: This constant is available since SDL 3.2.0.

See also: HapticCondition

◆ HAPTIC_GAIN

HapticEffectType SDL::HAPTIC_GAIN = SDL_HAPTIC_GAIN

constexpr

Device can set global gain.

Device supports setting the global gain.

Since: This constant is available since SDL 3.2.0.

See also: Haptic.SetGain

◆ HAPTIC_INERTIA

HapticEffectType SDL::HAPTIC_INERTIA = SDL_HAPTIC_INERTIA

constexpr

Inertia effect supported - uses axes acceleration.

Condition haptic effect that simulates inertia. Effect is based on the axes acceleration.

Since: This constant is available since SDL 3.2.0.

See also: HapticCondition

◆ HAPTIC_INFINITY

Uint32 SDL::HAPTIC_INFINITY = SDL_HAPTIC_INFINITY

constexpr

Used to play a device an infinite number of times.

Since: This constant is available since SDL 3.2.0.

See also: Haptic.RunEffect

◆ HAPTIC_LEFTRIGHT

HapticEffectType SDL::HAPTIC_LEFTRIGHT = SDL_HAPTIC_LEFTRIGHT

constexpr

Left/Right effect supported.

Haptic effect for direct control over high/low frequency motors.

Since: This constant is available since SDL 3.2.0.

See also: HapticLeftRight

◆ HAPTIC_PAUSE

HapticEffectType SDL::HAPTIC_PAUSE = SDL_HAPTIC_PAUSE

constexpr

Device can be paused.

Devices supports being paused.

Since: This constant is available since SDL 3.2.0.

See also: Haptic.Pause; Haptic.Resume

◆ HAPTIC_POLAR

HapticDirectionType SDL::HAPTIC_POLAR = SDL_HAPTIC_POLAR

constexpr

Uses polar coordinates for the direction.

Since: This constant is available since SDL 3.2.0.

See also: HapticDirection

◆ HAPTIC_RAMP

HapticEffectType SDL::HAPTIC_RAMP = SDL_HAPTIC_RAMP

constexpr

Ramp effect supported.

Ramp haptic effect.

Since: This constant is available since SDL 3.2.0.

See also: HapticRamp

◆ HAPTIC_RESERVED1

HapticEffectType SDL::HAPTIC_RESERVED1 = SDL_HAPTIC_RESERVED1

constexpr

Reserved for future use.

Since: This constant is available since SDL 3.2.0.

◆ HAPTIC_RESERVED2

HapticEffectType SDL::HAPTIC_RESERVED2 = SDL_HAPTIC_RESERVED2

constexpr

Reserved for future use.

Since: This constant is available since SDL 3.2.0.

◆ HAPTIC_RESERVED3

HapticEffectType SDL::HAPTIC_RESERVED3 = SDL_HAPTIC_RESERVED3

constexpr

Reserved for future use.

Since: This constant is available since SDL 3.2.0.

◆ HAPTIC_SAWTOOTHDOWN

HapticEffectType SDL::HAPTIC_SAWTOOTHDOWN = SDL_HAPTIC_SAWTOOTHDOWN

constexpr

Sawtoothdown wave effect supported.

Periodic haptic effect that simulates saw tooth down waves.

Since: This constant is available since SDL 3.2.0.

See also: HapticPeriodic

◆ HAPTIC_SAWTOOTHUP

HapticEffectType SDL::HAPTIC_SAWTOOTHUP = SDL_HAPTIC_SAWTOOTHUP

constexpr

Sawtoothup wave effect supported.

Periodic haptic effect that simulates saw tooth up waves.

Since: This constant is available since SDL 3.2.0.

See also: HapticPeriodic

◆ HAPTIC_SINE

HapticEffectType SDL::HAPTIC_SINE = SDL_HAPTIC_SINE

constexpr

Sine wave effect supported.

Periodic haptic effect that simulates sine waves.

Since: This constant is available since SDL 3.2.0.

See also: HapticPeriodic

◆ HAPTIC_SPHERICAL

HapticDirectionType SDL::HAPTIC_SPHERICAL = SDL_HAPTIC_SPHERICAL

constexpr

Uses spherical coordinates for the direction.

Since: This constant is available since SDL 3.2.0.

See also: HapticDirection

◆ HAPTIC_SPRING

HapticEffectType SDL::HAPTIC_SPRING = SDL_HAPTIC_SPRING

constexpr

Spring effect supported - uses axes position.

Condition haptic effect that simulates a spring. Effect is based on the axes position.

Since: This constant is available since SDL 3.2.0.

See also: HapticCondition

◆ HAPTIC_SQUARE

HapticEffectType SDL::HAPTIC_SQUARE = SDL_HAPTIC_SQUARE

constexpr

Square wave effect supported.

Periodic haptic effect that simulates square waves.

Since: This constant is available since SDL 3.2.0.

See also: HapticPeriodic

◆ HAPTIC_STATUS

HapticEffectType SDL::HAPTIC_STATUS = SDL_HAPTIC_STATUS

constexpr

Device can be queried for effect status.

Device supports querying effect status.

Since: This constant is available since SDL 3.2.0.

See also: Haptic.GetEffectStatus

◆ HAPTIC_STEERING_AXIS

HapticDirectionType SDL::HAPTIC_STEERING_AXIS = SDL_HAPTIC_STEERING_AXIS

constexpr

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.

Since: This constant is available since SDL 3.2.0.

See also: HapticDirection

◆ HAPTIC_TRIANGLE

HapticEffectType SDL::HAPTIC_TRIANGLE = SDL_HAPTIC_TRIANGLE

constexpr

Triangle wave effect supported.

Periodic haptic effect that simulates triangular waves.

Since: This constant is available since SDL 3.2.0.

See also: HapticPeriodic

Classes

Typedefs

Functions

Variables

Haptic effects

Direction encodings

Detailed Description

Typedef Documentation

◆ HapticCondition

◆ HapticConstant

◆ HapticCustom

◆ HapticDirection

◆ HapticEffect

◆ HapticEffectID

◆ HapticID

◆ HapticLeftRight

◆ HapticPeriodic

◆ HapticRamp

◆ HapticRef

Function Documentation

◆ Close()

◆ CloseHaptic()

◆ CreateEffect()

◆ CreateHapticEffect()

◆ DestroyEffect()

◆ DestroyHapticEffect()

◆ EffectSupported()

◆ GetEffectStatus()

◆ GetFeatures()

◆ GetHapticEffectStatus()

◆ GetHapticFeatures()

◆ GetHapticFromID()

◆ GetHapticID()

◆ GetHapticName()

◆ GetHapticNameForID()

◆ GetHaptics()

◆ GetID()

◆ GetMaxEffects()

◆ GetMaxEffectsPlaying()

◆ GetMaxHapticEffects()

◆ GetMaxHapticEffectsPlaying()

◆ GetName()

◆ GetNumAxes()

◆ GetNumHapticAxes()

◆ Haptic() [1/2]

◆ Haptic() [2/2]

◆ HapticEffectSupported()

◆ HapticRumbleSupported()

◆ InitHapticRumble()

◆ InitRumble()

◆ IsJoystickHaptic()

◆ IsMouseHaptic()

◆ OpenFromMouse()

◆ OpenHaptic()

◆ OpenHapticFromJoystick()

◆ OpenHapticFromMouse()

◆ Pause()

◆ PauseHaptic()

◆ PlayHapticRumble()

◆ PlayRumble()

◆ Resume()

◆ ResumeHaptic()

◆ RumbleSupported()

◆ RunEffect()

◆ RunHapticEffect()

◆ SetAutocenter()

◆ SetGain()

◆ SetHapticAutocenter()

◆ SetHapticGain()

◆ StopEffect()

◆ StopEffects()

◆ StopHapticEffect()

◆ StopHapticEffects()

◆ StopHapticRumble()

◆ StopRumble()

◆ UpdateEffect()

◆ UpdateHapticEffect()

Variable Documentation

◆ HAPTIC_AUTOCENTER

◆ HAPTIC_CARTESIAN