Skip to main content

XGameStreamingShowTouchControlsWithStateUpdateOnClient

Request that a specified streaming client device update its touch control state and then show a specified touch layout. All state updates happen before the new touch layout is displayed.

Syntax

Parameters

client   _In_
Type: XGameStreamingClientId
The streaming client device to update state and show the touch controls on. layout   _In_opt_z_
Type: char*
Name of the touch control layout to display or nullptr to display the standard layout. operationCount   _In_
Type: size_t
Size of the array of operations being passed. operations   _In_reads_opt_(operationCount)
Type: XGameStreamingTouchControlsStateOperation*
Array of all the state variable updates that are being requested.

Return value

Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.

Potential Errors

Remarks

This API should be used when the game would like to show a particular touch layout that also requires some state updates that may affect its rendering. Use this API if you would like to both update the state of variables that are referenced in a new touch layout AND switch to the touch layout on a specified streaming client devices. This API makes sure that all state updates are made before the new layout is displayed. If you would like to affect all streaming client devices use XGameStreamingShowTouchControlsWithStateUpdate. If the game only needs to change the layout, the game should use XGameStreamingShowTouchControlLayoutOnClient instead. If the state updates can affect the current layout or other layouts and updates should happen regardless of a specific touch layout change, the game should use XGameStreamingUpdateTouchControlsStateOnClient instead.

Examples

Requirements

Header: XGameStreaming.h Library: xgameruntime.lib Supported Platforms: Windows, XBOX One family consoles and XBOX Series consoles

See also

XGameStreaming
XGameStreamingTouchControlsStateOperationKind
XGameStreamingTouchControlsStateOperation
XGameStreamingTouchControlsStateValue
XGameStreamingShowTouchControlsWithStateUpdate
XGameStreamingUpdateTouchControlsState
XGameStreamingUpdateTouchControlsStateOnClient
Last modified on August 20, 2026