XGameStreamingHideTouchControls

Article
06/22/2023

Request that all connected streaming client devices hide the touch layout if they are visible.

Syntax

void XGameStreamingHideTouchControls();

Return value

Type: void

Remarks

This API requests that all connected game streaming clients remove any displayed touch overlay controls. If the player is not streaming the game, or if they are streaming to a device which is not showing touch overlay controls, this function does nothing.

To display a specific touch control layout, call XGameStreamingShowTouchControlLayout.

Every call to XGameStreamingHideTouchControls results in a message being sent over the network, so it should not be called every frame. Instead, only call this API when your game needs to transition out of having touch controls displayed on screen.

If your game needs to hide the touch control layout on a specific connected streaming client device, consider using XGameStreamingHideTouchControlsOnClient instead.

Examples

void OnShowMenu()
{
    // This game has native touch support for the menu system, so hide touch overlay controls
    XGameStreamingHideTouchControls();
}

void OnDismissMenu()
{
    // Show the touch overlay controls which were previously on the screen before we hid them
    // due to bringing up the menu.
    XGameStreamingShowTouchControlLayout(m_currentTouchLayout);
}

Requirements

Header: xgamestreaming.h

Library: xgameruntime.lib

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