Provided by: libsdl3-doc_3.2.8+ds-1_all bug

NAME

       SDL_HapticRamp - A structure containing a template for a Ramp effect.

HEADER FILE

       Defined in SDL3/SDL_haptic.h

SYNOPSIS

       #include "SDL3/SDL.h"

       typedef struct SDL_HapticRamp
       {
           /* Header */
           Uint16 type;            /**< SDL_HAPTIC_RAMP */
           SDL_HapticDirection direction;  /**< Direction of the effect. */

           /* Replay */
           Uint32 length;          /**< Duration of the effect. */
           Uint16 delay;           /**< Delay before starting the effect. */

           /* Trigger */
           Uint16 button;          /**< Button that triggers the effect. */
           Uint16 interval;        /**< How soon it can be triggered again after button. */

           /* Ramp */
           Sint16 start;           /**< Beginning strength level. */
           Sint16 end;             /**< Ending strength level. */

           /* Envelope */
           Uint16 attack_length;   /**< Duration of the attack. */
           Uint16 attack_level;    /**< Level at the start of the attack. */
           Uint16 fade_length;     /**< Duration of the fade. */
           Uint16 fade_level;      /**< Level at the end of the fade. */
       } SDL_HapticRamp;

DESCRIPTION

       This struct is exclusively for the SDL_HAPTIC_RAMP

       effect.

       The  ramp effect starts at start strength and ends at end strength. It augments in linear fashion. If you
       use attack and fade with a ramp the effects get added  to  the  ramp  effect  making  the  effect  become
       quadratic instead of linear.

AVAILABILITY

       This struct is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_HAPTIC_RAMP(3), (3), SDL_HapticEffect(3type)

Simple Directmedia Layer                            SDL 3.2.8                              SDL_HapticRamp(3type)