Files
gbdk-2020/docs/api/nes_2hardware_8h_source.html
2024-05-13 22:45:19 -07:00

163 lines
18 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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GBDK 2020 Docs: gbdk-lib/include/nes/hardware.h 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" />
<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.3.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('nes_2hardware_8h_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">hardware.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="nes_2hardware_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef _HARDWARE_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define _HARDWARE_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;types.h&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ae61804714a30560fb686c9e5217e54f3"> 10</a></span>&#160;<span class="preprocessor">#define __SHADOW_REG extern volatile uint8_t</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34"> 11</a></span>&#160;<span class="preprocessor">#define __REG(addr) volatile __at (addr) uint8_t</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a5f02ccf1491e0ff70833ac35d83cb814"> 13</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2000) PPUCTRL;</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ad4195c2da9cc37e948b779a3bba574da"> 14</a></span>&#160;<span class="preprocessor">#define PPUCTRL_NMI 0b10000000</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a1912c130a459dc70b7814721e62853f3"> 15</a></span>&#160;<span class="preprocessor">#define PPUCTRL_SPR_8X8 0b00000000</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a6d712a8ba6ec86c2937aeb1b8b36f340"> 16</a></span>&#160;<span class="preprocessor">#define PPUCTRL_SPR_8X16 0b00100000</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a8a693ef1e7481e9d66811dc6848e5575"> 17</a></span>&#160;<span class="preprocessor">#define PPUCTRL_BG_CHR 0b00010000</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ab3147e0e9e56b86bebba0bcf1c7609af"> 18</a></span>&#160;<span class="preprocessor">#define PPUCTRL_SPR_CHR 0b00001000</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a5709b6a188c2042aa32a4d4abe9f619a"> 19</a></span>&#160;<span class="preprocessor">#define PPUCTRL_INC32 0b00000100</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ae7753ae877137d76083b660aea9526b7"> 20</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#ae61804714a30560fb686c9e5217e54f3">__SHADOW_REG</a> <a class="code" href="nes_2hardware_8h.html#ae7753ae877137d76083b660aea9526b7">shadow_PPUCTRL</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a6a06f6bfe5466b54fcffb30e1fe657e5"> 22</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2001) PPUMASK;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a2c924ea42b8f571a6461bf6d42167491"> 23</a></span>&#160;<span class="preprocessor">#define PPUMASK_BLUE 0b10000000</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a32c11331376cfa653f9d66571382d430"> 24</a></span>&#160;<span class="preprocessor">#define PPUMASK_RED 0b01000000</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#adb6fcefb52ab83fe8aeeafe033391f94"> 25</a></span>&#160;<span class="preprocessor">#define PPUMASK_GREEN 0b00100000</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a73dfa1e321b7b5a3835450c0382f7779"> 26</a></span>&#160;<span class="preprocessor">#define PPUMASK_SHOW_SPR 0b00010000</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#aaf30bd58f6f863e21f605957d547bdd7"> 27</a></span>&#160;<span class="preprocessor">#define PPUMASK_SHOW_BG 0b00001000</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#add0805a7bbaa88cf568f7a8fa7eb252c"> 28</a></span>&#160;<span class="preprocessor">#define PPUMASK_SHOW_SPR_LC 0b00000100</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a0921fb5a3bfa138b479df91189d51f1c"> 29</a></span>&#160;<span class="preprocessor">#define PPUMASK_SHOW_BG_LC 0b00000010</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a4358b756ed8f83ee57451a4428a11829"> 30</a></span>&#160;<span class="preprocessor">#define PPUMASK_MONOCHROME 0b00000001</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a179ba142ebf05f2d0d2df6c47da2f6b4"> 31</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#ae61804714a30560fb686c9e5217e54f3">__SHADOW_REG</a> <a class="code" href="nes_2hardware_8h.html#a179ba142ebf05f2d0d2df6c47da2f6b4">shadow_PPUMASK</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a922873e2061c4bb9dc81c2888b6ec006"> 33</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2002) PPUSTATUS;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a49def3011c577712d7b1f28a39d95c5d"> 34</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2003) OAMADDR;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a8e3f1838c5af00b194772c6d02b5808a"> 35</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2004) OAMDATA;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a80603593390422b6f3d40fa7cf861b16"> 36</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2005) PPUSCROLL;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a8dea727962e32b701a7894c5b938fbda"> 37</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2006) PPUADDR;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#aa1833135b570bb325c30ca1d5720682d"> 38</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x2007) PPUDATA;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#afa5336aa76cfcbe00fc5dab15549bc23"> 39</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a>(0x4014) OAMDMA;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a519e327cac96f68a8ca9b77e0343672f"> 41</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_X_OFFSET 0</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#af334c0e7dd6e434b3dbebd45bcdeb75a"> 42</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_Y_OFFSET 0</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#add7f32ba868ef6517798f5fce337e4b2"> 43</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_WIDTH 32</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ad252264fdcf900e5fbf611f7a45962ed"> 44</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_HEIGHT 30</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a491dc081eae8c81e7ca88075ab806291"> 45</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_BUFFER_WIDTH 32</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a81fb56b6778772f829dab4c534e7749e"> 46</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_BUFFER_HEIGHT 30</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a4d682ed7a6158c5ba10afec739b17a8a"> 47</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_MAP_ENTRY_SIZE 1</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#af531e7ac0c0a58517fa3061631745c31"> 48</a></span>&#160;<span class="preprocessor">#define DEVICE_SPRITE_PX_OFFSET_X 0</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a7f6c8420831388300bbec13ea4cb57a0"> 49</a></span>&#160;<span class="preprocessor">#define DEVICE_SPRITE_PX_OFFSET_Y -1</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a62cb8564bf5e8cdd85ac33bc1c7896f2"> 50</a></span>&#160;<span class="preprocessor">#define DEVICE_WINDOW_PX_OFFSET_X 0</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a3f8565ca9dc8eacd88d0d58313408329"> 51</a></span>&#160;<span class="preprocessor">#define DEVICE_WINDOW_PX_OFFSET_Y 0</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ad14c51cdfb347c34c364f54e67dc978d"> 52</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_PX_WIDTH (DEVICE_SCREEN_WIDTH * 8)</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a7bd450aa268b881257089cf8cd6697ec"> 53</a></span>&#160;<span class="preprocessor">#define DEVICE_SCREEN_PX_HEIGHT (DEVICE_SCREEN_HEIGHT * 8)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">// Scrolling coordinates (will be written to PPUSCROLL at end-of-vblank by NMI handler)</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#a406100d23af09b16e4b43a2d0eefe741"> 56</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#ae61804714a30560fb686c9e5217e54f3">__SHADOW_REG</a> <a class="code" href="nes_2hardware_8h.html#a406100d23af09b16e4b43a2d0eefe741">bkg_scroll_x</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="nes_2hardware_8h.html#ad6629a16788cf8cc495555d7fae64d9f"> 57</a></span>&#160;<a class="code" href="nes_2hardware_8h.html#ae61804714a30560fb686c9e5217e54f3">__SHADOW_REG</a> <a class="code" href="nes_2hardware_8h.html#ad6629a16788cf8cc495555d7fae64d9f">bkg_scroll_y</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="anes_2hardware_8h_html_a1053e08ff700b39d8bdc370ff4d18a34"><div class="ttname"><a href="nes_2hardware_8h.html#a1053e08ff700b39d8bdc370ff4d18a34">__REG</a></div><div class="ttdeci">#define __REG(addr)</div><div class="ttdef"><b>Definition:</b> hardware.h:11</div></div>
<div class="ttc" id="anes_2hardware_8h_html_a179ba142ebf05f2d0d2df6c47da2f6b4"><div class="ttname"><a href="nes_2hardware_8h.html#a179ba142ebf05f2d0d2df6c47da2f6b4">shadow_PPUMASK</a></div><div class="ttdeci">__SHADOW_REG shadow_PPUMASK</div><div class="ttdef"><b>Definition:</b> hardware.h:31</div></div>
<div class="ttc" id="anes_2hardware_8h_html_a406100d23af09b16e4b43a2d0eefe741"><div class="ttname"><a href="nes_2hardware_8h.html#a406100d23af09b16e4b43a2d0eefe741">bkg_scroll_x</a></div><div class="ttdeci">__SHADOW_REG bkg_scroll_x</div><div class="ttdef"><b>Definition:</b> hardware.h:56</div></div>
<div class="ttc" id="anes_2hardware_8h_html_ad6629a16788cf8cc495555d7fae64d9f"><div class="ttname"><a href="nes_2hardware_8h.html#ad6629a16788cf8cc495555d7fae64d9f">bkg_scroll_y</a></div><div class="ttdeci">__SHADOW_REG bkg_scroll_y</div><div class="ttdef"><b>Definition:</b> hardware.h:57</div></div>
<div class="ttc" id="anes_2hardware_8h_html_ae61804714a30560fb686c9e5217e54f3"><div class="ttname"><a href="nes_2hardware_8h.html#ae61804714a30560fb686c9e5217e54f3">__SHADOW_REG</a></div><div class="ttdeci">#define __SHADOW_REG</div><div class="ttdef"><b>Definition:</b> hardware.h:10</div></div>
<div class="ttc" id="anes_2hardware_8h_html_ae7753ae877137d76083b660aea9526b7"><div class="ttname"><a href="nes_2hardware_8h.html#ae7753ae877137d76083b660aea9526b7">shadow_PPUCTRL</a></div><div class="ttdeci">__SHADOW_REG shadow_PPUCTRL</div><div class="ttdef"><b>Definition:</b> hardware.h:20</div></div>
</div><!-- fragment --></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>