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.
A representation of a single addressable Lamp and its properties. The methods on this object give information about the Lamp's relative position, color support, intended purposes, and associated keyboard scan code (if applicable).
Syntax
class ILampInfo : public IUnknown
Methods
| Method | Description |
|---|---|
| GetBlueLevelCount | Returns the number of blue intensities settable for the Lamp. |
| GetFixedColor | Returns whether a Lamp has a fixed color. |
| GetGainLevelCount | Returns the number of color independent intensities settable for this Lamp. |
| GetGreenLevelCount | Returns the number of blue intensities settable for the Lamp. |
| GetIndex | Returns the index in the LampArray at which the given lamp resides. |
| GetNearestSupportedColor | Finds the nearest/closest matching color supported by this Lamp relative to the desired color. |
| GetPosition | Returns the 3D position of the Lamp relative to the origin of the LampArray's bounding box. |
| GetPurposes | Returns the set of purposes for which the Lamp is intended to be used. |
| GetRedLevelCount | Returns the number of red intensities settable for the Lamp. |
| GetScanCode | Returns the keyboard scan code associated with this Lamp. |
| GetUpdateLatencyInMicroseconds | Returns the amount of time between the LampArray receiving an update for a Lamp and the update emanating from the device. |
Requirements
Header: LampArray.h
Supported platforms: Xbox One family consoles and Xbox Series consoles