fxengine/doc/html/bitmap_8h.html

363 lines
17 KiB
HTML

<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FxEngine: include/render/bitmap.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">FxEngine
&#160;<span id="projectnumber">0.0.1</span>
</div>
<div id="projectbrief">3d engine for fx9860G calculators</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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');
/* @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('bitmap_8h.html','');});
/* @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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">bitmap.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
</div>
<p><a href="bitmap_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 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="structbitmap__rich.html">bitmap_rich</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">bitmap rich type transparency is in the layout <a href="structbitmap__rich.html#details">More...</a><br /></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 name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4ce04fd15af6abbbc6427c95ad7807af"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structbitmap__rich.html">bitmap_rich</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a4ce04fd15af6abbbc6427c95ad7807af">bitmap_rich</a></td></tr>
<tr class="separator:a4ce04fd15af6abbbc6427c95ad7807af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a12b3899d0900dff435e02de4372413a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbitmap__rich.html">bitmap_rich</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a12b3899d0900dff435e02de4372413a0">bitmap_new_rich</a> (uint32_t size_px_x, uint32_t size_px_y, uint32_t *color, bool copy_color, uint32_t *layout, bool copy_layout)</td></tr>
<tr class="memdesc:a12b3899d0900dff435e02de4372413a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">{ function_description } <a href="#a12b3899d0900dff435e02de4372413a0">More...</a><br /></td></tr>
<tr class="separator:a12b3899d0900dff435e02de4372413a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68523e5a4c514084d71103589b8065b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a68523e5a4c514084d71103589b8065b7">bitmap_delete_rich</a> (<a class="el" href="structbitmap__rich.html">bitmap_rich</a> *bmp)</td></tr>
<tr class="memdesc:a68523e5a4c514084d71103589b8065b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">delete a rich bitmap created with <a class="el" href="bitmap_8h.html#a12b3899d0900dff435e02de4372413a0" title="{ function_description }">bitmap_new_rich()</a> <a href="#a68523e5a4c514084d71103589b8065b7">More...</a><br /></td></tr>
<tr class="separator:a68523e5a4c514084d71103589b8065b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9153decdd49572286686861518a60929"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a9153decdd49572286686861518a60929">bitmap_get_pixel_r</a> (const <a class="el" href="structbitmap__rich.html">bitmap_rich</a> *bmp, uint32_t x, uint32_t y)</td></tr>
<tr class="memdesc:a9153decdd49572286686861518a60929"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the color of pixel from rich bitmap <a href="#a9153decdd49572286686861518a60929">More...</a><br /></td></tr>
<tr class="separator:a9153decdd49572286686861518a60929"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1b667a294c2d69346ae3ddae679f945"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#ae1b667a294c2d69346ae3ddae679f945">bitmap_display_pixel_r</a> (const <a class="el" href="structbitmap__rich.html">bitmap_rich</a> *bmp, uint32_t bmp_x, uint32_t bmp_y, uint32_t x, uint32_t y)</td></tr>
<tr class="memdesc:ae1b667a294c2d69346ae3ddae679f945"><td class="mdescLeft">&#160;</td><td class="mdescRight">display a specific rich bitmap pixel on the screen <a href="#ae1b667a294c2d69346ae3ddae679f945">More...</a><br /></td></tr>
<tr class="separator:ae1b667a294c2d69346ae3ddae679f945"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a4ce04fd15af6abbbc6427c95ad7807af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ce04fd15af6abbbc6427c95ad7807af">&#9670;&nbsp;</a></span>bitmap_rich</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structbitmap__rich.html">bitmap_rich</a> <a class="el" href="structbitmap__rich.html">bitmap_rich</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitmap_8h_source.html#l00020">20</a> of file <a class="el" href="bitmap_8h_source.html">bitmap.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a68523e5a4c514084d71103589b8065b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68523e5a4c514084d71103589b8065b7">&#9670;&nbsp;</a></span>bitmap_delete_rich()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bitmap_delete_rich </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbitmap__rich.html">bitmap_rich</a> *&#160;</td>
<td class="paramname"><em>bmp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>delete a rich bitmap created with <a class="el" href="bitmap_8h.html#a12b3899d0900dff435e02de4372413a0" title="{ function_description }">bitmap_new_rich()</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bmp</td><td>The bitmap to delete </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae1b667a294c2d69346ae3ddae679f945"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1b667a294c2d69346ae3ddae679f945">&#9670;&nbsp;</a></span>bitmap_display_pixel_r()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bitmap_display_pixel_r </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbitmap__rich.html">bitmap_rich</a> *&#160;</td>
<td class="paramname"><em>bmp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bmp_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bmp_y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>display a specific rich bitmap pixel on the screen </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bmp</td><td>The bitmap </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bmp_x</td><td>The bitmap x coordinate (in pixels) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bmp_y</td><td>The bitmap y coordinate (in pixels) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>screen : x coordinate </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>screen : y coordinate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9153decdd49572286686861518a60929"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9153decdd49572286686861518a60929">&#9670;&nbsp;</a></span>bitmap_get_pixel_r()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t bitmap_get_pixel_r </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbitmap__rich.html">bitmap_rich</a> *&#160;</td>
<td class="paramname"><em>bmp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the color of pixel from rich bitmap </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bmp</td><td>The bitmap </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The bitmap x coordinate (in pixels) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The bitmap y coordinate (in pixels)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the color coded in a unsigned char : if (color &gt;&gt; 1) switch (color%2) { case 0: // WHITE break; case 1: // BLACK } else </dd></dl>
</div>
</div>
<a id="a12b3899d0900dff435e02de4372413a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12b3899d0900dff435e02de4372413a0">&#9670;&nbsp;</a></span>bitmap_new_rich()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbitmap__rich.html">bitmap_rich</a>* bitmap_new_rich </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size_px_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size_px_y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>copy_color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>copy_layout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>{ function_description } </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size_px_x</td><td>The width in px </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size_px_y</td><td>The height in px </td></tr>
<tr><td class="paramdir"></td><td class="paramname">color</td><td>color origin </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy_color</td><td>if you want to make a copy, or only to make a link </td></tr>
<tr><td class="paramdir"></td><td class="paramname">layout</td><td>layout origin -&gt; can be set as 0 if it isn't needed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy_layout</td><td>if you want to make a copy, or to make a link</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a rich bitmap, ready to use ! </dd></dl>
</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_ada157988d47c0ed8971be2c0e2fe61c.html">render</a></li><li class="navelem"><a class="el" href="bitmap_8h.html">bitmap.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>