Files
gbdk-2020/docs/api/font_8h.html
2025-12-27 17:53:11 -08:00

382 lines
20 KiB
HTML

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="cache-control" content="max-age=86400"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GBDK 2020 Docs: gbdk-lib/include/gbdk/font.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<!-- BEGIN: doxygen-awesome-css -->
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<!-- END: doxygen-awesome-css -->
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GBDK 2020 Docs
&#160;<span id="projectnumber">4.5.0</span>
</div>
<div id="projectbrief">API Documentation for GBDK 2020</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('font_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">font.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;types.h&gt;</code><br />
<code>#include &lt;<a class="el" href="stdint_8h_source.html">stdint.h</a>&gt;</code><br />
</div>
<p><a href="font_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsfont__handle.html">sfont_handle</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:FONT_256ENCODING"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_256ENCODING">FONT_256ENCODING</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:FONT_256ENCODING"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:FONT_128ENCODING"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_128ENCODING">FONT_128ENCODING</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:FONT_128ENCODING"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:FONT_NOENCODING"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_NOENCODING">FONT_NOENCODING</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:FONT_NOENCODING"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:FONT_COMPRESSED"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#FONT_COMPRESSED">FONT_COMPRESSED</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:FONT_COMPRESSED"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_t">font_t</a></td></tr>
<tr class="separator:font_t"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:mfont_handle"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsfont__handle.html">sfont_handle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#mfont_handle">mfont_handle</a></td></tr>
<tr class="separator:mfont_handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:pmfont_handle"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsfont__handle.html">sfont_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#pmfont_handle">pmfont_handle</a></td></tr>
<tr class="separator:pmfont_handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:font_init"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="font_8h.html#font_init">font_init</a> (void)</td></tr>
<tr class="separator:font_init"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:font_load"><td class="memItemLeft" align="right" valign="top"><a class="el" href="font_8h.html#font_t">font_t</a>&#160;</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>
<tr class="separator:font_load"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:font_set"><td class="memItemLeft" align="right" valign="top"><a class="el" href="font_8h.html#font_t">font_t</a>&#160;</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>
<tr class="separator:font_set"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:font_color"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr class="separator:font_color"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gfont_spect"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_spect">font_spect</a> []</td></tr>
<tr class="separator:gfont_spect"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gfont_italic"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_italic">font_italic</a> []</td></tr>
<tr class="separator:gfont_italic"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gfont_ibm"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_ibm">font_ibm</a> []</td></tr>
<tr class="separator:gfont_ibm"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gfont_min"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_min">font_min</a> []</td></tr>
<tr class="separator:gfont_min"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gbdk__fonts.html#gfont_ibm_fixed">font_ibm_fixed</a> []</td></tr>
<tr class="separator:gfont_ibm_fixed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="FONT_256ENCODING" name="FONT_256ENCODING"></a>
<h2 class="memtitle"><span class="permalink"><a href="#FONT_256ENCODING">&#9670;&nbsp;</a></span>FONT_256ENCODING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FONT_256ENCODING&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p >Various flags in the font header. </p>
</div>
</div>
<a id="FONT_128ENCODING" name="FONT_128ENCODING"></a>
<h2 class="memtitle"><span class="permalink"><a href="#FONT_128ENCODING">&#9670;&nbsp;</a></span>FONT_128ENCODING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FONT_128ENCODING&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="FONT_NOENCODING" name="FONT_NOENCODING"></a>
<h2 class="memtitle"><span class="permalink"><a href="#FONT_NOENCODING">&#9670;&nbsp;</a></span>FONT_NOENCODING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FONT_NOENCODING&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="FONT_COMPRESSED" name="FONT_COMPRESSED"></a>
<h2 class="memtitle"><span class="permalink"><a href="#FONT_COMPRESSED">&#9670;&nbsp;</a></span>FONT_COMPRESSED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FONT_COMPRESSED&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="font_t" name="font_t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#font_t">&#9670;&nbsp;</a></span>font_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="mfont_handle" name="mfont_handle"></a>
<h2 class="memtitle"><span class="permalink"><a href="#mfont_handle">&#9670;&nbsp;</a></span>mfont_handle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
<p >Internal representation of a font. What a font_t really is </p>
</div>
</div>
<a id="pmfont_handle" name="pmfont_handle"></a>
<h2 class="memtitle"><span class="permalink"><a href="#pmfont_handle">&#9670;&nbsp;</a></span>pmfont_handle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="font_init" name="font_init"></a>
<h2 class="memtitle"><span class="permalink"><a href="#font_init">&#9670;&nbsp;</a></span>font_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void font_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Initializes the font system. Should be called before other font functions. </p>
</div>
</div>
<a id="font_load" name="font_load"></a>
<h2 class="memtitle"><span class="permalink"><a href="#font_load">&#9670;&nbsp;</a></span>font_load()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="font_8h.html#font_t">font_t</a> font_load </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Load a font and set it as the current font. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>Pointer to a font to load (usually a gbdk font)</td></tr>
</table>
</dd>
</dl>
<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>
<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>
</div>
</div>
<a id="font_set" name="font_set"></a>
<h2 class="memtitle"><span class="permalink"><a href="#font_set">&#9670;&nbsp;</a></span>font_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="font_8h.html#font_t">font_t</a> font_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="font_8h.html#font_t">font_t</a>&#160;</td>
<td class="paramname"><em>font_handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Set the current font. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The previously used font handle. </dd></dl>
<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>
</div>
</div>
<a id="font_color" name="font_color"></a>
<h2 class="memtitle"><span class="permalink"><a href="#font_color">&#9670;&nbsp;</a></span>font_color()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void font_color </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>forecolor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>backcolor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Set the current <b>foreground</b> colour (for pixels), <b>background</b> colour </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<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>
</ul>
</div>
</body>
</html>