Graphics::WinFont Class Reference

Inheritance diagram for Graphics::WinFont:

Public Member Functions
bool	loadFromFON (const Common::Path &fileName, const WinFontDirEntry &dirEntry=WinFontDirEntry())
bool	loadFromFON (Common::SeekableReadStream &stream, const WinFontDirEntry &dirEntry=WinFontDirEntry())
bool	loadFromFNT (const Common::Path &fileName)
void	close ()
int	getFontHeight () const
int	getFontAscent () const
int	getMaxCharWidth () const
Common::String	getName () const
int	getCharWidth (uint32 chr) const
void	drawChar (Surface *dst, uint32 chr, int x, int y, uint32 color) const
int	getStyle () const
Public Member Functions inherited from Graphics::Font
virtual Common::String	getFontName () const
virtual int	getFontDescent () const
virtual int	getFontLeading () const
virtual int	getKerningOffset (uint32 left, uint32 right) const
virtual Common::Rect	getBoundingBox (uint32 chr) const
Common::Rect	getBoundingBox (const Common::String &str, int x=0, int y=0, const int w=0, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
Common::Rect	getBoundingBox (const Common::U32String &str, int x=0, int _y=0, const int w=0, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
virtual void	drawChar (ManagedSurface *dst, uint32 chr, int x, int y, uint32 color) const
void	drawString (Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
void	drawString (Surface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
void	drawString (ManagedSurface *dst, const Common::String &str, int x, int _y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
void	drawString (ManagedSurface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
int	getStringWidth (const Common::String &str) const
int	getStringWidth (const Common::U32String &str) const
int	wordWrapText (const Common::String &str, int maxWidth, Common::Array< Common::String > &lines, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
int	wordWrapText (const Common::U32String &str, int maxWidth, Common::Array< Common::U32String > &lines, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
int	wordWrapText (const Common::U32String &str, int maxWidth, Common::Array< Common::U32String > &lines, Common::Array< bool > &lineContinuation, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
void	scaleSingleGlyph (Surface *scaleSurface, int *grayScaleMap, int grayScaleMapSize, int width, int height, int xOffset, int yOffset, int grayLevel, int chr, int srcheight, int srcwidth, float scale) const

Static Public Member Functions
static WinFont *	scaleFont (const WinFont *src, int newSize)

Member Function Documentation

loadFromFON()

bool Graphics::WinFont::loadFromFON	(	const Common::Path &	fileName,
		const WinFontDirEntry &	dirEntry = WinFontDirEntry()
	)

Open a font with a name in an FON file.

If dirEntry is not given, the first font in the FONTDIR will be loaded

loadFromFNT()

bool Graphics::WinFont::loadFromFNT

(

const Common::Path &

fileName

)

Open a font from an FNT file

close()

void Graphics::WinFont::close

(

)

Close this font

getFontHeight()

int Graphics::WinFont::getFontHeight ( ) const

inlinevirtual

Return the height of the font.

Returns

Font height in pixels.

Implements Graphics::Font.

getFontAscent()

int Graphics::WinFont::getFontAscent ( ) const

inlinevirtual

Return the ascent of the font.

Returns

Font ascent in pixels. If it is unknown a value of -1 is returned.

Reimplemented from Graphics::Font.

getMaxCharWidth()

int Graphics::WinFont::getMaxCharWidth ( ) const

inlinevirtual

Return the maximum width of the font.

Returns

Maximum font width in pixels.

Implements Graphics::Font.

getCharWidth()

int Graphics::WinFont::getCharWidth ( uint32  chr ) const

virtual

Return the width of a specific character.

Parameters

chr	The character to query the width of.

Returns

The width of the character in pixels.

Implements Graphics::Font.

drawChar()

void Graphics::WinFont::drawChar ( Surface *  dst, uint32  chr, int  x, int  y, uint32  color  ) const

virtual

Draw a character at a specific point on the surface.

Note that the point describes the top left edge point where to draw the character. This can be different from the top left edge point of the character's bounding box. For example, TTF fonts sometimes move characters like 't' by one (or more) pixels to the left to create better visual results. To query the actual bounding box of a character, use getBoundingBox.

See also

getBoundingBox

The Font implementation should take care of not drawing outside of the specified surface.

Parameters

dst	The surface to draw on.
chr	The character to draw.
x	The x coordinate where to draw the character.
y	The y coordinate where to draw the character.
color	The color of the character.

Implements Graphics::Font.

---

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

• graphics/fonts/winfont.h