Font Class Reference

Inheritance diagram for Font:

[legend]Collaboration diagram for Font:

[legend]

---

Detailed Description

TrueType UTF-8 font.

Definition at line 16 of file Font.h.

Public Member Functions
	Font (const Path &file_ttf, int height)
	Create new font from file.
	~Font ()
int	getHeight ()
int	calcTextWidth (const std::string &text)
SDL_Surface *	renderText (const std::string &text, const SDL_Color &color) const
	Render text with this color.
SDL_Surface *	renderTextOutlined (const std::string &text, const SDL_Color &color, int outlineWidth=1) const
	Render text with black outline around font.
Static Public Member Functions
static void	init ()
	Prepare font rendering.
static void	shutdown ()
	Deinit font subsystem.

---

Constructor & Destructor Documentation

Font::Font (  const Path &  file_ttf, int  height )

Create new font from file. Initialized TTF_Init when necessary. Parameters: file_ttf  path to ttf file height  font height Exceptions: TTFException  when cannot open font Definition at line 25 of file Font.cpp. { m_ttfont = TTF_OpenFont(file_ttf.getNative().c_str(), height); if (!m_ttfont) { throw TTFException(ExInfo("OpenFont") .addInfo("file", file_ttf.getNative())); } //NOTE: bg color will be set to be transparent SDL_Color bg = {10, 10, 10, 0}; m_bg = bg; }

Font::~Font (   )

Definition at line 38 of file Font.cpp. { TTF_CloseFont(m_ttfont); }

---

Member Function Documentation

int Font::calcTextWidth (  const std::string &  text  )

Definition at line 66 of file Font.cpp. { int w; TTF_SizeUTF8(m_ttfont, text.c_str(), &w, NULL); return w; }

int Font::getHeight (   )  [inline]

Definition at line 26 of file Font.h. { return TTF_FontHeight(m_ttfont); }

void Font::init (   )  [static]

Prepare font rendering. Exceptions: TTFException  when cannot init SDL_ttf. Definition at line 48 of file Font.cpp. { if (TTF_Init() < 0) { throw TTFException(ExInfo("Init")); } }

SDL_Surface * Font::renderText (  const std::string &  text, const SDL_Color &  color )  const

Render text with this color. Parameters: text  utf-8 encoded text color  text color Returns: new rendered surface Exceptions: TTFException  when render fails SDLException  when converting fails Definition at line 82 of file Font.cpp. { const char *content = text.c_str(); if (text.empty()) { content = " "; LOG_WARNING(ExInfo("empty text to render") .addInfo("r", color.r) .addInfo("g", color.g) .addInfo("b", color.b)); } SDL_Surface *raw_surface = TTF_RenderUTF8_Shaded(m_ttfont, content, color, m_bg); if (!raw_surface) { throw TTFException(ExInfo("RenderUTF8") .addInfo("text", text)); } //NOTE: at index 0 is bg color if (SDL_SetColorKey(raw_surface, SDL_SRCCOLORKEY, 0) < 0) { throw SDLException(ExInfo("SetColorKey")); } SDL_Surface *surface = SDL_DisplayFormat(raw_surface); if (!surface) { throw SDLException(ExInfo("DisplayFormat")); } SDL_FreeSurface(raw_surface); return surface; }

SDL_Surface * Font::renderTextOutlined (  const std::string &  text, const SDL_Color &  color, int  outlineWidth = 1 )  const

Render text with black outline around font. Parameters: text  utf-8 encoded text color  text color outlineWidth  outline width Returns: new rendered surface Definition at line 122 of file Font.cpp. { SDL_Surface *surface = renderText(" " + text + " ", color); SDL_Color black = {0, 0, 0, 255}; Outline outline(black, outlineWidth); outline.drawOnColorKey(surface); return surface; }

void Font::shutdown (   )  [static]

Deinit font subsystem. Definition at line 59 of file Font.cpp. { TTF_Quit(); }

---

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

• Font.h
• Font.cpp

---