Share via

IGameInputDevice::SetInputSynchronizationState

  • Article

Enables or disables input synchronization for an input device.

Syntax

void SetInputSynchronizationState(  
         bool enabled  
)

Parameters

enabled   _In_
Type: bool

Indicates whether or not input synchronization state will be set to enabled.
If true, input synchronization will be enabled.

Remarks

The input synchronization feature analyzes calls made to the GameInput API to determine when the game is most likely to want input to be available. This function returns a not supported error if the input device does not support input synchronization. This device capability is reflected in the GameInputDeviceCapabilities enum.

Requirements

Header: gameinput.h

Library: xgameruntime.lib

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

See also

IGameInputDevice
IGameInputDevice::SendInputSynchronizationHint