include/SDL_haptic.h
changeset 7630 c711a2f14814
parent 7621 5caa5fb3deb6
child 7677 871d43c6968a
equal deleted inserted replaced
7629:a0a3bd77cbc4 7630:c711a2f14814
   481 /**
   481 /**
   482  *  \brief A structure containing a template for a Periodic effect.
   482  *  \brief A structure containing a template for a Periodic effect.
   483  *
   483  *
   484  *  The struct handles the following effects:
   484  *  The struct handles the following effects:
   485  *   - ::SDL_HAPTIC_SINE
   485  *   - ::SDL_HAPTIC_SINE
   486  *   - ::SDL_HAPTIC_SQUARE
   486  *   - ::SDL_HAPTIC_LEFTRIGHT
   487  *   - ::SDL_HAPTIC_TRIANGLE
   487  *   - ::SDL_HAPTIC_TRIANGLE
   488  *   - ::SDL_HAPTIC_SAWTOOTHUP
   488  *   - ::SDL_HAPTIC_SAWTOOTHUP
   489  *   - ::SDL_HAPTIC_SAWTOOTHDOWN
   489  *   - ::SDL_HAPTIC_SAWTOOTHDOWN
   490  *
   490  *
   491  *  A periodic effect consists in a wave-shaped effect that repeats itself
   491  *  A periodic effect consists in a wave-shaped effect that repeats itself
   527      \ | \ | \ | \ | \ | \ | \ |
   527      \ | \ | \ | \ | \ | \ | \ |
   528       \|  \|  \|  \|  \|  \|  \|
   528       \|  \|  \|  \|  \|  \|  \|
   529     \endverbatim
   529     \endverbatim
   530  *
   530  *
   531  *  \sa SDL_HAPTIC_SINE
   531  *  \sa SDL_HAPTIC_SINE
   532  *  \sa SDL_HAPTIC_SQUARE
   532  *  \sa SDL_HAPTIC_LEFTRIGHT
   533  *  \sa SDL_HAPTIC_TRIANGLE
   533  *  \sa SDL_HAPTIC_TRIANGLE
   534  *  \sa SDL_HAPTIC_SAWTOOTHUP
   534  *  \sa SDL_HAPTIC_SAWTOOTHUP
   535  *  \sa SDL_HAPTIC_SAWTOOTHDOWN
   535  *  \sa SDL_HAPTIC_SAWTOOTHDOWN
   536  *  \sa SDL_HapticEffect
   536  *  \sa SDL_HapticEffect
   537  */
   537  */
   538 typedef struct SDL_HapticPeriodic
   538 typedef struct SDL_HapticPeriodic
   539 {
   539 {
   540     /* Header */
   540     /* Header */
   541     Uint16 type;        /**< ::SDL_HAPTIC_SINE, ::SDL_HAPTIC_SQUARE,
   541     Uint16 type;        /**< ::SDL_HAPTIC_SINE, ::SDL_HAPTIC_LEFTRIGHT,
   542                              ::SDL_HAPTIC_TRIANGLE, ::SDL_HAPTIC_SAWTOOTHUP or
   542                              ::SDL_HAPTIC_TRIANGLE, ::SDL_HAPTIC_SAWTOOTHUP or
   543                              ::SDL_HAPTIC_SAWTOOTHDOWN */
   543                              ::SDL_HAPTIC_SAWTOOTHDOWN */
   544     SDL_HapticDirection direction;  /**< Direction of the effect. */
   544     SDL_HapticDirection direction;  /**< Direction of the effect. */
   545 
   545 
   546     /* Replay */
   546     /* Replay */