Share via


GetHapticInfo (v2)

Provides dynamic information about the complete haptic properties and capabilities of an input device.

Syntax

HRESULT GetHapticInfo(
    GameInputHapticInfo* info);

Parameters

info   _Out_
Type: GameInputHapticInfo*

Structure containing haptic metadata for the current device.

Return value

Type: HRESULT

Returns GAMEINPUT_E_HAPTIC_NOT_FOUND if haptic capabilities are not ready (or otherwise available) for the current device.

Remarks

The GetHapticInfo method queries the haptic metadata of the current device. As haptics rely on the Windows audio stack, it is possible that this information is not yet available at the time of device arrival. Rather than calling the GetHapticInfo method at device connection time, it is strongly recommended to register for device callbacks and wait for the GameInputDeviceHapticInfoReady device status notification. Doing this will ensure that haptics-capable devices receive the time required to initialize necessary resources before being polled for metadata.

Requirements

Header: GameInput.h

Library: gameinput.lib

Supported platforms: Windows

See also

Overview of GameInput

GameInputHapticInfo

RegisterDeviceCallback

GameInputDeviceStatus

IGameInputDevice