XGameStreamingUpdateTouchControlsState
Update state on all streaming clients 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
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 useXGameStreamingUpdateTouchControlsState to update the state for all connected clients or XGameStreamingUpdateTouchControlsStateOnClient to update a specific connected client.
If the game would needs 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.libSupported Platforms: Windows, XBOX One family consoles and XBOX Series consoles
See also
XGameStreamingXGameStreamingTouchControlsStateOperationKind
XGameStreamingTouchControlsStateOperation
XGameStreamingTouchControlsStateValue
XGameStreamingShowTouchControlsWithStateUpdate
XGameStreamingShowTouchControlsWithStateUpdateOnClient
XGameStreamingUpdateTouchControlsStateOnClient
