CL_Font::draw

Draws text to a graphic context.

	CL_Font::PrintInfo draw(
		int x, int y, const std::string& str, CL_GraphicContext* context = 0);

	CL_Font::PrintInfo draw(
		const CL_Rect& dest, const std::string& str, const std::string& delim = std::string(" "), CL_GraphicContext* context = 0);

	CL_Font::PrintInfo draw(
		int x, int y, const std::string::const_iterator& start, const std::string::const_iterator& end, CL_GraphicContext* context = 0);

	CL_Font::PrintInfo draw(
		const CL_Rect& dest, const std::string::const_iterator& start, const std::string::const_iterator& end, const std::string& delim = std::string(" "), CL_GraphicContext* context = 0);

Parameters:

str

The input string to draw.

start

String position to begin drawing at, inclusive.

end

String position to end drawing at, exclusive.

x, y

Anchor position to draw at. Actual drawing position depends on the alignment mode.

gc

Graphic context on which to draw. If null, will use CL_Display's current graphic context.

dest

Rectangle to draw text in. The text will be word-wrapped against delimiters to fit inside the rectangle.

delim

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

Return value:

A CL_Font::PrintInfo, containing stats about the text that was drawn.

Detailed description:

You can specify a dest rectangle with a width or height of zero or less to disable word wrapping or height truncating, respectively.

See also:

CL_Font