cscg22-gearboy

CSCG 2022 Challenge 'Gearboy'
git clone https://git.sinitax.com/sinitax/cscg22-gearboy
Log | Files | Refs | sfeed.txt

sms_2metasprites_8h.html (25056B)


      1<!-- HTML header for doxygen 1.8.14-->
      2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
      3<html xmlns="http://www.w3.org/1999/xhtml">
      4<head>
      5<meta http-equiv="cache-control" content="max-age=86400"/>
      6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
      7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
      8<meta name="generator" content="Doxygen 1.8.20"/>
      9<meta name="viewport" content="width=device-width, initial-scale=1"/>
     10<title>GBDK 2020 Docs: sms/metasprites.h File Reference</title>
     11<link href="tabs.css" rel="stylesheet" type="text/css"/>
     12<script type="text/javascript" src="jquery.js"></script>
     13<script type="text/javascript" src="dynsections.js"></script>
     14<link href="navtree.css" rel="stylesheet" type="text/css"/>
     15<script type="text/javascript" src="resize.js"></script>
     16<script type="text/javascript" src="navtreedata.js"></script>
     17<script type="text/javascript" src="navtree.js"></script>
     18<link href="search/search.css" rel="stylesheet" type="text/css"/>
     19<script type="text/javascript" src="search/searchdata.js"></script>
     20<script type="text/javascript" src="search/search.js"></script>
     21<link href="doxygen.css" rel="stylesheet" type="text/css" />
     22<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
     23</head>
     24<body>
     25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
     26<div id="titlearea">
     27<table cellspacing="0" cellpadding="0">
     28 <tbody>
     29 <tr style="height: 56px;">
     30  <td id="projectalign" style="padding-left: 0.5em;">
     31   <div id="projectname">GBDK 2020 Docs
     32   &#160;<span id="projectnumber">4.0.6</span>
     33   </div>
     34   <div id="projectbrief">API Documentation for GBDK 2020</div>
     35  </td>
     36 </tr>
     37 </tbody>
     38</table>
     39</div>
     40<!-- end header part -->
     41<!-- Generated by Doxygen 1.8.20 -->
     42<script type="text/javascript">
     43/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
     44var searchBox = new SearchBox("searchBox", "search",false,'Search');
     45/* @license-end */
     46</script>
     47<script type="text/javascript" src="menudata.js"></script>
     48<script type="text/javascript" src="menu.js"></script>
     49<script type="text/javascript">
     50/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
     51$(function() {
     52  initMenu('',true,false,'search.php','Search');
     53  $(document).ready(function() { init_search(); });
     54});
     55/* @license-end */</script>
     56<div id="main-nav"></div>
     57</div><!-- top -->
     58<div id="side-nav" class="ui-resizable side-nav-resizable">
     59  <div id="nav-tree">
     60    <div id="nav-tree-contents">
     61      <div id="nav-sync" class="sync"></div>
     62    </div>
     63  </div>
     64  <div id="splitbar" style="-moz-user-select:none;" 
     65       class="ui-resizable-handle">
     66  </div>
     67</div>
     68<script type="text/javascript">
     69/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
     70$(document).ready(function(){initNavTree('sms_2metasprites_8h.html',''); initResizable(); });
     71/* @license-end */
     72</script>
     73<div id="doc-content">
     74<!-- window showing the filter options -->
     75<div id="MSearchSelectWindow"
     76     onmouseover="return searchBox.OnSearchSelectShow()"
     77     onmouseout="return searchBox.OnSearchSelectHide()"
     78     onkeydown="return searchBox.OnSearchSelectKey(event)">
     79</div>
     80
     81<!-- iframe showing the search results (closed by default) -->
     82<div id="MSearchResultsWindow">
     83<iframe src="javascript:void(0)" frameborder="0" 
     84        name="MSearchResults" id="MSearchResults">
     85</iframe>
     86</div>
     87
     88<div class="header">
     89  <div class="summary">
     90<a href="#nested-classes">Data Structures</a> &#124;
     91<a href="#define-members">Macros</a> &#124;
     92<a href="#typedef-members">Typedefs</a> &#124;
     93<a href="#func-members">Functions</a> &#124;
     94<a href="#var-members">Variables</a>  </div>
     95  <div class="headertitle">
     96<div class="title">metasprites.h File Reference</div>  </div>
     97</div><!--header-->
     98<div class="contents">
     99<div class="textblock"><code>#include &lt;<a class="el" href="sms_2hardware_8h_source.html">sms/hardware.h</a>&gt;</code><br />
    100<code>#include &lt;types.h&gt;</code><br />
    101<code>#include &lt;<a class="el" href="stdint_8h_source.html">stdint.h</a>&gt;</code><br />
    102</div>
    103<p><a href="sms_2metasprites_8h_source.html">Go to the source code of this file.</a></p>
    104<table class="memberdecls">
    105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
    106Data Structures</h2></td></tr>
    107<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html">metasprite_t</a></td></tr>
    108<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    109</table><table class="memberdecls">
    110<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
    111Macros</h2></td></tr>
    112<tr class="memitem:a9f9f390a57460914e27c7604b7d8379a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#a9f9f390a57460914e27c7604b7d8379a">metasprite_end</a>&#160;&#160;&#160;-128</td></tr>
    113<tr class="separator:a9f9f390a57460914e27c7604b7d8379a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    114<tr class="memitem:aa88dc4d5e35045509b8955a4a23a30aa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#aa88dc4d5e35045509b8955a4a23a30aa">METASPR_ITEM</a>(dy,  dx,  dt,  a)&#160;&#160;&#160;{(dy),(dx),(dt)}</td></tr>
    115<tr class="separator:aa88dc4d5e35045509b8955a4a23a30aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    116<tr class="memitem:aa1d425dcce3cd104751744535b6a389a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#aa1d425dcce3cd104751744535b6a389a">METASPR_TERM</a>&#160;&#160;&#160;{<a class="el" href="sms_2metasprites_8h.html#a9f9f390a57460914e27c7604b7d8379a">metasprite_end</a>}</td></tr>
    117<tr class="separator:aa1d425dcce3cd104751744535b6a389a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    118</table><table class="memberdecls">
    119<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
    120Typedefs</h2></td></tr>
    121<tr class="memitem:aba6401cc8173158a9f37ee22094c03d3"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmetasprite__t.html">metasprite_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#aba6401cc8173158a9f37ee22094c03d3">metasprite_t</a></td></tr>
    122<tr class="separator:aba6401cc8173158a9f37ee22094c03d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    123</table><table class="memberdecls">
    124<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    125Functions</h2></td></tr>
    126<tr class="memitem:a0c668f442b4764275a1dade597a59e20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#a0c668f442b4764275a1dade597a59e20">hide_sprites_range</a> (<a class="el" href="asm_2gbz80_2types_8h.html#ab27e9918b538ce9d8ca692479b375b6a">UINT8</a> from, <a class="el" href="asm_2gbz80_2types_8h.html#ab27e9918b538ce9d8ca692479b375b6a">UINT8</a> to) <a class="el" href="asm_2z80_2types_8h.html#aa19670cfef9fe1cc31f28fafb0e1000a">Z88DK_CALLEE</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#aade844cba18122ad48cb2f92b1c87ab0">iyh</a></td></tr>
    127<tr class="separator:a0c668f442b4764275a1dade597a59e20"><td class="memSeparator" colspan="2">&#160;</td></tr>
    128<tr class="memitem:a77475e913bf0a19df28bdbf9d1cf392b"><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="sms_2metasprites_8h.html#a77475e913bf0a19df28bdbf9d1cf392b">move_metasprite</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> x, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> y)</td></tr>
    129<tr class="separator:a77475e913bf0a19df28bdbf9d1cf392b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    130<tr class="memitem:af8de5a888d65448b9d34027a0e1ce906"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#af8de5a888d65448b9d34027a0e1ce906">hide_metasprite</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> base_sprite)</td></tr>
    131<tr class="separator:af8de5a888d65448b9d34027a0e1ce906"><td class="memSeparator" colspan="2">&#160;</td></tr>
    132</table><table class="memberdecls">
    133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
    134Variables</h2></td></tr>
    135<tr class="memitem:aae51f066cc5436457f62351847bfc64b"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#aae51f066cc5436457f62351847bfc64b">__current_metasprite</a></td></tr>
    136<tr class="separator:aae51f066cc5436457f62351847bfc64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137<tr class="memitem:a345fa52509387bd18a4092178a18286f"><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="sms_2metasprites_8h.html#a345fa52509387bd18a4092178a18286f">__current_base_tile</a></td></tr>
    138<tr class="separator:a345fa52509387bd18a4092178a18286f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139<tr class="memitem:a4bfe4d95031b67951cf6bc342110db39"><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="sms_2metasprites_8h.html#a4bfe4d95031b67951cf6bc342110db39">__render_shadow_OAM</a></td></tr>
    140<tr class="separator:a4bfe4d95031b67951cf6bc342110db39"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141<tr class="memitem:af279c752a3b15c4bd5c67f54b92e553f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#af279c752a3b15c4bd5c67f54b92e553f">iyl</a></td></tr>
    142<tr class="separator:af279c752a3b15c4bd5c67f54b92e553f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143</table>
    144<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    145<div class="textblock"><h1><a class="anchor" id="autotoc_md4"></a>
    146Metasprite support</h1>
    147<p>A metasprite is a larger sprite made up from a collection of smaller individual hardware sprites. Different frames of the same metasprites can share tile data.</p>
    148<p>The api supports metasprites in both <a class="el" href="sms_8h.html#aa87bec0d134136fdb727f52cb773b792">SPRITES_8x8</a> and <a class="el" href="sms_8h.html#af91d252f07f4764996154820f970c101">SPRITES_8x16</a> mode. If 8x16 mode is used then the height of the metasprite must be a multiple of 16.</p>
    149<p>The origin (pivot) for the metasprite is not required to be in the upper left-hand corner as with regular hardware sprites.</p>
    150<p>Use the <a class="el" href="docs_toolchain.html#utility_png2asset">utility_png2asset</a> tool to convert single or multiple frames of graphics into metasprite structured data for use with the ...metasprite...() functions.</p>
    151<h1><a class="anchor" id="autotoc_md5"></a>
    152Metasprites composed of variable numbers of sprites</h1>
    153<p>When using png2asset, it's common for the output of different frames to be composed of different numbers of hardware sprites (since it's trying to create each frame as efficiently as possible). Due to that, it's good practice to clear out (hide) unused sprites in the shadow_OAM that have been set by previous frames. </p>
    154</div><h2 class="groupheader">Macro Definition Documentation</h2>
    155<a id="a9f9f390a57460914e27c7604b7d8379a"></a>
    156<h2 class="memtitle"><span class="permalink"><a href="#a9f9f390a57460914e27c7604b7d8379a">&#9670;&nbsp;</a></span>metasprite_end</h2>
    157
    158<div class="memitem">
    159<div class="memproto">
    160      <table class="memname">
    161        <tr>
    162          <td class="memname">#define metasprite_end&#160;&#160;&#160;-128</td>
    163        </tr>
    164      </table>
    165</div><div class="memdoc">
    166
    167</div>
    168</div>
    169<a id="aa88dc4d5e35045509b8955a4a23a30aa"></a>
    170<h2 class="memtitle"><span class="permalink"><a href="#aa88dc4d5e35045509b8955a4a23a30aa">&#9670;&nbsp;</a></span>METASPR_ITEM</h2>
    171
    172<div class="memitem">
    173<div class="memproto">
    174      <table class="memname">
    175        <tr>
    176          <td class="memname">#define METASPR_ITEM</td>
    177          <td>(</td>
    178          <td class="paramtype">&#160;</td>
    179          <td class="paramname">dy, </td>
    180        </tr>
    181        <tr>
    182          <td class="paramkey"></td>
    183          <td></td>
    184          <td class="paramtype">&#160;</td>
    185          <td class="paramname">dx, </td>
    186        </tr>
    187        <tr>
    188          <td class="paramkey"></td>
    189          <td></td>
    190          <td class="paramtype">&#160;</td>
    191          <td class="paramname">dt, </td>
    192        </tr>
    193        <tr>
    194          <td class="paramkey"></td>
    195          <td></td>
    196          <td class="paramtype">&#160;</td>
    197          <td class="paramname">a&#160;</td>
    198        </tr>
    199        <tr>
    200          <td></td>
    201          <td>)</td>
    202          <td></td><td>&#160;&#160;&#160;{(dy),(dx),(dt)}</td>
    203        </tr>
    204      </table>
    205</div><div class="memdoc">
    206
    207</div>
    208</div>
    209<a id="aa1d425dcce3cd104751744535b6a389a"></a>
    210<h2 class="memtitle"><span class="permalink"><a href="#aa1d425dcce3cd104751744535b6a389a">&#9670;&nbsp;</a></span>METASPR_TERM</h2>
    211
    212<div class="memitem">
    213<div class="memproto">
    214      <table class="memname">
    215        <tr>
    216          <td class="memname">#define METASPR_TERM&#160;&#160;&#160;{<a class="el" href="sms_2metasprites_8h.html#a9f9f390a57460914e27c7604b7d8379a">metasprite_end</a>}</td>
    217        </tr>
    218      </table>
    219</div><div class="memdoc">
    220
    221</div>
    222</div>
    223<h2 class="groupheader">Typedef Documentation</h2>
    224<a id="aba6401cc8173158a9f37ee22094c03d3"></a>
    225<h2 class="memtitle"><span class="permalink"><a href="#aba6401cc8173158a9f37ee22094c03d3">&#9670;&nbsp;</a></span>metasprite_t</h2>
    226
    227<div class="memitem">
    228<div class="memproto">
    229      <table class="memname">
    230        <tr>
    231          <td class="memname">typedef struct <a class="el" href="structmetasprite__t.html">metasprite_t</a> <a class="el" href="structmetasprite__t.html">metasprite_t</a></td>
    232        </tr>
    233      </table>
    234</div><div class="memdoc">
    235<p>Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd>
    236  <table class="params">
    237    <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
    238    <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
    239    <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles</td></tr>
    240  </table>
    241  </dd>
    242</dl>
    243<p>Metasprites are built from multiple <a class="el" href="structmetasprite__t.html">metasprite_t</a> items (one for each sub-sprite) and a pool of tiles they reference. If a metasprite has multiple frames then each frame will be built from some number of <a class="el" href="structmetasprite__t.html">metasprite_t</a> items (which may vary based on how many sprites are required for that particular frame).</p>
    244<p>A metasprite frame is terminated with a {metasprite_end} entry. </p>
    245
    246</div>
    247</div>
    248<h2 class="groupheader">Function Documentation</h2>
    249<a id="a0c668f442b4764275a1dade597a59e20"></a>
    250<h2 class="memtitle"><span class="permalink"><a href="#a0c668f442b4764275a1dade597a59e20">&#9670;&nbsp;</a></span>hide_sprites_range()</h2>
    251
    252<div class="memitem">
    253<div class="memproto">
    254      <table class="memname">
    255        <tr>
    256          <td class="memname">void hide_sprites_range </td>
    257          <td>(</td>
    258          <td class="paramtype"><a class="el" href="asm_2gbz80_2types_8h.html#ab27e9918b538ce9d8ca692479b375b6a">UINT8</a>&#160;</td>
    259          <td class="paramname"><em>from</em>, </td>
    260        </tr>
    261        <tr>
    262          <td class="paramkey"></td>
    263          <td></td>
    264          <td class="paramtype"><a class="el" href="asm_2gbz80_2types_8h.html#ab27e9918b538ce9d8ca692479b375b6a">UINT8</a>&#160;</td>
    265          <td class="paramname"><em>to</em>&#160;</td>
    266        </tr>
    267        <tr>
    268          <td></td>
    269          <td>)</td>
    270          <td></td><td></td>
    271        </tr>
    272      </table>
    273</div><div class="memdoc">
    274<p>Hides all hardware sprites in range from &lt;= X &lt; to </p><dl class="params"><dt>Parameters</dt><dd>
    275  <table class="params">
    276    <tr><td class="paramname">from</td><td>start OAM index </td></tr>
    277    <tr><td class="paramname">to</td><td>finish OAM index </td></tr>
    278  </table>
    279  </dd>
    280</dl>
    281
    282</div>
    283</div>
    284<a id="a77475e913bf0a19df28bdbf9d1cf392b"></a>
    285<h2 class="memtitle"><span class="permalink"><a href="#a77475e913bf0a19df28bdbf9d1cf392b">&#9670;&nbsp;</a></span>move_metasprite()</h2>
    286
    287<div class="memitem">
    288<div class="memproto">
    289<table class="mlabels">
    290  <tr>
    291  <td class="mlabels-left">
    292      <table class="memname">
    293        <tr>
    294          <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> move_metasprite </td>
    295          <td>(</td>
    296          <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *&#160;</td>
    297          <td class="paramname"><em>metasprite</em>, </td>
    298        </tr>
    299        <tr>
    300          <td class="paramkey"></td>
    301          <td></td>
    302          <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
    303          <td class="paramname"><em>base_tile</em>, </td>
    304        </tr>
    305        <tr>
    306          <td class="paramkey"></td>
    307          <td></td>
    308          <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
    309          <td class="paramname"><em>base_sprite</em>, </td>
    310        </tr>
    311        <tr>
    312          <td class="paramkey"></td>
    313          <td></td>
    314          <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
    315          <td class="paramname"><em>x</em>, </td>
    316        </tr>
    317        <tr>
    318          <td class="paramkey"></td>
    319          <td></td>
    320          <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
    321          <td class="paramname"><em>y</em>&#160;</td>
    322        </tr>
    323        <tr>
    324          <td></td>
    325          <td>)</td>
    326          <td></td><td></td>
    327        </tr>
    328      </table>
    329  </td>
    330  <td class="mlabels-right">
    331<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    332  </tr>
    333</table>
    334</div><div class="memdoc">
    335<p>Moves metasprite to the absolute position x and y</p>
    336<dl class="params"><dt>Parameters</dt><dd>
    337  <table class="params">
    338    <tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
    339    <tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
    340    <tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite <br  />
    341 </td></tr>
    342    <tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
    343    <tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
    344  </table>
    345  </dd>
    346</dl>
    347<p>Moves <b>metasprite</b> to the absolute position <b>x</b> and <b>y</b> (with <b>no flip</b> on the X or Y axis). Hardware sprites are allocated starting from <b>base_sprite</b>, using tiles starting from <b>base_tile</b>.</p>
    348<p>Sets: </p><ul>
    349<li>__current_metasprite = metasprite; </li>
    350<li>__current_base_tile = base_tile;</li>
    351</ul>
    352<dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite </dd></dl>
    353
    354</div>
    355</div>
    356<a id="af8de5a888d65448b9d34027a0e1ce906"></a>
    357<h2 class="memtitle"><span class="permalink"><a href="#af8de5a888d65448b9d34027a0e1ce906">&#9670;&nbsp;</a></span>hide_metasprite()</h2>
    358
    359<div class="memitem">
    360<div class="memproto">
    361<table class="mlabels">
    362  <tr>
    363  <td class="mlabels-left">
    364      <table class="memname">
    365        <tr>
    366          <td class="memname">void hide_metasprite </td>
    367          <td>(</td>
    368          <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *&#160;</td>
    369          <td class="paramname"><em>metasprite</em>, </td>
    370        </tr>
    371        <tr>
    372          <td class="paramkey"></td>
    373          <td></td>
    374          <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
    375          <td class="paramname"><em>base_sprite</em>&#160;</td>
    376        </tr>
    377        <tr>
    378          <td></td>
    379          <td>)</td>
    380          <td></td><td></td>
    381        </tr>
    382      </table>
    383  </td>
    384  <td class="mlabels-right">
    385<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    386  </tr>
    387</table>
    388</div><div class="memdoc">
    389<p>Hides a metasprite from the screen</p>
    390<dl class="params"><dt>Parameters</dt><dd>
    391  <table class="params">
    392    <tr><td class="paramname">metasprite</td><td>Pointer to first struct of the desired metasprite frame </td></tr>
    393    <tr><td class="paramname">base_sprite</td><td>Number of hardware sprite to start with</td></tr>
    394  </table>
    395  </dd>
    396</dl>
    397<p>Sets: </p><ul>
    398<li>__current_metasprite = metasprite; </li>
    399</ul>
    400
    401</div>
    402</div>
    403<h2 class="groupheader">Variable Documentation</h2>
    404<a id="aae51f066cc5436457f62351847bfc64b"></a>
    405<h2 class="memtitle"><span class="permalink"><a href="#aae51f066cc5436457f62351847bfc64b">&#9670;&nbsp;</a></span>__current_metasprite</h2>
    406
    407<div class="memitem">
    408<div class="memproto">
    409<table class="mlabels">
    410  <tr>
    411  <td class="mlabels-left">
    412      <table class="memname">
    413        <tr>
    414          <td class="memname">const void* __current_metasprite</td>
    415        </tr>
    416      </table>
    417  </td>
    418  <td class="mlabels-right">
    419<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
    420  </tr>
    421</table>
    422</div><div class="memdoc">
    423
    424</div>
    425</div>
    426<a id="a345fa52509387bd18a4092178a18286f"></a>
    427<h2 class="memtitle"><span class="permalink"><a href="#a345fa52509387bd18a4092178a18286f">&#9670;&nbsp;</a></span>__current_base_tile</h2>
    428
    429<div class="memitem">
    430<div class="memproto">
    431<table class="mlabels">
    432  <tr>
    433  <td class="mlabels-left">
    434      <table class="memname">
    435        <tr>
    436          <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> __current_base_tile</td>
    437        </tr>
    438      </table>
    439  </td>
    440  <td class="mlabels-right">
    441<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
    442  </tr>
    443</table>
    444</div><div class="memdoc">
    445
    446</div>
    447</div>
    448<a id="a4bfe4d95031b67951cf6bc342110db39"></a>
    449<h2 class="memtitle"><span class="permalink"><a href="#a4bfe4d95031b67951cf6bc342110db39">&#9670;&nbsp;</a></span>__render_shadow_OAM</h2>
    450
    451<div class="memitem">
    452<div class="memproto">
    453<table class="mlabels">
    454  <tr>
    455  <td class="mlabels-left">
    456      <table class="memname">
    457        <tr>
    458          <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> __render_shadow_OAM</td>
    459        </tr>
    460      </table>
    461  </td>
    462  <td class="mlabels-right">
    463<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
    464  </tr>
    465</table>
    466</div><div class="memdoc">
    467
    468</div>
    469</div>
    470<a id="af279c752a3b15c4bd5c67f54b92e553f"></a>
    471<h2 class="memtitle"><span class="permalink"><a href="#af279c752a3b15c4bd5c67f54b92e553f">&#9670;&nbsp;</a></span>iyl</h2>
    472
    473<div class="memitem">
    474<div class="memproto">
    475      <table class="memname">
    476        <tr>
    477          <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> iyl</td>
    478        </tr>
    479      </table>
    480</div><div class="memdoc">
    481
    482</div>
    483</div>
    484</div><!-- contents -->
    485</div><!-- doc-content -->
    486<!-- HTML footer for doxygen 1.8.14-->
    487<!-- start footer part -->
    488<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    489</div>
    490</body>
    491</html>