IGameInputForceFeedbackEffect::GetState

  • Article

Retrieves the current state for a force feedback effect.

Syntax

GameInputFeedbackEffectState GetState(  
)

Parameters

This method has no parameters.

Return value

Type: GameInputFeedbackEffectState

The state of the force feedback effect.

Remarks

The GetState method retrieves the current state of a force feedback effect. The current state 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

See also

Overview of GameInput
IGameInputForceFeedbackEffect::SetState
IGameInputForceFeedbackEffect