GameInputHapticWaveformInfo (v0)

Describes characteristics of a haptic feedback effect.

Syntax

typedef struct GameInputHapticWaveformInfo {  
    GameInputUsage usage;  
    bool isDurationSupported;  
    bool isIntensitySupported;  
    bool isRepeatSupported;  
    bool isRepeatDelaySupported;  
    uint64_t defaultDuration;  
} GameInputHapticWaveformInfo  

Members

usage
Type: GameInputUsage

ID of the HID usage for the haptic waveform.

isDurationSupported
Type: bool

If true, the duration of the effect can be specified.

isIntensitySupported
Type: bool

If true, the intensity level of the effect can be specified.

isRepeatSupported
Type: bool

If true, the effect can be repeated.

isRepeatDelaySupported
Type: bool

If true, a delay between repetitions of the effect can be specified.

defaultDuration
Type: uint64_t

The default duration of the effect.

Remarks

This structure is used in the GameInputHapticFeedbackMotorInfo structure. GameInputHapticFeedbackMotorInfo is used in the GameInputDeviceInfo structure; for more information, see GetDeviceInfo.

To send a waveform to a haptic feedback motor, use IGameInputDevice::SetHapticMotorState.

Requirements

Header: GameInput.h

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

See also

Overview of GameInput
GameInput