Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Describes the closed caption properties.
Syntax
typedef struct XClosedCaptionProperties {
XColor BackgroundColor;
XColor FontColor;
XColor WindowColor;
XClosedCaptionFontEdgeAttribute FontEdgeAttribute;
XClosedCaptionFontStyle FontStyle;
float FontScale;
bool Enabled;
} XClosedCaptionProperties
Members
BackgroundColor
Type: XColor
The color of the closed caption background.
FontColor
Type: XColor
The color of the closed caption text font.
WindowColor
Type: XColor
The color of the closed caption window.
FontEdgeAttribute
Type: XClosedCaptionFontEdgeAttribute
The font edge attribute of the closed caption text.
FontStyle
Type: XClosedCaptionFontStyle
The font style of the closed caption text.
FontScale
Type: float
The font scale of the closed caption text.
Enabled
Type: bool
True if closed captioning is enabled, false otherwise.
Remarks
To retrieve the current closed caption properties, call the XClosedCaptionGetProperties function. The XClosedCaptionGetProperties function takes a pointer to a XClosedCaptionProperties structure as an argument.
The following example demonstrates how to retrieve the closed caption properties.
XClosedCaptionProperties ccProperties;
if (SUCCEEDED(XClosedCaptionGetProperties(&ccProperties))
{
// The game title can now access color and font settings in the ccProperties structure.
}
Requirements
Header: XAccessibility.h
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles