IGameInputDevice::ApplyLightingSystemDefault

Discards all staged lighting colors and returns the lamps on the input device to their default behavior.

Syntax

void ApplyLightingSystemDefault();

Parameters

This method has no parameters.

Return value

Type: void

Remarks

Call this method when your application no longer needs to control the lighting of a device, for example when the player leaves a game mode that uses custom lighting. It discards every color that was staged by calling IGameInputDevice::SetLightingColor and releases control of the lamps, so that they return to the behavior that the system or the device provides by default. For devices whose protocol has no way to resume the default behavior, the lamps are turned off. After calling this method, you can take control of the lamps again by staging new colors and calling IGameInputDevice::ApplyLightingColors. The following example restores the default lighting of a device.

void RestoreDefaultLighting(IGameInputDevice* device) noexcept
{
    if ((device->GetSupportedInput() & GameInputKindLighting) != 0)
    {
        device->ApplyLightingSystemDefault();
    }
}

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.

Last modified on November 5, 2026

⌘I

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