GameInputSystemButtonCallback

Warning

Deprecated. This callback function was removed in GameInput v4 and is not available in the current API. Read system button state from input readings with IGameInputReading::GetSystemButtonState and GameInputKindSystemButton instead.

Title-defined callback called when the Guide or Share button is pressed or released.

Syntax

void GameInputSystemButtonCallback(
    GameInputCallbackToken callbackToken,
    void* context,
    IGameInputDevice* device,
    uint64_t timestamp,
    GameInputSystemButtons currentButtons,
    GameInputSystemButtons previousButtons
);

Parameters

callbackToken   _In_
Type: GameInputCallbackToken

The callback token returned by IGameInput::RegisterSystemButtonCallback.

context   _In_
Type: void*

The title defined context passed to IGameInput::RegisterSystemButtonCallback.

device   _In_
Type: IGameInputDevice*

The device that triggered the event.

timestamp   _In_
Type: uint64_t

The microsecond timestamp associated with the event.

currentButtons   _In_
Type: GameInputSystemButtons

The set of system buttons that are currently pressed.

previousButtons   _In_
Type: GameInputSystemButtons

The set of system buttons that were previously pressed before this change.

Return value

Type: void

Remarks

The GameInputSystemButtonCallback function is the title-defined callback for the Guide or Share button (pressed or released) events. It is registered with the IGameInput::RegisterSystemButtonCallback method. This function is triggered by the conditions set from the registration method. For more information, see IGameInput::RegisterSystemButtonCallback.

Requirements

Header: GameInput.h

See also

Deprecated GameInput API members
IGameInputReading::GetSystemButtonState
Overview of GameInput
GameInput

Version History

Version	Changes
v4	Removed.
v1	Introduced. Replaces GameInputGuideButtonCallback.