LampInfo Class

Definition

Namespace:

Windows.Devices.Lights

Container of various properties of an individual lamp for a specific index.

public ref class LampInfo sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class LampInfo final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class LampInfo

Public NotInheritable Class LampInfo

Inheritance

Object Platform::Object IInspectable LampInfo

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v7.0)

Properties

BlueLevelCount	The number of blue intensities settable for this lamp.
FixedColor	If this lamp index has a fixed color, the color is returned; otherwise null.
GainLevelCount	The number of color independent intensities settable for this lamp.
GreenLevelCount	The number of green intensities settable for this lamp.
Index	Zero based index of the lamp. Every lamp is associated with one unique index.
Position	3D position of the lamp relative to the origin of the bounding-box.
Purposes	Purpose/s of the lamp.
RedLevelCount	The number of red intensities settable for this lamp.
UpdateLatency	Time between the device receiving an update for a lamp and it emanating from the device.

Methods

GetNearestSupportedColor(Color)

Finds the nearest/closest matching color to the desired color, supported by this lamp. Call this to know whether a specific color will be applied during (e.g.) LampArray.SetColor