LampArrayColorRampEffect Class

  • Reference

Definition

Namespace:
Windows.Devices.Lights.Effects
Edit

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

public ref class LampArrayColorRampEffect sealed : ILampArrayEffect
/// [Windows.Foundation.Metadata.Activatable(Windows.Devices.Lights.Effects.ILampArrayColorRampEffectFactory, 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 LampArrayColorRampEffect final : ILampArrayEffect
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Devices.Lights.Effects.ILampArrayColorRampEffectFactory), 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 LampArrayColorRampEffect : ILampArrayEffect
function LampArrayColorRampEffect(lampArray, lampIndexes)
Public NotInheritable Class LampArrayColorRampEffect
Implements ILampArrayEffect
Inheritance
Object Platform::Object IInspectable LampArrayColorRampEffect
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

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.

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

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[])

Creates and initializes a new instance of the effect.

Properties

Color

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

Gets or sets the behavior when effect completes.
RampDuration

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

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

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

Applies to

See also