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

> Obtém os grupos de iluminação nos quais o dispositivo de entrada tem lâmpadas controláveis.

Obtém os grupos de iluminação nos quais o dispositivo de entrada tem lâmpadas controláveis.

## Sintaxe

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

### Parâmetros

Este método não tem parâmetros.

### Valor retornado

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

Uma combinação de sinalizadores `GameInputLightingGroups` para cada grupo de iluminação nomeado que contém pelo menos uma lâmpada no dispositivo. Retorna `GameInputLightingGroupUnknown` (0) se o dispositivo não tiver lâmpadas em nenhum grupo nomeado.

## Comentários

Cada sinalizador no valor retornado identifica um grupo nomeado de lâmpadas, como `GameInputLightingGroupFaceButtons` ou `GameInputLightingGroupCenterLight`, que você pode endereçar com [IGameInputDevice::SetLightingColor](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md). O método nunca relata `GameInputLightingGroupUnknown` como um grupo, pois o valor dele é 0.

Um dispositivo pode ter lâmpadas que não pertencem a nenhum grupo nomeado. Portanto, um valor retornado igual a 0 nem sempre significa que o dispositivo não tem lâmpadas. Para determinar se um dispositivo oferece suporte à iluminação, verifique se [IGameInputDevice::GetSupportedInput](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md) inclui `GameInputKindLighting` ou chame [IGameInputDevice::GetSupportedLightingGroupSize](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroupsize.md) com `GameInputLightingGroupAll`. Para contar as lâmpadas que não estão em um grupo nomeado, chame `GetSupportedLightingGroupSize` com `GameInputLightingGroupUnknown`.

O exemplo a seguir define os botões frontais como vermelhos e a luz central como azul em dispositivos que têm esses grupos e, em seguida, aplica as cores em uma única atualização.

```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();
}
```

O conjunto de grupos de iluminação com suporte não muda durante o tempo de vida do objeto de dispositivo.

> [!NOTE]
>
> O suporte à iluminação depende do dispositivo e da plataforma. Atualmente, o GameInput oferece suporte à iluminação em dispositivos com Iluminação Dinâmica do Windows (LampArray) e na barra de luz dos controles DualSense.

## Requisitos

**Cabeçalho:** GameInput.h

**Biblioteca:** gameinput.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Confira também

[Visão geral do GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputDevice](https://docs.xbox.com/pt-BR/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/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroupsize.md)\
[IGameInputDevice::SetLightingColor](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md)\
[IGameInputDevice::ApplyLightingColors](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_applylightingcolors.md)\
[IGameInputDevice::ApplyLightingSystemDefault](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_applylightingsystemdefault.md)

## Histórico de versões

| Versão | Alterações |
| - | - |
| **v4** | Introduzido. |


## Related topics

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