summaryrefslogtreecommitdiff
path: root/manuals/guile-sdl2/Fonts.html
blob: 890440f1789ca5f02b0cfcc4ec74136b197793e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2016, 2017, 2018, 2019  David Thompson davet@gnu.org

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".

A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.


* Guile-SDL2: (guile-sdl2).     SDL2 bindings for Guile.

The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
 -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Fonts (Guile-SDL2)</title>

<meta name="description" content="Fonts (Guile-SDL2)">
<meta name="keywords" content="Fonts (Guile-SDL2)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="API-Reference.html" rel="up" title="API Reference">
<link href="Hints.html" rel="next" title="Hints">
<link href="Sound.html" rel="prev" title="Sound">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
    body {
        margin-left: 14rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (min-width: 800px) and (max-width: 1140px) {
    body {
        margin-left: 6rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (max-width: 800px) {
    body {
        margin: 1rem;
    }
}

-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">


</head>

<body lang="en">
<span id="Fonts"></span><div class="header">
<p>
Next: <a href="Hints.html" accesskey="n" rel="next">Hints</a>, Previous: <a href="Sound.html" accesskey="p" rel="prev">Sound</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Fonts-1"></span><h3 class="section">3.11 Fonts</h3>

<div class="example">
<pre class="example">(use-modules (sdl2 ttf))
</pre></div>

<dl>
<dt id="index-ttf_002dinit">Procedure: <strong>ttf-init</strong></dt>
<dd><p>Initialize the TTF system.
</p></dd></dl>

<dl>
<dt id="index-ttf_002dquit">Procedure: <strong>ttf-quit</strong></dt>
<dd><p>Shut down and clean up the TTF system.
</p></dd></dl>

<dl>
<dt id="index-load_002dfont">Procedure: <strong>load-font</strong> <em>file point-size</em></dt>
<dd><p>Load TTF font from <var>file</var> and return a new font object whose glyph size is
<var>point-size</var>.
</p></dd></dl>

<dl>
<dt id="index-delete_002dfont_0021">Procedure: <strong>delete-font!</strong> <em>font</em></dt>
<dd><p>Delete the memory allocated for <var>font</var>.
</p></dd></dl>

<dl>
<dt id="index-font_002dheight">Procedure: <strong>font-height</strong> <em>font</em></dt>
<dd><p>Return the maximum height of <var>font</var>.
</p></dd></dl>

<dl>
<dt id="index-font_002dascent">Procedure: <strong>font-ascent</strong> <em>font</em></dt>
<dd><p>Return the maximum pixel ascent of all glyphs in <var>font</var>.  This can
also be interpreted as the distance from the top of the font to the
baseline.
</p></dd></dl>

<dl>
<dt id="index-font_002ddescent">Procedure: <strong>font-descent</strong> <em>font</em></dt>
<dd><p>Return the maximum pixel descent of all glyphs in <var>font</var>.  This
can also be interpreted as the distance from the baseline to the
bottom of the font.
</p></dd></dl>

<dl>
<dt id="index-font_002dline_002dskip">Procedure: <strong>font-line-skip</strong> <em>font</em></dt>
<dd><p>Return the recommended pixel height of a line of text using
<var>font</var>.
</p></dd></dl>

<dl>
<dt id="index-font_002dsize_002dtext">Procedure: <strong>font-size-text</strong> <em>font text</em></dt>
<dd><p>Return 2 values for the resulting surface size of the string
<var>text</var> using <var>font</var>.
</p></dd></dl>

<dl>
<dt id="index-font_002dglyph_002dindex">Procedure: <strong>font-glyph-index</strong> <em>font char</em></dt>
<dd><p>Return the index of the glyph for <var>char</var> in <var>font</var>, or
<code>#f</code> if <var>char</var> is not present.
</p></dd></dl>

<dl>
<dt id="index-font_002dglyph_002dmetrics">Procedure: <strong>font-glyph-metrics</strong> <em>font char</em></dt>
<dd><p>Return values for the metrics of <var>char</var> in <var>font</var>: min x, max
x, min y, max y, and advance.
</p></dd></dl>

<dl>
<dt id="index-font">font-style: <strong>font</strong></dt>
<dd><p>Return the rendering style of <var>font</var> as a list that may contain
any of the following symbols:
</p>
<ul>
<li> <code>bold</code>
</li><li> <code>italic</code>
</li><li> <code>underline</code>
</li><li> <code>strikethrough</code>
</li></ul>

<p>The empty list is returned if none of the above styles are applied.
</p></dd></dl>

<dl>
<dt id="index-font-1">font-set-style!: <strong>font</strong> <em>style</em></dt>
<dd><p>Set the rendering style of <var>font</var> to <var>style</var>, a list that may
contain any of the following symbols:
</p>
<ul>
<li> <code>bold</code>
</li><li> <code>italic</code>
</li><li> <code>underline</code>
</li><li> <code>strikethrough</code>
</li></ul>

<p>The empty list means that none of the above stylings will be used.
</p></dd></dl>

<dl>
<dt id="index-render_002dfont_002dsolid">Procedure: <strong>render-font-solid</strong> <em>font text color</em></dt>
<dd><p>Render <var>text</var>, a UTF-8 encoded string, using <var>font</var> and <var>color</var>, the
foreground color, and return a surface containing the results.
</p></dd></dl>

<dl>
<dt id="index-render_002dfont_002dblended">Procedure: <strong>render-font-blended</strong> <em>font text color</em></dt>
<dd><p>Render <var>text</var>, a UTF-8 encoded string, using <var>font</var> and <var>color</var>, the
foreground color, and return a high-quality alpha-blended surface containing the
results.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Hints.html" accesskey="n" rel="next">Hints</a>, Previous: <a href="Sound.html" accesskey="p" rel="prev">Sound</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>