LampArrayCustomEffect LampArrayCustomEffect LampArrayCustomEffect LampArrayCustomEffect LampArrayCustomEffect Class

Definition

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 : sealed class LampArrayCustomEffect : ILampArrayEffect
struct winrt::Windows::Devices::Lights::Effects::LampArrayCustomEffect : ILampArrayEffect
public sealed class LampArrayCustomEffect : ILampArrayEffect
Public NotInheritable Class LampArrayCustomEffect Implements ILampArrayEffect
var lampArrayCustomEffect = new lampArrayCustomEffect(lampArray, lampIndexes);
Attributes

Windows 10 requirements

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

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[]) LampArrayCustomEffect(LampArray, Int32[]) LampArrayCustomEffect(LampArray, Int32[]) LampArrayCustomEffect(LampArray, Int32[]) LampArrayCustomEffect(LampArray, Int32[])

Creates and initializes a new instance of the effect.

Properties

Duration Duration Duration Duration Duration

Gets or sets the duration of the effect.

UpdateInterval UpdateInterval UpdateInterval UpdateInterval 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 ZIndex ZIndex ZIndex ZIndex

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

Events

UpdateRequested UpdateRequested UpdateRequested UpdateRequested UpdateRequested

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