Controls the RGB lighting of Logitech keyboards and other peripherals. More...

Public Member Functions
native proto void	SetLighting (int red, int green, int blue)
	Sets the lighting on connected and supported devices.

native proto bool	SaveCurrentLighting ()
	Saves the current lighting so it can be restored after a temporary effect is finished.

native proto bool	RestoreLighting ()
	Restores the last saved lighting.

native proto bool	StopEffects ()
	Stops any currently running effects (started from FlashLighting or PulseLighting).

native proto bool	FlashLighting (int red, int green, int blue, int msDuration, int msInterval)
	Saves the current lighting, plays the flashing effect on the targeted devices, and finally restores the saved lighting.

native proto bool	PulseLighting (int red, int green, int blue, int msDuration, int msInterval)
	Saves the current lighting, plays the pulsing effect on targeted devices, and finally restores the saved lighting.

native proto bool	SetLightingForKey (string keyName, int red, int green, int blue)
	Sets the key identified by the given name to the desired color.

native proto bool	SaveLightingForKey (string keyName)
	Saves the current color on the key specified by the name passed as an argument.

native proto bool	RestoreLightingForKey (string keyName)
	Restores the saved color on the key specified by the name passed as an argument.

native proto bool	FlashSingleKey (string keyName, int red, int green, int blue, int msDuration, int msInterval)
	Starts a flashing effect on the key specified by the parameter.

native proto bool	PulseSingleKey (string keyName, int startRed, int startGreen, int startBlue, int finishRed, int finishGreen, int finishBlue, int msDuration, bool isInfinite)
	Starts a pulsing effect on the key specified by the parameter.

native proto bool	StopEffectsOnKey (string keyName)
	Stops any ongoing effect on the key specified by the parameter.

Static Public Member Functions
static proto native LogitechLED	Get ()
	Returns an instance of LogitechLED, or nullptr if not initialized.

Detailed Description

Controls the RGB lighting of Logitech keyboards and other peripherals.

Member Function Documentation

◆ FlashLighting()

native proto bool LogitechLED.FlashLighting	(	int	red,
		int	green,
		int	blue,
		int	msDuration,
		int	msInterval )

Saves the current lighting, plays the flashing effect on the targeted devices, and finally restores the saved lighting.

Parameters

red	Amount of red (0–100)
green	Amount of green (0–100)
blue	Amount of blue (0–100)
msDuration	Duration of the effect in milliseconds. Can be set to 0 to make the effect run until stopped through StopEffects().
msInterval	Duration of the flashing interval in milliseconds.

Returns: False if initialization failed or there is no connection with Logitech Gaming Software.

◆ FlashSingleKey()

native proto bool LogitechLED.FlashSingleKey	(	string	keyName,
		int	red,
		int	green,
		int	blue,
		int	msDuration,
		int	msInterval )

Starts a flashing effect on the key specified by the parameter.

The key will flash with an interval defined by msInterval for msDuration milliseconds, alternating between the specified color and black. This function affects only per-key backlighting on supported connected devices.

Parameters

keyName	Enfusion key name.
red	Amount of red (0–100).
green	Amount of green (0–100).
blue	Amount of blue (0–100).
msDuration	Duration of the effect in milliseconds. Can be set to 0 to make the effect run until stopped through StopEffects() or StopEffectsOnKey().
msInterval	Duration of the flashing interval in milliseconds.

Returns: False if an invalid key name was passed, initialization failed, or there is no connection with Logitech Gaming Software.

◆ Get()

static proto native LogitechLED LogitechLED.Get ( )

static

Returns an instance of LogitechLED, or nullptr if not initialized.

◆ PulseLighting()

native proto bool LogitechLED.PulseLighting	(	int	red,
		int	green,
		int	blue,
		int	msDuration,
		int	msInterval )

Saves the current lighting, plays the pulsing effect on targeted devices, and finally restores the saved lighting.

Parameters

red	Amount of red (0–100)
green	Amount of green (0–100)
blue	Amount of blue (0–100)
msDuration	Duration of the effect in milliseconds. Can be set to 0 to make the effect run until stopped through StopEffects().
msInterval	Duration of the pulsing interval in milliseconds.

Returns: False if initialization failed or there is no connection with Logitech Gaming Software.

◆ PulseSingleKey()

native proto bool LogitechLED.PulseSingleKey	(	string	keyName,
		int	startRed,
		int	startGreen,
		int	startBlue,
		int	finishRed,
		int	finishGreen,
		int	finishBlue,
		int	msDuration,
		bool	isInfinite )

Starts a pulsing effect on the key specified by the parameter.

The key will pulse from the start color to the finish color for msDuration milliseconds. This function affects only per-key backlighting on supported connected devices.

Parameters

keyName	Enfusion key name.
startRed	Amount of red (0–100).
startGreen	Amount of green (0–100).
startBlue	Amount of blue (0–100).
finishRed	Amount of red (0–100).
finishGreen	Amount of green (0–100).
finishBlue	Amount of blue (0–100).
msDuration	Duration of the effect in milliseconds.
isInfinite	If set to true, the effect will loop infinitely until stopped with a call to StopEffects() or StopEffectsOnKey().

Returns: False if an invalid key name was passed, initialization failed, or there is no connection with Logitech Gaming Software.

◆ RestoreLighting()

native proto bool LogitechLED.RestoreLighting ( )

Restores the last saved lighting.

It should be called after a temporary effect is finished.

Returns: False if initialization failed or there is no connection with Logitech Gaming Software.

◆ RestoreLightingForKey()

native proto bool LogitechLED.RestoreLightingForKey ( string keyName )

Restores the saved color on the key specified by the name passed as an argument.

Use this function with SaveLightingForKey to preserve the state of a key before applying any effect.

Parameters

keyName Enfusion key name.

Returns: False if an invalid key name was passed, initialization failed, or there is no connection with Logitech Gaming Software.

◆ SaveCurrentLighting()

native proto bool LogitechLED.SaveCurrentLighting ( )

Saves the current lighting so it can be restored after a temporary effect is finished.

Returns: False if initialization failed or there is no connection with Logitech Gaming Software.

◆ SaveLightingForKey()

native proto bool LogitechLED.SaveLightingForKey ( string keyName )

Saves the current color on the key specified by the name passed as an argument.

Use this function with RestoreLightingForKey to preserve the state of a key before applying any effect.

Parameters

keyName Enfusion key name.

Returns: False if an invalid key name was passed, initialization failed, or there is no connection with Logitech Gaming Software.

◆ SetLighting()

native proto void LogitechLED.SetLighting	(	int	red,
		int	green,
		int	blue )

Sets the lighting on connected and supported devices.

Parameters

red	Amount of red (0–100)
green	Amount of green (0–100)
blue	Amount of blue (0–100)

◆ SetLightingForKey()

native proto bool LogitechLED.SetLightingForKey	(	string	keyName,
		int	red,
		int	green,
		int	blue )

Sets the key identified by the given name to the desired color.

This function affects only per-key backlighting on supported connected devices.

Parameters

keyName	Enfusion key name.
red	Amount of red (0–100).
green	Amount of green (0–100).
blue	Amount of blue (0–100).

Returns: False if an invalid key name was passed, initialization failed, or there is no connection with Logitech Gaming Software.

◆ StopEffects()

native proto bool LogitechLED.StopEffects ( )

Stops any currently running effects (started from FlashLighting or PulseLighting).

Returns: False if initialization failed or there is no connection with Logitech Gaming Software.

◆ StopEffectsOnKey()

native proto bool LogitechLED.StopEffectsOnKey ( string keyName )

Stops any ongoing effect on the key specified by the parameter.

This function affects only per-key backlighting on supported connected devices.

Parameters

keyName Enfusion key name.

Returns: False if an invalid key name was passed, initialization failed, or there is no connection with Logitech Gaming Software.

The documentation for this interface was generated from the following file:

Game/Utilities/LogitechLED.c

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ FlashLighting()

◆ FlashSingleKey()

◆ Get()

◆ PulseLighting()

◆ PulseSingleKey()

◆ RestoreLighting()

◆ RestoreLightingForKey()

◆ SaveCurrentLighting()

◆ SaveLightingForKey()

◆ SetLighting()

◆ SetLightingForKey()

◆ StopEffects()

◆ StopEffectsOnKey()