Skip to content

lamparrayupdaterequestedeventargs_setcolor_1486217082.md

Latest commit

 

History

History
48 lines (30 loc) · 1.69 KB

lamparrayupdaterequestedeventargs_setcolor_1486217082.md

File metadata and controls

48 lines (30 loc) · 1.69 KB
-api-id M:Windows.Devices.Lights.Effects.LampArrayUpdateRequestedEventArgs.SetColor(Windows.UI.Color)
-api-type winrt method
ms.custom RS5

Windows.Devices.Lights.Effects.LampArrayUpdateRequestedEventArgs.SetColor

-description

Sets every lamp index specified in the effect to the desired color.

-parameters

-param desiredColor

Desired color to set every lamp to.

-remarks

If a lamp doesn't support the desired color, it is set to the NearestSupportedColor

Black is equivalent to a lamp being 'off'.

-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