Panda3D
Static Public Member Functions

FontPool Class Reference

This is the preferred interface for loading fonts for the TextNode system. More...

#include "fontPool.h"

List of all members.

Static Public Member Functions

static void add_font (const string &filename, TextFont *font)
 Adds the indicated already-loaded font to the pool.
static int garbage_collect ()
 Releases only those fonts in the pool that have a reference count of exactly 1; i.e.
static bool has_font (const string &filename)
 Returns true if the font has ever been loaded, false otherwise.
static void list_contents (ostream &out)
 Lists the contents of the font pool to the indicated output stream.
static TextFontload_font (const string &filename)
 Loads the given filename up into a font, if it has not already been loaded, and returns the new font.
static void release_all_fonts ()
 Releases all fonts in the pool and restores the pool to the empty state.
static void release_font (const string &filename)
 Removes the indicated font from the pool, indicating it will never be loaded again; the font may then be freed.
static bool verify_font (const string &filename)
 Loads the given filename up into a font, if it has not already been loaded, and returns true to indicate success, or false to indicate failure.
static void write (ostream &out)
 Lists the contents of the font pool to the indicated output stream.

Detailed Description

This is the preferred interface for loading fonts for the TextNode system.

It is similar to ModelPool and TexturePool in that it unifies references to the same filename.

Definition at line 33 of file fontPool.h.


Member Function Documentation

void FontPool::add_font ( const string &  filename,
TextFont font 
) [inline, static]

Adds the indicated already-loaded font to the pool.

The font will always replace any previously-loaded font in the pool that had the same filename.

Definition at line 65 of file fontPool.I.

int FontPool::garbage_collect ( ) [inline, static]

Releases only those fonts in the pool that have a reference count of exactly 1; i.e.

only those fonts that are not being used outside of the pool. Returns the number of fonts released.

Definition at line 103 of file fontPool.I.

bool FontPool::has_font ( const string &  filename) [inline, static]

Returns true if the font has ever been loaded, false otherwise.

Definition at line 23 of file fontPool.I.

void FontPool::list_contents ( ostream &  out) [inline, static]

Lists the contents of the font pool to the indicated output stream.

Definition at line 114 of file fontPool.I.

TextFont * FontPool::load_font ( const string &  filename) [inline, static]

Loads the given filename up into a font, if it has not already been loaded, and returns the new font.

If a font with the same filename was previously loaded, returns that one instead. If the font file cannot be found, returns NULL.

Definition at line 52 of file fontPool.I.

Referenced by verify_font().

void FontPool::release_all_fonts ( ) [inline, static]

Releases all fonts in the pool and restores the pool to the empty state.

Definition at line 90 of file fontPool.I.

void FontPool::release_font ( const string &  filename) [inline, static]

Removes the indicated font from the pool, indicating it will never be loaded again; the font may then be freed.

If this function is never called, a reference count will be maintained on every font every loaded, and fonts will never be freed.

Definition at line 79 of file fontPool.I.

bool FontPool::verify_font ( const string &  filename) [inline, static]

Loads the given filename up into a font, if it has not already been loaded, and returns true to indicate success, or false to indicate failure.

If this returns true, it is guaranteed that a subsequent call to load_font() with the same font name will return a valid Font pointer.

Definition at line 38 of file fontPool.I.

References load_font().

void FontPool::write ( ostream &  out) [static]

Lists the contents of the font pool to the indicated output stream.

Definition at line 34 of file fontPool.cxx.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations