XGameStreamingGetLastFrameDisplayed
Deprecated. This API is deprecated as of the 2604 GDK release and will be removed in a future GDK release. There’s no replacement API: titles should use XGameStreamingGetStreamAddedLatency for latency-aware gameplay adjustments instead.
Syntax
Parameters
client _In_Type: XGameStreamingClientId The ID of the streaming client device that is being queried. framePipelineToken _Out_
Type: D3D12XBOX_FRAME_PIPELINE_TOKEN* The frame pipeline token that was last displayed on the client device.
Return value
Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.Potential Errors
Remarks
When a player is streaming a game,XGameStreamingGetLastFrameDisplayed can be utilized if the game needs to change game behavior upon confirmation that a particular frame was displayed on the user’s screen.
Some examples of when a game may utilize this include:
- A visual timer has expired and the player took no action before the expiration.
- An action was not taken within the appropriate window.
- A player continued their motion out of bounds and did not take action to recover.
XGameStreamingGetLastFrameDisplayed should be used when trying to determine when an action should have been taken, but wasn’t. In the case where the game needs to determine what was being displayed when an input was done by the player, the game should utilize XGameStreamingGetAssociatedFrame.
Example
Requirements
Header: xgamestreaming.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesConceptual documentation
See also
XGameStreamingGetAssociatedFrameXGameStreaming
Game Streaming Latency Compensation Overview
