#include <gls_text.h>

Public Attributes
const GlsRenderObject::InitParameters	renderInitParameters

const GlsTextureVertexArray::InitParameters	verticesInitParameters

const GlsUInt32	rows

const GlsUInt32	border

const GlsFloat32	cellWidth

const GlsFloat32	cellHeight

const GlsFontBase const	font

const GlsBool	halo

const GlsColor	haloColor

const Justification	justification

const GlsFloat32	lineSpacing

const GlsUInt32	numChars

const GlsChar *const	str

const GlsBool	shadow

const GlsFloat32	shadowDistance

const GlsColor	shadowColor

const GlsBool	uppercase

const GlsBool	wrapText

const CharAttribute	charAttribute

Detailed Description

initialization parameters for a GlsText object

Member Data Documentation

const GlsUInt32 GlsText::InitParameters::border

size of border in logical units

const GlsFloat32 GlsText::InitParameters::cellHeight

height of character cell in logical units ( >= 0.0f )

const GlsFloat32 GlsText::InitParameters::cellWidth

width of character cell in logical units ( >= 0.0f )

const CharAttribute GlsText::InitParameters::charAttribute

initial character attribute for all characters

const GlsFontBase* const* GlsText::InitParameters::font

font for text display

const GlsBool GlsText::InitParameters::halo

GLS_TRUE if halo is enabled else GLS_FALSE

const GlsColor GlsText::InitParameters::haloColor

initial halo color

const Justification GlsText::InitParameters::justification

text justification mode

const GlsFloat32 GlsText::InitParameters::lineSpacing

amount of cell height used to space lines of text, ( lineSpacing >= 0.0f )

const GlsUInt32 GlsText::InitParameters::numChars

number of characters the text object can hold

const GlsRenderObject::InitParameters GlsText::InitParameters::renderInitParameters

base class initialization parameters

const GlsUInt32 GlsText::InitParameters::rows

number of rows of text ( > 0 )

const GlsBool GlsText::InitParameters::shadow

GLS_TRUE if shadow effect is on else GLS_FALSE

const GlsColor GlsText::InitParameters::shadowColor

initial color of the shadow effect behind the characters

const GlsFloat32 GlsText::InitParameters::shadowDistance

amount of cell width for offset of shadow effect, ( -1.0f <= shadowDistance <= 1.0f )

const GlsChar* const GlsText::InitParameters::str

initial string value for text

const GlsBool GlsText::InitParameters::uppercase

GLS_TRUE if all text is displayed in uppercase else GLS_FALSE

const GlsTextureVertexArray::InitParameters GlsText::InitParameters::verticesInitParameters

vertices for background poly

const GlsBool GlsText::InitParameters::wrapText

GLS_TRUE if text is wrapped else GLS_FALSE