include/SDL_haptic.h
changeset 9146 dbef1f283c3f
parent 9070 8973a237f360
child 9147 6bf589c8d549
equal deleted inserted replaced
9145:aa99e029b12e 9146:dbef1f283c3f
   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
   492  *  over time.  The type determines the shape of the wave and the parameters
   492  *  over time.  The type determines the shape of the wave and the parameters
   493  *  determine the dimensions of the wave.
   493  *  determine the dimensions of the wave.
   494  *
   494  *
   495  *  Phase is given by hundredth of a cycle meaning that giving the phase a value
   495  *  Phase is given by hundredth of a degree meaning that giving the phase a value
   496  *  of 9000 will displace it 25% of its period.  Here are sample values:
   496  *  of 9000 will displace it 25% of its period.  Here are sample values:
   497  *   -     0: No phase displacement.
   497  *   -     0: No phase displacement.
   498  *   -  9000: Displaced 25% of its period.
   498  *   -  9000: Displaced 25% of its period.
   499  *   - 18000: Displaced 50% of its period.
   499  *   - 18000: Displaced 50% of its period.
   500  *   - 27000: Displaced 75% of its period.
   500  *   - 27000: Displaced 75% of its period.
   553 
   553 
   554     /* Periodic */
   554     /* Periodic */
   555     Uint16 period;      /**< Period of the wave. */
   555     Uint16 period;      /**< Period of the wave. */
   556     Sint16 magnitude;   /**< Peak value. */
   556     Sint16 magnitude;   /**< Peak value. */
   557     Sint16 offset;      /**< Mean value of the wave. */
   557     Sint16 offset;      /**< Mean value of the wave. */
   558     Uint16 phase;       /**< Horizontal shift given by hundredth of a cycle. */
   558     Uint16 phase;       /**< Horizontal shift given by hundredth of a degree. */
   559 
   559 
   560     /* Envelope */
   560     /* Envelope */
   561     Uint16 attack_length;   /**< Duration of the attack. */
   561     Uint16 attack_length;   /**< Duration of the attack. */
   562     Uint16 attack_level;    /**< Level at the start of the attack. */
   562     Uint16 attack_level;    /**< Level at the start of the attack. */
   563     Uint16 fade_length; /**< Duration of the fade. */
   563     Uint16 fade_length; /**< Duration of the fade. */