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

# SetBrightnessLevel

> Sets the overall brightness scale applied to every Lamp on a LampArray, where 0.0 is completely off and 1.0 is maximum brightness.

Sets the overall brightness of the ILampArray, where 0.0 is completely off and 1.0 is maximum brightness.

This brightness level will be applied to the entire device. Every Lamp will be scaled equally by the brightness value.

## Syntax

```cpp theme={null}
void SetBrightnessLevel(
    double brightnessLevel)
```

### Parameters

*brightnessLevel*\
Type: double

The desired brightness level to set.

### Return value

Type: void

## Remarks

Parameter values outside the supported brightness range (from 0.0 to 1.0 inclusive) will be clamped.

## Requirements

**Header:** LampArray.h

**Library:** xgameplatform.lib

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[Lighting API Overview](https://docs.xbox.com/build/core-features/common/lighting/gc-lighting-toc.md)\
[ILampArray::GetBrightnessLevel](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getbrightnesslevel.md)\
[ILampArray](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md)


## Related topics

- [GetBrightnessLevel](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getbrightnesslevel.md)
- [ILampArray (Interface contents)](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md)
- [GetGainLevelCount](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getgainlevelcount.md)
- [Gaming Sustainability The Elder Scrolls Online Case Study](https://docs.xbox.com/build/game-principles/sustainability/case-studies/case-studies-elder-scrolls-online.md)
- [HCSettingsSetTraceLevel](https://docs.xbox.com/reference/live/httpclient/trace/functions/hcsettingssettracelevel.md)