IGameInputReading::GetSensorsState

Retrieve a view of the input reading that describes the state of sensors on the device.

Syntax

bool GetSensorsState(
    GameInputSensorsState* state
);

Parameters

state   _Out_
Type: GameInputSensorsState*

Interpretation of the input as a set of sensors.

Return value

Type: bool

Returns true on successful interpretation of sensor input. Returns false when attempting to read an input that is not recognized as sensor input.

Remarks

Call the IGameInputReading::GetInputKind method to see which Get*State functions will return a valid interpretation for some IGameInputReading. Each Get*State function has a corresponding entry in the IGameInputReading::GetInputKind enum. If you attempt to call a Get*State function where the corresponding IGameInputReading::GetInputKind flag is not set, the function will return with default at rest values as well as a false return value.

Requirements

Header: GameInput.h

Library: gameinput.lib

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

See also

Input API Overview
IGameInputReading
GameInputSensorsState
GameInputSensorsInfo
GameInputSensorsKind