次の方法で共有

XGameStreamingSetResolution

  • [アーティクル]

ストリームの解像度を設定します。

構文

HRESULT XGameStreamingSetResolution(
        uint32_t width,
        uint32_t height
)

パラメーター

width _In_
型: uint32_t

ストリームの解像度を設定する幅。

height _In_
型: uint32_t

ストリームの解像度を設定する高さ。

戻り値

型: HRESULT

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

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

エラー コード エラー値 エラーの原因
E_GAMESTREAMING_NOT_INITIALIZED 0x89245400 XGameStreaming ランタイムが初期化されていません。 他の API を呼び出す前に XGameStreamingInitialize を呼び出します。
E_INVALIDARG 0x80070057 幅または高さパラメーター、またはハードウェアが要件を満たしていません。

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

解説

標準以外の解像度のこの API は、Xbox ゲーム ストリーミング サーバー、Xbox Series X 開発キット、および Xbox Series S テスト キットでのみ成功します。 720p や 1080p などの標準解像度は、ハードウェアに関係なく成功します。 その理由は、リテール版の Xbox はリモート再生を介してのみストリーミングでき、テレビにビデオを出力している可能性があるためです。そのため、標準以外の解像度を使用すると、歪んだ画像が生成されます。

幅と高さは 640 x 360 以上である必要があります。最大値は XGameStreamingGetDisplayDetails から取得できる XGameStreamingDisplayDetails の maxWidth フィールドと maxHeight フィールドにあります。

width * height から計算される最大ピクセル数は、エンコーダーの最大値以下である必要があります。 最大値は、XGameStreamingGetDisplayDetails API を使用して確認できます。 この値は将来増加する可能性があります。

width と height は 8 で割り切れる必要があります。

API は必要な頻度で呼び出すことができますが、ストリームの解決は 200 ミリ秒ごとに 1 回しか変更できません。 その 200 ミリ秒のウィンドウ内で発生した呼び出しからの最後の解像度は、そのウィンドウが経過した後に適用されます。

この API では、接続されているすべてのクライアントのストリームの解像度が設定されることに注意してください。 つまり、複数のクライアントが接続されている場合にゲームに最適なオプションを決定するには、特別な考慮事項が必要な場合があります。 標準の 16:9 解像度を使用することを意味する場合や、すべてのクライアントに最適な解像度を見つけようとすることを意味する場合があります。

注意

ストリーム解像度を変更すると、ID3D12CommandQueue::PresentX でのビューの四角形のスケーリングが変更されます。 D3D12XBOX_PRESENT_PLANE_PARAMETERS.pDestPlacementBase スケール ファクター 0.0 から 1.0 は、標準の 1920x1080 または 3840x2160 の解像度ではなく、XGameStreamingSetResolution に渡される高さと幅を参照します。す。

例


#define DEFAULT_GAME_WIDTH 1920
#define DEFAULT_GAME_HEIGHT 1080

#define GAME_WIDEST_SUPPORTED_ASPECT_RATIO 21.5f / 9.0f
#define GAME_TALLEST_SUPPORTED_ASPECT_RATIO 16.0f / 10.0f

static uint32_t s_currentStreamWidth = DEFAULT_GAME_WIDTH;
static uint32_t s_currentStreamHeight = DEFAULT_GAME_HEIGHT;

// Option 1: Event driven. Note: be aware of potential threading issues when using the task queue.
void GameStreamingClientManager::OnConnectionStateChanged(XGameStreamingClientId client, XGameStreamingConnectionState connected)
{
    // Other connection work like registering or unregistering for the client properties change events.
    ...

    UpdateResolutionIfNeeded();
}

void GameStreamingClientManager::OnClientPropertiesChanged(
    XGameStreamingClientId client,
    uint32_t updatedPropertiesCount,
    XGameStreamingClientProperty* updatedProperties)
{
    for (uint32_t i = 0; i < updatedPropertiesCount; ++i)
    {
        switch (updatedProperties[i])
        {
        case XGameStreamingClientProperty::DisplayDetails:
        {
            UpdateResolutionIfNeeded();
            break;
        }

        default:
            // A characteristic we are not tracking - do nothing
            break;
        }
    }
}

// Option 2: Polling.

void Game::Update(DX::StepTimer const& timer)
{
    ...

    gameStreamingClientManager->UpdateResolutionIfNeeded();

    ...
}

void GameStreamingClientManager::UpdateResolutionIfNeeded()
{
    bool changeResolution = false;
    bool useDefaultResolution = true;

    // Only use custom resolution when there is only one streaming client connected.
    if (XGameStreamingGetClientCount() == 1)
    {
        XGameStreamingClientId client;
        uint32_t clientsUsed = 0;
        HRESULT hr = XGameStreamingGetClients(1, &client, &clientsUsed);
        if (SUCCEEDED(hr) && clientsUsed == 1)
        {
            XGameStreamingDisplayDetails displayDetails = {};
            hr = XGameStreamingGetDisplayDetails(client, DEFAULT_GAME_WIDTH * DEFAULT_GAME_HEIGHT, GAME_WIDEST_SUPPORTED_ASPECT_RATIO, GAME_TALLEST_SUPPORTED_ASPECT_RATIO, &displayDetails);

            if (SUCCEEDED(hr))
            {
                useDefaultResolution = false;

                // Assuming the game supports all resolutions, use the stream resolution to the preferred dimensions as provided.
                if (s_currentStreamWidth != displayDetails.preferredWidth || s_currentStreamHeight != displayDetails.preferredHeight)
                {
                    changeResolution = true;
                    s_currentStreamWidth = displayDetails.preferredWidth;
                    s_currentStreamHeight = displayDetails.preferredHeight;
                }
            }
            else
            {
                LogFormat(L"XGameStreamingGetDisplayDetails failed %x", hr);
            }
        }
        else
        {
            LogFormat(L"XGameStreamingGetClients failed hr=%x clientsUsed=%d", hr, clientsUsed);
        }
    }

    if (useDefaultResolution)
    {
        if (s_currentStreamWidth != DEFAULT_GAME_WIDTH || s_currentStreamHeight != DEFAULT_GAME_HEIGHT)
        {
            changeResolution = true;
            s_currentStreamWidth = DEFAULT_GAME_WIDTH;
            s_currentStreamHeight = DEFAULT_GAME_HEIGHT;
        }
    }

    if (changeResolution)
    {
        // Update the stream to the new resolution.
        HRESULT hr = XGameStreamingSetResolution(s_currentStreamWidth, s_currentStreamHeight);
        if (SUCCEEDED(hr))
        {
            // Update the game to render at the new resolution.
        }
        else
        {
            LogFormat(L"XGameStreamingSetResolution failed %x", hr);
        }
    }
}

要件

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

関連項目

XGameStreaming
XGameStreamingDisplayDetails
XGameStreamingGetDisplayDetails
カスタム解像度の概要