My Project
Public Attributes | List of all members
SDL_HapticCustom Struct Reference

A structure containing a template for the SDL_HAPTIC_CUSTOM effect. More...

#include <SDL_haptic.h>

Public Attributes

Uint16 type
 
SDL_HapticDirection direction
 
Uint32 length
 
Uint16 delay
 
Uint16 button
 
Uint16 interval
 
Uint8 channels
 
Uint16 period
 
Uint16 samples
 
Uint16 * data
 
Uint16 attack_length
 
Uint16 attack_level
 
Uint16 fade_length
 
Uint16 fade_level
 

Detailed Description

A structure containing a template for the SDL_HAPTIC_CUSTOM effect.

This struct is exclusively for the SDL_HAPTIC_CUSTOM effect.

A custom force feedback effect is much like a periodic effect, where the application can define its exact shape. You will have to allocate the data yourself. Data should consist of channels * samples Uint16 samples.

If channels is one, the effect is rotated using the defined direction. Otherwise it uses the samples in data for the different axes.

See also
SDL_HAPTIC_CUSTOM
SDL_HapticEffect

Member Data Documentation

◆ attack_length

Uint16 SDL_HapticCustom::attack_length

Duration of the attack.

◆ attack_level

Uint16 SDL_HapticCustom::attack_level

Level at the start of the attack.

◆ button

Uint16 SDL_HapticCustom::button

Button that triggers the effect.

◆ channels

Uint8 SDL_HapticCustom::channels

Axes to use, minimum of one.

◆ data

Uint16* SDL_HapticCustom::data

Should contain channels*samples items.

◆ delay

Uint16 SDL_HapticCustom::delay

Delay before starting the effect.

◆ direction

SDL_HapticDirection SDL_HapticCustom::direction

Direction of the effect.

◆ fade_length

Uint16 SDL_HapticCustom::fade_length

Duration of the fade.

◆ fade_level

Uint16 SDL_HapticCustom::fade_level

Level at the end of the fade.

◆ interval

Uint16 SDL_HapticCustom::interval

How soon it can be triggered again after button.

◆ length

Uint32 SDL_HapticCustom::length

Duration of the effect.

◆ period

Uint16 SDL_HapticCustom::period

Sample periods.

◆ samples

Uint16 SDL_HapticCustom::samples

Amount of samples.

◆ type

Uint16 SDL_HapticCustom::type

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