CL_Font::get_height

Returns the drawn height of the entire font or a string.

	int get_height();

	int get_height(
		const std::string& str, const CL_Size& max_size = CL_Size(0, 0), const std::string& delim = std::string(" "));

	int get_height(
		const std::string::const_iterator& start, const std::string::const_iterator& end, const CL_Size& max_size = CL_Size(0, 0), const std::string& delim = std::string(" "));

Parameters:

str

String to get the height of.

start

A starting iterator, inclusive.

end

An ending iterator, exclusive.

max_size

Same effect as the size of the dest rectangle passed to draw(), for word wrapping and height truncating

delim

When word-wrapping, specifies characters (other than newlines) that act as word seperators.

Return value:

The height in pixels.

Detailed description:

The height of the entire font is the height of the tallest glyph in the font; this is what is returned if you specify no arguments. The point of having the height functions accept a string is to compensate for strings spanning multiple lines.

See also:

CL_Font