Share via

LampArrayKind Enumeration

Describes the general type of the physical device this ILampArray is part of.

Syntax

enum class LampArrayKind : uint32_t
{
    Undefined       = 0,
    Keyboard        = 1,
    Mouse           = 2,
    GameController  = 3,
    Peripheral      = 4,
    Scene           = 5,
    Notification    = 6,
    Chassis         = 7,
    Wearable        = 8,
    Furniture       = 9,
    Art             = 10,
    Headset         = 11
};

Constants

Constant Description
Undefined LampArrayKind is not specified for this device.
Keyboard Is part of a keyboard or keypad.
Mouse Is part of a mouse.
GameController Is part of a game controller (for example, gamepad, flight stick, sailing simulation device).
Peripheral Is part of a more general peripheral/accessory (for example, speakers, mousepad, microphone, webcam).
Scene Illuminates a room/performance stage/area (for example, room light bulbs, spotlights, wash lights, strobe lights, booth-strips, billboard/sign, camera flash).
Notification Is part of a notification device.
Chassis Is part of an internal PC case component (for example, RAM stick, motherboard, fan).
Wearable Is embedded in a wearable accessory (for example, audio headset, wristband, watch, shoes).
Furniture Is embedded in a piece of furniture (for example, chair, desk, bookcase).
Art Is embedded in an artwork (for example, painting, sculpture).
Headset Is embedded in a wearable accessory designed specifically for the head (for example, headphones). This is a specialization of Wearable.

Remarks

It is likely this list will expand in the future, so avoid placing error checks that validate whether a LampArrayKind is within the current bounds. The preferred approach is to compare against the subset of LampArrayKinds the application supports.

Requirements

Header: Declared in LampArray.h.

See also

Lighting API Overview
ILampArray::GetLampArrayKind