GameInputRumbleMotors

Enumerates the API supported rumble motors for an input device.

Syntax

enum GameInputRumbleMotors
{
    GameInputRumbleNone          = 0x00000000,
    GameInputRumbleLowFrequency  = 0x00000001,
    GameInputRumbleHighFrequency = 0x00000002,
    GameInputRumbleLeftTrigger   = 0x00000004,
    GameInputRumbleRightTrigger  = 0x00000008
};

Constants

Constant	Description
GameInputRumbleNone	No rumble motor.
GameInputRumbleLowFrequency	Rumble motor with low frequency.
GameInputRumbleHighFrequency	Rumble motor with high frequency.
GameInputRumbleLeftTrigger	Rumble motor in the left trigger.
GameInputRumbleRightTrigger	Rumble motor in the right trigger.

Remarks

Rumble enumeration is based on the XBOX gamepad, but other devices are supported. Call IGameInputDevice::GetSupportedRumbleMotors to get the rumble motors that a device supports, and use IGameInputDevice::SetRumbleState with a GameInputRumbleParams structure to drive them.

In GameInput v3 and earlier, the supported rumble motors are reported in the supportedRumbleMotors member of GameInputDeviceInfo.

Requirements

Header: GameInput.h

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

See also

Input API Overview
GameInput
IGameInputDevice::GetSupportedRumbleMotors
IGameInputDevice::SetRumbleState
GameInputRumbleParams

Version History

Version	Changes
v0	Introduced.