LampPurposes Enum

Reference

Definition

Namespace:: Windows.Devices.Lights

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Purpose/s of a lamp.

This enumeration supports a bitwise combination of its member values.

public enum class LampPurposes

/// [System.Flags]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
enum class LampPurposes

[System.Flags]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
public enum LampPurposes

var value = Windows.Devices.Lights.LampPurposes.undefined

Public Enum LampPurposes

Inheritance: Enum
LampPurposes

Attributes: FlagsAttribute ContractVersionAttribute

Windows requirements

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

Fields

Name	Value	Description
Undefined	0	No Purposes defined for this lamp.
Control	1	Control Lamp (for example, button/key/slider)
Accent	2	Accent Lamp that doesn't interact with the user (for example, case fan LED, illuminated side panels on a keyboard).
Branding	4	Device branding (for example, manufacturer logo).
Status	8	Status lamp (for example, unread email, CPU temperature).
Illumination	16	Illuminates an object that is outside of the LampArray (for example, stage spotlight, car headlights, camera flash).
Presentation	32	A lamp the user directly looks at (for example, within an artwork or costume).

Remarks

It is likely this list will expand in the future, so avoid placing error checks that validate a Purpose is within the current bounds. Preferred approach is to compare against the subset of Purposes the application supports.

Applies to

Share via