IGameInput::CreateAggregateDevice

Article
11/09/2023

Note

This function is not yet implemented.

Creates a virtual IGameInputDevice instance which aggregates all input of the specified GameInputKind.

Syntax

HRESULT CreateAggregateDevice(  
         GameInputKind inputKind,  
         IGameInputDevice** device  
)

Parameters

inputKind _In_
Type: GameInputKind

The type of input which the returned virtual IGameInputDevice will aggregate readings for.

device _COM_Outptr_
Type: IGameInputDevice**

The resulting IGameInputDevice. Will return null on error.

Return value

Type: HRESULT

This function is not yet implemented. Returns E_NOTIMPL.

Planned implementation commonly returns an error when an unsupported GameInputKind is used or when attempting to combine GameInputKind flags.

Remarks

The input kind specified in the call to the CreateAggregateDevice method must be a single value from the GameInputKind enumeration; combining GameInputKind flags is not supported. If an application needs aggregated input for multiple input kinds, it must create a virtual IGameInputDevice instance for each one.

There are a few input kinds that do not make sense from an aggregation perspective. To avoid surprising or unexpected behavior, aggregation of the following input kinds is not supported:

GameInputKindRawDeviceReport
GameInputKindController
GameInputKindTouch
GameInputKindMotion

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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

Partager via