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

# XDisplayHdrModeInfo

> XDisplayHdrModeInfo

# XDisplayHdrModeInfo

Specifies the minimum and maximum tone map luminance values for HDR (high dynamic range) mode on the attached display.

## Syntax

```cpp theme={null}
typedef struct XDisplayHdrModeInfo {  
    float minToneMapLuminance;  
    float maxToneMapLuminance;  
    float maxFullFrameToneMapLuminance;  
} XDisplayHdrModeInfo  
```

### Members

*minToneMapLuminance*\
Type: float

The minimum tone map luminance (MinTML) value, in nits.

*maxToneMapLuminance*\
Type: float

The maximum tone map luminance (MaxTML) value, in nits.

*maxFullFrameToneMapLuminance*\
Type: float

The maximum full-frame tone map luminance (MaxFFTML) value, in nits.

## Remarks

The [XDisplayTryEnableHdrMode](/reference/system/xdisplay/functions/xdisplaytryenablehdrmode) function returns an [XDisplayHdrModeResult](/reference/system/xdisplay/enums/xdisplayhdrmoderesult) enumeration value that indicates whether the function can enable HDR mode for the attached display. If **XDisplayHdrModeResult::Enabled** is returned, the function also provides an **XDisplayHdrModeInfo** structure that contains information about HDR mode for the display, including the minimum and maximum tone map luminance values for HDR mode.

For more information about HDR luminance values and tone mapping, see the [For a Better HDR Gaming Experience](https://www.hgig.org/doc/ForBetterHDRGaming.pdf) presentation on the [HDR Gaming Interest Group](https://www.hgig.org/) website.

The following example attempts to enable HDR mode for the attached display. If [XDisplayHdrModeInfo::Enabled](/reference/system/xdisplay/enums/xdisplayhdrmoderesult) is returned, then HDR mode is enabled for the display and the game uses the luminance values from the returned **XDisplayHdrModeInfo** structure to initialize in HDR mode; otherwise, HDR mode is either unavailable or disabled, and the game initializes in SDR (standard dynamic range) mode.

```cpp theme={null}
void Game::InitializeHDRMode() 
{
    // Attempt to enable HDR mode, then initialize based on the 
    // result of the attempt.
    XDisplayHdrModeInfo displayModeHdrInfo;

    if (XDisplayHdrModeResult::Enabled == XDisplayTryEnableHdrMode(XDisplayHdrModePreference::PreferHdr, &displayModeHdrInfo))
    {
        // HDR mode is enabled for the attached display.
        InitializeAsHDR(
            displayModeHdrInfo.minToneMapLuminance,
            displayModeHdrInfo.maxToneMapLuminance,
            displayModeHdrInfo.maxFullFrameToneMapLuminance);
    }
    else
    {
        // Either HDR mode is disabled for the attached display, or the
        // attached display does not support HDR.
        InitializeAsSDR();
    }
}
```

## Requirements

**Header:** XDisplay.h

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

## See also

[XDisplayHdrModeResult](/reference/system/xdisplay/enums/xdisplayhdrmoderesult)\
[XDisplayTryEnableHdrMode](/reference/system/xdisplay/functions/xdisplaytryenablehdrmode)\
[XDisplay](/reference/system/xdisplay/xdisplay_members)


## Related topics

- [XDisplayHdrModeResult](/reference/system/xdisplay/enums/xdisplayhdrmoderesult.md)
- [XDisplayHdrModePreference](/reference/system/xdisplay/enums/xdisplayhdrmodepreference.md)
- [XDisplayTryEnableHdrMode](/reference/system/xdisplay/functions/xdisplaytryenablehdrmode.md)
- [XDisplay](/reference/system/xdisplay/xdisplay_members.md)
- [XR-131 Display Mode Support for Game DVR and Screenshots](/publishing/certification/xr/xr-131.md)