IGameInputForceFeedbackEffect::SetState

Article
06/22/2023

Sets the state for a force-feedback effect.

Syntax

void SetState(  
         GameInputFeedbackEffectState state  
)

Parameters

state _In_
Type: GameInputFeedbackEffectState

The new state set for a force feedback effect.

Return value

Type: void

No return.

Remarks

The IGameInputForceFeedbackEffect::SetState method sets the state for a force feedback effect. The set state of the force feedback effect may be running, stopped, or paused. For more information, see Advanced GameInput topics.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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