Share via


IsForceFeedbackMotorPoweredOn (v1)

Indicates whether a specific force feedback motor is powered on.

Syntax

bool IsForceFeedbackMotorPoweredOn(
    uint32_t motorIndex
);

Parameters

motorIndex   _In_
Type: uint32_t

Force feedback motor index.

Return value

Type: bool

Returns false if the fore feedback motor is not powered on. Returns true if the force feedback motor is powered on.

Remarks

Force feedback motors require an external power source because a USB connection cannot provide sufficient current to drive the motor. A motor's power state is therefore not something that is under the control of software. However, it can be reported so that an application can notify the user.

There is no change in behavior of any GameInput force feedback methods when a motor has no power; thus, no effects will be played by the device. Essentially, the APIs function as though the process does not have input focus. If the effects are loaded into a force feedback motor without power, and power is later supplied to the motor. The effects will start playing as if the process gained input focus. Like the behavior for input focus, this is done to simplify the programming model.

Requirements

Header: GameInput.h

Library: gameinput.lib

Supported platforms: Windows

See also

GameInput Overview of GameInput IGameInputDevice