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

GlsFloat32 GlsFontBase::RenderAttributes::baselineShift

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

GlsColor GlsFontBase::RenderAttributes::bgColor

background color

GlsVector2D GlsFontBase::RenderAttributes::cellSize

size of character cell to render

GlsBool GlsFontBase::RenderAttributes::emphasize

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

GlsBool GlsFontBase::RenderAttributes::expandTabs

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

GlsColor GlsFontBase::RenderAttributes::fgColor

foreground color (actual character color)

GlsColor GlsFontBase::RenderAttributes::haloColor

color of halo around text if haloEffect == GLS_TRUE

GlsBool GlsFontBase::RenderAttributes::haloEffect

GLS_TRUE if char is drawn with a halo effect else GLS_FALSE

GlsBool GlsFontBase::RenderAttributes::inverse

GLS_TRUE if char is rendered with inverse video effect else GLS_FALSE

GlsBool GlsFontBase::RenderAttributes::proportional

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

GlsFloat32 GlsFontBase::RenderAttributes::scale

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

GlsBool GlsFontBase::RenderAttributes::shadow

GLS_TRUE if char is rendered with a shadow

GlsColor GlsFontBase::RenderAttributes::shadowColor

color of shadow behind text if shadow == GLS_TRUE

GlsFloat32 GlsFontBase::RenderAttributes::shadowDistance

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

GlsFloat32 GlsFontBase::RenderAttributes::spacing

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

GlsVector2D GlsFontBase::RenderAttributes::startPosition

position where rendering will begin

GlsFloat32 GlsFontBase::RenderAttributes::tabSpacing

number of tab widths to use when expanding tabs

GlsBool GlsFontBase::RenderAttributes::uppercase

GLS_TRUE to render characters all in uppercase else GLS_FALSE