blob: c16df5f58b7f68b294469d4c3d52e9c1ed7ccdf2 [file] [edit]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>32blit API: graphics/font.hpp Source File</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" />
</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">32blit API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('font_8hpp_source.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="headertitle">
<div class="title">font.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceblit.html">blit</a> {</div>
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="structblit_1_1Font.html"> 6</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1Font.html">Font</a> {</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; constexpr <a class="code" href="structblit_1_1Font.html">Font</a>(<span class="keyword">const</span> uint8_t *<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>, <span class="keyword">const</span> uint8_t *<a class="code" href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043">char_w_variable</a>, uint8_t <a class="code" href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a">char_w</a>, uint8_t char_h, uint8_t <a class="code" href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6">spacing_y</a> = 1)</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; : <a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>(<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>), <a class="code" href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a">char_w</a>(<a class="code" href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a">char_w</a>), char_h(char_h), <a class="code" href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6">spacing_y</a>(<a class="code" href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6">spacing_y</a>), <a class="code" href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043">char_w_variable</a>(<a class="code" href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043">char_w_variable</a>) {}</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="structblit_1_1Font.html#a4aadedd6c257a43b4021eaf5984b444b"> 11</a></span>&#160; constexpr <a class="code" href="structblit_1_1Font.html#a4aadedd6c257a43b4021eaf5984b444b">Font</a>(<span class="keyword">const</span> uint8_t *<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>) : <a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>(<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a> + 8 + <a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>[4]), <a class="code" href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a">char_w</a>(<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>[5]), char_h(<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>[6]), <a class="code" href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6">spacing_y</a>(<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>[7]), <a class="code" href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043">char_w_variable</a>(<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a> + 8) {}</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda"> 14</a></span>&#160; <span class="keyword">const</span> uint8_t *<a class="code" href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">data</a>;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a"> 17</a></span>&#160; uint8_t <a class="code" href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a">char_w</a>, char_h;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6"> 20</a></span>&#160; uint8_t <a class="code" href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6">spacing_y</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043"> 23</a></span>&#160; <span class="keyword">const</span> uint8_t *<a class="code" href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043">char_w_variable</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; };</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structblit_1_1Font.html">Font</a> outline_font;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structblit_1_1Font.html">Font</a> fat_font;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structblit_1_1Font.html">Font</a> minimal_font;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;}</div>
<div class="ttc" id="anamespaceblit_html"><div class="ttname"><a href="namespaceblit.html">blit</a></div><div class="ttdef"><b>Definition:</b> audio.cpp:10</div></div>
<div class="ttc" id="astructblit_1_1Font_html"><div class="ttname"><a href="structblit_1_1Font.html">blit::Font</a></div><div class="ttdef"><b>Definition:</b> font.hpp:6</div></div>
<div class="ttc" id="astructblit_1_1Font_html_a4aadedd6c257a43b4021eaf5984b444b"><div class="ttname"><a href="structblit_1_1Font.html#a4aadedd6c257a43b4021eaf5984b444b">blit::Font::Font</a></div><div class="ttdeci">constexpr Font(const uint8_t *data)</div><div class="ttdoc">Create a font from a packed font asset.</div><div class="ttdef"><b>Definition:</b> font.hpp:11</div></div>
<div class="ttc" id="astructblit_1_1Font_html_a5347d635ebed6b4d7a9f65644497d043"><div class="ttname"><a href="structblit_1_1Font.html#a5347d635ebed6b4d7a9f65644497d043">blit::Font::char_w_variable</a></div><div class="ttdeci">const uint8_t * char_w_variable</div><div class="ttdoc">Individual character widths.</div><div class="ttdef"><b>Definition:</b> font.hpp:23</div></div>
<div class="ttc" id="astructblit_1_1Font_html_a7940b51cf48b32e834b0c5ca7ad3f90a"><div class="ttname"><a href="structblit_1_1Font.html#a7940b51cf48b32e834b0c5ca7ad3f90a">blit::Font::char_w</a></div><div class="ttdeci">uint8_t char_w</div><div class="ttdoc">Fixed character size.</div><div class="ttdef"><b>Definition:</b> font.hpp:17</div></div>
<div class="ttc" id="astructblit_1_1Font_html_ab57ed4b5011bdecc1c9ea8c03be482c6"><div class="ttname"><a href="structblit_1_1Font.html#ab57ed4b5011bdecc1c9ea8c03be482c6">blit::Font::spacing_y</a></div><div class="ttdeci">uint8_t spacing_y</div><div class="ttdoc">Extra line spacing.</div><div class="ttdef"><b>Definition:</b> font.hpp:20</div></div>
<div class="ttc" id="astructblit_1_1Font_html_ae513a43c05c11622873dfc0a3a03fdda"><div class="ttname"><a href="structblit_1_1Font.html#ae513a43c05c11622873dfc0a3a03fdda">blit::Font::data</a></div><div class="ttdeci">const uint8_t * data</div><div class="ttdoc">Character data (packed 1 bit per pixel)</div><div class="ttdef"><b>Definition:</b> font.hpp:14</div></div>
</div><!-- fragment --></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_e79632891301b850df87e9c0030293fa.html">graphics</a></li><li class="navelem"><b>font.hpp</b></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.1 </li>
</ul>
</div>
</body>
</html>