mirror of
https://github.com/gbdk-2020/gbdk-2020.git
synced 2026-03-03 05:54:33 +01:00
992 lines
48 KiB
HTML
992 lines
48 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/nes/metasprites.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
|
|
 <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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('nes_2metasprites_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="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">metasprites.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <<a class="el" href="nes_2hardware_8h_source.html">nes/hardware.h</a>></code><br />
|
|
<code>#include <types.h></code><br />
|
|
<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
|
|
</div>
|
|
<p><a href="nes_2metasprites_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="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html">metasprite_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:metasprite_end"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#metasprite_end">metasprite_end</a>   -128</td></tr>
|
|
<tr class="separator:metasprite_end"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:METASPR_ITEM"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#METASPR_ITEM">METASPR_ITEM</a>(dy, dx, dt, a)   {(dy),(dx),(dt),(a)}</td></tr>
|
|
<tr class="separator:METASPR_ITEM"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:METASPR_TERM"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#METASPR_TERM">METASPR_TERM</a>   {<a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>}</td></tr>
|
|
<tr class="separator:METASPR_TERM"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:metasprite_t"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmetasprite__t.html">metasprite_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#metasprite_t">metasprite_t</a></td></tr>
|
|
<tr class="separator:metasprite_t"><td class="memSeparator" colspan="2"> </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:hide_sprites_range"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#hide_sprites_range">hide_sprites_range</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> from, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> to) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
|
|
<tr class="separator:hide_sprites_range"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_ex"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_ex">move_metasprite_ex</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_prop, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_ex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite">move_metasprite</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_flipx"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_flipx">move_metasprite_flipx</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_prop, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_flipx"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_vflip"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_vflip">move_metasprite_vflip</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_vflip"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_flipy"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_flipy">move_metasprite_flipy</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_prop, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_flipy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_hflip"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_hflip">move_metasprite_hflip</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_hflip"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_flipxy"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_flipxy">move_metasprite_flipxy</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_prop, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_flipxy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:move_metasprite_hvflip"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#move_metasprite_hvflip">move_metasprite_hvflip</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_tile, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> x, <a class="el" href="stdint_8h.html#int16_t">int16_t</a> y)</td></tr>
|
|
<tr class="separator:move_metasprite_hvflip"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:hide_metasprite"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#hide_metasprite">hide_metasprite</a> (const <a class="el" href="structmetasprite__t.html">metasprite_t</a> *metasprite, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> base_sprite)</td></tr>
|
|
<tr class="separator:hide_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:__current_metasprite"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#__current_metasprite">__current_metasprite</a></td></tr>
|
|
<tr class="separator:__current_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:__current_base_tile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#__current_base_tile">__current_base_tile</a></td></tr>
|
|
<tr class="separator:__current_base_tile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:__current_base_prop"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#__current_base_prop">__current_base_prop</a></td></tr>
|
|
<tr class="separator:__current_base_prop"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:__render_shadow_OAM"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nes_2metasprites_8h.html#__render_shadow_OAM">__render_shadow_OAM</a></td></tr>
|
|
<tr class="separator:__render_shadow_OAM"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h1><a class="anchor" id="autotoc_md316"></a>
|
|
Metasprite support</h1>
|
|
<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>
|
|
<p >See the main <a class="el" href="gb_2metasprites_8h.html#metasprite_main_docs">metasprite docs</a> under the game Boy platform for additional details. </p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="metasprite_end" name="metasprite_end"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#metasprite_end">◆ </a></span>metasprite_end</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define metasprite_end   -128</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="METASPR_ITEM" name="METASPR_ITEM"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#METASPR_ITEM">◆ </a></span>METASPR_ITEM</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define METASPR_ITEM</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">dy, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">dx, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">dt, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">a </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   {(dy),(dx),(dt),(a)}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="METASPR_TERM" name="METASPR_TERM"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#METASPR_TERM">◆ </a></span>METASPR_TERM</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define METASPR_TERM   {<a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="metasprite_t" name="metasprite_t"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#metasprite_t">◆ </a></span>metasprite_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<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>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
|
|
<tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
|
|
<tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles </td></tr>
|
|
<tr><td class="paramname">props</td><td>(uint8_t) Property Flags</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<p >A metasprite frame is terminated with a {metasprite_end} entry. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="hide_sprites_range" name="hide_sprites_range"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#hide_sprites_range">◆ </a></span>hide_sprites_range()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void hide_sprites_range </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
|
|
<td class="paramname"><em>from</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> </td>
|
|
<td class="paramname"><em>to</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Hides all hardware sprites in range from <= X < to </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">from</td><td>start OAM index </td></tr>
|
|
<tr><td class="paramname">to</td><td>finish OAM index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_ex" name="move_metasprite_ex"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_ex">◆ </a></span>move_metasprite_ex()</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#uint8_t">uint8_t</a> move_metasprite_ex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_prop</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Moves metasprite to the absolute position x and y</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
|
|
<tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
|
|
<tr><td class="paramname">base_prop</td><td>Base sprite property flags </td></tr>
|
|
<tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
|
|
<tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
|
|
<tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<p >Sets: </p><ul>
|
|
<li>__current_metasprite = metasprite; </li>
|
|
<li>__current_base_tile = base_tile;</li>
|
|
</ul>
|
|
<p>Note: Overwrites OAM sprite properties (such as palette), see <a class="el" href="gb_2metasprites_8h.html#metasprite_and_sprite_properties">Metasprites and sprite properties</a>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite" name="move_metasprite"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite">◆ </a></span>move_metasprite()</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#uint8_t">uint8_t</a> move_metasprite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Obsolete. Replaced by <a class="el" href="gb_2metasprites_8h.html#move_metasprite_ex">move_metasprite_ex()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_flipx" name="move_metasprite_flipx"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_flipx">◆ </a></span>move_metasprite_flipx()</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#uint8_t">uint8_t</a> move_metasprite_flipx </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_prop</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Moves metasprite to the absolute position x and y, <b>flipped by X (horizontally)</b></p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
|
|
<tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
|
|
<tr><td class="paramname">base_prop</td><td>Base sprite property flags </td></tr>
|
|
<tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
|
|
<tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
|
|
<tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Same as <a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a>, but with the metasprite flipped by X (horizontally).</p>
|
|
<p >Sets: </p><ul>
|
|
<li>__current_metasprite = metasprite; </li>
|
|
<li>__current_base_tile = base_tile;</li>
|
|
</ul>
|
|
<p>Note: Overwrites OAM sprite properties (such as palette), see <a class="el" href="gb_2metasprites_8h.html#metasprite_and_sprite_properties">Metasprites and sprite properties</a>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_vflip" name="move_metasprite_vflip"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_vflip">◆ </a></span>move_metasprite_vflip()</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#uint8_t">uint8_t</a> move_metasprite_vflip </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Obsolete. Replaced by <a class="el" href="gb_2metasprites_8h.html#move_metasprite_flipx">move_metasprite_flipx()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_flipy" name="move_metasprite_flipy"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_flipy">◆ </a></span>move_metasprite_flipy()</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#uint8_t">uint8_t</a> move_metasprite_flipy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_prop</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Moves metasprite to the absolute position x and y, <b>flipped by Y (vertically)</b></p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
|
|
<tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
|
|
<tr><td class="paramname">base_prop</td><td>Base sprite property flags </td></tr>
|
|
<tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
|
|
<tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
|
|
<tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Same as <a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a>, but with the metasprite flipped by Y (vertically).</p>
|
|
<p >Sets: </p><ul>
|
|
<li>__current_metasprite = metasprite; </li>
|
|
<li>__current_base_tile = base_tile;</li>
|
|
</ul>
|
|
<p>Note: Overwrites OAM sprite properties (such as palette), see <a class="el" href="gb_2metasprites_8h.html#metasprite_and_sprite_properties">Metasprites and sprite properties</a>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_hflip" name="move_metasprite_hflip"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_hflip">◆ </a></span>move_metasprite_hflip()</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#uint8_t">uint8_t</a> move_metasprite_hflip </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Obsolete. Replaced by <a class="el" href="gb_2metasprites_8h.html#move_metasprite_flipy">move_metasprite_flipy()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_flipxy" name="move_metasprite_flipxy"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_flipxy">◆ </a></span>move_metasprite_flipxy()</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#uint8_t">uint8_t</a> move_metasprite_flipxy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_prop</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Moves metasprite to the absolute position x and y, <b>flipped by X and Y (horizontally and vertically)</b></p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
|
|
<tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
|
|
<tr><td class="paramname">base_prop</td><td>Base sprite property flags </td></tr>
|
|
<tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
|
|
<tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
|
|
<tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Same as <a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a>, but with the metasprite flipped by X and Y (horizontally and vertically).</p>
|
|
<p >Sets: </p><ul>
|
|
<li>__current_metasprite = metasprite; </li>
|
|
<li>__current_base_tile = base_tile;</li>
|
|
</ul>
|
|
<p>Note: Overwrites OAM sprite properties (such as palette), see <a class="el" href="gb_2metasprites_8h.html#metasprite_and_sprite_properties">Metasprites and sprite properties</a>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="move_metasprite_hvflip" name="move_metasprite_hvflip"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_hvflip">◆ </a></span>move_metasprite_hvflip()</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#uint8_t">uint8_t</a> move_metasprite_hvflip </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_tile</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> </td>
|
|
<td class="paramname"><em>base_sprite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </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#int16_t">int16_t</a> </td>
|
|
<td class="paramname"><em>y</em> </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 >Obsolete. Replaced by <a class="el" href="gb_2metasprites_8h.html#move_metasprite_flipxy">move_metasprite_flipxy()</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="hide_metasprite" name="hide_metasprite"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#hide_metasprite">◆ </a></span>hide_metasprite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void hide_metasprite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
|
|
<td class="paramname"><em>metasprite</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> </td>
|
|
<td class="paramname"><em>base_sprite</em> </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 >Hides a metasprite from the screen</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metasprite</td><td>Pointer to first struct of the desired metasprite frame </td></tr>
|
|
<tr><td class="paramname">base_sprite</td><td>Number of hardware sprite to start with</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Sets: </p><ul>
|
|
<li>__current_metasprite = metasprite; </li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="__current_metasprite" name="__current_metasprite"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#__current_metasprite">◆ </a></span>__current_metasprite</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const void* __current_metasprite</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="__current_base_tile" name="__current_base_tile"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#__current_base_tile">◆ </a></span>__current_base_tile</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#uint8_t">uint8_t</a> __current_base_tile</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="__current_base_prop" name="__current_base_prop"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#__current_base_prop">◆ </a></span>__current_base_prop</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#uint8_t">uint8_t</a> __current_base_prop</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="__render_shadow_OAM" name="__render_shadow_OAM"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#__render_shadow_OAM">◆ </a></span>__render_shadow_OAM</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#uint8_t">uint8_t</a> __render_shadow_OAM</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</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_af92cb28f7f9115544c8de6a3c7e6d6b.html">nes</a></li><li class="navelem"><a class="el" href="nes_2metasprites_8h.html">metasprites.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>
|