font_metrics.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 ** Mark Page
29 */
30
31
32 #pragma once
33
34 #include <memory>
35
36 namespace clan
37 {
40
41 class FontMetrics_Impl;
42
46 class FontMetrics
47 {
50 public:
51 FontMetrics();
52
53 FontMetrics(
54 float height,
55 float ascent,
56 float descent,
57 float internal_leading,
58 float external_leading,
59 float line_height, // If 0, then line_height is calculated as height + external_leading
60 float pixel_ratio
61 );
62
63 ~FontMetrics();
65
68 public:
70 float get_height() const;
71
73 float get_line_height() const;
74
76 float get_baseline_offset() const;
77
79 float get_ascent() const;
80
82 float get_descent() const;
83
85 float get_internal_leading() const;
86
88 float get_external_leading() const;
90
93 private:
94 std::shared_ptr<FontMetrics_Impl> impl;
96 };
97
98 }
99
101
clan
Definition: clanapp.h:35
clan::FontMetrics::get_height
float get_height() const
Returns the height of the font.
clan::FontMetrics::~FontMetrics
~FontMetrics()
clan::FontMetrics::get_line_height
float get_line_height() const
Return the distance between lines.
clan::FontMetrics::FontMetrics
FontMetrics()
clan::FontMetrics::get_external_leading
float get_external_leading() const
Returns the amount of extra leading (space) that to add between rows.
clan::FontMetrics::get_descent
float get_descent() const
Returns the font descender.
clan::FontMetrics::get_baseline_offset
float get_baseline_offset() const
Returns the baseline offset from the top of a line.
clan::FontMetrics::get_ascent
float get_ascent() const
Returns the font ascender.
clan::FontMetrics::get_internal_leading
float get_internal_leading() const
Returns the amount of leading (space) inside the bounds set by the get_height() function.
clan::FontMetrics
Font metrics class.
Definition: font_metrics.h:46