> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lighting API の概要

> Lighting API の概要

## はじめに

Microsoft Game Development Kit (GDK) は、キーボード、マウス、ヘッドセットなど、さまざまな周辺機器の RGB ライティングを制御するための軽量な API を提供します。

対応デバイスは、[HID standard for Lighting and Illumination](https://www.usb.org/sites/default/files/hutrr84_-_lighting_and_illumination_page.pdf) を実装しているか、これに準拠しています。この仕様では以下のように定義されています。

* *Lamp* とは、オン/オフの状態、明るさ、または RGB カラー値を操作できる単一の LED、電球、その他の光源です。

* 1 つ以上の Lamp を含み、前述の HID ライティング標準に準拠したデバイスは *LampArray* と呼ばれます。

GDK に含まれるライティング API も LampArray という名前を使用しています。

> **注意:** 2023 年 3 月の recovery 時点で、GDK Lighting API はコンソール上で以下のデバイスのみをサポートしています。今後の recovery リリースで対応デバイスが追加される予定です。
>
> * Razer Turret for XBOX One (キーボードおよびマウス)
> * Razer BlackWidow Tournament Edition Chroma V2

## トピック

[LampArray の基礎](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/lighting-basics.md)
LampArray API を構成する基本オブジェクトの取得方法と確認方法について説明します。

[LampArray への色の設定](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/lighting-colors.md)
LampArray API による基本的な色の操作方法について説明します。

[LampArray エフェクト](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/lighting-effects.md)
より複雑な LampArray のライティング エフェクトを作成するためのヒントを紹介します。

## 関連項目

[LampArray API リファレンス](https://docs.xbox.com/ja-jp/reference/lighting/gc-reference-lighting-toc.md)

[Microsoft Game Development Kit](https://docs.xbox.com/ja-jp/services/playfab/sdks/platforms/gdk.md)


## Related topics

- [Lighting API リファレンス (API の内容)](https://docs.xbox.com/ja-jp/reference/lighting/gc-reference-lighting-toc.md)
- [ILampArray (インターフェイスの内容)](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md)
- [ILampInfo (インターフェイスの内容)](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo.md)
- [LampArray エフェクト](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/lighting-effects.md)
- [RegisterLampArrayCallback](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/functions/registerlamparraycallback.md)