XGameStreamingGetAssociatedFrame
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
gamepadReading _In_Type: IGameInputReading* The gamepad reading that is being queried. framePipelineToken _Out_
Type: D3D12XBOX_FRAME_PIPELINE_TOKEN* The frame pipeline token associated with the frame that was displayed on the client’s device when the input was taken by the player. This pipeline token corresponds to the PresentX call when it was presented by the game and sent to 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,XGameStreamingGetAssociatedFrame can be utilized if the game needs to change game behavior based upon what particular frame was displayed on the players’s device when the input was taken.
This would allow the game to make its simulation decisions based on the frame that the player saw at time of input, not the current one.
XGameStreamingGetAssociatedFrame can only provide information for the game about the frame being displayed when a new input reading is created. In the case where the game needs to determine what was being displayed when an input may not have been done by the player, the game should utilize XGameStreamingGetLastFrameDisplayed.
Example
Requirements
Header: xgamestreaming.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesConceptual documentation
See also
XGameStreamingGetLastFrameDisplayedXGameStreaming
Game Streaming Latency Compensation Overview
