GameInputKeyboardLayoutCallback

Title-defined callback for the guide-button (pressed or released) event.

Syntax

void GameInputKeyboardLayoutCallback(
        GameInputCallbackToken callbackToken,
        void * context,
        IGameInputDevice * device,
        uint64_t timestamp,
        uint32_t currentLayout,
        uint32_t previousLayout
)

Parameters

callbackToken   _In_
Type: GameInputCallbackToken

The callback token returned by IGameInput::RegisterKeyboardLayoutCallback.

context   _In_
Type: void*

The title defined context passed to IGameInput::RegisterKeyboardLayoutCallback.

device   _In_
Type: IGameInputDevice*

The device that triggered the event.

timestamp   _In_
Type: uint64_t

The microsecond timestamp associated with the event.

currentLayout   _In_
Type: uint32_t

The new/current keyboard layout.

previousLayout   _In_
Type: uint32_t

The previous keyboard layout.

Return value

Type: void

Remarks

The GameInputKeyboardLayoutCallback function is used by the title-defined callback when the keyboard layout changes. It is registered with the IGameInput::RegisterKeyboardLayoutCallback method. This function is triggered by the conditions set from the registration method. For more information, see Advanced GameInput topics.

The currentLayout and previousLayout parameters contain the Keyboard Layout ID values that are identical to those provided by the GetKeyboardLayoutName function, but expressed as a 32-bit integer instead of a string.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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

See also

Overview of GameInput
GameInput