GameInputHapticFeedbackParams (v0)

Describes a haptic feedback effect for an input device.

Syntax

typedef struct GameInputHapticFeedbackParams {  
    uint32_t waveformIndex;  
    uint64_t duration;  
    float intensity;  
    uint32_t playCount;  
    uint64_t repeatDelay;  
} GameInputHapticFeedbackParams  

Members

waveformIndex
Type: uint32_t

Index of the waveform for the effect. (See the waveformInfo member of GameInputHapticFeedbackMotorInfo.)

duration
Type: uint64_t

Duration, in microseconds, of the effect.

intensity
Type: float

Intensity of the effect as a normalized value in the range of [0.0, 1.0].

playCount
Type: uint32_t

Number of times the effect will be played.

repeatDelay
Type: uint64_t

Time, in microseconds, to delay before repeating the effect.

Remarks

This structure is used by the IGameInputDevice::SetHapticMotorState method.

For information about a haptic feedback motor, examine GameInputHapticFeedbackMotorInfo. The waveformInfo member contains descriptions (GameInputHapticWaveformInfo) of the available waveforms.

Requirements

Header: GameInput.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Overview of GameInput
GameInput