GameInputKeyState

Describes the state of an active key on a game controller.

Syntax

typedef struct GameInputKeyState {  
    uint32_t scanCode;  
    uint32_t codePoint;  
    uint8_t virtualKey;  
    bool isDeadKey;  
} GameInputKeyState  

Members

scanCode
Type: uint32_t

The scan code of the key.

codePoint
Type: uint32_t

The Unicode code point of the physical glyph on the key.

virtualKey
Type: uint8_t

The virtual-key code.

isDeadKey
Type: bool

Indicates whether the key is dead. (A dead key modifies the character generated by the next keystroke.)

Remarks

This structure is used by the IGameInputReading::GetKeyState method. GetKeyState is intended solely for mapping keyboard input to game actions, not for regular text input.

For more information, see GameInput readings.

Requirements

Header: GameInput.h

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

See also

Overview of GameInput
GameInput