Syntax
Parameters
groupType: 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.
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 consolesSee also
Overview of GameInputIGameInputDevice
GameInputLightingGroups
IGameInputDevice::GetSupportedLightingGroups
IGameInputDevice::SetLightingColor
IGameInputDevice::ApplyLightingColors
