SDL_HapticCondition Struct Reference

A structure containing a template for a Condition effect. More...

#include <SDL_haptic.h>

Data Fields
Uint16	type
SDL_HapticDirection	direction
Uint32	length
Uint16	delay
Uint16	button
Uint16	interval
Uint16	right_sat [3]
Uint16	left_sat [3]
Sint16	right_coeff [3]
Sint16	left_coeff [3]
Uint16	deadband [3]
Sint16	center [3]

---

Detailed Description

A structure containing a template for a Condition effect.

The struct handles the following effects:

• SDL_HAPTIC_SPRING: Effect based on axes position.
• SDL_HAPTIC_DAMPER: Effect based on axes velocity.
• SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
• SDL_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 SDL_HapticDirection diagram for which side is positive and which is negative.

See also:

SDL_HapticDirection

SDL_HAPTIC_SPRING

SDL_HAPTIC_DAMPER

SDL_HAPTIC_INERTIA

SDL_HAPTIC_FRICTION

SDL_HapticEffect

---

Field Documentation

Uint16 button

Button that triggers the effect.

Sint16 center[3]

Position of the dead zone.

Uint16 deadband[3]

Size of the dead zone.

Uint16 delay

Delay before starting the effect.

SDL_HapticDirection direction

Direction of the effect - Not used ATM.

Uint16 interval

How soon it can be triggered again after button.

Sint16 left_coeff[3]

How fast to increase the force towards the negative side.

Uint16 left_sat[3]

Level when joystick is to the negative side.

Uint32 length

Duration of the effect.

Sint16 right_coeff[3]

How fast to increase the force towards the positive side.

Uint16 right_sat[3]

Level when joystick is to the positive side.

Uint16 type

SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER, SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION

---

The documentation for this struct was generated from the following file:

• /Users/hercules/trunk/SDL/include/SDL_haptic.h