Skip to main content

XGameStreamingUpdateTouchControlsStateOnClient

Update state on a specified streaming client that touch layouts can use to alter their behavior. Any visual changes to the touch control set that is currently being displayed will be done after ALL the variables are updated.

Syntax

Parameters

client   _In_
Type: XGameStreamingClientId
The streaming client device to update state on. 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

Touch layouts used by streaming clients can depend on state, whose initial values are embedded into the touch layout bundle. The game can update the state, which can cause the layout that is currently being displayed to the player to change. The game can use XGameStreamingUpdateTouchControlsState to update the state for all connected clients or XGameStreamingUpdateTouchControlsStateOnClient to update a specific connected client. If the game would like to update the state AND make a layout change at the same time, it can utilize XGameStreamingShowTouchControlsWithStateUpdate or XGameStreamingShowTouchControlsWithStateUpdateOnClient.

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