Skip to main content

XGameStreamingGetDisplayDetails

この API は、指定されたクライアントのディスプレイの詳細を返します。これを使用して、レンダリングするカスタム アスペクト比や、DirectCapture を有効にするために使用する解像度など、根拠のある判断を行うことができます。

Syntax

Parameters

client   _In_
型: XGameStreamingClientId
照会するストリーミング クライアント。 maxSupportedPixels   _In_
型: uint32_t
ゲームがサポートする最大ピクセル数。 widestSupportedAspectRatio   _In_
型: float
ゲームがサポートする最も横長のアスペクト比。これは、サポートされる最も横長の解像度を使用して width / height から計算されます。 tallestSupportedAspectRatio   _In_
型: float
ゲームがサポートする最も縦長のアスペクト比。これは、サポートされる最も縦長の解像度を使用して width / height から計算されます。 displayDetails   _Out_
型: XGameStreamingDisplayDetails*
ストリーミング クライアントのディスプレイの詳細。

Return value

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

想定されるエラー

エラー コードの一覧については、Error Codes を参照してください。

Remarks

displayDetails 内のデータは、ゲームのレンダリング解像度や、重要な情報や UI を操作可能かつ隠されない位置に配置するための情報など、ゲームの各種側面を制御するために使用できます。 displayDetails 構造体内の preferredWidth および preferredHeight は、ストリーミング クライアント上の実際のディスプレイ、ストリーミング システムに基づく制限、およびゲームから提供されるパラメーター (maxSupportedPixelswidestSupportedAspectRatiotallestSupportedAspectRatio) に基づいて決定されます。 このデータはゲームの起動時には利用できない可能性があり、また必ずしもクライアント接続イベントの時点で利用可能とは限らないため、ゲームはイベントまたはポーリングを使用する必要があります。

Example

Requirements

ヘッダー: xgamestreaming.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、XBOX One ファミリー本体および XBOX Series 本体

See also

XGameStreaming XGameStreamingDisplayDetails XGameStreamingRegisterClientPropertiesChanged XGameStreamingSetResolution Custom Resolution Overview
最終更新日 2026年8月24日