> ## 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::GetSupportedLightingGroupSize

> Obtient le nombre de lampes du périphérique d'entrée dans la sélection de groupes d'éclairage spécifiée.

Obtient le nombre de lampes du périphérique d'entrée dans la sélection de groupes d'éclairage spécifiée.

## Syntaxe

```cpp theme={null}
uint32_t GetSupportedLightingGroupSize(
    GameInputLightingGroups group
);
```

### Paramètres

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

Sélection de groupes d'éclairage dont les lampes sont comptées. Il peut s'agir d'un ou de plusieurs indicateurs de groupe nommé, de `GameInputLightingGroupAll` ou de `GameInputLightingGroupUnknown`.

### Valeur de retour

Type : uint32\_t

Nombre de lampes dans la sélection. Retourne 0 si le périphérique n'a aucune lampe dans la sélection ou si *group* contient des indicateurs non définis.

## Remarques

La valeur de *group* est interprétée comme suit.

| Valeur de *group* | Lampes comptées |
| - | - |
| `GameInputLightingGroupAll` | Toutes les lampes du périphérique, y compris celles qui n'appartiennent à aucun groupe nommé. |
| `GameInputLightingGroupUnknown` | Uniquement les lampes qui n'appartiennent à aucun groupe nommé. |
| Un ou plusieurs indicateurs de groupe nommé | Somme des nombres de lampes de chaque groupe nommé de la sélection. |

Le nombre de lampes d'une sélection constitue la limite supérieure exclusive du paramètre *groupOrderIndex* de [IGameInputDevice::SetLightingColor](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md) lorsque vous ciblez une lampe individuelle par son ordinal. L'exception est `GameInputLightingGroupKeyboardKey`, qui cible les lampes individuelles par code de balayage du clavier.

L'exemple suivant allume chaque lampe du groupe des boutons de façade avec une nuance de vert différente.

```cpp theme={null}
void SetFaceButtonGradient(IGameInputDevice* device) noexcept
{
    const uint32_t lampCount = device->GetSupportedLightingGroupSize(GameInputLightingGroupFaceButtons);
    for (uint32_t i = 0; i < lampCount; ++i)
    {
        const uint8_t green = static_cast<uint8_t>(255 * (i + 1) / lampCount);
        device->SetLightingColor({ 0, green, 0 }, GameInputLightingGroupFaceButtons, i);
    }

    device->ApplyLightingColors();
}
```

Les nombres de lampes ne changent 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 des périphériques Windows Dynamic Lighting (LampArray) et de 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/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputDevice](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)\
[GameInputLightingGroups](https://learn.microsoft.com/en-us/gaming/gdk/docs/reference/input/gameinput/enums/gameinputlightinggroups)\
[IGameInputDevice::GetSupportedLightingGroups](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroups.md)\
[IGameInputDevice::SetLightingColor](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md)\
[IGameInputDevice::ApplyLightingColors](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_applylightingcolors.md)

## Historique des versions

| Version | Modifications |
| - | - |
| **v4** | Introduite. |


## Related topics

- [IGameInputDevice::GetSupportedLightingGroups](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroups.md)
- [IGameInputDevice::SetLightingColor](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md)
- [IGameInputDevice::GetSupportedInput](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md)
- [IGameInputDevice::GetSupportedRumbleMotors](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedrumblemotors.md)
- [IGameInputDevice::GetSupportedSystemButtons](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedsystembuttons.md)