IGameInputReading::GetUiNavigationState
Retrieve a view of the input reading that describes the state of a UI navigation.
Syntax
bool GetUiNavigationState(
GameInputUiNavigationState* state
)
Parameters
state _Out_
Type: GameInputUiNavigationState*
Interpretation of the input as UI navigation.
Return value
Type: bool
Returns true on successful interpretation of a UI Navigation input. Returns false when attempting to read an input that is not recognized as a UI Navigation 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: xgameruntime.lib
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles