LampArrayCustomEffect Class

  • Reference

Definition

Namespace:
Windows.Devices.Lights.Effects
Edit

This effect provides an entry-point for developer-defined custom effects into the effect framework; allowing it to be included and scheduled within playlists.

public ref class LampArrayCustomEffect sealed : ILampArrayEffect
/// [Windows.Foundation.Metadata.Activatable(Windows.Devices.Lights.Effects.ILampArrayCustomEffectFactory, 458752, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class LampArrayCustomEffect final : ILampArrayEffect
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Devices.Lights.Effects.ILampArrayCustomEffectFactory), 458752, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class LampArrayCustomEffect : ILampArrayEffect
function LampArrayCustomEffect(lampArray, lampIndexes)
Public NotInheritable Class LampArrayCustomEffect
Implements ILampArrayEffect
Inheritance
Object Platform::Object IInspectable LampArrayCustomEffect
Attributes
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Implements
ILampArrayEffect

Windows requirements

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

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.

Remarks

Similar to BitmapEffect, a developer specifies the subset of lamp indexes to affect and then subscribes to the UpdateRequested event to modify lamp state at a recurring interval.

Constructors

LampArrayCustomEffect(LampArray, Int32[])

Creates and initializes a new instance of the effect.

Properties

Duration

Gets or sets the duration of the effect.
UpdateInterval

Gets or sets the interval between the triggering of the UpdateRequested event. The supplied image will be displayed until the event is next triggered.
ZIndex

The global precedence for two effects that modify the same lamp.

Events

UpdateRequested

Event triggered by the system to indicate that lamp state should be modified.

Applies to

See also