include/SDL_haptic.h
author Edgar Simo <bobbens@gmail.com>
Wed, 09 Jul 2008 18:29:11 +0000
branchgsoc2008_force_feedback
changeset 2511 f12ae0bae468
parent 2507 8ef1d0f4d0c1
child 2512 ef147ee4896c
permissions -rw-r--r--
Fixed bugs in documentation.
Improved code correctness a bit.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 2008 Edgar Simo
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  * \file SDL_haptic.h
    25  *
    26  * \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
    27  *  devices.
    28  *
    29  * The basic usage is as follows:
    30  *   - Initialize the Subsystem (SDL_INIT_HAPTIC).
    31  *   - Open a Haptic Device.
    32  *     - SDL_HapticOpen(...) to open from index.
    33  *     - SDL_HapticOpenFromJoystick(...) to open from an existing joystick.
    34  *   - Create an effect (SDL_HapticEffect).
    35  *   - Upload the effect with SDL_HapticNewEffect(...).
    36  *   - Run the effect with SDL_HapticRunEffect(...).
    37  *   - (optional) Free the effect with SDL_HapticDestroyEffect(...).
    38  *   - Close the haptic device with SDL_HapticClose(...).
    39  *
    40  * Example:
    41  *
    42  * \code
    43  * int test_haptic( SDL_Joystick * joystick ) {
    44  *    SDL_Haptic *haptic;
    45  *    SDL_HapticEffect effect;
    46  *    int effect_id;
    47  *
    48  *    // Open the device
    49  *    haptic = SDL_HapticOpenFromJoystick( joystick );
    50  *    if (haptic == NULL) return -1; // Most likely joystick isn't haptic
    51  *
    52  *    // See if it can do sine waves
    53  *    if ((SDL_HapticQuery(haptic) & SDL_HAPTIC_SINE)==0) {
    54  *       SDL_HapticClose(haptic); // No sine effect
    55  *       return -1;
    56  *    }
    57  *
    58  *    // Create the effect
    59  *    memset( &effect, 0, sizeof(SDL_HapticEffect) ); // 0 is safe default
    60  *    effect.type = SDL_HAPTIC_SINE;
    61  *    effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
    62  *    effect.periodic.direction.dir[0] = 18000; // Force comes from south
    63  *    effect.periodic.period = 1000; // 1000 ms
    64  *    effect.periodic.magnitude = 20000; // 20000/32767 strength
    65  *    effect.periodic.length = 5000; // 5 seconds long
    66  *    effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
    67  *    effect.periodic.fade_length = 1000; // Takes 1 second to fade away
    68  *
    69  *    // Upload the effect
    70  *    effect_id = SDL_HapticNewEffect( haptic, &effect );
    71  *
    72  *    // Test the effect
    73  *    SDL_HapticRunEffect( haptic, effect_id );
    74  *    SDL_Delay( 5000); // Wait for the effect to finish
    75  *
    76  *    // We destroy the effect, although closing the device also does this
    77  *    SDL_HapticDestroyEffect( haptic, effect_id );
    78  *
    79  *    // Close the device
    80  *    SDL_HapticClose(haptic);
    81  *
    82  *    return 0; // Success
    83  * }
    84  * \endcode
    85  *
    86  * \author Edgar Simo Serra
    87  */
    88 
    89 #ifndef _SDL_haptic_h
    90 #define _SDL_haptic_h
    91 
    92 #include "SDL_stdinc.h"
    93 #include "SDL_error.h"
    94 #include "SDL_joystick.h"
    95 
    96 #include "begin_code.h"
    97 /* Set up for C function definitions, even when using C++ */
    98 #ifdef __cplusplus
    99 /* *INDENT-OFF* */
   100 extern "C" {
   101    /* *INDENT-ON* */                                                         
   102 #endif /* __cplusplus */
   103 
   104 /**
   105  * \typedef SDL_Haptic
   106  *
   107  * \brief The haptic structure used to identify an SDL haptic.
   108  *
   109  * \sa SDL_HapticOpen
   110  * \sa SDL_HapticOpenFromJoystick
   111  * \sa SDL_HapticClose
   112  */
   113 struct _SDL_Haptic;                                                     
   114 typedef struct _SDL_Haptic SDL_Haptic;
   115 
   116 
   117 /*
   118  * Different haptic features a device can have.
   119  */
   120 /**
   121  * \def SDL_HAPTIC_CONSTANT
   122  *
   123  * \brief Constant haptic effect.
   124  *
   125  * \sa SDL_HapticCondition
   126  */
   127 #define SDL_HAPTIC_CONSTANT   (1<<0) /* Constant effect supported */
   128 /**
   129  * \def SDL_HAPTIC_SINE
   130  *
   131  * \brief Periodic haptic effect that simulates sine waves.
   132  *
   133  * \sa SDL_HapticPeriodic
   134  */
   135 #define SDL_HAPTIC_SINE       (1<<1) /* Sine wave effect supported */
   136 /**
   137  * \def SDL_HAPTIC_SQUARE
   138  *
   139  * \brief Periodic haptic effect that simulates square waves.
   140  * 
   141  * \sa SDL_HapticPeriodic
   142  */
   143 #define SDL_HAPTIC_SQUARE     (1<<2) /* Square wave effect supported */
   144 /**
   145  * \def SDL_HAPTIC_TRIANGLE
   146  *
   147  * \brief Periodic haptic effect that simulates triangular waves.
   148  *
   149  * \sa SDL_HapticPeriodic
   150  */
   151 #define SDL_HAPTIC_TRIANGLE   (1<<3) /* Triangle wave effect supported */
   152 /**
   153  * \def SDL_HAPTIC_SAWTOOTHUP
   154  *
   155  * \brief Periodic haptic effect that simulates saw tooth up waves.
   156  *
   157  * \sa SDL_HapticPeriodic
   158  */
   159 #define SDL_HAPTIC_SAWTOOTHUP (1<<4) /* Sawtoothup wave effect supported */
   160 /**
   161  * \def SDL_HAPTIC_SAWTOOTHDOWN
   162  *
   163  * \brief Periodic haptic effect that simulates saw tooth down waves.
   164  *
   165  * \sa SDL_HapticPeriodic
   166  */
   167 #define SDL_HAPTIC_SAWTOOTHDOWN (1<<5) /* Sawtoothdown wave effect supported */
   168 /**
   169  * \def SDL_HAPTIC_RAMP
   170  *
   171  * \brief Ramp haptic effect.
   172  *
   173  * \sa SDL_HapticRamp
   174  */
   175 #define SDL_HAPTIC_RAMP       (1<<6) /* Ramp effect supported */
   176 /**
   177  * \def SDL_HAPTIC_SPRING
   178  *
   179  * \brief Condition haptic effect that simulates a spring.  Effect is based on the
   180  * axes position.
   181  *
   182  * \sa SDL_HapticCondition
   183  */
   184 #define SDL_HAPTIC_SPRING     (1<<7) /* Spring effect supported - uses axes position */
   185 /**
   186  * \def SDL_HAPTIC_DAMPER
   187  *
   188  * \brief Condition haptic effect that simulates dampening.  Effect is based on the
   189  * axes velocity.
   190  *
   191  * \sa SDL_HapticCondition
   192  */
   193 #define SDL_HAPTIC_DAMPER     (1<<8) /* Damper effect supported - uses axes velocity */
   194 /**
   195  * \def SDL_HAPTIC_INERTIA
   196  *
   197  * \brief Condition haptic effect that simulates inertia.  Effect is based on the axes
   198  * acceleration.
   199  *
   200  * \sa SDL_HapticCondition
   201  */
   202 #define SDL_HAPTIC_INERTIA    (1<<9) /* Inertia effect supported - uses axes acceleration */
   203 /**
   204  * \def SDL_HAPTIC_FRICTION
   205  *
   206  * \brief Condition haptic effect that simulates friction.  Effect is based on the axes
   207  * movement.
   208  *
   209  * \sa SDL_HapticCondition
   210  */
   211 #define SDL_HAPTIC_FRICTION   (1<<10) /* Friction effect supported - uses axes movement */
   212 /**
   213  * \def SDL_HAPTIC_CUSTOM
   214  *
   215  * \brief User defined custom haptic effect. TODO.
   216  */
   217 #define SDL_HAPTIC_CUSTOM     (1<<11) /* Custom effect is supported */
   218 /* These last two are features the device has, not effects */
   219 /**
   220  * \def SDL_HAPTIC_GAIN
   221  *
   222  * \brief Device supports setting the global gain.
   223  *
   224  * \sa SDL_HapticSetGain
   225  */
   226 #define SDL_HAPTIC_GAIN       (1<<12) /* Device can set global gain */
   227 /**
   228  * \def SDL_HAPTIC_AUTOCENTER
   229  *
   230  * \brief Device supports setting autocenter.
   231  *
   232  * \sa SDL_HapticSetAutocenter
   233  */
   234 #define SDL_HAPTIC_AUTOCENTER (1<<13) /* Device can set autocenter */
   235 /**
   236  * \def SDL_HAPTIC_STATUS
   237  *
   238  * \brief Device can be queried for effect status.
   239  *
   240  * \sa SDL_HapticGetEffectStatus
   241  */
   242 #define SDL_HAPTIC_STATUS     (1<<14) /* Device can be queried for effect status */
   243 
   244 
   245 /*
   246  * Direction encodings
   247  */
   248 /**
   249  * \def SDL_HAPTIC_POLAR
   250  *
   251  * \brief Uses polar coordinates for the direction.
   252  *
   253  * \sa SDL_HapticDirection
   254  */
   255 #define SDL_HAPTIC_POLAR      0
   256 /**
   257  * \def SDL_HAPTIC_CARTESIAN
   258  *
   259  * \brief Uses cartesian coordinates for the direction.
   260  *
   261  * \sa SDL_HapticDirection
   262  */
   263 #define SDL_HAPTIC_CARTESIAN  1
   264 
   265 
   266 /**
   267  * \struct SDL_HapticDirection
   268  *
   269  * \brief Structure that represents a haptic direction.
   270  *
   271  * Directions can be specified by:
   272  *   - SDL_HAPTIC_POLAR : Specified by polar coordinates.
   273  *   - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
   274  *
   275  * Cardinal directions of the haptic device are relative to the positioning
   276  *  of the device.  North is considered to be away from the user.
   277  *
   278  * The following diagram represents the cardinal directions:
   279  * \code
   280  *            .--.
   281  *            |__| .-------.
   282  *            |=.| |.-----.|
   283  *            |--| ||     ||
   284  *            |  | |'-----'|
   285  *            |__|~')_____('
   286  *              [ COMPUTER ]
   287  *
   288  *
   289  *                  North (-1)
   290  *                    ^
   291  *                    |
   292  *                    |
   293  * (1)  West <----[ HAPTIC ]----> East (-1)
   294  *                    |
   295  *                    |
   296  *                    v
   297  *                  South (1)
   298  *
   299  *
   300  *                 [ USER ]
   301  *                   \|||/
   302  *                   (o o)
   303  *             ---ooO-(_)-Ooo---
   304  * \endcode
   305  *
   306  * If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a 
   307  *  degree starting north and turning clockwise.  The cardinal directions would be:
   308  *   - North: 0 (0 degrees)
   309  *   - East: 9000 (90 degrees)
   310  *   - South: 18000 (180 degrees)
   311  *   - West: 27000 (270 degrees)
   312  *
   313  * If type is SDL_HAPTIC_CARTESIAN, direction is encoded by position.
   314  *  The cardinal directions would be:
   315  *   - North:  0,-1
   316  *   - East:  -1, 0
   317  *   - South:  0, 1
   318  *   - West:   1, 0
   319  *
   320  *
   321  * Example:
   322  * \code
   323  * SDL_HapticDirection direction;
   324  *
   325  * direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
   326  * direction.dir = 18000; // Force comes from the south meaning the user will
   327  *                         // have to pull the stick to counteract.
   328  * \endcode
   329  *
   330  * \sa SDL_HAPTIC_POLAR
   331  * \sa SDL_HAPTIC_CARTESIAN
   332  * \sa SDL_HapticEffect
   333  */
   334 typedef struct SDL_HapticDirection {
   335    Uint8 type; /**< The type of encoding. */
   336    Uint16 dir[2]; /**< The encoded direction. */
   337 } SDL_HapticDirection;
   338 
   339 
   340 /**
   341  * \struct SDL_HapticConstant
   342  *
   343  * \brief A structure containing a template for a Constant effect.
   344  *
   345  * The struct is exclusive to the SDL_HAPTIC_CONSTANT effect.
   346  *
   347  * A constant effect applies a constant force in the specified direction
   348  *  to the joystick.
   349  *
   350  * \sa SDL_HAPTIC_CONSTANT
   351  * \sa SDL_HapticEffect
   352  */
   353 typedef struct SDL_HapticConstant {
   354    /* Header */
   355    Uint16 type; /**< SDL_HAPTIC_CONSTANT */
   356    SDL_HapticDirection direction; /**< Direction of the effect. */
   357 
   358    /* Replay */
   359    Uint16 length; /**< Duration of the effect. */
   360    Uint16 delay; /**< Delay before starting the effect. */
   361 
   362    /* Trigger */
   363    Uint16 button; /**< Button that triggers the effect. */
   364    Uint16 interval; /**< How soon it can be triggered again after button. */
   365 
   366    /* Constant */
   367    Sint16 level; /**< Strength of the constant effect. */
   368 
   369    /* Envelope */
   370    Uint16 attack_length; /**< Duration of the attack. */
   371    Uint16 attack_level; /**< Level at the start of the attack. */
   372    Uint16 fade_length; /**< Duration of the fade. */
   373    Uint16 fade_level; /**< Level at the end of the fade. */
   374 } SDL_HapticConstant;
   375 /**
   376  * \struct SDL_HapticPeriodic
   377  *
   378  * \brief A structure containing a template for a Periodic effect.
   379  *
   380  * The struct handles the following effects:
   381  *   - SDL_HAPTIC_SINE
   382  *   - SDL_HAPTIC_SQUARE
   383  *   - SDL_HAPTIC_TRIANGLE
   384  *   - SDL_HAPTIC_SAWTOOTHUP
   385  *   - SDL_HAPTIC_SAWTOOTHDOWN
   386  *
   387  * A periodic effect consists in a wave-shaped effect that repeats itself
   388  *  over time.  The type determines the shape of the wave and the parameters
   389  *  determine the dimensions of the wave.
   390  *
   391  * Examples:
   392  * \code
   393  * SDL_HAPTIC_SINE
   394  *   __      __      __      __
   395  *  /  \    /  \    /  \    /
   396  * /    \__/    \__/    \__/
   397  *
   398  * SDL_HAPTIC_SQUARE
   399  *  __    __    __    __    __
   400  * |  |  |  |  |  |  |  |  |  |
   401  * |  |__|  |__|  |__|  |__|  |
   402  *
   403  * SDL_HAPTIC_TRIANGLE
   404  *   /\    /\    /\    /\    /\
   405  *  /  \  /  \  /  \  /  \  /
   406  * /    \/    \/    \/    \/
   407  *
   408  * SDL_HAPTIC_SAWTOOTHUP
   409  *   /|  /|  /|  /|  /|  /|  /|
   410  *  / | / | / | / | / | / | / |
   411  * /  |/  |/  |/  |/  |/  |/  |
   412  *
   413  * SDL_HAPTIC_SAWTOOTHDOWN
   414  * \  |\  |\  |\  |\  |\  |\  |
   415  *  \ | \ | \ | \ | \ | \ | \ |
   416  *   \|  \|  \|  \|  \|  \|  \|
   417  * \endcode
   418  *
   419  * \sa SDL_HAPTIC_SINE
   420  * \sa SDL_HAPTIC_SQUARE
   421  * \sa SDL_HAPTIC_TRIANGLE
   422  * \sa SDL_HAPTIC_SAWTOOTHUP
   423  * \sa SDL_HAPTIC_SAWTOOTHDOWN
   424  * \sa SDL_HapticEffect
   425  */
   426 typedef struct SDL_HapticPeriodic {
   427    /* Header */
   428    Uint16 type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE,
   429                      SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
   430                      SDL_HAPTIC_SAWTOOTHDOWN */
   431    SDL_HapticDirection direction; /**< Direction of the effect. */
   432 
   433    /* Replay */
   434    Uint16 length; /**< Duration of the effect. */
   435    Uint16 delay; /**< Delay before starting the effect. */
   436 
   437    /* Trigger */
   438    Uint16 button; /**< Button that triggers the effect. */
   439    Uint16 interval; /**< How soon it can be triggered again after button. */
   440 
   441    /* Periodic */
   442    Uint16 period; /**< Period of the wave. */
   443    Sint16 magnitude; /**< Peak value. */
   444    Sint16 offset; /**< Mean value of the wave. */
   445    Uint16 phase; /**< Horizontal shift. */
   446 
   447    /* Envelope */
   448    Uint16 attack_length; /**< Duration of the attack. */
   449    Uint16 attack_level; /**< Level at the start of the attack. */
   450    Uint16 fade_length; /**< Duration of the fade. */
   451    Uint16 fade_level; /**< Level at the end of the fade. */
   452 } SDL_HapticPeriodic;
   453 /**
   454  * \struct SDL_HapticCondition
   455  *
   456  * \brief A structure containing a template for a Condition effect.
   457  *
   458  * The struct handles the following effects:
   459  *   - SDL_HAPTIC_SPRING: Effect based on axes position.
   460  *   - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
   461  *   - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
   462  *   - SDL_HAPTIC_FRICTION: Effect based on axes movement.
   463  *
   464  * Direction is handled by condition internals instead of a direction member.
   465  *  The condition effect specific members have two parameters.  The first
   466  *  refers to the X axis, the second refers to the Y axis.  The right terms
   467  *  refer to the positive side of the axis and the left terms refer to the
   468  *  negative side of the axis.  Please refer to the SDL_HapticDirection 
   469  *  diagram for which side is positive and which is negative.
   470  *
   471  * \sa SDL_HapticDirection
   472  * \sa SDL_HAPTIC_SPRING
   473  * \sa SDL_HAPTIC_DAMPER
   474  * \sa SDL_HAPTIC_INERTIA
   475  * \sa SDL_HAPTIC_FRICTION
   476  * \sa SDL_HapticEffect
   477  */
   478 typedef struct SDL_HapticCondition {
   479    /* Header */
   480    Uint16 type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
   481                      SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
   482 
   483    /* Replay */
   484    Uint16 length; /**< Duration of the effect. */
   485    Uint16 delay; /**< Delay before starting the effect. */
   486 
   487    /* Trigger */
   488    Uint16 button; /**< Button that triggers the effect. */
   489    Uint16 interval; /**< How soon it can be triggered again after button. */
   490 
   491    /* Condition */
   492    Uint16 right_sat[2]; /**< Level when joystick is to the positive side. */
   493    Uint16 left_sat[2]; /**< Level when joystick is to the negative side. */
   494    Sint16 right_coeff[2]; /**< How fast to increase the force towards the positive side. */
   495    Sint16 left_coeff[2]; /**< How fast to increase the force towards the negative side. */
   496    Uint16 deadband[2]; /**< Size of the dead zone. */
   497    Sint16 center[2]; /**< Position of the dead zone. */
   498 } SDL_HapticCondition;
   499 /**
   500  * \struct SDL_HapticRamp
   501  *
   502  * \brief A structure containing a template for a Ramp effect.
   503  *
   504  * This struct is exclusively for the SDL_HAPTIC_RAMP effect.
   505  *
   506  * The ramp effect starts at start strength and ends at end strength.
   507  *  It augments in linear fashion.  If you use attack and fade with a ramp
   508  *  they effects get added to the ramp effect making the effect become
   509  *  quadratic instead of linear.
   510  *
   511  * \sa SDL_HAPTIC_RAMP
   512  * \sa SDL_HapticEffect
   513  */
   514 typedef struct SDL_HapticRamp {
   515    /* Header */
   516    Uint16 type; /**< SDL_HAPTIC_RAMP */
   517    SDL_HapticDirection direction; /**< Direction of the effect. */
   518 
   519    /* Replay */
   520    Uint16 length; /**< Duration of the effect. */
   521    Uint16 delay; /**< Delay before starting the effect. */
   522 
   523    /* Trigger */
   524    Uint16 button; /**< Button that triggers the effect. */
   525    Uint16 interval; /**< How soon it can be triggered again after button. */
   526 
   527    /* Ramp */
   528    Sint16 start; /**< Beginning strength level. */
   529    Sint16 end; /**< Ending strength level. */
   530 
   531    /* Envelope */
   532    Uint16 attack_length; /**< Duration of the attack. */
   533    Uint16 attack_level; /**< Level at the start of the attack. */
   534    Uint16 fade_length; /**< Duration of the fade. */
   535    Uint16 fade_level; /**< Level at the end of the fade. */
   536 } SDL_HapticRamp;
   537 /**
   538  * \union SDL_HapticEffect
   539  *
   540  * \brief The generic template for any haptic effect.
   541  *
   542  * All values max at 32767 (0x7FFF).  Signed values also can be negative.
   543  *  Time values unless specified otherwise are in milliseconds.
   544  *
   545  * Common parts:
   546  * \code
   547  * // Replay - All effects have this
   548  * Uint16 length;        // Duration of effect (ms).
   549  * Uint16 delay;         // Delay before starting effect.
   550  *
   551  * // Trigger - All effects have this
   552  * Uint16 button;        // Button that triggers effect.
   553  * Uint16 interval;      // How soon before effect can be triggered again.
   554  *
   555  * // Envelope - All effects except condition effects have this
   556  * Uint16 attack_length; // Duration of the attack (ms).
   557  * Uint16 attack_level;  // Level at the start of the attack.
   558  * Uint16 fade_length;   // Duration of the fade out (ms).
   559  * Uint16 fade_level;    // Level at the end of the fade.
   560  * \endcode
   561  *
   562  *
   563  * Here we have an example of a constant effect evolution in time:
   564  *
   565  * \code
   566  * Strength
   567  * ^
   568  * |
   569  * |    effect level -->  _________________
   570  * |                     /                 \
   571  * |                    /                   \
   572  * |                   /                     \
   573  * |                  /                       \ 
   574  * | attack_level --> |                        \
   575  * |                  |                        |  <---  fade_level
   576  * |
   577  * +--------------------------------------------------> Time
   578  *                    [--]                 [---]
   579  *                    attack_length        fade_length
   580  * 
   581  * [------------------][-----------------------]
   582  * delay               length
   583  * \endcode
   584  *
   585  * Note either the attack_level or the fade_level may be above the actual
   586  *  effect level.
   587  *
   588  * \sa SDL_HapticConstant
   589  * \sa SDL_HapticPeriodic
   590  * \sa SDL_HapticCondition
   591  * \sa SDL_HapticRamp
   592  */
   593 typedef union SDL_HapticEffect {
   594    /* Common for all force feedback effects */
   595    Uint16 type; /**< Effect type. */
   596    SDL_HapticConstant constant; /**< Constant effect. */
   597    SDL_HapticPeriodic periodic; /**< Periodic effect. */
   598    SDL_HapticCondition condition; /**< Condition effect. */
   599    SDL_HapticRamp ramp; /**< Ramp effect. */
   600 } SDL_HapticEffect;
   601 
   602 
   603 /* Function prototypes */
   604 /**
   605  * \fn int SDL_NumHaptics(void)
   606  *
   607  * \brief Count the number of joysticks attached to the system.
   608  *
   609  *    \return Number of haptic devices detected on the system.
   610  */
   611 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
   612 
   613 /**
   614  * \fn const char * SDL_HapticName(int device_index)
   615  *
   616  * \brief Get the implementation dependent name of a Haptic device.
   617  * This can be called before any joysticks are opened.
   618  * If no name can be found, this function returns NULL.
   619  *
   620  *    \param device_index Index of the device to get it's name.
   621  *    \return Name of the device or NULL on error.
   622  *
   623  * \sa SDL_NumHaptics
   624  */
   625 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
   626 
   627 /**
   628  * \fn SDL_Haptic * SDL_HapticOpen(int device_index)
   629  *
   630  * \brief Opens a Haptic device for usage - the index passed as an
   631  * argument refers to the N'th Haptic device on this system.
   632  *
   633  * When opening a haptic device, it's gain will be set to maximum and
   634  *  autocenter will be disabled.  To modify these values use
   635  *  SDL_HapticSetGain and SDL_HapticSetAutocenter
   636  *
   637  *    \param device_index Index of the device to open.
   638  *    \return Device identifier or NULL on error.
   639  *
   640  * \sa SDL_HapticIndex
   641  * \sa SDL_HapticOpenFromJoystick
   642  * \sa SDL_HapticClose
   643  * \sa SDL_HapticSetGain
   644  * \sa SDL_HapticSetAutocenter
   645  */
   646 extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
   647 
   648 /**
   649  * \fn int SDL_HapticOpened(int device_index)
   650  *
   651  * \brief Checks if the haptic device at index has been opened.
   652  *
   653  *    \param device_index Index to check to see if it has been opened.
   654  *    \return 1 if it has been opened or 0 if it hasn't.
   655  * 
   656  * \sa SDL_HapticOpen
   657  * \sa SDL_HapticIndex
   658  */
   659 extern DECLSPEC int SDL_HapticOpened(int device_index);
   660 
   661 /**
   662  * \fn int SDL_HapticIndex(SDL_Haptic * haptic)
   663  *
   664  * \brief Gets the index of a haptic device.
   665  *
   666  *    \param haptic Haptic device to get the index of.
   667  *    \return The index of the haptic device or -1 on error.
   668  *
   669  * \sa SDL_HapticOpen
   670  * \sa SDL_HapticOpened
   671  */
   672 extern DECLSPEC int SDL_HapticIndex(SDL_Haptic * haptic);
   673 
   674 /**
   675  * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
   676  *
   677  * \brief Checks to see if a joystick has haptic features.
   678  *
   679  *    \param joystick Joystick to test for haptic capabilities.
   680  *    \return SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't
   681  *            or -1 if an error ocurred.
   682  *
   683  * \sa SDL_HapticOpenFromJoystick
   684  */
   685 extern DECLSPEC int SDL_JoystickIsHaptic(SDL_Joystick * joystick);
   686 
   687 /**
   688  * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
   689  *
   690  * \brief Opens a Haptic device for usage from a Joystick device.  Still has
   691  * to be closed seperately to the joystick.
   692  *
   693  *    \param joystick Joystick to create a haptic device from.
   694  *    \return A valid haptic device identifier on success or NULL on error.
   695  *
   696  * \sa SDL_HapticOpen
   697  * \sa SDL_HapticClose
   698  */
   699 extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);
   700 
   701 /**
   702  * \fn void SDL_HapticClose(SDL_Haptic * haptic)
   703  *
   704  * \brief Closes a Haptic device previously opened with SDL_HapticOpen.
   705  *
   706  *    \param haptic Haptic device to close.
   707  */
   708 extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
   709 
   710 /**
   711  * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
   712  *
   713  * \brief Returns the number of effects a haptic device can store.
   714  *
   715  *    \param haptic The haptic device to query effect max.
   716  *    \return The number of effects the haptic device can store or
   717  *            -1 on error.
   718  *
   719  * \sa SDL_HapticQuery
   720  */
   721 extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
   722 
   723 /**
   724  * \fn unsigned int SDL_HapticQuery(SDL_Haptic * haptic)
   725  *
   726  * \brief Gets the haptic devices supported features in bitwise matter.
   727  *
   728  * Example: 
   729  * \code
   730  * if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
   731  *    printf("We have constant haptic effect!");
   732  * }
   733  * \endcode
   734  *    
   735  *
   736  *    \param haptic The haptic device to query.
   737  *    \return Haptic features in bitwise manner (OR'd).
   738  *
   739  * \sa SDL_HapticNumEffects
   740  * \sa SDL_HapticEffectSupported
   741  */
   742 extern DECLSPEC unsigned int SDL_HapticQuery(SDL_Haptic * haptic);
   743 
   744 /**
   745  * \fn int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
   746  *
   747  * \brief Checks to see if effect is supported by haptic.
   748  *
   749  *    \param haptic Haptic device to check on.
   750  *    \param effect Effect to check to see if it is supported.
   751  *    \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or 
   752  *            -1 on error.
   753  * 
   754  * \sa SDL_HapticQuery
   755  * \sa SDL_HapticNewEffect
   756  */
   757 extern DECLSPEC int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   758 
   759 /**
   760  * \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
   761  *
   762  * \brief Creates a new haptic effect on the device.
   763  *
   764  *    \param haptic Haptic device to create the effect on.
   765  *    \param effect Properties of the effect to create.
   766  *    \return The id of the effect on success or -1 on error.
   767  *
   768  * \sa SDL_HapticUpdateEffect
   769  * \sa SDL_HapticRunEffect
   770  * \sa SDL_HapticDestroyEffect
   771  */
   772 extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   773 
   774 /**
   775  * \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
   776  *
   777  * \brief Updates an effect.  Can be used dynamically, although behaviour when
   778  * dynamically changing direction may be strange.  Specifically the effect
   779  * may reupload itself and start playing from the start.  You cannot change
   780  * the type either when running UpdateEffect.
   781  *
   782  *    \param haptic Haptic device that has the effect.
   783  *    \param effect Effect to update.
   784  *    \param data New effect properties to use.
   785  *    \return The id of the effect on success or -1 on error.
   786  *
   787  * \sa SDL_HapticNewEffect
   788  * \sa SDL_HapticRunEffect
   789  * \sa SDL_HapticDestroyEffect
   790  */
   791 extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
   792 
   793 /**
   794  * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect)
   795  *
   796  * \brief Runs the haptic effect on it's assosciated haptic device.
   797  *
   798  *    \param haptic Haptic device to run the effect on.
   799  *    \param effect Identifier of the haptic effect to run.
   800  *    \return 0 on success or -1 on error.
   801  *
   802  * \sa SDL_HapticStopEffect
   803  * \sa SDL_HapticDestroyEffect
   804  * \sa SDL_HapticGetEffectStatus
   805  */
   806 extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
   807 
   808 /**
   809  * \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
   810  *
   811  * \brief Stops the haptic effect on it's assosciated haptic device.
   812  *
   813  *    \param haptic Haptic device to stop the effect on.
   814  *    \param effect Identifier of the effect to stop.
   815  *    \return 0 on success or -1 on error.
   816  *
   817  * \sa SDL_HapticRunEffect
   818  * \sa SDL_HapticDestroyEffect
   819  */
   820 extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
   821 
   822 /**
   823  * \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
   824  *
   825  * \brief Destroys a haptic effect on the device.  This will stop the effect
   826  * if it's running.  Effects are automatically destroyed when the device is
   827  * closed.
   828  *
   829  *    \param haptic Device to destroy the effect on.
   830  *    \param effect Identifier of the effect to destroy.
   831  * 
   832  * \sa SDL_HapticNewEffect
   833  */
   834 extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
   835 
   836 /**
   837  * \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
   838  *
   839  * \brief Gets the status of the current effect on the haptic device.
   840  *
   841  * Device must support the SDL_HAPTIC_STATUS feature.
   842  *
   843  *    \param haptic Haptic device to query the effect status on.
   844  *    \param effect Identifier of the effect to query it's status.
   845  *    \return 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing
   846  *            or -1 on error.
   847  *
   848  * \sa SDL_HapticRunEffect
   849  * \sa SDL_HapticStopEffect
   850  */
   851 extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
   852 
   853 /**
   854  * \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
   855  *
   856  * \brief Sets the global gain of the device.  Gain should be between 0 and 100.
   857  *
   858  * Device must support the SDL_HAPTIC_GAIN feature.
   859  *
   860  * The user may specify the maxmimum gain by setting the environment variable
   861  *  SDL_HAPTIC_GAIN_MAX which should be between 0 and 100.  All calls to
   862  *  SDL_HapticSetGain will scale linearly using SDL_HAPTIC_GAIN_MAX as the
   863  *  maximum.
   864  *
   865  *    \param haptic Haptic device to set the gain on.
   866  *    \param gain Value to set the gain to, should be between 0 and 100.
   867  *    \return 0 on success or -1 on error.
   868  *
   869  * \sa SDL_HapticQuery
   870  */
   871 extern DECLSPEC int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
   872 
   873 /**
   874  * \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
   875  *
   876  * \brief Sets the global autocenter of the device.  Autocenter should be between
   877  * 0 and 100.  Setting it to 0 will disable autocentering.
   878  *
   879  * Device must support the SDL_HAPTIC_AUTOCENTER feature.
   880  *
   881  *    \param haptic Haptic device to set autocentering on.
   882  *    \param autocenter Value to set autocenter to, 0 disables autocentering.
   883  *    \return 0 on success or -1 on error.
   884  *
   885  * \sa SDL_HapticQuery
   886  */
   887 extern DECLSPEC int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
   888 
   889 
   890 /* Ends C function definitions when using C++ */
   891 #ifdef __cplusplus
   892 /* *INDENT-OFF* */
   893 }
   894 /* *INDENT-ON* */
   895 #endif
   896 #include "close_code.h"
   897 
   898 #endif /* _SDL_haptic_h */
   899 
   900 /* vi: set ts=4 sw=4 expandtab: */
   901 
   902