> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IGameInputDevice::GetSupportedLightingGroups

> Obtient les groupes d'éclairage dans lesquels le périphérique d'entrée possède des lampes contrôlables.

Obtient les groupes d'éclairage dans lesquels le périphérique d'entrée possède des lampes contrôlables.

## Syntaxe

```cpp theme={null}
GameInputLightingGroups GetSupportedLightingGroups();
```

### Paramètres

Cette méthode n'a aucun paramètre.

### Valeur de retour

Type : [GameInputLightingGroups](https://learn.microsoft.com/en-us/gaming/gdk/docs/reference/input/gameinput/enums/gameinputlightinggroups)

Une combinaison d'indicateurs `GameInputLightingGroups` pour chaque groupe d'éclairage nommé qui contient au moins une lampe sur le périphérique. Retourne `GameInputLightingGroupUnknown` (0) si le périphérique n'a aucune lampe dans un groupe nommé.

## Remarques

Chaque indicateur de la valeur retournée identifie un groupe nommé de lampes, comme `GameInputLightingGroupFaceButtons` ou `GameInputLightingGroupCenterLight`, que vous pouvez cibler avec [IGameInputDevice::SetLightingColor](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md). La méthode ne signale jamais `GameInputLightingGroupUnknown` comme groupe, car sa valeur est 0.

Un périphérique peut avoir des lampes qui n'appartiennent à aucun groupe nommé. Une valeur de retour de 0 ne signifie donc pas toujours que le périphérique n'a aucune lampe. Pour déterminer si un périphérique prend en charge l'éclairage, vérifiez si [IGameInputDevice::GetSupportedInput](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md) inclut `GameInputKindLighting`, ou appelez [IGameInputDevice::GetSupportedLightingGroupSize](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroupsize.md) avec `GameInputLightingGroupAll`. Pour compter les lampes qui ne font partie d'aucun groupe nommé, appelez `GetSupportedLightingGroupSize` avec `GameInputLightingGroupUnknown`.

L'exemple suivant définit les boutons frontaux en rouge et le voyant central en bleu sur les périphériques qui possèdent ces groupes, puis applique les couleurs en une seule mise à jour.

```cpp theme={null}
void SetControllerLighting(IGameInputDevice* device) noexcept
{
    const GameInputLightingGroups groups = device->GetSupportedLightingGroups();

    if ((groups & GameInputLightingGroupFaceButtons) != 0)
    {
        device->SetLightingColor({ 255, 0, 0 }, GameInputLightingGroupFaceButtons);
    }

    if ((groups & GameInputLightingGroupCenterLight) != 0)
    {
        device->SetLightingColor({ 0, 0, 255 }, GameInputLightingGroupCenterLight);
    }

    device->ApplyLightingColors();
}
```

L'ensemble des groupes d'éclairage pris en charge ne change pas pendant toute la durée de vie de l'objet périphérique.

> [!NOTE]
>
> La prise en charge de l'éclairage dépend du périphérique et de la plateforme. Actuellement, GameInput prend en charge l'éclairage sur les périphériques Windows Dynamic Lighting (LampArray) et sur la barre lumineuse des manettes DualSense.

## Configuration requise

**En-tête :** GameInput.h

**Bibliothèque :** gameinput.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Voir aussi

[Vue d'ensemble de GameInput](https://docs.xbox.com/fr-CA/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputDevice](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)\
[GameInputLightingGroups](https://learn.microsoft.com/en-us/gaming/gdk/docs/reference/input/gameinput/enums/gameinputlightinggroups)\
[IGameInputDevice::GetSupportedLightingGroupSize](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroupsize.md)\
[IGameInputDevice::SetLightingColor](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md)\
[IGameInputDevice::ApplyLightingColors](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_applylightingcolors.md)\
[IGameInputDevice::ApplyLightingSystemDefault](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_applylightingsystemdefault.md)

## Historique des versions

| Version | Modifications |
| - | - |
| **v4** | Introduit. |


## Related topics

- [IGameInputDevice::GetSupportedLightingGroupSize](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroupsize.md)
- [IGameInputDevice::SetLightingColor](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md)
- [IGameInputDevice::ApplyLightingColors](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_applylightingcolors.md)
- [IGameInputDevice::GetSupportedInput](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md)
- [IGameInputDevice::GetDeviceFamily](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getdevicefamily.md)