Public Member Functions | Public Attributes

FBHUDTextElement Class Reference

Search for all occurrences

Detailed Description

Heads Up display.

Text element. Render text with a background rectangle to the HUD.

Definition at line 200 of file fbhud.h.

#include <fbhud.h>

Inheritance diagram for FBHUDTextElement:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBHUDTextElement (const char *pName, HIObject pObject=NULL)
 Constructor.
FBStringListGetFontList ()
 Returns a list of supported fonts.

Public Attributes

FBPropertyString Content
 Read Write Property: C like format to display like in printf.
FBPropertyString Font
 Read Write Property: Specifies the font.
FBPropertyColorAndAlpha Color
 Read Write Property: Text color.
FBPropertyColorAndAlpha BackgroundColor
 Read Write Property: Background text color.
FBPropertyBool ForceTimeCodeDisplay
 Read Write Property: Specifies if the display of time-related reference property will be in timecode format.
FBPropertyBool AdjustWidthToFitText
 Read Write Property: If On it it will adjust the width of a text element so that a text character's aspect ratio does not change as the content grows or shrinks.

Constructor & Destructor Documentation

FBHUDTextElement ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of new HUD text element.
pObjectFor internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

FBStringList* GetFontList ( )

Returns a list of supported fonts.


Member Data Documentation

Read Write Property: C like format to display like in printf.

Definition at line 218 of file fbhud.h.

Read Write Property: Specifies the font.

Definition at line 219 of file fbhud.h.

Read Write Property: Text color.

Definition at line 220 of file fbhud.h.

Read Write Property: Background text color.

Definition at line 221 of file fbhud.h.

Read Write Property: Specifies if the display of time-related reference property will be in timecode format.

Definition at line 222 of file fbhud.h.

Read Write Property: If On it it will adjust the width of a text element so that a text character's aspect ratio does not change as the content grows or shrinks.

Definition at line 223 of file fbhud.h.


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

FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement
FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement