GameInputColor

Describes a color used to light the lamps on an input device.

Syntax

struct GameInputColor
{
    uint8_t r;
    uint8_t g;
    uint8_t b;
};

r
Type: uint8_t

Intensity of the red component, from 0 (off) to 255 (full intensity).

g
Type: uint8_t

Intensity of the green component, from 0 (off) to 255 (full intensity).

b
Type: uint8_t

Intensity of the blue component, from 0 (off) to 255 (full intensity).

This structure is passed to IGameInputDevice::SetLightingColor to stage a color for a selection of lamps. Staged colors are sent to the device when IGameInputDevice::ApplyLightingColors is called. A color of { 0, 0, 0 } turns the selected lamps off.

The way a color is displayed depends on the device. Some lamps can't reproduce every color, and a device might approximate the requested color.

Header: GameInput.h

Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Version	Changes
v4	Introduced.

Was this page helpful?