SDL 3.0
SDL_HapticRamp Struct Reference

#include <SDL_haptic.h>

Collaboration diagram for SDL_HapticRamp:

Data Fields

SDL_HapticEffectType type
SDL_HapticDirection direction
Uint32 length
Uint16 delay
Uint16 button
Uint16 interval
Sint16 start
Sint16 end
Uint16 attack_length
Uint16 attack_level
Uint16 fade_length
Uint16 fade_level

Detailed Description

A structure containing a template for a Ramp effect.

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.

Since
This struct is available since SDL 3.2.0.
See also
SDL_HAPTIC_RAMP
SDL_HapticEffect

Definition at line 767 of file SDL_haptic.h.

Field Documentation

◆ attack_length

Uint16 SDL_HapticRamp::attack_length

Duration of the attack.

Definition at line 786 of file SDL_haptic.h.

◆ attack_level

Uint16 SDL_HapticRamp::attack_level

Level at the start of the attack.

Definition at line 787 of file SDL_haptic.h.

◆ button

Uint16 SDL_HapticRamp::button

Button that triggers the effect.

Definition at line 778 of file SDL_haptic.h.

◆ delay

Uint16 SDL_HapticRamp::delay

Delay before starting the effect.

Definition at line 775 of file SDL_haptic.h.

◆ direction

SDL_HapticDirection SDL_HapticRamp::direction

Direction of the effect.

Definition at line 771 of file SDL_haptic.h.

◆ end

Sint16 SDL_HapticRamp::end

Ending strength level.

Definition at line 783 of file SDL_haptic.h.

◆ fade_length

Uint16 SDL_HapticRamp::fade_length

Duration of the fade.

Definition at line 788 of file SDL_haptic.h.

◆ fade_level

Uint16 SDL_HapticRamp::fade_level

Level at the end of the fade.

Definition at line 789 of file SDL_haptic.h.

◆ interval

Uint16 SDL_HapticRamp::interval

How soon it can be triggered again after button.

Definition at line 779 of file SDL_haptic.h.

◆ length

Uint32 SDL_HapticRamp::length

Duration of the effect.

Definition at line 774 of file SDL_haptic.h.

◆ start

Sint16 SDL_HapticRamp::start

Beginning strength level.

Definition at line 782 of file SDL_haptic.h.

◆ type

SDL_HapticEffectType SDL_HapticRamp::type

SDL_HAPTIC_RAMP

Definition at line 770 of file SDL_haptic.h.

The documentation for this struct was generated from the following file: