CL_Font::bounding_rect - ClanLib Game SDK

Home | All Classes | Grouped Classes | Index | Search

# CL_Font::bounding_rect

Calculate the rectangle that would be occupied by a draw operation.

    	CL_Rect bounding_rect(
    		int x, int y, const std::string& str);

    	CL_Rect bounding_rect(
    		CL_Rect dest, const std::string& str);

    	CL_Rect bounding_rect(
    		int x, int y, std::string::const_iterator start, std::string::const_iterator end);

    	CL_Rect bounding_rect(
    		CL_Rect dest, std::string::const_iterator start, std::string::const_iterator end);

Parameters:

str
  The input string to process.
start
  String position to begin processing at, inclusive.
end
  String position to end processing at, exclusive.
x, y
  Anchor position to simulate draw at. Actual position depends on the alignment mode.
dest
  Rectangle to draw text in. The text will be word-wrapped against delimiters to fit inside the rectangle.

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_Rect | CL_Font

Questions or comments, write to the ClanLib mailing list.