igor::iTextureFont Class Reference

#include <iTextureFont.h>

Public Member Functions
	~iTextureFont ()
float32	measureWidth (const iaString &text, float32 size)
float32	measureHeight (const iaString &text, float32 size, float32 maxWidth, float32 lineHeight=1.15f)
bool	isValid () const
iTexturePtr	getTexture () const
const std::vector< iCharacterDimensions > &	getCharacters () const

Static Public Member Functions
static iTextureFontPtr	create (iTexturePtr texture, iFontType type=iFontType::FixedDigitWidth, iColorMask colorMask=iColorMask::Alpha, float32 colorMaskThreshold=0.5f)

Detailed Description

texture font

Constructor & Destructor Documentation

~iTextureFont()

igor::iTextureFont::~iTextureFont

(

)

cleans up

Member Function Documentation

create()

iTextureFontPtr igor::iTextureFont::create ( iTexturePtr  texture, iFontType  type = iFontType::FixedDigitWidth, iColorMask  colorMask = iColorMask::Alpha, float32  colorMaskThreshold = 0.5f  )

static

Returns

a newly created font

Parameters

texture	the texture to use (needs to be loaded already)
type	font type
colorMask	use this color channel to detect the size of characters
colorMaskThreshold	this threshold determines what texel belongs to the character and wich not

getCharacters()

const std::vector< iCharacterDimensions > & igor::iTextureFont::getCharacters

(

)

const

returns character set

Returns

vector of characters

getTexture()

iTexturePtr igor::iTextureFont::getTexture

(

)

const

returns pointer to the font texture

Returns

pointer to font texture

isValid()

bool igor::iTextureFont::isValid

(

)

const

returns true if the font was loading correctly

measureHeight()

float32 igor::iTextureFont::measureHeight	(	const iaString &	text,
		float32	size,
		float32	maxWidth,
		float32	lineHeight = 1.15f
	)

calculates the height of a iaString with line breaks

Parameters

text	the text to calculate with
size	font size
maxWidth	with to make line break
lineHeight	factor for the line height (default value is 1.15)

measureWidth()

float32 igor::iTextureFont::measureWidth	(	const iaString &	text,
		float32	size
	)

calculates the width of the given iaString using this font

Parameters

text	the text to calculate the width
size	size of the font

---

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

• /home/martin/dev/Igor/src/igor/igor/resources/texture/iTextureFont.h
• /home/martin/dev/Igor/src/igor/igor/resources/texture/iTextureFont.cpp