IGameInputDevice::GetSupportedLightingGroups

Gets the lighting groups in which the input device has controllable lamps.

Syntax

GameInputLightingGroups GetSupportedLightingGroups();

Parameters

This method has no parameters.

Return value

Type: GameInputLightingGroups A combination of GameInputLightingGroups flags for every named lighting group that contains at least one lamp on the device. Returns GameInputLightingGroupUnknown (0) if the device has no lamps in any named group.

Remarks

Each flag in the returned value identifies a named group of lamps, such as GameInputLightingGroupFaceButtons or GameInputLightingGroupCenterLight, that you can address with IGameInputDevice::SetLightingColor. The method never reports GameInputLightingGroupUnknown as a group, because its value is 0. A device can have lamps that don’t belong to any named group. A return value of 0 therefore doesn’t always mean that the device has no lamps. To determine whether a device supports lighting at all, check whether IGameInputDevice::GetSupportedInput includes GameInputKindLighting, or call IGameInputDevice::GetSupportedLightingGroupSize with GameInputLightingGroupAll. To count lamps that aren’t in a named group, call GetSupportedLightingGroupSize with GameInputLightingGroupUnknown. The following example sets the face buttons to red and the center light to blue on devices that have those groups, and then applies the colors in a single update.

void SetControllerLighting(IGameInputDevice* device) noexcept
{
    const GameInputLightingGroups groups = device->GetSupportedLightingGroups();

    if ((groups & GameInputLightingGroupFaceButtons) != 0)
    {
        device->SetLightingColor({ 255, 0, 0 }, GameInputLightingGroupFaceButtons);
    }

    if ((groups & GameInputLightingGroupCenterLight) != 0)
    {
        device->SetLightingColor({ 0, 0, 255 }, GameInputLightingGroupCenterLight);
    }

    device->ApplyLightingColors();
}

The set of supported lighting groups doesn’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

Version History

Version	Changes
v4	Introduced.

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

​Version History

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History