XClosedCaptionFontEdgeAttribute

Specifies the edge style of the closed caption text.

Syntax

enum class XClosedCaptionFontEdgeAttribute  : uint32_t  
{  
    Default = 0,  
    NoEdgeAttribute = 1,  
    RaisedEdges = 2,  
    DepressedEdges = 3,  
    UniformedEdges = 4,  
    DropShadowedEdges = 5  
}  

Constants

Constant Description
Default Default style edges/shadows appear around closed caption text.
NoEdgeAttribute No edges/shadows appear around closed caption text.
RaisedEdges Raised edges/shadows appear around closed caption text.
DepressedEdges Depressed edges/shadows appear around closed caption text.
UniformedEdges Uniform edges/shadows appear around closed caption text.
DropShadowedEdges Drop shadowed edges/shadows appear around closed caption text.

Remarks

You can retrieve the current closed caption properties by calling the XClosedCaptionGetProperties function. The XClosedCaptionGetProperties function takes a pointer to a XClosedCaptionProperties structure as an argument. The XClosedCaptionFontEdgeAttribute enumeration is a member of the XClosedCaptionProperties structure.

Requirements

Header: XAccessibility.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XAccessibility

XClosedCaptionGetProperties

XClosedCaptionProperties