LampArrayBitmapEffect LampArrayBitmapEffect LampArrayBitmapEffect LampArrayBitmapEffect LampArrayBitmapEffect Class

Definition

Renders a series of images to selected lamp indexes on the device.

public : sealed class LampArrayBitmapEffect : ILampArrayEffect
struct winrt::Windows::Devices::Lights::Effects::LampArrayBitmapEffect : ILampArrayEffect
public sealed class LampArrayBitmapEffect : ILampArrayEffect
Public NotInheritable Class LampArrayBitmapEffect Implements ILampArrayEffect
var lampArrayBitmapEffect = new lampArrayBitmapEffect(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

Effect captures a series of images, by the caller subscribing to the BitmapRequested event and calling UpdateBitmap when triggered. This allows for images created on-the-fly to be supplied to the effect.

Best effort is made to create a 2D composition of requested lamps and scale up/down images.

Before you can play an effect, you must append it to a LampArrayEffectPlaylist (see Append ).

If a LampArray is bound to a LampArrayBitmapEffect and it disconnects, progress of the effect continues as a no-op. No exception/error is thrown/returned.

Constructors

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

StartDelay StartDelay StartDelay StartDelay StartDelay

Gets or sets the duration to delay before starting the effect.

SuggestedBitmapSize SuggestedBitmapSize SuggestedBitmapSize SuggestedBitmapSize SuggestedBitmapSize

Gets the most suitable image size for the caller selected lamp indexes that results in minimal scaling/distortion.

UpdateInterval UpdateInterval UpdateInterval UpdateInterval UpdateInterval

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

ZIndex ZIndex ZIndex ZIndex ZIndex

Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same LampArray ).

Events

BitmapRequested BitmapRequested BitmapRequested BitmapRequested BitmapRequested

Event triggered by the system to indicate a new image should be supplied to the effect.