include/SDL_haptic.h
author Edgar Simo <bobbens@gmail.com>
Fri, 18 Jul 2008 08:00:16 +0000
branchgsoc2008_force_feedback
changeset 2526 2d88b82ce781
parent 2525 1fb3fba13a2c
child 2532 688cad3f6090
permissions -rw-r--r--
More documentation.
SDL_HapticPeriodic.phase now should make sense.
More explicit if you try to update an effect type.
     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, 1 );
    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  * \def SDL_HAPTIC_SHPERICAL
   266  *
   267  * \brief Uses spherical coordinates for the direction.
   268  *
   269  * \sa SDL_HapticDirection
   270  */
   271 #define SDL_HAPTIC_SPHERICAL  2
   272 
   273 
   274 /*
   275  * Misc defines.
   276  */
   277 /**
   278  * \def SDL_HAPTIC_INFINITY
   279  *
   280  * \brief Used to play a device an infinite number of times.
   281  *
   282  * \sa SDL_HapticRunEffect
   283  */
   284 #define SDL_HAPTIC_INFINITY   4294967295U
   285 
   286 
   287 /**
   288  * \struct SDL_HapticDirection
   289  *
   290  * \brief Structure that represents a haptic direction.
   291  *
   292  * Directions can be specified by:
   293  *   - SDL_HAPTIC_POLAR : Specified by polar coordinates.
   294  *   - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
   295  *   - SDL_HAPTIC_SHPERICAL : Specified by spherical coordinates.
   296  *
   297  * Cardinal directions of the haptic device are relative to the positioning
   298  *  of the device.  North is considered to be away from the user.
   299  *
   300  * The following diagram represents the cardinal directions:
   301  * \code
   302  *              .--.
   303  *              |__| .-------.
   304  *              |=.| |.-----.|
   305  *              |--| ||     ||
   306  *              |  | |'-----'|
   307  *              |__|~')_____('
   308  *                [ COMPUTER ]
   309  *
   310  *
   311  *                  North (0,-1)
   312  *                      ^
   313  *                      |
   314  *                      |
   315  * (1,0)  West <----[ HAPTIC ]----> East (-1,0)
   316  *                      |
   317  *                      |
   318  *                      v
   319  *                   South (0,1)
   320  *
   321  *
   322  *                   [ USER ]
   323  *                     \|||/
   324  *                     (o o)
   325  *               ---ooO-(_)-Ooo---
   326  * \endcode
   327  *
   328  * If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a 
   329  *  degree starting north and turning clockwise.  SDL_HAPTIC_POLAR only uses
   330  *  the first dir parameter.  The cardinal directions would be:
   331  *   - North: 0 (0 degrees)
   332  *   - East: 9000 (90 degrees)
   333  *   - South: 18000 (180 degrees)
   334  *   - West: 27000 (270 degrees)
   335  *
   336  * If type is SDL_HAPTIC_CARTESIAN, direction is encoded by three positions
   337  *  (X axis, Y axis and Z axis (with 3 axes)).  SDL_HAPTIC_CARTESIAN uses
   338  *  the first three dir parameters.  The cardinal directions would be:
   339  *   - North:  0,-1, 0
   340  *   - East:  -1, 0, 0
   341  *   - South:  0, 1, 0
   342  *   - West:   1, 0, 0
   343  *  The Z axis represents the height of the effect if supported, otherwise
   344  *  it's unused.  In cartesian encoding (1,2) would be the same as (2,4), you
   345  *  can use any multiple you want, only the direction matters.
   346  *
   347  * If type is SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations.
   348  *  The first two  dir parameters are used.  The dir parameters are as follows
   349  *  (all values are in hundredths of degrees):
   350  *    1) Degrees from (1, 0) rotated towards (0, 1).
   351  *    2) Degrees towards (0, 0, 1) (device needs at least 3 axes).
   352  *
   353  *
   354  * Example of force coming from the south with all encodings (force coming
   355  *  from the south means the user will have to pull the stick to counteract):
   356  * \code
   357  * SDL_HapticDirection direction;
   358  *
   359  * // Cartesian directions
   360  * direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding.
   361  * direction.dir[0] = 0; // X position
   362  * direction.dir[1] = 1; // Y position
   363  * // Assuming the device has 2 axes, we don't need to specify third parameter.
   364  *
   365  * // Polar directions
   366  * direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
   367  * direction.dir[0] = 18000; // Polar only uses first parameter
   368  *
   369  * // Spherical coordinates
   370  * direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding
   371  * direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
   372  * \endcode
   373  *
   374  * \sa SDL_HAPTIC_POLAR
   375  * \sa SDL_HAPTIC_CARTESIAN
   376  * \sa SDL_HAPTIC_SHPERICAL
   377  * \sa SDL_HapticEffect
   378  * \sa SDL_HapticNumAxes
   379  */
   380 typedef struct SDL_HapticDirection {
   381    Uint8 type; /**< The type of encoding. */
   382    Uint16 dir[3]; /**< The encoded direction. */
   383 } SDL_HapticDirection;
   384 
   385 
   386 /**
   387  * \struct SDL_HapticConstant
   388  *
   389  * \brief A structure containing a template for a Constant effect.
   390  *
   391  * The struct is exclusive to the SDL_HAPTIC_CONSTANT effect.
   392  *
   393  * A constant effect applies a constant force in the specified direction
   394  *  to the joystick.
   395  *
   396  * \sa SDL_HAPTIC_CONSTANT
   397  * \sa SDL_HapticEffect
   398  */
   399 typedef struct SDL_HapticConstant {
   400    /* Header */
   401    Uint16 type; /**< SDL_HAPTIC_CONSTANT */
   402    SDL_HapticDirection direction; /**< Direction of the effect. */
   403 
   404    /* Replay */
   405    Uint32 length; /**< Duration of the effect. */
   406    Uint16 delay; /**< Delay before starting the effect. */
   407 
   408    /* Trigger */
   409    Uint16 button; /**< Button that triggers the effect. */
   410    Uint16 interval; /**< How soon it can be triggered again after button. */
   411 
   412    /* Constant */
   413    Sint16 level; /**< Strength of the constant effect. */
   414 
   415    /* Envelope */
   416    Uint16 attack_length; /**< Duration of the attack. */
   417    Uint16 attack_level; /**< Level at the start of the attack. */
   418    Uint16 fade_length; /**< Duration of the fade. */
   419    Uint16 fade_level; /**< Level at the end of the fade. */
   420 } SDL_HapticConstant;
   421 /**
   422  * \struct SDL_HapticPeriodic
   423  *
   424  * \brief A structure containing a template for a Periodic effect.
   425  *
   426  * The struct handles the following effects:
   427  *   - SDL_HAPTIC_SINE
   428  *   - SDL_HAPTIC_SQUARE
   429  *   - SDL_HAPTIC_TRIANGLE
   430  *   - SDL_HAPTIC_SAWTOOTHUP
   431  *   - SDL_HAPTIC_SAWTOOTHDOWN
   432  *
   433  * A periodic effect consists in a wave-shaped effect that repeats itself
   434  *  over time.  The type determines the shape of the wave and the parameters
   435  *  determine the dimensions of the wave.
   436  *
   437  * Phase is given by hundredth of a cyle meaning that giving the phase a value
   438  *  of 9000 will displace it 25% of it's period.  Here are sample values:
   439  *    -     0: No phase displacement.
   440  *    -  9000: Displaced 25% of it's period.
   441  *    - 18000: Displaced 50% of it's period.
   442  *    - 27000: Displaced 75% of it's period.
   443  *    - 36000: Displaced 100% of it's period, same as 0, but 0 is preffered.
   444  *
   445  * Examples:
   446  * \code
   447  * SDL_HAPTIC_SINE
   448  *   __      __      __      __
   449  *  /  \    /  \    /  \    /
   450  * /    \__/    \__/    \__/
   451  *
   452  * SDL_HAPTIC_SQUARE
   453  *  __    __    __    __    __
   454  * |  |  |  |  |  |  |  |  |  |
   455  * |  |__|  |__|  |__|  |__|  |
   456  *
   457  * SDL_HAPTIC_TRIANGLE
   458  *   /\    /\    /\    /\    /\
   459  *  /  \  /  \  /  \  /  \  /
   460  * /    \/    \/    \/    \/
   461  *
   462  * SDL_HAPTIC_SAWTOOTHUP
   463  *   /|  /|  /|  /|  /|  /|  /|
   464  *  / | / | / | / | / | / | / |
   465  * /  |/  |/  |/  |/  |/  |/  |
   466  *
   467  * SDL_HAPTIC_SAWTOOTHDOWN
   468  * \  |\  |\  |\  |\  |\  |\  |
   469  *  \ | \ | \ | \ | \ | \ | \ |
   470  *   \|  \|  \|  \|  \|  \|  \|
   471  * \endcode
   472  *
   473  * \sa SDL_HAPTIC_SINE
   474  * \sa SDL_HAPTIC_SQUARE
   475  * \sa SDL_HAPTIC_TRIANGLE
   476  * \sa SDL_HAPTIC_SAWTOOTHUP
   477  * \sa SDL_HAPTIC_SAWTOOTHDOWN
   478  * \sa SDL_HapticEffect
   479  */
   480 typedef struct SDL_HapticPeriodic {
   481    /* Header */
   482    Uint16 type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE,
   483                      SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
   484                      SDL_HAPTIC_SAWTOOTHDOWN */
   485    SDL_HapticDirection direction; /**< Direction of the effect. */
   486 
   487    /* Replay */
   488    Uint32 length; /**< Duration of the effect. */
   489    Uint16 delay; /**< Delay before starting the effect. */
   490 
   491    /* Trigger */
   492    Uint16 button; /**< Button that triggers the effect. */
   493    Uint16 interval; /**< How soon it can be triggered again after button. */
   494 
   495    /* Periodic */
   496    Uint16 period; /**< Period of the wave. */
   497    Sint16 magnitude; /**< Peak value. */
   498    Sint16 offset; /**< Mean value of the wave. */
   499    Uint16 phase; /**< Horizontal shift given by hundredth of a cycle. */
   500 
   501    /* Envelope */
   502    Uint16 attack_length; /**< Duration of the attack. */
   503    Uint16 attack_level; /**< Level at the start of the attack. */
   504    Uint16 fade_length; /**< Duration of the fade. */
   505    Uint16 fade_level; /**< Level at the end of the fade. */
   506 } SDL_HapticPeriodic;
   507 /**
   508  * \struct SDL_HapticCondition
   509  *
   510  * \brief A structure containing a template for a Condition effect.
   511  *
   512  * The struct handles the following effects:
   513  *   - SDL_HAPTIC_SPRING: Effect based on axes position.
   514  *   - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
   515  *   - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
   516  *   - SDL_HAPTIC_FRICTION: Effect based on axes movement.
   517  *
   518  * Direction is handled by condition internals instead of a direction member.
   519  *  The condition effect specific members have three parameters.  The first
   520  *  refers to the X axis, the second refers to the Y axis and the third
   521  *  refers to the Z axis.  The right terms refer to the positive side of the
   522  *  axis and the left terms refer to the negative side of the axis.  Please 
   523  *  refer to the SDL_HapticDirection  diagram for which side is positive and
   524  *  which is negative.
   525  *
   526  * \sa SDL_HapticDirection
   527  * \sa SDL_HAPTIC_SPRING
   528  * \sa SDL_HAPTIC_DAMPER
   529  * \sa SDL_HAPTIC_INERTIA
   530  * \sa SDL_HAPTIC_FRICTION
   531  * \sa SDL_HapticEffect
   532  */
   533 typedef struct SDL_HapticCondition {
   534    /* Header */
   535    Uint16 type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
   536                      SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
   537    SDL_HapticDirection direction; /**< Direction of the effect - Not used ATM. */
   538 
   539    /* Replay */
   540    Uint32 length; /**< Duration of the effect. */
   541    Uint16 delay; /**< Delay before starting the effect. */
   542 
   543    /* Trigger */
   544    Uint16 button; /**< Button that triggers the effect. */
   545    Uint16 interval; /**< How soon it can be triggered again after button. */
   546 
   547    /* Condition */
   548    Uint16 right_sat[3]; /**< Level when joystick is to the positive side. */
   549    Uint16 left_sat[3]; /**< Level when joystick is to the negative side. */
   550    Sint16 right_coeff[3]; /**< How fast to increase the force towards the positive side. */
   551    Sint16 left_coeff[3]; /**< How fast to increase the force towards the negative side. */
   552    Uint16 deadband[3]; /**< Size of the dead zone. */
   553    Sint16 center[3]; /**< Position of the dead zone. */
   554 } SDL_HapticCondition;
   555 /**
   556  * \struct SDL_HapticRamp
   557  *
   558  * \brief A structure containing a template for a Ramp effect.
   559  *
   560  * This struct is exclusively for the SDL_HAPTIC_RAMP effect.
   561  *
   562  * The ramp effect starts at start strength and ends at end strength.
   563  *  It augments in linear fashion.  If you use attack and fade with a ramp
   564  *  they effects get added to the ramp effect making the effect become
   565  *  quadratic instead of linear.
   566  *
   567  * \sa SDL_HAPTIC_RAMP
   568  * \sa SDL_HapticEffect
   569  */
   570 typedef struct SDL_HapticRamp {
   571    /* Header */
   572    Uint16 type; /**< SDL_HAPTIC_RAMP */
   573    SDL_HapticDirection direction; /**< Direction of the effect. */
   574 
   575    /* Replay */
   576    Uint32 length; /**< Duration of the effect. */
   577    Uint16 delay; /**< Delay before starting the effect. */
   578 
   579    /* Trigger */
   580    Uint16 button; /**< Button that triggers the effect. */
   581    Uint16 interval; /**< How soon it can be triggered again after button. */
   582 
   583    /* Ramp */
   584    Sint16 start; /**< Beginning strength level. */
   585    Sint16 end; /**< Ending strength level. */
   586 
   587    /* Envelope */
   588    Uint16 attack_length; /**< Duration of the attack. */
   589    Uint16 attack_level; /**< Level at the start of the attack. */
   590    Uint16 fade_length; /**< Duration of the fade. */
   591    Uint16 fade_level; /**< Level at the end of the fade. */
   592 } SDL_HapticRamp;
   593 /**
   594  * \union SDL_HapticEffect
   595  *
   596  * \brief The generic template for any haptic effect.
   597  *
   598  * All values max at 32767 (0x7FFF).  Signed values also can be negative.
   599  *  Time values unless specified otherwise are in milliseconds.
   600  *
   601  * You can also pass SDL_HAPTIC_INFINITY to length instead of a 0-32767 value.
   602  *  Neither delay, interval, attack_length nor fade_length support 
   603  *  SDL_HAPTIC_INFINITY.  Fade will also not be used since effect never ends.
   604  *
   605  * Common parts:
   606  * \code
   607  * // Replay - All effects have this
   608  * Uint32 length;        // Duration of effect (ms).
   609  * Uint16 delay;         // Delay before starting effect.
   610  *
   611  * // Trigger - All effects have this
   612  * Uint16 button;        // Button that triggers effect.
   613  * Uint16 interval;      // How soon before effect can be triggered again.
   614  *
   615  * // Envelope - All effects except condition effects have this
   616  * Uint16 attack_length; // Duration of the attack (ms).
   617  * Uint16 attack_level;  // Level at the start of the attack.
   618  * Uint16 fade_length;   // Duration of the fade out (ms).
   619  * Uint16 fade_level;    // Level at the end of the fade.
   620  * \endcode
   621  *
   622  *
   623  * Here we have an example of a constant effect evolution in time:
   624  *
   625  * \code
   626  * Strength
   627  * ^
   628  * |
   629  * |    effect level -->  _________________
   630  * |                     /                 \
   631  * |                    /                   \
   632  * |                   /                     \
   633  * |                  /                       \ 
   634  * | attack_level --> |                        \
   635  * |                  |                        |  <---  fade_level
   636  * |
   637  * +--------------------------------------------------> Time
   638  *                    [--]                 [---]
   639  *                    attack_length        fade_length
   640  * 
   641  * [------------------][-----------------------]
   642  * delay               length
   643  * \endcode
   644  *
   645  * Note either the attack_level or the fade_level may be above the actual
   646  *  effect level.
   647  *
   648  * \sa SDL_HapticConstant
   649  * \sa SDL_HapticPeriodic
   650  * \sa SDL_HapticCondition
   651  * \sa SDL_HapticRamp
   652  */
   653 typedef union SDL_HapticEffect {
   654    /* Common for all force feedback effects */
   655    Uint16 type; /**< Effect type. */
   656    SDL_HapticConstant constant; /**< Constant effect. */
   657    SDL_HapticPeriodic periodic; /**< Periodic effect. */
   658    SDL_HapticCondition condition; /**< Condition effect. */
   659    SDL_HapticRamp ramp; /**< Ramp effect. */
   660 } SDL_HapticEffect;
   661 
   662 
   663 /* Function prototypes */
   664 /**
   665  * \fn int SDL_NumHaptics(void)
   666  *
   667  * \brief Count the number of joysticks attached to the system.
   668  *
   669  *    \return Number of haptic devices detected on the system.
   670  */
   671 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
   672 
   673 /**
   674  * \fn const char * SDL_HapticName(int device_index)
   675  *
   676  * \brief Get the implementation dependent name of a Haptic device.
   677  * This can be called before any joysticks are opened.
   678  * If no name can be found, this function returns NULL.
   679  *
   680  *    \param device_index Index of the device to get it's name.
   681  *    \return Name of the device or NULL on error.
   682  *
   683  * \sa SDL_NumHaptics
   684  */
   685 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
   686 
   687 /**
   688  * \fn SDL_Haptic * SDL_HapticOpen(int device_index)
   689  *
   690  * \brief Opens a Haptic device for usage - the index passed as an
   691  * argument refers to the N'th Haptic device on this system.
   692  *
   693  * When opening a haptic device, it's gain will be set to maximum and
   694  *  autocenter will be disabled.  To modify these values use
   695  *  SDL_HapticSetGain and SDL_HapticSetAutocenter
   696  *
   697  *    \param device_index Index of the device to open.
   698  *    \return Device identifier or NULL on error.
   699  *
   700  * \sa SDL_HapticIndex
   701  * \sa SDL_HapticOpenFromMouse
   702  * \sa SDL_HapticOpenFromJoystick
   703  * \sa SDL_HapticClose
   704  * \sa SDL_HapticSetGain
   705  * \sa SDL_HapticSetAutocenter
   706  */
   707 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
   708 
   709 /**
   710  * \fn int SDL_HapticOpened(int device_index)
   711  *
   712  * \brief Checks if the haptic device at index has been opened.
   713  *
   714  *    \param device_index Index to check to see if it has been opened.
   715  *    \return 1 if it has been opened or 0 if it hasn't.
   716  * 
   717  * \sa SDL_HapticOpen
   718  * \sa SDL_HapticIndex
   719  */
   720 extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index);
   721 
   722 /**
   723  * \fn int SDL_HapticIndex(SDL_Haptic * haptic)
   724  *
   725  * \brief Gets the index of a haptic device.
   726  *
   727  *    \param haptic Haptic device to get the index of.
   728  *    \return The index of the haptic device or -1 on error.
   729  *
   730  * \sa SDL_HapticOpen
   731  * \sa SDL_HapticOpened
   732  */
   733 extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic);
   734 
   735 /**
   736  * \fn int SDL_MouseIsHaptic(void)
   737  *
   738  * \brief Gets whether or not the current mouse has haptic capabilities.
   739  *
   740  *    \return SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
   741  *
   742  * \sa SDL_HapticOpenFromMouse
   743  */
   744 extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void);
   745 
   746 /**
   747  * \fn SDL_Haptic * SDL_HapticOpenFromMouse(void)
   748  *
   749  * \brief Tries to open a haptic device from the current mouse.
   750  *
   751  *    \return The haptic device identifier or NULL on error.
   752  *
   753  * \sa SDL_MouseIsHaptic
   754  * \sa SDL_HapticOpen
   755  */
   756 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void);
   757 
   758 /**
   759  * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
   760  *
   761  * \brief Checks to see if a joystick has haptic features.
   762  *
   763  *    \param joystick Joystick to test for haptic capabilities.
   764  *    \return SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't
   765  *            or -1 if an error ocurred.
   766  *
   767  * \sa SDL_HapticOpenFromJoystick
   768  */
   769 extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
   770 
   771 /**
   772  * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
   773  *
   774  * \brief Opens a Haptic device for usage from a Joystick device.  Still has
   775  * to be closed seperately to the joystick.
   776  *
   777  *    \param joystick Joystick to create a haptic device from.
   778  *    \return A valid haptic device identifier on success or NULL on error.
   779  *
   780  * \sa SDL_HapticOpen
   781  * \sa SDL_HapticClose
   782  */
   783 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);
   784 
   785 /**
   786  * \fn void SDL_HapticClose(SDL_Haptic * haptic)
   787  *
   788  * \brief Closes a Haptic device previously opened with SDL_HapticOpen.
   789  *
   790  *    \param haptic Haptic device to close.
   791  */
   792 extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
   793 
   794 /**
   795  * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
   796  *
   797  * \brief Returns the number of effects a haptic device can store.
   798  *
   799  *    \param haptic The haptic device to query effect max.
   800  *    \return The number of effects the haptic device can store or
   801  *            -1 on error.
   802  *
   803  * \sa SDL_HapticNumEffectsPlaying
   804  * \sa SDL_HapticQuery
   805  */
   806 extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
   807 
   808 /**
   809  * \fn int SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic)
   810  *
   811  * \brief Returns the number of effects a haptic device can play at the same time.
   812  *
   813  *    \param haptic The haptic device to query maximum playing effect.s
   814  *    \return The number of effects the haptic device can play at the same time
   815  *            or -1 on error.
   816  *
   817  * \sa SDL_HapticNumEffects
   818  * \sa SDL_HapticQuery
   819  */
   820 extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
   821 
   822 /**
   823  * \fn unsigned int SDL_HapticQuery(SDL_Haptic * haptic)
   824  *
   825  * \brief Gets the haptic devices supported features in bitwise matter.
   826  *
   827  * Example: 
   828  * \code
   829  * if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
   830  *    printf("We have constant haptic effect!");
   831  * }
   832  * \endcode
   833  *    
   834  *
   835  *    \param haptic The haptic device to query.
   836  *    \return Haptic features in bitwise manner (OR'd).
   837  *
   838  * \sa SDL_HapticNumEffects
   839  * \sa SDL_HapticEffectSupported
   840  */
   841 extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic);
   842 
   843 
   844 /**
   845  * \fn int SDL_HapticNumAxes(SDL_Haptic * haptic)
   846  *
   847  * \brief Gets the number of haptic axes the device has.
   848  *
   849  * \sa SDL_HapticDirection
   850  */
   851 extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic);
   852 
   853 /**
   854  * \fn int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
   855  *
   856  * \brief Checks to see if effect is supported by haptic.
   857  *
   858  *    \param haptic Haptic device to check on.
   859  *    \param effect Effect to check to see if it is supported.
   860  *    \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or 
   861  *            -1 on error.
   862  * 
   863  * \sa SDL_HapticQuery
   864  * \sa SDL_HapticNewEffect
   865  */
   866 extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   867 
   868 /**
   869  * \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
   870  *
   871  * \brief Creates a new haptic effect on the device.
   872  *
   873  *    \param haptic Haptic device to create the effect on.
   874  *    \param effect Properties of the effect to create.
   875  *    \return The id of the effect on success or -1 on error.
   876  *
   877  * \sa SDL_HapticUpdateEffect
   878  * \sa SDL_HapticRunEffect
   879  * \sa SDL_HapticDestroyEffect
   880  */
   881 extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   882 
   883 /**
   884  * \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
   885  *
   886  * \brief Updates the properties of an effect.
   887  *
   888  * Can be used dynamically, although behaviour when dynamically changing
   889  * direction may be strange.  Specifically the effect may reupload itself
   890  * and start playing from the start.  You cannot change the type either when
   891  * running UpdateEffect.
   892  *
   893  *    \param haptic Haptic device that has the effect.
   894  *    \param effect Effect to update.
   895  *    \param data New effect properties to use.
   896  *    \return The id of the effect on success or -1 on error.
   897  *
   898  * \sa SDL_HapticNewEffect
   899  * \sa SDL_HapticRunEffect
   900  * \sa SDL_HapticDestroyEffect
   901  */
   902 extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
   903 
   904 /**
   905  * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, int iterations)
   906  *
   907  * \brief Runs the haptic effect on it's assosciated haptic device.
   908  *
   909  * If iterations are SDL_HAPTIC_INFINITY, it'll run the effect over and over
   910  *  repeating the envelope (attack and fade) every time.  If you only want the
   911  *  effect to last forever, set SDL_HAPTIC_INFINITY in the effect's length
   912  *  parameter.
   913  *
   914  *    \param haptic Haptic device to run the effect on.
   915  *    \param effect Identifier of the haptic effect to run.
   916  *    \param iterations Number of iterations to run the effect. Use
   917  *           SDL_HAPTIC_INFINITY for infinity.
   918  *    \return 0 on success or -1 on error.
   919  *
   920  * \sa SDL_HapticStopEffect
   921  * \sa SDL_HapticDestroyEffect
   922  * \sa SDL_HapticGetEffectStatus
   923  */
   924 extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations);
   925 
   926 /**
   927  * \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
   928  *
   929  * \brief Stops the haptic effect on it's assosciated haptic device.
   930  *
   931  *    \param haptic Haptic device to stop the effect on.
   932  *    \param effect Identifier of the effect to stop.
   933  *    \return 0 on success or -1 on error.
   934  *
   935  * \sa SDL_HapticRunEffect
   936  * \sa SDL_HapticDestroyEffect
   937  */
   938 extern DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
   939 
   940 /**
   941  * \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
   942  *
   943  * \brief Destroys a haptic effect on the device.  This will stop the effect
   944  * if it's running.  Effects are automatically destroyed when the device is
   945  * closed.
   946  *
   947  *    \param haptic Device to destroy the effect on.
   948  *    \param effect Identifier of the effect to destroy.
   949  * 
   950  * \sa SDL_HapticNewEffect
   951  */
   952 extern DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
   953 
   954 /**
   955  * \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
   956  *
   957  * \brief Gets the status of the current effect on the haptic device.
   958  *
   959  * Device must support the SDL_HAPTIC_STATUS feature.
   960  *
   961  *    \param haptic Haptic device to query the effect status on.
   962  *    \param effect Identifier of the effect to query it's status.
   963  *    \return 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing
   964  *            or -1 on error.
   965  *
   966  * \sa SDL_HapticRunEffect
   967  * \sa SDL_HapticStopEffect
   968  */
   969 extern DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
   970 
   971 /**
   972  * \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
   973  *
   974  * \brief Sets the global gain of the device.  Gain should be between 0 and 100.
   975  *
   976  * Device must support the SDL_HAPTIC_GAIN feature.
   977  *
   978  * The user may specify the maxmimum gain by setting the environment variable
   979  *  SDL_HAPTIC_GAIN_MAX which should be between 0 and 100.  All calls to
   980  *  SDL_HapticSetGain will scale linearly using SDL_HAPTIC_GAIN_MAX as the
   981  *  maximum.
   982  *
   983  *    \param haptic Haptic device to set the gain on.
   984  *    \param gain Value to set the gain to, should be between 0 and 100.
   985  *    \return 0 on success or -1 on error.
   986  *
   987  * \sa SDL_HapticQuery
   988  */
   989 extern DECLSPEC int SDLCALL SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
   990 
   991 /**
   992  * \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
   993  *
   994  * \brief Sets the global autocenter of the device.  Autocenter should be between
   995  * 0 and 100.  Setting it to 0 will disable autocentering.
   996  *
   997  * Device must support the SDL_HAPTIC_AUTOCENTER feature.
   998  *
   999  *    \param haptic Haptic device to set autocentering on.
  1000  *    \param autocenter Value to set autocenter to, 0 disables autocentering.
  1001  *    \return 0 on success or -1 on error.
  1002  *
  1003  * \sa SDL_HapticQuery
  1004  */
  1005 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
  1006 
  1007 
  1008 /* Ends C function definitions when using C++ */
  1009 #ifdef __cplusplus
  1010 /* *INDENT-OFF* */
  1011 }
  1012 /* *INDENT-ON* */
  1013 #endif
  1014 #include "close_code.h"
  1015 
  1016 #endif /* _SDL_haptic_h */
  1017 
  1018 /* vi: set ts=4 sw=4 expandtab: */
  1019 
  1020