include/SDL_haptic.h
changeset 12088 399cc39583cc
parent 11811 5d94cb6b24d3
child 12271 44a639b5f1af
equal deleted inserted replaced
12087:cb546477e34f 12088:399cc39583cc
   654  * \brief A structure containing a template for a Left/Right effect.
   654  * \brief A structure containing a template for a Left/Right effect.
   655  *
   655  *
   656  * This struct is exclusively for the ::SDL_HAPTIC_LEFTRIGHT effect.
   656  * This struct is exclusively for the ::SDL_HAPTIC_LEFTRIGHT effect.
   657  *
   657  *
   658  * The Left/Right effect is used to explicitly control the large and small
   658  * The Left/Right effect is used to explicitly control the large and small
   659  * motors, commonly found in modern game controllers. One motor is high
   659  * motors, commonly found in modern game controllers. The small (right) motor
   660  * frequency, the other is low frequency.
   660  * is high frequency, and the large (left) motor is low frequency.
   661  *
   661  *
   662  * \sa SDL_HAPTIC_LEFTRIGHT
   662  * \sa SDL_HAPTIC_LEFTRIGHT
   663  * \sa SDL_HapticEffect
   663  * \sa SDL_HapticEffect
   664  */
   664  */
   665 typedef struct SDL_HapticLeftRight
   665 typedef struct SDL_HapticLeftRight
   666 {
   666 {
   667     /* Header */
   667     /* Header */
   668     Uint16 type;            /**< ::SDL_HAPTIC_LEFTRIGHT */
   668     Uint16 type;            /**< ::SDL_HAPTIC_LEFTRIGHT */
   669 
   669 
   670     /* Replay */
   670     /* Replay */
   671     Uint32 length;          /**< Duration of the effect. */
   671     Uint32 length;          /**< Duration of the effect in milliseconds. */
   672 
   672 
   673     /* Rumble */
   673     /* Rumble */
   674     Uint16 large_magnitude; /**< Control of the large controller motor. */
   674     Uint16 large_magnitude; /**< Control of the large controller motor. */
   675     Uint16 small_magnitude; /**< Control of the small controller motor. */
   675     Uint16 small_magnitude; /**< Control of the small controller motor. */
   676 } SDL_HapticLeftRight;
   676 } SDL_HapticLeftRight;