comparison include/SDL_haptic.h @ 2525:1fb3fba13a2c gsoc2008_force_feedback

Added third axis to condition effects.
author Edgar Simo <bobbens@gmail.com>
date Thu, 17 Jul 2008 16:08:46 +0000
parents 366d84fdf8d1
children 2d88b82ce781
comparison
equal deleted inserted replaced
2524:1a55848ce198 2525:1fb3fba13a2c
506 * - SDL_HAPTIC_DAMPER: Effect based on axes velocity. 506 * - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
507 * - SDL_HAPTIC_INERTIA: Effect based on axes acceleration. 507 * - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
508 * - SDL_HAPTIC_FRICTION: Effect based on axes movement. 508 * - SDL_HAPTIC_FRICTION: Effect based on axes movement.
509 * 509 *
510 * Direction is handled by condition internals instead of a direction member. 510 * Direction is handled by condition internals instead of a direction member.
511 * The condition effect specific members have two parameters. The first 511 * The condition effect specific members have three parameters. The first
512 * refers to the X axis, the second refers to the Y axis. The right terms 512 * refers to the X axis, the second refers to the Y axis and the third
513 * refer to the positive side of the axis and the left terms refer to the 513 * refers to the Z axis. The right terms refer to the positive side of the
514 * negative side of the axis. Please refer to the SDL_HapticDirection 514 * axis and the left terms refer to the negative side of the axis. Please
515 * diagram for which side is positive and which is negative. 515 * refer to the SDL_HapticDirection diagram for which side is positive and
516 * which is negative.
516 * 517 *
517 * \sa SDL_HapticDirection 518 * \sa SDL_HapticDirection
518 * \sa SDL_HAPTIC_SPRING 519 * \sa SDL_HAPTIC_SPRING
519 * \sa SDL_HAPTIC_DAMPER 520 * \sa SDL_HAPTIC_DAMPER
520 * \sa SDL_HAPTIC_INERTIA 521 * \sa SDL_HAPTIC_INERTIA
534 /* Trigger */ 535 /* Trigger */
535 Uint16 button; /**< Button that triggers the effect. */ 536 Uint16 button; /**< Button that triggers the effect. */
536 Uint16 interval; /**< How soon it can be triggered again after button. */ 537 Uint16 interval; /**< How soon it can be triggered again after button. */
537 538
538 /* Condition */ 539 /* Condition */
539 Uint16 right_sat[2]; /**< Level when joystick is to the positive side. */ 540 Uint16 right_sat[3]; /**< Level when joystick is to the positive side. */
540 Uint16 left_sat[2]; /**< Level when joystick is to the negative side. */ 541 Uint16 left_sat[3]; /**< Level when joystick is to the negative side. */
541 Sint16 right_coeff[2]; /**< How fast to increase the force towards the positive side. */ 542 Sint16 right_coeff[3]; /**< How fast to increase the force towards the positive side. */
542 Sint16 left_coeff[2]; /**< How fast to increase the force towards the negative side. */ 543 Sint16 left_coeff[3]; /**< How fast to increase the force towards the negative side. */
543 Uint16 deadband[2]; /**< Size of the dead zone. */ 544 Uint16 deadband[3]; /**< Size of the dead zone. */
544 Sint16 center[2]; /**< Position of the dead zone. */ 545 Sint16 center[3]; /**< Position of the dead zone. */
545 } SDL_HapticCondition; 546 } SDL_HapticCondition;
546 /** 547 /**
547 * \struct SDL_HapticRamp 548 * \struct SDL_HapticRamp
548 * 549 *
549 * \brief A structure containing a template for a Ramp effect. 550 * \brief A structure containing a template for a Ramp effect.