PLRenderer::FontManager Class Reference

Abstract renderer font manager. More...

#include <FontManager.h>

List of all members.

Public Member Functions
Renderer &	GetRenderer () const
	Returns the owner renderer.
PLRENDERER_API Font *	GetDefaultFontTexture ()
	Returns the default texture font.
PLRENDERER_API void	SetDefaultFontTexture (FontTexture *pFont)
	Sets the default texture font.
PLRENDERER_API FontTexture *	GetFontTexture (const PLCore::String &sFilename, PLCore::uint32 nSize=12, PLCore::uint32 nResolution=96)
	Returns a texture font.
PLRENDERER_API void	ClearFontTexture ()
	Clears all texture fonts.
virtual PLRENDERER_API Font *	CreateFontTexture (const PLCore::String &sFilename, PLCore::uint32 nSize=12, PLCore::uint32 nResolution=96)
	Creates a texture font.
virtual Font *	CreateFontTexture (PLCore::File &cFile, PLCore::uint32 nSize=12, PLCore::uint32 nResolution=96)=0
	Creates a texture font.
Protected Member Functions
PLRENDERER_API	FontManager (Renderer &cRenderer)
	Constructor.
virtual PLRENDERER_API	~FontManager ()
	Destructor.
Protected Attributes
Renderer *	m_pRenderer
ResourceHandler *	m_pDefaultFontTextureHandler
bool	m_bDefaultFontTextureSet
PLCore::Array< FontTexture * >	m_lstFontTexture

---

Detailed Description

Abstract renderer font manager.

---

Constructor & Destructor Documentation

PLRENDERER_API PLRenderer::FontManager::FontManager

(

Renderer &

cRenderer

)

[protected]

Constructor.

Parameters:

[in]

cRenderer

Owner renderer

virtual PLRENDERER_API PLRenderer::FontManager::~FontManager

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

Renderer & PLRenderer::FontManager::GetRenderer

(

)

const [inline]

Returns the owner renderer.

Returns:

The owner renderer

PLRENDERER_API Font* PLRenderer::FontManager::GetDefaultFontTexture

(

)

Returns the default texture font.

Returns:

The default texture font, a null pointer on error

Remarks:

The default texture font setting is build in and is set to

• Filename = "Data/Fonts/LinLibertine_Re-2.7.9.9.otf"
• Size = 15 Resolution = 96 In order to remove the default texture font or to set another default texture font, just set it during the application initialization. The font is internally not initialized until it's first real usage, so, this approach doesn't introduce overhead if you never use the build in default font.

PLRENDERER_API void PLRenderer::FontManager::SetDefaultFontTexture

(

FontTexture *

pFont

)

Sets the default texture font.

Parameters:

[in]

pFont

The texture font or a null pointer

PLRENDERER_API FontTexture* PLRenderer::FontManager::GetFontTexture	(	const PLCore::String &	sFilename,
		PLCore::uint32	nSize = 12,
		PLCore::uint32	nResolution = 96
	)

Returns a texture font.

Parameters:

[in]	sFilename	The font filename
[in]	nSize	Nominal font size in points, for example 12 (72 points per inch)
[in]	nResolution	The horizontal and vertical resolution in DPI, for example 96

Returns:

The texture font, a null pointer on error (do not destroy this instance, it's owned by this manager)

Remarks:

Unlike the "CreateFontTexture()"-methods, this method checks whether or not the requested font is already registered within this manager, if so, this instance will be returned instead of a new one.

PLRENDERER_API void PLRenderer::FontManager::ClearFontTexture

(

)

Clears all texture fonts.

virtual PLRENDERER_API Font* PLRenderer::FontManager::CreateFontTexture	(	const PLCore::String &	sFilename,
		PLCore::uint32	nSize = 12,
		PLCore::uint32	nResolution = 96
	)		[virtual]

Creates a texture font.

Parameters:

[in]	sFilename	The font filename
[in]	nSize	Nominal font size in points, for example 12 (72 points per inch)
[in]	nResolution	The horizontal and vertical resolution in DPI, for example 96

Returns:

The created texture font, destroy the instance if you no longer need it

Note:

• The default implementations opens and reads in the file

virtual Font* PLRenderer::FontManager::CreateFontTexture	(	PLCore::File &	cFile,
		PLCore::uint32	nSize = 12,
		PLCore::uint32	nResolution = 96
	)		[pure virtual]

Creates a texture font.

Parameters:

[in]	cFile	File to load from, must be opened and readable
[in]	nSize	Nominal font size in points, for example 12 (72 points per inch)
[in]	nResolution	The horizontal and vertical resolution in DPI, for example 96

Returns:

The created texture font, destroy the instance if you no longer need it

---

Member Data Documentation

Renderer* PLRenderer::FontManager::m_pRenderer [protected]

Owner renderer, always valid!

ResourceHandler* PLRenderer::FontManager::m_pDefaultFontTextureHandler [protected]

Default texture font, always valid!

bool PLRenderer::FontManager::m_bDefaultFontTextureSet [protected]

Default font texture already set?

PLCore::Array<FontTexture*> PLRenderer::FontManager::m_lstFontTexture [protected]

Texture fonts

---

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

• PLRenderer/include/PLRenderer/Renderer/FontManager.h
• FontManager.inl