IGameInputDevice::SetLightingColor

入力デバイス上の 1 つ以上のランプのカラーをステージングします。このカラーは、次に IGameInputDevice::ApplyLightingColors を呼び出したときにデバイスに送信されます。

構文

void SetLightingColor(
    GameInputColor color,
    GameInputLightingGroups group,
    uint32_t groupOrderIndex = GAMEINPUT_LIGHTING_GROUP_ORDER_INDEX_ALL
);

パラメーター

color
型: GameInputColor 選択したランプに対してステージングするカラー。 group
型: GameInputLightingGroups 設定するランプを含むライティンググループの選択範囲。1 つ以上の名前付きグループフラグ、デバイス上のすべてのランプを選択する GameInputLightingGroupAll、またはどの名前付きグループにも属さないランプを選択する GameInputLightingGroupUnknown を指定できます。 groupOrderIndex _In_opt_
型: uint32_t group 内の個々のランプを選択します。既定値の GAMEINPUT_LIGHTING_GROUP_ORDER_INDEX_ALL は、group 内のすべてのランプを選択します。その他の値の解釈については、「解説」を参照してください。

戻り値

型: void

解説

SetLightingColor はランプをすぐには変更しません。選択したランプのカラーを記録 (ステージング) します。ステージングされたすべてのカラーを 1 回の更新でデバイスに送信するには、IGameInputDevice::ApplyLightingColors を呼び出します。カラーを適用するまでは何も送信されないため、複数のグループや個々のランプを設定して、それらを同時に変化させることができます。ステージングされたカラーは適用された後も有効なままであるため、後で 1 つのグループを変更するには、そのグループの新しいカラーをステージングして、もう一度適用するだけで済みます。 groupOrderIndex パラメーターは次のように解釈されます。

groupOrderIndex の値	選択されるランプ
`GAMEINPUT_LIGHTING_GROUP_ORDER_INDEX_ALL` (0xFFFFFFFF)	group 内のすべてのランプ。
キーボードスキャンコード (group が `GameInputLightingGroupKeyboardKey` の場合)	そのスキャンコードを持つキーのランプ。スキャンコードには Set 1 エンコードを使用します: 0x01 ～ 0x7F、拡張スキャンコード 0xE001 ～ 0xE07F、または Pause キーの場合は 0xE11D。
その他の値	group 内で 0 から始まるその位置にあるランプ。この値は、group に対して IGameInputDevice::GetSupportedLightingGroupSize から返される値より小さくなければなりません。

GameInputLightingGroupKeyboardKey を他の名前付きグループと組み合わせた選択範囲では、インデックスがあいまいになるため、個々のランプを選択できません。このような選択範囲では GAMEINPUT_LIGHTING_GROUP_ORDER_INDEX_ALL を使用してください。GameInputLightingGroupAll では、デバイス上のすべてのランプの中での 0 から始まる位置によって、個々のランプを選択できます。選択範囲がデバイスに対して有効でない場合、呼び出しは無視され、何もステージングされません。選択範囲は、デバイスにない名前付きグループを含む場合 (IGameInputDevice::GetSupportedLightingGroups を参照)、ランプを含まない場合、または範囲外の groupOrderIndex や有効なスキャンコードではない groupOrderIndex を指定した場合に無効になります。切断されたデバイスに対する呼び出しは何の効果もありません。ステージングされたカラーを破棄してランプを既定の動作に戻すには、IGameInputDevice::ApplyLightingSystemDefault を呼び出します。次の例では、コントローラーのフェイスボタンを赤に、センターライトを青に設定してから、両方のカラーを 1 回の更新で適用します。

void SetControllerLighting(IGameInputDevice* device) noexcept
{
    const GameInputLightingGroups groups = device->GetSupportedLightingGroups();

    if ((groups & GameInputLightingGroupFaceButtons) != 0)
    {
        device->SetLightingColor({ 255, 0, 0 }, GameInputLightingGroupFaceButtons);
    }

    if ((groups & GameInputLightingGroupCenterLight) != 0)
    {
        device->SetLightingColor({ 0, 0, 255 }, GameInputLightingGroupCenterLight);
    }

    device->ApplyLightingColors();
}

次の例では、キーごとのライティングを備えたキーボードのすべてのキーを暗くし、Set 1 スキャンコード 0x1E を持つ A キーを強調表示します。

void HighlightKeyA(IGameInputDevice* device) noexcept
{
    if ((device->GetSupportedLightingGroups() & GameInputLightingGroupKeyboardKey) == 0)
    {
        return;
    }

    device->SetLightingColor({ 16, 16, 16 }, GameInputLightingGroupKeyboardKey);
    device->SetLightingColor({ 0, 255, 0 }, GameInputLightingGroupKeyboardKey, 0x1E);
    device->ApplyLightingColors();
}

ライティングのサポートは、デバイスとプラットフォームによって異なります。現在、GameInput は、Windows Dynamic Lighting (LampArray) デバイスと DualSense コントローラーのライトバーでのライティングをサポートしています。

要件

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

バージョン履歴

バージョン	変更内容
v4	導入されました。

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

構文

パラメーター

戻り値

解説

要件

関連項目

バージョン履歴

​構文

​パラメーター

​戻り値

​解説

​要件

​関連項目

​バージョン履歴

構文

パラメーター

戻り値

解説

要件

関連項目

バージョン履歴