IGameInput::CreateDispatcher

  • Article

Creates a dispatcher for manually scheduling GameInput background work.

Syntax

HRESULT CreateDispatcher(  
         IGameInputDispatcher** dispatcher  
)

Parameters

dispatcher   _COM_Outptr_
Type: IGameInputDispatcher**

The created dispatcher which will be used to handle background work.

Return value

Type: HRESULT

Function result.

Remarks

Making a reference to the IGameInputDispatcher switches GameInput to "manual dispatch" mode. Releasing all references to theIGameInputDispatcher object returns GameInput to "automatic dispatch" mode. IGameInputDispatcher is its own interface which you can use to dispatch events and open wait handles.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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

See also

Input API Overview
IGameInput
IGameInputDispatcher
IGameInputDispatcher::Dispatch
IGameInputDispatcher::OpenWaitHandle