My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Attributes | List of all members
SDL_HapticCondition Struct Reference

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

#include <SDL_haptic.h>

Public Attributes

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:

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

Member Data Documentation

Uint16 SDL_HapticCondition::button

Button that triggers the effect.

Sint16 SDL_HapticCondition::center[3]

Position of the dead zone.

Uint16 SDL_HapticCondition::deadband[3]

Size of the dead zone.

Uint16 SDL_HapticCondition::delay

Delay before starting the effect.

SDL_HapticDirection SDL_HapticCondition::direction

Direction of the effect - Not used ATM.

Uint16 SDL_HapticCondition::interval

How soon it can be triggered again after button.

Sint16 SDL_HapticCondition::left_coeff[3]

How fast to increase the force towards the negative side.

Uint16 SDL_HapticCondition::left_sat[3]

Level when joystick is to the negative side.

Uint32 SDL_HapticCondition::length

Duration of the effect.

Sint16 SDL_HapticCondition::right_coeff[3]

How fast to increase the force towards the positive side.

Uint16 SDL_HapticCondition::right_sat[3]

Level when joystick is to the positive side.

Uint16 SDL_HapticCondition::type

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