GameInputSystemButtonCallback (v0)

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 currentState,
        GameInputSystemButtons previousState
)  

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.

currentState   _In_
Type: GameInputSystemButtons

The set of system buttons that are currently pressed.

previousState   _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.

This was added in the Windows SDK 10.0.26031 Preview GameInput.h and will be added to a future release of the GDK.

Requirements

Header: GameInput.h

Library: gameinput.lib

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

See also

Overview of GameInput
GameInput