gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/font_8h.html
1 <!-- HTML header for doxygen 1.8.14-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="cache-control" content="max-age=86400"/>
6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
8 <meta name="generator" content="Doxygen 1.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/gbdk/font.h File Reference</title>
11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="jquery.js"></script>
13 <script type="text/javascript" src="dynsections.js"></script>
14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
15 <script type="text/javascript" src="resize.js"></script>
16 <script type="text/javascript" src="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="search/searchdata.js"></script>
20 <script type="text/javascript" src="search/search.js"></script>
21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('font_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#nested-classes">Data Structures</a> |
104 <a href="#define-members">Macros</a> |
105 <a href="#typedef-members">Typedefs</a> |
106 <a href="#func-members">Functions</a> |
107 <a href="#var-members">Variables</a> </div>
108 <div class="headertitle"><div class="title">font.h File Reference</div></div>
109 </div><!--header-->
110 <div class="contents">
111 <div class="textblock"><code>#include <types.h></code><br />
112 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
113 </div>
114 <p><a href="font_8h_source.html">Go to the source code of this file.</a></p>
115 <table class="memberdecls">
116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
117 Data Structures</h2></td></tr>
118 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsfont__handle.html">sfont_handle</a></td></tr>
119 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
120 </table><table class="memberdecls">
121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
122 Macros</h2></td></tr>
123 <tr class="memitem:FONT_256ENCODING"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_256ENCODING">FONT_256ENCODING</a>   0</td></tr>
124 <tr class="separator:FONT_256ENCODING"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:FONT_128ENCODING"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_128ENCODING">FONT_128ENCODING</a>   1</td></tr>
126 <tr class="separator:FONT_128ENCODING"><td class="memSeparator" colspan="2"> </td></tr>
127 <tr class="memitem:FONT_NOENCODING"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_NOENCODING">FONT_NOENCODING</a>   2</td></tr>
128 <tr class="separator:FONT_NOENCODING"><td class="memSeparator" colspan="2"> </td></tr>
129 <tr class="memitem:FONT_COMPRESSED"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_COMPRESSED">FONT_COMPRESSED</a>   4</td></tr>
130 <tr class="separator:FONT_COMPRESSED"><td class="memSeparator" colspan="2"> </td></tr>
131 </table><table class="memberdecls">
132 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
133 Typedefs</h2></td></tr>
134 <tr class="memitem:font_t"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_t">font_t</a></td></tr>
135 <tr class="separator:font_t"><td class="memSeparator" colspan="2"> </td></tr>
136 <tr class="memitem:mfont_handle"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsfont__handle.html">sfont_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#mfont_handle">mfont_handle</a></td></tr>
137 <tr class="separator:mfont_handle"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:pmfont_handle"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsfont__handle.html">sfont_handle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#pmfont_handle">pmfont_handle</a></td></tr>
139 <tr class="separator:pmfont_handle"><td class="memSeparator" colspan="2"> </td></tr>
140 </table><table class="memberdecls">
141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
142 Functions</h2></td></tr>
143 <tr class="memitem:font_init"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_init">font_init</a> (void)</td></tr>
144 <tr class="separator:font_init"><td class="memSeparator" colspan="2"> </td></tr>
145 <tr class="memitem:font_load"><td class="memItemLeft" align="right" valign="top"><a class="el" href="font_8h.html#font_t">font_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_load">font_load</a> (void *font) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
146 <tr class="separator:font_load"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:font_set"><td class="memItemLeft" align="right" valign="top"><a class="el" href="font_8h.html#font_t">font_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_set">font_set</a> (<a class="el" href="font_8h.html#font_t">font_t</a> font_handle) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
148 <tr class="separator:font_set"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:font_color"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_color">font_color</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> forecolor, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> backcolor) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
150 <tr class="separator:font_color"><td class="memSeparator" colspan="2"> </td></tr>
151 </table><table class="memberdecls">
152 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
153 Variables</h2></td></tr>
154 <tr class="memitem:gfont_spect"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_spect">font_spect</a> []</td></tr>
155 <tr class="separator:gfont_spect"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:gfont_italic"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_italic">font_italic</a> []</td></tr>
157 <tr class="separator:gfont_italic"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:gfont_ibm"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_ibm">font_ibm</a> []</td></tr>
159 <tr class="separator:gfont_ibm"><td class="memSeparator" colspan="2"> </td></tr>
160 <tr class="memitem:gfont_min"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_min">font_min</a> []</td></tr>
161 <tr class="separator:gfont_min"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:gfont_ibm_fixed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_ibm_fixed">font_ibm_fixed</a> []</td></tr>
163 <tr class="separator:gfont_ibm_fixed"><td class="memSeparator" colspan="2"> </td></tr>
164 </table>
165 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
166 <div class="textblock"><p >Multiple font support for the GameBoy Michael Hope, 1999 <a href="#" onclick="location.href='mai'+'lto:'+'mic'+'ha'+'elh'+'@e'+'art'+'hl'+'ing'+'.n'+'et'; return false;">micha<span style="display: none;">.nosp@m.</span>elh@<span style="display: none;">.nosp@m.</span>earth<span style="display: none;">.nosp@m.</span>ling<span style="display: none;">.nosp@m.</span>.net</a> </p>
167 </div><h2 class="groupheader">Macro Definition Documentation</h2>
168 <a id="FONT_256ENCODING" name="FONT_256ENCODING"></a>
169 <h2 class="memtitle"><span class="permalink"><a href="#FONT_256ENCODING">◆ </a></span>FONT_256ENCODING</h2>
170
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">#define FONT_256ENCODING   0</td>
176 </tr>
177 </table>
178 </div><div class="memdoc">
179 <p >Various flags in the font header. </p>
180
181 </div>
182 </div>
183 <a id="FONT_128ENCODING" name="FONT_128ENCODING"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#FONT_128ENCODING">◆ </a></span>FONT_128ENCODING</h2>
185
186 <div class="memitem">
187 <div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname">#define FONT_128ENCODING   1</td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194
195 </div>
196 </div>
197 <a id="FONT_NOENCODING" name="FONT_NOENCODING"></a>
198 <h2 class="memtitle"><span class="permalink"><a href="#FONT_NOENCODING">◆ </a></span>FONT_NOENCODING</h2>
199
200 <div class="memitem">
201 <div class="memproto">
202 <table class="memname">
203 <tr>
204 <td class="memname">#define FONT_NOENCODING   2</td>
205 </tr>
206 </table>
207 </div><div class="memdoc">
208
209 </div>
210 </div>
211 <a id="FONT_COMPRESSED" name="FONT_COMPRESSED"></a>
212 <h2 class="memtitle"><span class="permalink"><a href="#FONT_COMPRESSED">◆ </a></span>FONT_COMPRESSED</h2>
213
214 <div class="memitem">
215 <div class="memproto">
216 <table class="memname">
217 <tr>
218 <td class="memname">#define FONT_COMPRESSED   4</td>
219 </tr>
220 </table>
221 </div><div class="memdoc">
222
223 </div>
224 </div>
225 <h2 class="groupheader">Typedef Documentation</h2>
226 <a id="font_t" name="font_t"></a>
227 <h2 class="memtitle"><span class="permalink"><a href="#font_t">◆ </a></span>font_t</h2>
228
229 <div class="memitem">
230 <div class="memproto">
231 <table class="memname">
232 <tr>
233 <td class="memname">typedef <a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> <a class="el" href="font_8h.html#font_t">font_t</a></td>
234 </tr>
235 </table>
236 </div><div class="memdoc">
237 <p >font_t is a handle to a font loaded by <a class="el" href="font_8h.html#font_load">font_load()</a>. It can be used with <a class="el" href="font_8h.html#font_set">font_set()</a> </p>
238
239 </div>
240 </div>
241 <a id="mfont_handle" name="mfont_handle"></a>
242 <h2 class="memtitle"><span class="permalink"><a href="#mfont_handle">◆ </a></span>mfont_handle</h2>
243
244 <div class="memitem">
245 <div class="memproto">
246 <table class="memname">
247 <tr>
248 <td class="memname">typedef struct <a class="el" href="structsfont__handle.html">sfont_handle</a> <a class="el" href="font_8h.html#mfont_handle">mfont_handle</a></td>
249 </tr>
250 </table>
251 </div><div class="memdoc">
252 <p >Internal representation of a font. What a font_t really is </p>
253
254 </div>
255 </div>
256 <a id="pmfont_handle" name="pmfont_handle"></a>
257 <h2 class="memtitle"><span class="permalink"><a href="#pmfont_handle">◆ </a></span>pmfont_handle</h2>
258
259 <div class="memitem">
260 <div class="memproto">
261 <table class="memname">
262 <tr>
263 <td class="memname">typedef struct <a class="el" href="structsfont__handle.html">sfont_handle</a>* <a class="el" href="font_8h.html#pmfont_handle">pmfont_handle</a></td>
264 </tr>
265 </table>
266 </div><div class="memdoc">
267
268 </div>
269 </div>
270 <h2 class="groupheader">Function Documentation</h2>
271 <a id="font_init" name="font_init"></a>
272 <h2 class="memtitle"><span class="permalink"><a href="#font_init">◆ </a></span>font_init()</h2>
273
274 <div class="memitem">
275 <div class="memproto">
276 <table class="memname">
277 <tr>
278 <td class="memname">void font_init </td>
279 <td>(</td>
280 <td class="paramtype">void </td>
281 <td class="paramname"></td><td>)</td>
282 <td></td>
283 </tr>
284 </table>
285 </div><div class="memdoc">
286 <p >Initializes the font system. Should be called before other font functions. </p>
287
288 </div>
289 </div>
290 <a id="font_load" name="font_load"></a>
291 <h2 class="memtitle"><span class="permalink"><a href="#font_load">◆ </a></span>font_load()</h2>
292
293 <div class="memitem">
294 <div class="memproto">
295 <table class="memname">
296 <tr>
297 <td class="memname"><a class="el" href="font_8h.html#font_t">font_t</a> font_load </td>
298 <td>(</td>
299 <td class="paramtype">void * </td>
300 <td class="paramname"><em>font</em></td><td>)</td>
301 <td></td>
302 </tr>
303 </table>
304 </div><div class="memdoc">
305 <p >Load a font and set it as the current font. </p><dl class="params"><dt>Parameters</dt><dd>
306 <table class="params">
307 <tr><td class="paramname">font</td><td>Pointer to a font to load (usually a gbdk font)</td></tr>
308 </table>
309 </dd>
310 </dl>
311 <dl class="section return"><dt>Returns</dt><dd>Handle to the loaded font, which can be used with <a class="el" href="font_8h.html#font_set">font_set()</a> </dd></dl>
312 <dl class="section see"><dt>See also</dt><dd><a class="el" href="font_8h.html#font_init">font_init()</a>, <a class="el" href="font_8h.html#font_set">font_set()</a>, <a class="el" href="group__gbdk__fonts.html">List of gbdk fonts</a> </dd></dl>
313
314 </div>
315 </div>
316 <a id="font_set" name="font_set"></a>
317 <h2 class="memtitle"><span class="permalink"><a href="#font_set">◆ </a></span>font_set()</h2>
318
319 <div class="memitem">
320 <div class="memproto">
321 <table class="memname">
322 <tr>
323 <td class="memname"><a class="el" href="font_8h.html#font_t">font_t</a> font_set </td>
324 <td>(</td>
325 <td class="paramtype"><a class="el" href="font_8h.html#font_t">font_t</a> </td>
326 <td class="paramname"><em>font_handle</em></td><td>)</td>
327 <td></td>
328 </tr>
329 </table>
330 </div><div class="memdoc">
331 <p >Set the current font. </p><dl class="params"><dt>Parameters</dt><dd>
332 <table class="params">
333 <tr><td class="paramname">font_handle</td><td>handle of a font returned by <a class="el" href="font_8h.html#font_load">font_load()</a></td></tr>
334 </table>
335 </dd>
336 </dl>
337 <dl class="section return"><dt>Returns</dt><dd>The previously used font handle. </dd></dl>
338 <dl class="section see"><dt>See also</dt><dd><a class="el" href="font_8h.html#font_init">font_init()</a>, <a class="el" href="font_8h.html#font_load">font_load()</a> </dd></dl>
339
340 </div>
341 </div>
342 <a id="font_color" name="font_color"></a>
343 <h2 class="memtitle"><span class="permalink"><a href="#font_color">◆ </a></span>font_color()</h2>
344
345 <div class="memitem">
346 <div class="memproto">
347 <table class="memname">
348 <tr>
349 <td class="memname">void font_color </td>
350 <td>(</td>
351 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
352 <td class="paramname"><em>forecolor</em>, </td>
353 </tr>
354 <tr>
355 <td class="paramkey"></td>
356 <td></td>
357 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
358 <td class="paramname"><em>backcolor</em> </td>
359 </tr>
360 <tr>
361 <td></td>
362 <td>)</td>
363 <td></td><td></td>
364 </tr>
365 </table>
366 </div><div class="memdoc">
367 <p >Set the current <b>foreground</b> colour (for pixels), <b>background</b> colour </p>
368
369 </div>
370 </div>
371 </div><!-- contents -->
372 </div><!-- doc-content -->
373 <!-- start footer part -->
374 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
375 <ul>
376 <li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="dir_aedcfcf321a7f13aa34b51e3093299b2.html">gbdk</a></li><li class="navelem"><a class="el" href="font_8h.html">font.h</a></li>
377 <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
378 </ul>
379 </div>
380 </body>
381 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.