font_metrics.h Source File - ClanLib SDK
Description: font_metrics.h Source File

font_metrics.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
32
33#include <memory>
34
35namespace clan
36{
39
40 class FontMetrics_Impl;
41
45 class FontMetrics
46 {
47 public:
48 FontMetrics();
49
50 FontMetrics(
51 float height,
52 float ascent,
53 float descent,
54 float internal_leading,
55 float external_leading,
56 float line_height, // If 0, then line_height is calculated as height + external_leading
57 float pixel_ratio
58 );
59
60 ~FontMetrics();
61
63 float get_height() const;
64
66 float get_line_height() const;
67
69 float get_baseline_offset() const;
70
72 float get_ascent() const;
73
75 float get_descent() const;
76
78 float get_internal_leading() const;
79
81 float get_external_leading() const;
82
83 private:
84 std::shared_ptr<FontMetrics_Impl> impl;
85 };
86
88}
clan::FontMetrics::get_descent
float get_descent() const
Returns the font descender.
clan::FontMetrics::get_ascent
float get_ascent() const
Returns the font ascender.
clan::FontMetrics::get_line_height
float get_line_height() const
Return the distance between lines.
clan::FontMetrics::~FontMetrics
~FontMetrics()
clan::FontMetrics::get_baseline_offset
float get_baseline_offset() const
Returns the baseline offset from the top of a line.
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::FontMetrics
FontMetrics()
clan::FontMetrics::get_height
float get_height() const
Returns the height of the font.
clan::FontMetrics::get_external_leading
float get_external_leading() const
Returns the amount of extra leading (space) that to add between rows.
clan::FontMetrics::FontMetrics
FontMetrics(float height, float ascent, float descent, float internal_leading, float external_leading, float line_height, float pixel_ratio)
clan
Definition clanapp.h:36