LampArrayColorRampEffect LampArrayColorRampEffect LampArrayColorRampEffect LampArrayColorRampEffect LampArrayColorRampEffect Class

Definition

Transitions lamp/s from their existing color (whatever last set to), to the prescribed color.

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

Transition is via a simple linear curve over the prescribed RampDuration.

Behavior across lamps is not guaranteed to be identical as lamp/s can start from different colors.

Must be Appended to a LampArrayEffectPlaylist before can be played.

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

Constructors

LampArrayColorRampEffect(LampArray, Int32[]) LampArrayColorRampEffect(LampArray, Int32[]) LampArrayColorRampEffect(LampArray, Int32[]) LampArrayColorRampEffect(LampArray, Int32[]) LampArrayColorRampEffect(LampArray, Int32[])

Creates and initializes a new instance of the effect.

Properties

Color Color Color Color Color

Gets or sets the color of peak intensity for the effect.

CompletionBehavior CompletionBehavior CompletionBehavior CompletionBehavior CompletionBehavior

Gets or sets the behavior when effect completes.

RampDuration RampDuration RampDuration RampDuration RampDuration

Gets or sets the time spent ramping-up to peak intensity from the previously set color.

StartDelay StartDelay StartDelay StartDelay StartDelay

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

ZIndex ZIndex ZIndex ZIndex ZIndex

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