GlsFontBase::RenderAttributes Struct Reference

#include <gls_font_base.h>

Public Attributes
GlsVector2D	startPosition
GlsVector2D	cellSize
GlsFloat32	baselineShift
GlsFloat32	scale
GlsFloat32	spacing
GlsBool	emphasize
GlsBool	haloEffect
GlsBool	inverse
GlsBool	shadow
GlsFloat32	shadowDistance
GlsColor	fgColor
GlsColor	bgColor
GlsColor	haloColor
GlsColor	shadowColor
GlsBool	uppercase
GlsBool	proportional
GlsBool	expandTabs
GlsFloat32	tabSpacing

Detailed Description

attributes describing how a character will be rendered

Member Data Documentation

baselineShift

GlsFloat32 GlsFontBase::RenderAttributes::baselineShift

amount of character height to shift the character baseline, ( -1.0f <= baselineShift <= 1.0f )

bgColor

GlsColor GlsFontBase::RenderAttributes::bgColor

background color

cellSize

GlsVector2D GlsFontBase::RenderAttributes::cellSize

size of character cell to render

emphasize

GlsBool GlsFontBase::RenderAttributes::emphasize

GLS_TRUE if char is drawn with emphasis ( bold ) else GLS_FALSE

expandTabs

GlsBool GlsFontBase::RenderAttributes::expandTabs

GLS_TRUE to expand tab characters width by multiplying by tabSpacing else GLS_FALSE

fgColor

GlsColor GlsFontBase::RenderAttributes::fgColor

foreground color (actual character color)

haloColor

GlsColor GlsFontBase::RenderAttributes::haloColor

color of halo around text if haloEffect == GLS_TRUE

haloEffect

GlsBool GlsFontBase::RenderAttributes::haloEffect

GLS_TRUE if char is drawn with a halo effect else GLS_FALSE

inverse

GlsBool GlsFontBase::RenderAttributes::inverse

GLS_TRUE if char is rendered with inverse video effect else GLS_FALSE

proportional

GlsBool GlsFontBase::RenderAttributes::proportional

GLS_TRUE to render characters with proportional spacing else GLS_FALSE for fixed width spacing

scale

GlsFloat32 GlsFontBase::RenderAttributes::scale

amount of character height to scale the char, ( 0.0f < scale <= 1.0f )

shadow

GlsBool GlsFontBase::RenderAttributes::shadow

GLS_TRUE if char is rendered with a shadow

shadowColor

GlsColor GlsFontBase::RenderAttributes::shadowColor

color of shadow behind text if shadow == GLS_TRUE

shadowDistance

GlsFloat32 GlsFontBase::RenderAttributes::shadowDistance

amount of cell width to offset shadow if shadow == GLS_TRUE, ( -1.0f <= shadowDistance <= 1.0f )

spacing

GlsFloat32 GlsFontBase::RenderAttributes::spacing

amount of character width to space the char, spacing >= 0.0f

startPosition

GlsVector2D GlsFontBase::RenderAttributes::startPosition

position where rendering will begin

tabSpacing

GlsFloat32 GlsFontBase::RenderAttributes::tabSpacing

number of tab widths to use when expanding tabs

uppercase

GlsBool GlsFontBase::RenderAttributes::uppercase

GLS_TRUE to render characters all in uppercase else GLS_FALSE