Skip to main content
Gets the number of lamps on the input device in the specified lighting group selection.

Syntax

Parameters

group
Type: GameInputLightingGroups
The lighting group selection whose lamps are counted. This can be one or more named group flags, GameInputLightingGroupAll, or GameInputLightingGroupUnknown.

Return value

Type: uint32_t The number of lamps in the selection. Returns 0 if the device has no lamps in the selection or if group contains undefined flags.

Remarks

The value of group is interpreted as follows. The lamp count of a selection is the exclusive upper bound for the groupOrderIndex parameter of IGameInputDevice::SetLightingColor when you address an individual lamp by its ordinal. The exception is GameInputLightingGroupKeyboardKey, which addresses individual lamps by keyboard scan code instead. The following example lights each lamp in the face button group with a different shade of green.
The lamp counts don’t change for the lifetime of the device object.
Lighting support depends on the device and the platform. Currently, GameInput supports lighting on Windows Dynamic Lighting (LampArray) devices and on the lightbar of DualSense controllers.

Requirements

Header: GameInput.h Library: gameinput.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

See also

Overview of GameInput
IGameInputDevice
GameInputLightingGroups
IGameInputDevice::GetSupportedLightingGroups
IGameInputDevice::SetLightingColor
IGameInputDevice::ApplyLightingColors

Version History

Last modified on November 5, 2026