GameInputGuideButtonCallback

Article
03/05/2024

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

Syntax

C++

void GameInputGuideButtonCallback(  
         GameInputCallbackToken callbackToken,  
         void* context,  
         IGameInputDevice* device,  
         uint64_t timestamp,  
         bool isPressed  
)

Parameters

callbackToken _In_
Type: GameInputCallbackToken

The callback token returned by IGameInput::RegisterGuideButtonCallback.

context _In_
Type: void*

The title defined context passed to IGameInput::RegisterGuideButtonCallback.

device _In_
Type: IGameInputDevice*

The device that triggered the event.

timestamp _In_
Type: uint64_t

The microsecond timestamp associated with the event.

isPressed _In_
Type: bool

Boolean indicating whether the guide button is pressed.

Return value

Type: void

Remarks

Warning

This API is deprecated and will be removed in a future release. Use GameInputSystemButtonCallback instead.

The GameInputGuideButtonCallback function is used by the title-defined callback for the guide button (pressed or released) event. It is registered with the IGameInput::RegisterDeviceCallback method. This function is triggered by the conditions set from the registration method. For more information, see Advanced GameInput topics.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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

Share via