> ## 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 リファレンス (API の内容)

> Lighting API リファレンス

# Lighting API リファレンス

Microsoft Game Development Kit (GDK) の Lighting API のリファレンス資料です。これらの API を使用して、対応する LampArray 周辺機器 (キーボード、マウス、ヘッドセット、その他の HID ライティング デバイス) を列挙し、RGB ライティングを制御します。

## 対応周辺機器の列挙

対応する周辺機器を検出するには、ステータス コールバックを登録します。LampArray API は、接続された各デバイスに対してこのコールバックを呼び出し、また、デバイスが接続または取り外されるたびに再度呼び出します。

1. [LampArrayStatusCallback](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/functions/lamparraystatuscallback.md) 関数を実装して、デバイスの接続および切断イベントを受け取ります。
2. [RegisterLampArrayStatusCallback](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/functions/registerlamparraystatuscallback.md) を呼び出してコールバックを登録します。[LampArrayEnumerationKind](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/enums/lamparrayenumerationkind.md) 値を渡して、初期列挙を非同期で実行するか、接続されているすべてのデバイスが報告されるまでブロックするかを制御します。
3. コールバック内で [ILampArray](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md) インスタンスを検査し、[DeviceId](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getdeviceid.md)、[LampArrayKind](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlamparraykind.md)、[LampCount](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount.md)、[VendorId](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getvendorid.md)、[ProductId](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getproductid.md) などのデバイス プロパティを読み取ります。
4. 通知が不要になったら、[UnregisterLampArrayStatusCallback](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/functions/unregisterlamparraycallback.md) を呼び出してイベントの受信を停止します。

サンプル コードを含む完全なウォークスルーについては、[LampArray の基礎](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/lighting-basics.md) を参照してください。

## このセクションの内容

[LampArray](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/lamparray_members.md)\
デバイスの列挙とライティングの制御に使用される関数、インターフェイス、列挙型、構造体を含む LampArray API のメンバーです。

## 関連項目

[Lighting API の概要](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/gc-lighting-toc.md)


## Related topics

- [API リファレンス (目次)](https://docs.xbox.com/ja-jp/reference/gc-reference-toc.md)
- [XGameSave Wrapper リファレンス (API の内容)](https://docs.xbox.com/ja-jp/reference/system/Wrappers/xgamesave_wrapper_members.md)
- [Windows Device Portal REST API リファレンス (API の内容)](https://docs.xbox.com/ja-jp/reference/deviceportal/atoc-deviceportal-reference.md)
- [開発キット専用 API リファレンス (API の内容)](https://docs.xbox.com/ja-jp/reference/devkit/atoc-devkit-reference.md)
- [Input API リファレンス](https://docs.xbox.com/ja-jp/reference/input/gc-reference-input-toc.md)