XGameStreamingGetAssociatedFrame

特定の入力読み取りからフレーム パイプライン トークンを取得します。

構文

HRESULT XGameStreamingGetAssociatedFrame(  
         IGameInputReading* gamepadReading,  
         D3D12XBOX_FRAME_PIPELINE_TOKEN* framePipelineToken  
)  

パラメーター

gamepadReading _In_
型: IGameInputReading*

クエリされているゲームパッドの読み取り値。

framePipelineToken _Out_
型: D3D12XBOX_FRAME_PIPELINE_TOKEN*

プレイヤーによって入力が行われたときにクライアントのデバイスに表示されたフレームに関連付けられているフレーム パイプライン トークン。 このパイプライン トークンは、ゲームによって提供され、クライアント デバイスに送信されたときの PresentX の呼び出しに対応します。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合はエラー コードを返します。

返される可能性のあるエラー

エラー コード	エラー値	エラーの原因
E_GAMESTREAMING_NOT_INITIALIZED	0x89245400	XGameStreaming ランタイムが初期化されていません。 他の API を呼び出す前に XGameStreamingInitialize を呼び出してください。
E_GAMESTREAMING_NO_DATA	0x89245402	要求されたデータは利用できません。 データは後で利用可能になる場合があります。
E_GAMESTREAMING_NOT_STREAMING_CONTROLLER	0x89245404	現在の読み取り値は、ストリーミング コントローラーからのものではありません。

解説

プレイヤーがゲームをストリーミングしているとき、入力が行われたときに特定のフレームがプレイヤーのデバイスに表示されるようにゲームの動作を変更する必要がある場合、XGameStreamingGetAssociatedFrame を利用できます。

これを使用すると、ゲームは、現在のフレームではなく入力時にプレイヤーに表示されたフレームに基づいてシミュレーションの決定を行うことができます。

XGameStreamingGetAssociatedFrame は、新しい入力読み取り値が作成されたときに表示されているフレームに関するゲームの情報のみを提供できます。 プレイヤーによって入力が行われなかったときに表示されたものをゲームが判断する必要がある場合、ゲームは、XGameStreamingGetLastFrameDisplayed を利用する必要があります。

例

// In this example, when processing input, the game would like to pass along the frame 
// that was being displayed to the player at the time of input so that their simulation
// engine can take that into account.

// The framePipelineToken was initially captured at the callback of WaitFrameEventX

void Game::Update(DX::StepTimer const& timer)
{
    IGameInputReading* reading;
    if (SUCCEEDED(g_gameInput->GetCurrentReading(GameInputKindGamepad, g_gamepad, &reading)))
    {
        D3D12XBOX_FRAME_PIPELINE_TOKEN framePipelineToken = D3D12XBOX_FRAME_PIPELINE_TOKEN_NULL;        

        if SUCCEEDED(XGameStreamingGetAssociatedFrame(&reading, &framePipelineToken)) 
        {
            SimulateBasedOnInputAndFrameDisplayed(reading, framePipelineToken);
        }
        else 
        {
            // simulate based on current frame
            SimulateBasedOnInput(reading);
        }

        reading->Release();
    }
}

要件

ヘッダー: xgamestreaming.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameStreamingGetLastFrameDisplayed
XGameStreaming
ゲーム ストリーミング待機時間補正の概要