You.i Engine
IYIClosedCaptionsRenderer::Span Struct Reference

Detailed Description

A struct containing information about a span of text within a Cue.

See also
Cue

#include <player/YiClosedCaptionsRenderer.h>

Public Member Functions

 Span ()
 

Public Attributes

CYIString text
 
CYIString fontFamily
 
bool bItalic
 True if the font should be italic. More...
 
bool bBold
 True if the font should be bold. More...
 
bool bUnderline
 True if the font should be underlined. More...
 
float fFontSize
 The font size in pixels, relative to the video height. More...
 
CYIColor fontColor
 The font color. Defaults to white. More...
 
CYIColor characterBackgroundColor
 The character background color. Defaults to transparent. More...
 

Constructor & Destructor Documentation

IYIClosedCaptionsRenderer::Span::Span ( )

Member Data Documentation

bool IYIClosedCaptionsRenderer::Span::bBold

True if the font should be bold.

bool IYIClosedCaptionsRenderer::Span::bItalic

True if the font should be italic.

bool IYIClosedCaptionsRenderer::Span::bUnderline

True if the font should be underlined.

CYIColor IYIClosedCaptionsRenderer::Span::characterBackgroundColor

The character background color. Defaults to transparent.

float IYIClosedCaptionsRenderer::Span::fFontSize

The font size in pixels, relative to the video height.

CYIColor IYIClosedCaptionsRenderer::Span::fontColor

The font color. Defaults to white.

CYIString IYIClosedCaptionsRenderer::Span::fontFamily
CYIString IYIClosedCaptionsRenderer::Span::text

The documentation for this struct was generated from the following file: