fgf_height() (Fastgraph/Fonts)

Win32 DirectX Fastgraph/Light

Prototype

int fgf_height (char *string, int length);

Function fgf_height (ByVal string As String, ByVal length As Long) As Long

function fgf_height (string : string; length : integer) : integer;

Description

The fgf_height() function determines the height in pixels of a given character string when displayed in the current font. The height of a string is defined as the height of the tallest character in the string, including the extra pixel rows reserved for descender characters.

Parameters

string is the character string for which the height is to be computed.

length is the number of characters to consider in string, including any characters that control color selection and underlining. It must be less than or equal to the physical string length.

Return value

The height in pixels of string when displayed in the current font. If there is no current font, fgf_height() returns zero.

Restrictions

none

See also

fgf_width()

Examples

FGFW5, FGFW6