RegularFace Class Reference

A font which uses regular TTFs to render most text in STK. More...

#include <regular_face.hpp>

Inheritance diagram for RegularFace:

Public Member Functions
	RegularFace ()
	Constructor of RegularFace.
virtual void	init () OVERRIDE
	Initialize the font structure, but don't load glyph here.
virtual void	reset () OVERRIDE
	Clear all the loaded characters, sub-class can do pre-loading of characters after this.
virtual bool	useColorGlyphPage () const OVERRIDE
Public Member Functions inherited from FontWithFace
	FontWithFace (const std::string &name)
	Constructor.
virtual	~FontWithFace ()
	Destructor.
virtual void	init ()
	Initialize the font structure, but don't load glyph here.
virtual void	reset ()
	Clear all the loaded characters, sub-class can do pre-loading of characters after this.
virtual core::dimension2d< u32 >	getDimension (const core::stringw &text, FontSettings *font_settings=NULL)
	Get the dimension of text with support to different FontSettings, it will also do checking for missing characters in font and lazy load them.
int	getCharacterFromPos (const wchar_t *text, int pixel_x, FontSettings *font_settings=NULL) const
	Calculate the index of the character in the text on a specific position.
void	render (const std::vector< gui::GlyphLayout > &gl, const core::rect< s32 > &position, const video::SColor &color, bool hcenter, bool vcenter, const core::rect< s32 > *clip, FontSettings *font_settings, FontCharCollector *char_collector=NULL)
	Render text and clip it to the specified rectangle if wanted, it will also do checking for missing characters in font and lazy load them.
virtual void	drawText (const core::stringw &text, const core::rect< s32 > &position, const video::SColor &color, bool hcenter, bool vcenter, const core::rect< s32 > *clip, FontSettings *font_settings, FontCharCollector *char_collector=NULL)
void	drawTextQuick (const core::stringw &text, const core::rect< s32 > &position, const video::SColor &color, bool hcenter, bool vcenter, const core::rect< s32 > *clip, FontSettings *font_settings, FontCharCollector *char_collector=NULL)
void	dumpGlyphPage (const std::string &name)
	Write the current glyph page in png inside current running directory.
void	dumpGlyphPage ()
	Write the current glyph page in png inside current running directory.
gui::IGUISpriteBank *	getSpriteBank () const
	Return the sprite bank.
const FontArea &	getAreaFromCharacter (const wchar_t c, bool *fallback_font) const
	Return the FontArea about a character.
unsigned int	getDPI () const
	Return the dpi of this face.
FaceTTF *	getFaceTTF () const
void	insertGlyph (unsigned font_number, unsigned glyph_index)
	Render a glyph for a character into bitmap and save it into the glyph page.
int	getFontMaxHeight () const
int	getGlyphMaxHeight () const
virtual bool	disableTextShaping () const
float	getInverseShaping () const
virtual bool	useColorGlyphPage () const
void	setDPI ()
	Set the face dpi which is resolution-dependent.

Private Member Functions
virtual unsigned int	getGlyphPageSize () const OVERRIDE
	Defined by sub-class about the texture size of glyph page, it should be a power of two.
virtual float	getScalingFactorOne () const OVERRIDE
	Defined by sub-class about the scaling factor 1.
virtual unsigned int	getScalingFactorTwo () const OVERRIDE
	Defined by sub-class about the scaling factor 2.

Additional Inherited Members
Protected Member Functions inherited from FontWithFace
void	insertCharacters (const wchar_t *in_ptr, bool first_load=false)
	Check characters to see if they are loaded in font, if not load them.
void	updateCharactersList ()
	Update the supported characters for this font if required.
void	setFallbackFont (FontWithFace *face)
	Set the fallback font for this font, so if some character is missing in this font, it will use that fallback font to try rendering it.
void	setFallbackFontScale (float scale)
	Set the scaling of fallback font.
Protected Attributes inherited from FontWithFace
int	m_font_max_height
	Used in vertical dimension calculation.
int	m_glyph_max_height
	Used in top side bearing calculation.

Detailed Description

A font which uses regular TTFs to render most text in STK.

Constructor & Destructor Documentation

RegularFace()

RegularFace::RegularFace

(

)

Constructor of RegularFace.

Parameters

ttf	FaceTTF for RegularFace to use.

Member Function Documentation

getGlyphPageSize()

virtual unsigned int RegularFace::getGlyphPageSize ( ) const

inlineprivatevirtual

Defined by sub-class about the texture size of glyph page, it should be a power of two.

Implements FontWithFace.

getScalingFactorOne()

virtual float RegularFace::getScalingFactorOne ( ) const

inlineprivatevirtual

Defined by sub-class about the scaling factor 1.

Implements FontWithFace.

getScalingFactorTwo()

virtual unsigned int RegularFace::getScalingFactorTwo ( ) const

inlineprivatevirtual

Defined by sub-class about the scaling factor 2.

Implements FontWithFace.

init()

void RegularFace::init ( )

virtual

Initialize the font structure, but don't load glyph here.

Reimplemented from FontWithFace.

reset()

void RegularFace::reset ( )

virtual

Clear all the loaded characters, sub-class can do pre-loading of characters after this.

Reimplemented from FontWithFace.

useColorGlyphPage()

virtual bool RegularFace::useColorGlyphPage ( ) const

inlinevirtual

Reimplemented from FontWithFace.

---

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

• font/regular_face.hpp
• font/regular_face.cpp