Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Sets new parameters on a force-feedback effect.
Syntax
bool SetParams(
const GameInputForceFeedbackParams* params
)
Parameters
params _In_
Type: GameInputForceFeedbackParams*
The new force-feedback parameters to be set.
Return value
Type: bool
The results of setting the new parameters. If the function succeeds, it returns true.
Remarks
When setting new parameters for a force feedback effect, the motor will attempt to continue the effect uninterrupted. You may only set new parameters on a force feedback effect if the new parameters and the old parameters share the same GameInputForceFeedbackEffectKind enumeration. For more information, see Advanced GameInput topics.
Note that the duration timer is not refreshed if the duration value does not change. It will only be refreshed if a different duration value is provided, or the effect is stopped and restarted.
Requirements
Header: GameInput.h
Library: xgameruntime.lib
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles
See also
Overview of GameInput
GameInputForceFeedbackParams
IGameInputForceFeedbackEffect