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

> Obtém o número de lâmpadas do dispositivo de entrada na seleção de grupos de iluminação especificada.

Obtém o número de lâmpadas do dispositivo de entrada na seleção de grupos de iluminação especificada.

## Sintaxe

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

### Parâmetros

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

A seleção de grupos de iluminação cujas lâmpadas são contadas. Pode ser um ou mais sinalizadores de grupo nomeado, `GameInputLightingGroupAll` ou `GameInputLightingGroupUnknown`.

### Valor retornado

Tipo: uint32\_t

O número de lâmpadas na seleção. Retorna 0 se o dispositivo não tiver lâmpadas na seleção ou se *group* contiver sinalizadores indefinidos.

## Comentários

O valor de *group* é interpretado da seguinte maneira.

| Valor de *group* | Lâmpadas contadas |
| - | - |
| `GameInputLightingGroupAll` | Todas as lâmpadas do dispositivo, incluindo as lâmpadas que não pertencem a um grupo nomeado. |
| `GameInputLightingGroupUnknown` | Somente as lâmpadas que não pertencem a nenhum grupo nomeado. |
| Um ou mais sinalizadores de grupo nomeado | A soma das contagens de lâmpadas de cada grupo nomeado na seleção. |

A contagem de lâmpadas de uma seleção é o limite superior exclusivo do parâmetro *groupOrderIndex* de [IGameInputDevice::SetLightingColor](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setlightingcolor.md) quando você endereça uma lâmpada individual pela sua posição ordinal. A exceção é `GameInputLightingGroupKeyboardKey`, que endereça lâmpadas individuais pelo código de verificação do teclado.

O exemplo a seguir acende cada lâmpada do grupo de botões frontais com um tom diferente de verde.

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

As contagens de lâmpadas não mudam 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::GetSupportedLightingGroups](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedlightinggroups.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)

## Histórico de versões

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


## Related topics

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