IGameInputDevice::SendInputSynchronizationHint

  • Article

Analyzes calls made to the GameInput API to determine when the game input device is available.

Syntax

void SendInputSynchronizationHint(  
)

Parameters

This method has no parameters.

Return value

Type: void

No return value

Remarks

The IGameInputDevice::SendInputSynchronizationHint synchronization method analyzes calls made to the GameInput API and determines when a game's input device is available. If there is an issue determining the input device's availability, call this function to allow the GameInput API to synchronize the pattern so that it gets called more often than other calls to the GameInput API.

Note

For best results, it is recommended to call this function on a fixed cadence within the game loop.

Requirements

Header: gameinput.h

Library: xgameruntime.lib

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

See also

Advanced GameInput topics
Overview of GameInput
IGameInputDevice::SetInputSynchronizationState
IGameInputDevice