PtTerminalFontInfo()

Convert the font name to a fixed-width font name

Synopsis:

int PtTerminalFontInfo( 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, PtTerminalFontInfo() 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 the PhDim_t structure (see the Photon Library Reference) it points to.
• If offs isn't NULL, the function stores, in the PhPoint_t structure that it points to, the position that should be given to a drawing function in order to draw the character cell starting at position (0, 0).

Returns:

0 if the font name exists and is a fixed-width font, and -1 if not.

Classification:

Photon

See also:

PtTerminal