Home | All Classes | Grouped Classes | Index | Search

CL_Font::get_width

Returns the drawn width of a character or string.

	int get_width(
		unsigned char letter);

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

	int get_width(
		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:

letter
Character to get the width of.
str
String to get the width 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 width in pixels.

Detailed description:

It's important to note that newlines have no width, unless you specify a glyph for them in the sprite (which is pretty useless anyways). Other unknown characters have the width of a space.

See also:

CL_Font



Questions or comments, write to the ClanLib mailing list.