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

926 lines
43 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/gb/drawing.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('drawing_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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">drawing.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="drawing_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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:GRAPHICS_WIDTH"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#GRAPHICS_WIDTH">GRAPHICS_WIDTH</a>&#160;&#160;&#160;160</td></tr>
<tr class="separator:GRAPHICS_WIDTH"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:GRAPHICS_HEIGHT"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#GRAPHICS_HEIGHT">GRAPHICS_HEIGHT</a>&#160;&#160;&#160;144</td></tr>
<tr class="separator:GRAPHICS_HEIGHT"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:SOLID"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#SOLID">SOLID</a>&#160;&#160;&#160;0x00 /* Overwrites the existing pixels */</td></tr>
<tr class="separator:SOLID"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:OR"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#OR">OR</a>&#160;&#160;&#160;0x01 /* Performs a logical OR */</td></tr>
<tr class="separator:OR"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:XOR"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#XOR">XOR</a>&#160;&#160;&#160;0x02 /* Performs a logical XOR */</td></tr>
<tr class="separator:XOR"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:AND"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#AND">AND</a>&#160;&#160;&#160;0x03 /* Performs a logical AND */</td></tr>
<tr class="separator:AND"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:WHITE"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#WHITE">WHITE</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:WHITE"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:LTGREY"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#LTGREY">LTGREY</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:LTGREY"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:DKGREY"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#DKGREY">DKGREY</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:DKGREY"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:BLACK"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#BLACK">BLACK</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:BLACK"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:M_NOFILL"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#M_NOFILL">M_NOFILL</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:M_NOFILL"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:M_FILL"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#M_FILL">M_FILL</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:M_FILL"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:SIGNED"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#SIGNED">SIGNED</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:SIGNED"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:UNSIGNED"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#UNSIGNED">UNSIGNED</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:UNSIGNED"><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:gprint"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#gprint">gprint</a> (char *str) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
<tr class="separator:gprint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gprintln"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#gprintln">gprintln</a> (<a class="el" href="stdint_8h.html#int16_t">int16_t</a> number, <a class="el" href="stdint_8h.html#int8_t">int8_t</a> radix, <a class="el" href="stdint_8h.html#int8_t">int8_t</a> signed_value) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
<tr class="separator:gprintln"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gprintn"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#gprintn">gprintn</a> (<a class="el" href="stdint_8h.html#int8_t">int8_t</a> number, <a class="el" href="stdint_8h.html#int8_t">int8_t</a> radix, <a class="el" href="stdint_8h.html#int8_t">int8_t</a> signed_value) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
<tr class="separator:gprintn"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gprintf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#int8_t">int8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#gprintf">gprintf</a> (char *fmt,...) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
<tr class="separator:gprintf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:plot"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#plot">plot</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> colour, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="el" href="sms_8h.html#mode">mode</a>) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:plot"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:plot_point"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#plot_point">plot_point</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:plot_point"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:switch_data"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#switch_data">switch_data</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *src, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *dst) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:switch_data"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:draw_image"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#draw_image">draw_image</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *data)</td></tr>
<tr class="separator:draw_image"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:line"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#line">line</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x1, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y1, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x2, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y2) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:line"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:box"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#box">box</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x1, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y1, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x2, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y2, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> style) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:box"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:circle"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#circle">circle</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> radius, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> style) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:circle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:getpix"><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="drawing_8h.html#getpix">getpix</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:getpix"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:wrtchr"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#wrtchr">wrtchr</a> (char chr) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:wrtchr"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gotogxy"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#gotogxy">gotogxy</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:gotogxy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:color"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="drawing_8h.html#color">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="stdint_8h.html#uint8_t">uint8_t</a> <a class="el" href="sms_8h.html#mode">mode</a>) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
<tr class="separator:color"><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 >All Points Addressable (APA) mode drawing library.</p>
<p >Drawing routines originally by Pascal Felber Legendary overhall by Jon Fuge : <a href="https://github.com/jf1452">https://github.com/jf1452</a> Commenting by Michael Hope</p>
<p >Note: The standard text <a class="el" href="stdio_8h.html#printf">printf()</a> and <a class="el" href="stdio_8h.html#putchar">putchar()</a> cannot be used in APA mode - use <a class="el" href="drawing_8h.html#gprintf">gprintf()</a> and <a class="el" href="drawing_8h.html#wrtchr">wrtchr()</a> instead.</p>
<p >Note: Using drawing.h will cause it's custom LCD ISR (<code>drawing_lcd</code>) to be installed. Changing the mode (<code>mode(M_TEXT_OUT);</code>) will cause them to be de-installed.</p>
<p >The valid coordinate ranges are from (x,y) 0,0 to 159,143. There is no built-in clipping, so drawing outside valid coordinates will likely produce undesired results (wrapping/etc).</p>
<hr />
<p ><b>Important note for the drawing API :</b></p>
<p >The Game Boy graphics hardware is not well suited to frame-buffer style graphics such as the kind provided in <code>drawing.h</code>. Due to that, <b>most drawing functions (rectangles, circles, etc) will be slow</b> . When possible it's much faster and more efficient to work with the tiles and tile maps that the Game Boy hardware is built around. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="GRAPHICS_WIDTH" name="GRAPHICS_WIDTH"></a>
<h2 class="memtitle"><span class="permalink"><a href="#GRAPHICS_WIDTH">&#9670;&nbsp;</a></span>GRAPHICS_WIDTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRAPHICS_WIDTH&#160;&#160;&#160;160</td>
</tr>
</table>
</div><div class="memdoc">
<p >Size of the screen in pixels </p>
</div>
</div>
<a id="GRAPHICS_HEIGHT" name="GRAPHICS_HEIGHT"></a>
<h2 class="memtitle"><span class="permalink"><a href="#GRAPHICS_HEIGHT">&#9670;&nbsp;</a></span>GRAPHICS_HEIGHT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRAPHICS_HEIGHT&#160;&#160;&#160;144</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="SOLID" name="SOLID"></a>
<h2 class="memtitle"><span class="permalink"><a href="#SOLID">&#9670;&nbsp;</a></span>SOLID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOLID&#160;&#160;&#160;0x00 /* Overwrites the existing pixels */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="OR" name="OR"></a>
<h2 class="memtitle"><span class="permalink"><a href="#OR">&#9670;&nbsp;</a></span>OR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OR&#160;&#160;&#160;0x01 /* Performs a logical OR */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="XOR" name="XOR"></a>
<h2 class="memtitle"><span class="permalink"><a href="#XOR">&#9670;&nbsp;</a></span>XOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XOR&#160;&#160;&#160;0x02 /* Performs a logical XOR */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="AND" name="AND"></a>
<h2 class="memtitle"><span class="permalink"><a href="#AND">&#9670;&nbsp;</a></span>AND</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AND&#160;&#160;&#160;0x03 /* Performs a logical AND */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="WHITE" name="WHITE"></a>
<h2 class="memtitle"><span class="permalink"><a href="#WHITE">&#9670;&nbsp;</a></span>WHITE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WHITE&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p >Possible drawing colours </p>
</div>
</div>
<a id="LTGREY" name="LTGREY"></a>
<h2 class="memtitle"><span class="permalink"><a href="#LTGREY">&#9670;&nbsp;</a></span>LTGREY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LTGREY&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="DKGREY" name="DKGREY"></a>
<h2 class="memtitle"><span class="permalink"><a href="#DKGREY">&#9670;&nbsp;</a></span>DKGREY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DKGREY&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="BLACK" name="BLACK"></a>
<h2 class="memtitle"><span class="permalink"><a href="#BLACK">&#9670;&nbsp;</a></span>BLACK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLACK&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="M_NOFILL" name="M_NOFILL"></a>
<h2 class="memtitle"><span class="permalink"><a href="#M_NOFILL">&#9670;&nbsp;</a></span>M_NOFILL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_NOFILL&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p >Possible fill styles for <a class="el" href="drawing_8h.html#box">box()</a> and <a class="el" href="drawing_8h.html#circle">circle()</a> </p>
</div>
</div>
<a id="M_FILL" name="M_FILL"></a>
<h2 class="memtitle"><span class="permalink"><a href="#M_FILL">&#9670;&nbsp;</a></span>M_FILL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_FILL&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="SIGNED" name="SIGNED"></a>
<h2 class="memtitle"><span class="permalink"><a href="#SIGNED">&#9670;&nbsp;</a></span>SIGNED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SIGNED&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p >Possible values for signed_value in <a class="el" href="drawing_8h.html#gprintln">gprintln()</a> and <a class="el" href="drawing_8h.html#gprintn">gprintn()</a> </p>
</div>
</div>
<a id="UNSIGNED" name="UNSIGNED"></a>
<h2 class="memtitle"><span class="permalink"><a href="#UNSIGNED">&#9670;&nbsp;</a></span>UNSIGNED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UNSIGNED&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gprint" name="gprint"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gprint">&#9670;&nbsp;</a></span>gprint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gprint </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Print the string 'str' with no interpretation </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="drawing_8h.html#gotogxy">gotogxy()</a> </dd></dl>
</div>
</div>
<a id="gprintln" name="gprintln"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gprintln">&#9670;&nbsp;</a></span>gprintln()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gprintln </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a>&#160;</td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#int8_t">int8_t</a>&#160;</td>
<td class="paramname"><em>radix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#int8_t">int8_t</a>&#160;</td>
<td class="paramname"><em>signed_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Print 16 bit <b>number</b> in <b>radix</b> (base) in the default font at the current text position.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>number to print </td></tr>
<tr><td class="paramname">radix</td><td>radix (base) to print with </td></tr>
<tr><td class="paramname">signed_value</td><td>should be set to SIGNED or UNSIGNED depending on whether the number is signed or not</td></tr>
</table>
</dd>
</dl>
<p>The current position is advanced by the numer of characters printed. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="drawing_8h.html#gotogxy">gotogxy()</a> </dd></dl>
</div>
</div>
<a id="gprintn" name="gprintn"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gprintn">&#9670;&nbsp;</a></span>gprintn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gprintn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#int8_t">int8_t</a>&#160;</td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#int8_t">int8_t</a>&#160;</td>
<td class="paramname"><em>radix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#int8_t">int8_t</a>&#160;</td>
<td class="paramname"><em>signed_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Print 8 bit <b>number</b> in <b>radix</b> (base) in the default font at the current text position.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="drawing_8h.html#gprintln">gprintln()</a>, <a class="el" href="drawing_8h.html#gotogxy">gotogxy()</a> </dd></dl>
</div>
</div>
<a id="gprintf" name="gprintf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gprintf">&#9670;&nbsp;</a></span>gprintf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="stdint_8h.html#int8_t">int8_t</a> gprintf </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Print the string and arguments given by <b>fmt</b> with arguments __...__</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>The format string as per printf </td></tr>
<tr><td class="paramname">...</td><td>params</td></tr>
</table>
</dd>
</dl>
<p>Currently supported: </p><ul>
<li>%c (character) </li>
<li>%u (int) </li>
<li>%d (int8_t) </li>
<li>%o (int8_t as octal) </li>
<li>%x (int8_t as hex) </li>
<li>%s (string)</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of items printed, or -1 if there was an error. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="drawing_8h.html#gotogxy">gotogxy()</a> </dd></dl>
</div>
</div>
<a id="plot" name="plot"></a>
<h2 class="memtitle"><span class="permalink"><a href="#plot">&#9670;&nbsp;</a></span>plot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void plot </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x</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>y</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>colour</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>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Old style plot - try <a class="el" href="drawing_8h.html#plot_point">plot_point()</a> </p>
</div>
</div>
<a id="plot_point" name="plot_point"></a>
<h2 class="memtitle"><span class="permalink"><a href="#plot_point">&#9670;&nbsp;</a></span>plot_point()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void plot_point </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x</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>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Plot a point in the current drawing mode and colour at <b>x,y</b> </p>
</div>
</div>
<a id="switch_data" name="switch_data"></a>
<h2 class="memtitle"><span class="permalink"><a href="#switch_data">&#9670;&nbsp;</a></span>switch_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void switch_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x</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>y</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>src</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>dst</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Exchanges the tile on screen at x,y with the tile pointed by src, original tile is saved in dst. Both src and dst may be NULL - saving or copying to screen is not performed in this case. </p>
</div>
</div>
<a id="draw_image" name="draw_image"></a>
<h2 class="memtitle"><span class="permalink"><a href="#draw_image">&#9670;&nbsp;</a></span>draw_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void draw_image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Draw a full screen image at <b>data</b> </p>
</div>
</div>
<a id="line" name="line"></a>
<h2 class="memtitle"><span class="permalink"><a href="#line">&#9670;&nbsp;</a></span>line()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void line </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x1</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>y1</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>x2</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>y2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Draw a line in the current drawing mode and colour from <b>x1,y1</b> to <b>x2,y2</b> </p>
</div>
</div>
<a id="box" name="box"></a>
<h2 class="memtitle"><span class="permalink"><a href="#box">&#9670;&nbsp;</a></span>box()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void box </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x1</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>y1</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>x2</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>y2</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>style</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Draw a box (rectangle) with corners <b>x1,y1</b> and <b>x2,y2</b> using fill mode <b>style</b> (one of NOFILL or FILL) </p>
</div>
</div>
<a id="circle" name="circle"></a>
<h2 class="memtitle"><span class="permalink"><a href="#circle">&#9670;&nbsp;</a></span>circle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void circle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x</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>y</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>radius</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>style</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Draw a circle with centre at <b>x,y</b> and <b>radius</b> using fill mode <b>style</b> (one of NOFILL or FILL) </p>
</div>
</div>
<a id="getpix" name="getpix"></a>
<h2 class="memtitle"><span class="permalink"><a href="#getpix">&#9670;&nbsp;</a></span>getpix()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> getpix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x</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>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns the current colour of the pixel at <b>x,y</b> </p>
</div>
</div>
<a id="wrtchr" name="wrtchr"></a>
<h2 class="memtitle"><span class="permalink"><a href="#wrtchr">&#9670;&nbsp;</a></span>wrtchr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wrtchr </td>
<td>(</td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>chr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Prints the character <b>chr</b> in the default font at the current text position.</p>
<p >The current position is advanced by 1 after the character is printed. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="drawing_8h.html#gotogxy">gotogxy()</a> </dd></dl>
</div>
</div>
<a id="gotogxy" name="gotogxy"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gotogxy">&#9670;&nbsp;</a></span>gotogxy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gotogxy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td>
<td class="paramname"><em>x</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>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Sets the current text position to <b>x,y</b>.</p>
<p >Note: <b>x</b> and <b>y</b> have units of tiles (8 pixels per unit) </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="drawing_8h.html#wrtchr">wrtchr()</a> </dd></dl>
</div>
</div>
<a id="color" name="color"></a>
<h2 class="memtitle"><span class="permalink"><a href="#color">&#9670;&nbsp;</a></span>color()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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>, </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>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Set the current <b>forecolor</b> colour, <b>backcolor</b> colour, and draw <b>mode</b></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">forecolor</td><td>The primary drawing color (outlines of rectangles with <a class="el" href="drawing_8h.html#box">box()</a>, letter color with <a class="el" href="drawing_8h.html#gprintf">gprintf()</a>, etc). </td></tr>
<tr><td class="paramname">backcolor</td><td>Secondary or background color where applicable (fill color of rectangles with <a class="el" href="drawing_8h.html#box">box()</a> when <a class="el" href="drawing_8h.html#M_FILL">M_FILL</a> is specifed, background color of text with <a class="el" href="drawing_8h.html#gprintf">gprintf()</a>, etc). </td></tr>
<tr><td class="paramname">mode</td><td>Drawing style to use. Several settings are available <code>SOLID</code>, <code>OR</code>, <code>XOR</code>, <code>AND</code>.</td></tr>
</table>
</dd>
</dl>
<p>In order to completely overwrite existing pixels use <code>SOLID</code> for <b>mode</b> </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_bdfe001eb73b667f67d57fb851301eb1.html">gb</a></li><li class="navelem"><a class="el" href="drawing_8h.html">drawing.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>