Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Sets every Lamp on the ILampArray to the desired color.
Syntax
void SetColor(
LampArrayColor desiredColor)
Parameters
desiredColor Type: LampArrayColor
The desired color to set.
Return value
Type: void
Remarks
Black (a zero-filled LampArrayColor) is equivalent to a Lamp being 'off'.
The alpha value (LampArrayColor::a) represents the relative transparency of a color, where zero is fully transparent and 0xFF is fully opaque. If an alpha value other than 0xFF is used, the color will undergo an additional blending step against black. To avoid this blending step, do not pass in any alpha value other than 0xFF when setting colors.
Lamp state will not be flushed to the device if the ILampArray is disabled for the current process (see ILampArray::SetIsEnabled).
Requirements
Header: LampArray.h
Library: xgameplatform.lib
Supported platforms: Xbox One family consoles and Xbox Series consoles
See also
Lighting API Overview
Setting Colors on a LampArray
LampArrayColor
ILampArray::SetColorsForIndices
ILampArray::SetColorsForScanCodes
ILampArray