Mirrors/gbdk-2020
2
0
Fork 0
mirror of https://github.com/gbdk-2020/gbdk-2020.git synced 2026-03-19 13:48:30 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
3e2ff4dcf4d5712ea7ddbce52dbbc4aca662fc3d
gbdk-2020/docs/api/hblankcpy_8h.html
bbbbbr d87fbe7f10 Docs: regenerate documentation for gbdk 4.4.0
2025-05-09 23:47:16 -07:00

281 lines
13 KiB
HTML
Raw Blame History

<!-- 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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GBDK 2020 Docs: gbdk-lib/include/gb/hblankcpy.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_extra.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">GBDK 2020 Docs
&#160;<span id="projectnumber">4.4.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.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('hblankcpy_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="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">hblankcpy.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="stdint_8h_source.html">stdint.h</a>&gt;</code><br />
</div>
<p><a href="hblankcpy_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6d0127b6bf7926f3329ae255b116ffb7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hblankcpy_8h.html#a6d0127b6bf7926f3329ae255b116ffb7">hblank_copy_vram</a> (const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> count)</td></tr>
<tr class="separator:a6d0127b6bf7926f3329ae255b116ffb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76fcbe1a2a022d4cd36b473e24ba9abd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hblankcpy_8h.html#a76fcbe1a2a022d4cd36b473e24ba9abd">hblank_cpy_vram</a> (const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> count)</td></tr>
<tr class="separator:a76fcbe1a2a022d4cd36b473e24ba9abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49bc3430f31b23fa03cd771ace74c8ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hblankcpy_8h.html#a49bc3430f31b23fa03cd771ace74c8ba">hblank_copy</a> (<a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *dest, const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour, <a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> size)</td></tr>
<tr class="separator:a49bc3430f31b23fa03cd771ace74c8ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a5ec0b43c3711c82df5dbe10dbba4fd36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hblankcpy_8h.html#a5ec0b43c3711c82df5dbe10dbba4fd36">hblank_copy_destination</a></td></tr>
<tr class="separator:a5ec0b43c3711c82df5dbe10dbba4fd36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6d0127b6bf7926f3329ae255b116ffb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d0127b6bf7926f3329ae255b116ffb7">&#9670;&nbsp;</a></span>hblank_copy_vram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hblank_copy_vram </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
<td class="paramname"><em>sour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>HBlank stack copy routine </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sour</td><td>Source address to copy from </td></tr>
<tr><td class="paramname">count</td><td>Number of 16 byte chunks to copy</td></tr>
</table>
</dd>
</dl>
<p>Performs the required STAT_REG, IE_REG, IF_REG manipulation when called and restores STAT_REG and IE_REG on exit (unlike <a class="el" href="hblankcpy_8h.html#a76fcbe1a2a022d4cd36b473e24ba9abd">hblank_cpy_vram()</a>).</p>
<p>Before calling:</p><ul>
<li>Set the destination using <a class="el" href="hblankcpy_8h.html#a5ec0b43c3711c82df5dbe10dbba4fd36">hblank_copy_destination</a></li>
<li>Interrupts must be disabled</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="hblankcpy_8h.html#a76fcbe1a2a022d4cd36b473e24ba9abd">hblank_cpy_vram</a>, <a class="el" href="hblankcpy_8h.html#a5ec0b43c3711c82df5dbe10dbba4fd36">hblank_copy_destination</a>, <a class="el" href="hblankcpy_8h.html#a49bc3430f31b23fa03cd771ace74c8ba">hblank_copy</a> </dd></dl>
</div>
</div>
<a id="a76fcbe1a2a022d4cd36b473e24ba9abd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76fcbe1a2a022d4cd36b473e24ba9abd">&#9670;&nbsp;</a></span>hblank_cpy_vram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hblank_cpy_vram </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
<td class="paramname"><em>sour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>HBlank stack copy routine </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sour</td><td>Source address to copy from </td></tr>
<tr><td class="paramname">count</td><td>Number of 16 byte chunks to copy</td></tr>
</table>
</dd>
</dl>
<p>Unlike <a class="el" href="hblankcpy_8h.html#a6d0127b6bf7926f3329ae255b116ffb7">hblank_copy_vram()</a> does not perform the required STAT_REG, IE_REG, IF_REG manipulation, nor does it restore STAT_REG and IE_REG on exit.</p>
<p>Before calling:</p><ul>
<li>Set the destination using <a class="el" href="hblankcpy_8h.html#a5ec0b43c3711c82df5dbe10dbba4fd36">hblank_copy_destination</a></li>
<li>Interrupts must be properly configured</li>
<li>Interrupts must be disabled</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="hblankcpy_8h.html#a6d0127b6bf7926f3329ae255b116ffb7">hblank_copy_vram</a>, <a class="el" href="hblankcpy_8h.html#a5ec0b43c3711c82df5dbe10dbba4fd36">hblank_copy_destination</a>, <a class="el" href="hblankcpy_8h.html#a49bc3430f31b23fa03cd771ace74c8ba">hblank_copy</a> </dd></dl>
</div>
</div>
<a id="a49bc3430f31b23fa03cd771ace74c8ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49bc3430f31b23fa03cd771ace74c8ba">&#9670;&nbsp;</a></span>hblank_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void hblank_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
<td class="paramname"><em>sour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a>&#160;</td>
<td class="paramname"><em>size</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>HBlank stack copy routine (must be called with interrupts disabled!) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>destination pointer </td></tr>
<tr><td class="paramname">sour</td><td>source pointer </td></tr>
<tr><td class="paramname">size</td><td>number of bytes to copy (rounded to 16-byte chunks)</td></tr>
</table>
</dd>
</dl>
<p>Performs a fast vram safe copy of data during HBlank. </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a5ec0b43c3711c82df5dbe10dbba4fd36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ec0b43c3711c82df5dbe10dbba4fd36">&#9670;&nbsp;</a></span>hblank_copy_destination</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>* hblank_copy_destination</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destination address for hblank copy routine </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink