Lighting API Overview

Introduction

The Microsoft Game Development Kit (GDK) provides lightweight APIs to control RGB lighting on a variety of peripheral devices, including keyboards, mice, headsets, and more.

Compatible devices implement or adapt to the HID standard for Lighting and Illumination. In this specification:

  • A Lamp is a single LED, bulb or other light source that can be manipulated in terms of on/off state, brightness and/or RGB color value.

  • A device containing one or more Lamps and conforming to the aforementioned HID lighting standard is called a LampArray.

The lighting APIs included in the GDK also carry the name LampArray.

Please note: As of the March 2023 recovery, the GDK Lighting API only supports the following devices on console. Support for additional devices will be added in future recovery releases.

  • Razer Turret for Xbox One (keyboard and mouse)
  • Razer BlackWidow Tournament Edition Chroma V2

Topics

LampArray Basics
Describes how to obtain and inspect the basic objects that comprise the LampArray API.

Setting Colors on a LampArray
Describes how to perform basic color operations with the LampArray API.

LampArray Effects
Provides tips on creating more complex LampArray lighting effects.

See also

LampArray API reference

Microsoft Game Development Kit