PtTerminalFont()

Convert font name to a fixed-width font name

Synopsis:

char *PtTerminalFont( const char *font, 
                      PhDim_t *size,
                      PhPoint_t *offs );

Description:

This function makes sure that the given font exists and is a fixed-width font. It returns an allocated copy of the name. If the appropriate font doesn't exist, PtTerminalFont() returns NULL.

This function stores information about the font's geometry at locations pointed to by size and offs:

• If size isn't NULL, the width and height of the character cell are stored in *size.
• If offs isn't NULL, the function stores in *offs the position that should be given to a drawing function in order to draw the character cell starting at position (0, 0).

If the specified font doesn't exist, the information about the default font is returned.

Returns:

An allocated copy of the font name, or NULL if the appropriate font doesn't exist.

Classification:

Photon