LampPurposes LampPurposes LampPurposes LampPurposes LampPurposes Enum

Definition

Purpose/s of a lamp.

This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

public : enum class LampPurposes
enum class winrt::Windows::Devices::Lights::LampPurposes : uint32_t
public enum LampPurposes
Public Enum LampPurposes
var value = Windows.Devices.Lights.LampPurposes.accent;
Attributes
System.FlagsAttribute ContractVersionAttribute

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Fields

Accent Accent Accent Accent Accent 2

Accent Lamp that doesn't interact with the user (e.g. case fan LED, illuminated side panels on a keyboard).

Branding Branding Branding Branding Branding 4

Device branding (e.g. manufacturer logo).

Control Control Control Control Control 1

Control Lamp (e.g. button/key/slider)

Illumination Illumination Illumination Illumination Illumination 16

Illuminates an object that is outside of the LampArray (e.g. stage spotlight, car headlights, camera flash).

Presentation Presentation Presentation Presentation Presentation 32

A lamp the user directly looks at (e.g. within an artwork or costume).

Status Status Status Status Status 8

Status lamp (e.g. unread email, CPU temperature).

Undefined Undefined Undefined Undefined Undefined 0

No Purposes defined for this lamp.

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.