XHighContrastGetMode

返回当前高对比度模式。

语法

HRESULT XHighContrastGetMode(  
         XHighContrastMode* mode  
)  

参数

mode _Out_
类型:XHighContrastMode*

当前高对比度模式样式

返回值

类型:HRESULT

如果 mode 包含当前 XHighContrastMode,则 HRESULT 将成功。 否则,返回错误代码。
有关错误代码的列表,请参阅错误代码

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息,请参阅时间敏感线程

为使此函数成功,必须启用隐式字幕。 用户必须在游戏名称的 UI 中启用隐藏字幕功能。 如果用户启用了隐藏字幕,则您的游戏可以通过调用 XClosedCaptionSetEnabled 来标记隐藏字幕的状态。

下面的示例演示如何返回当前高对比度模式。

XHighContrastMode highContrastMode;
if (SUCCEEDED(XHighContrastGetMode(&highContrastMode))
{
    // The game title can now use the enumeration result to set colors and other visual
    // options for the user interface.
}

要求

头文件:XAccessibility.h

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XAccessibility

XHighContrastMode

XClosedCaptionSetEnabled