CreateForceFeedbackEffect

Article
2025-04-28

Uses the IGameInputForceFeedbackEffect interface to track the force feedback effect acting upon a motor.

Syntax

HRESULT CreateForceFeedbackEffect(  
         uint32_t motorIndex,  
         const GameInputForceFeedbackParams* params,  
         IGameInputForceFeedbackEffect** effect  
)

Parameters

motorIndex _In_
Type: uint32_t

Index of the motor affected by the force feedback effect.

params _In_
Type: GameInputForceFeedbackParams*

Parameters that define the nature of the force feedback effect.

effect _COM_Outptr_
Type: IGameInputForceFeedbackEffect**

The resulting IGameInputForceFeedbackEffect interface that tracks the life of the effect's resolution.

Return value

Type: HRESULT

Returns E_NOTIMPL.

This function returns an error result if there are insufficient hardware resources to create the effect, or if the requested effect is not supported by the hardware.

Remarks

The CreateForceFeedbackEffect method uses the IGameInputForceFeedbackEffect interface to track the force feedback effect acting upon a motor. If the tracked device is disconnected before the feedback effect finishes, its lifetime feedback effect is orphaned and will report its state as "stopped" until the resources are released. For more information, see Overview of GameInput.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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

Share via