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

# XDisplayHdrModeResult

> XDisplayHdrModeResult

# XDisplayHdrModeResult

指定附加显示器上 HDR（高动态范围）支持的当前状态。

## Syntax

```cpp theme={null}
enum class XDisplayHdrModeResult  : uint32_t  
{  
    Unknown = 0,  
    Enabled = 1,  
    Disabled = 2  
}  
```

## Constants

| 常量       | 说明                  |
| -------- | ------------------- |
| Unknown  | 发生错误，HDR 支持的当前状态未知。 |
| Enabled  | HDR 模式已启用。          |
| Disabled | HDR 模式已禁用。          |

## Remarks

[XDisplayTryEnableHdrMode](/reference/system/xdisplay/functions/xdisplaytryenablehdrmode) 函数返回 **XDisplayHdrModeResult** 枚举值，指示该函数是否可以为附加的显示器启用 HDR 模式。如果返回 **XDisplayHdrModeResult::Enabled**，该函数还会提供包含 HDR 模式最小和最大色调映射亮度值的 [XDisplayHdrModeInfo](/reference/system/xdisplay/structs/xdisplayhdrmodeinfo) 结构。

以下示例尝试为附加的显示器启用 HDR 模式。如果返回 **XDisplayHdrModeInfo::Enabled**，则表示已为显示器启用 HDR 模式，游戏将使用返回的 [XDisplayHdrModeInfo](/reference/system/xdisplay/structs/xdisplayhdrmodeinfo) 结构中的亮度值以 HDR 模式初始化；否则，HDR 模式不可用或已禁用，游戏将以 SDR（标准动态范围）模式初始化。

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

**头文件：** XDisplay.h

**受支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## See also

[XDisplayHdrModeInfo](/reference/system/xdisplay/structs/xdisplayhdrmodeinfo)\
[XDisplayTryEnableHdrMode](/reference/system/xdisplay/functions/xdisplaytryenablehdrmode)\
[XDisplay](/reference/system/xdisplay/xdisplay_members)


## Related topics

- [XDisplayTryEnableHdrMode](/zh-CN/reference/system/xdisplay/functions/xdisplaytryenablehdrmode.md)
- [XDisplayHdrModeInfo](/zh-CN/reference/system/xdisplay/structs/xdisplayhdrmodeinfo.md)
- [XDisplay](/zh-CN/reference/system/xdisplay/xdisplay_members.md)
- [XDisplayHdrModePreference](/zh-CN/reference/system/xdisplay/enums/xdisplayhdrmodepreference.md)
- [Screen Capture (wdcapture.exe)](/zh-CN/tools/tools-pc/commandlinetools/gr-wdCapture.md)