Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.81 KB

lamparraysolideffect.md

File metadata and controls

47 lines (28 loc) · 1.81 KB
Raw
-api-id -api-type ms.custom
T:Windows.Devices.Lights.Effects.LampArraySolidEffect
winrt class
RS5

Windows.Devices.Lights.Effects.LampArraySolidEffect

-description

Displays a solid/static color for a specific duration.

-remarks

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

All lamps within the effect behave identically, subject to constraints of the lamp indexes (for example, color channels). Best effort will always be done to accommodate lamp index constraints.

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

-examples

:::row::: :::column:::

    [LampArray sample](https://github.com/microsoft/Windows-universal-samples/tree/main/Samples/LampArray)
    
    Demonstrates how to control RGB lighting of peripheral devices using the [**Windows.Devices.Lights**](/uwp/api/windows.devices.lights) and [**Windows.Devices.Lights.Effects**](/uwp/api/windows.devices.lights.effects) APIs.

:::column-end:::
:::column:::

    [AutoRGB Sample](https://github.com/microsoft/Dynamic-Lighting-AutoRGB)
    
    Demonstrates how to extract a single, representative color from a desktop screen and use it to illuminate LED lamps on a connected RGB device.
        
:::column-end:::

:::row-end:::

-see-also

Lighting and Illumination (www.usb.org), Dynamic lighting