Lighting API Reference
Lighting API reference material for the Microsoft Game Development Kit (GDK). Use these APIs to enumerate compatible LampArray peripherals (keyboards, mice, headsets, and other HID lighting devices) and control their RGB lighting.Enumerate compatible peripherals
To discover compatible peripherals, register a status callback that the LampArray API invokes for each connected device, and again whenever a device is attached or removed.- Implement a LampArrayStatusCallback function to receive device connect and disconnect events.
- Call RegisterLampArrayStatusCallback to register the callback. Pass a LampArrayEnumerationKind value to control whether initial enumeration runs asynchronously or blocks until every connected device has been reported.
- In the callback, inspect the ILampArray instance to read device properties such as DeviceId, LampArrayKind, LampCount, VendorId, and ProductId.
- When you no longer need notifications, call UnregisterLampArrayCallback to stop receiving events.
In this section
LampArrayLampArray API members, including the functions, interfaces, enums, and structs used to enumerate devices and control lighting.