LampArray.GetIndicesForPurposes(LampPurposes) Method

Reference

Definition

Namespace:: Windows.Devices.Lights

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Searches for all lamp indices that are bound to the specified LampPurposes.

public:
 virtual Platform::Array <int> ^ GetIndicesForPurposes(LampPurposes purposes) = GetIndicesForPurposes;

winrt::array_view <int> GetIndicesForPurposes(LampPurposes const& purposes);

public int[] GetIndicesForPurposes(LampPurposes purposes);

function getIndicesForPurposes(purposes)

Public Function GetIndicesForPurposes (purposes As LampPurposes) As Integer()

Parameters

purposes: LampPurposes

The LampPurposes.

Returns

Int32[]

int[]

Array of all lamp indices that are bound to the specific LampPurposes. Array is empty if no lamp indices are found bound to the LampPurposes.

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

Lamp indices can be (optionally) bound by the device to multiple LampPurposes.

Applies to