Share via


LampArrayEffectCompletionBehavior Enum

Definition

Behavior when an effect completes.

public enum class LampArrayEffectCompletionBehavior
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
enum class LampArrayEffectCompletionBehavior
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
public enum LampArrayEffectCompletionBehavior
var value = Windows.Devices.Lights.Effects.LampArrayEffectCompletionBehavior.clearState
Public Enum LampArrayEffectCompletionBehavior
Inheritance
LampArrayEffectCompletionBehavior
Attributes

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
ClearState 0

Clears the state of all lamps when effect completes for the start of the next effect in the playlist. This is the typical case for most effects.

KeepState 1

Maintains the state of all lamps when effect completes, so state is preserved for start of the next effect in the playlist. Use to seamlessly connect effects when the end state is known.

Examples

LampArray sample

Demonstrates how to control RGB lighting of peripheral devices using the Windows.Devices.Lights and Windows.Devices.Lights.Effects APIs.

AutoRGB Sample

Demonstrates how to extract a single, representative color from a desktop screen and use it to illuminate LED lamps on a connected RGB device.

Applies to

See also