gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/sms_2metasprites_8h.html
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.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/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-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('sms_2metasprites_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#nested-classes">Data Structures</a> |
104 <a href="#define-members">Macros</a> |
105 <a href="#typedef-members">Typedefs</a> |
106 <a href="#func-members">Functions</a> |
107 <a href="#var-members">Variables</a> </div>
108 <div class="headertitle"><div class="title">metasprites.h File Reference</div></div>
109 </div><!--header-->
110 <div class="contents">
111 <div class="textblock"><code>#include <<a class="el" href="sms_8h_source.html">sms/sms.h</a>></code><br />
112 <code>#include <<a class="el" href="sms_2hardware_8h_source.html">sms/hardware.h</a>></code><br />
113 <code>#include <types.h></code><br />
114 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
115 </div>
116 <p><a href="sms_2metasprites_8h_source.html">Go to the source code of this file.</a></p>
117 <table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
119 Data Structures</h2></td></tr>
120 <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>
121 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
122 </table><table class="memberdecls">
123 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
124 Macros</h2></td></tr>
125 <tr class="memitem:metasprite_end"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>   -128</td></tr>
126 <tr class="separator:metasprite_end"><td class="memSeparator" colspan="2"> </td></tr>
127 <tr class="memitem:METASPR_ITEM"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#METASPR_ITEM">METASPR_ITEM</a>(dy, dx, dt, a)   {(dy),(dx),(dt)}</td></tr>
128 <tr class="separator:METASPR_ITEM"><td class="memSeparator" colspan="2"> </td></tr>
129 <tr class="memitem:METASPR_TERM"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#METASPR_TERM">METASPR_TERM</a>   {<a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>}</td></tr>
130 <tr class="separator:METASPR_TERM"><td class="memSeparator" colspan="2"> </td></tr>
131 </table><table class="memberdecls">
132 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
133 Typedefs</h2></td></tr>
134 <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="sms_2metasprites_8h.html#metasprite_t">metasprite_t</a></td></tr>
135 <tr class="separator:metasprite_t"><td class="memSeparator" colspan="2"> </td></tr>
136 </table><table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
138 Functions</h2></td></tr>
139 <tr class="memitem:hide_sprites_range"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_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#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#iyh">iyh</a></td></tr>
140 <tr class="separator:hide_sprites_range"><td class="memSeparator" colspan="2"> </td></tr>
141 <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="sms_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>
142 <tr class="separator:move_metasprite_ex"><td class="memSeparator" colspan="2"> </td></tr>
143 <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="sms_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>
144 <tr class="separator:move_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
145 <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="sms_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>
146 <tr class="separator:move_metasprite_flipx"><td class="memSeparator" colspan="2"> </td></tr>
147 <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="sms_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>
148 <tr class="separator:move_metasprite_flipy"><td class="memSeparator" colspan="2"> </td></tr>
149 <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="sms_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>
150 <tr class="separator:move_metasprite_flipxy"><td class="memSeparator" colspan="2"> </td></tr>
151 <tr class="memitem:hide_metasprite"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_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>
152 <tr class="separator:hide_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
153 </table><table class="memberdecls">
154 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
155 Variables</h2></td></tr>
156 <tr class="memitem:__current_metasprite"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#__current_metasprite">__current_metasprite</a></td></tr>
157 <tr class="separator:__current_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
158 <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="sms_2metasprites_8h.html#__current_base_tile">__current_base_tile</a></td></tr>
159 <tr class="separator:__current_base_tile"><td class="memSeparator" colspan="2"> </td></tr>
160 <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="sms_2metasprites_8h.html#__render_shadow_OAM">__render_shadow_OAM</a></td></tr>
161 <tr class="separator:__render_shadow_OAM"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:iyl"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2metasprites_8h.html#iyl">iyl</a></td></tr>
163 <tr class="separator:iyl"><td class="memSeparator" colspan="2"> </td></tr>
164 </table>
165 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
166 <div class="textblock"><h1><a class="anchor" id="autotoc_md315"></a>
167 Metasprite support</h1>
168 <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>
169 <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>
170 <h1><a class="anchor" id="autotoc_md317"></a>
171 Metasprite support</h1>
172 <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>
173 <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>
174 </div><h2 class="groupheader">Macro Definition Documentation</h2>
175 <a id="metasprite_end" name="metasprite_end"></a>
176 <h2 class="memtitle"><span class="permalink"><a href="#metasprite_end">◆ </a></span>metasprite_end</h2>
177
178 <div class="memitem">
179 <div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">#define metasprite_end   -128</td>
183 </tr>
184 </table>
185 </div><div class="memdoc">
186
187 </div>
188 </div>
189 <a id="METASPR_ITEM" name="METASPR_ITEM"></a>
190 <h2 class="memtitle"><span class="permalink"><a href="#METASPR_ITEM">◆ </a></span>METASPR_ITEM</h2>
191
192 <div class="memitem">
193 <div class="memproto">
194 <table class="memname">
195 <tr>
196 <td class="memname">#define METASPR_ITEM</td>
197 <td>(</td>
198 <td class="paramtype"> </td>
199 <td class="paramname">dy, </td>
200 </tr>
201 <tr>
202 <td class="paramkey"></td>
203 <td></td>
204 <td class="paramtype"> </td>
205 <td class="paramname">dx, </td>
206 </tr>
207 <tr>
208 <td class="paramkey"></td>
209 <td></td>
210 <td class="paramtype"> </td>
211 <td class="paramname">dt, </td>
212 </tr>
213 <tr>
214 <td class="paramkey"></td>
215 <td></td>
216 <td class="paramtype"> </td>
217 <td class="paramname">a </td>
218 </tr>
219 <tr>
220 <td></td>
221 <td>)</td>
222 <td></td><td>   {(dy),(dx),(dt)}</td>
223 </tr>
224 </table>
225 </div><div class="memdoc">
226
227 </div>
228 </div>
229 <a id="METASPR_TERM" name="METASPR_TERM"></a>
230 <h2 class="memtitle"><span class="permalink"><a href="#METASPR_TERM">◆ </a></span>METASPR_TERM</h2>
231
232 <div class="memitem">
233 <div class="memproto">
234 <table class="memname">
235 <tr>
236 <td class="memname">#define METASPR_TERM   {<a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>}</td>
237 </tr>
238 </table>
239 </div><div class="memdoc">
240
241 </div>
242 </div>
243 <h2 class="groupheader">Typedef Documentation</h2>
244 <a id="metasprite_t" name="metasprite_t"></a>
245 <h2 class="memtitle"><span class="permalink"><a href="#metasprite_t">◆ </a></span>metasprite_t</h2>
246
247 <div class="memitem">
248 <div class="memproto">
249 <table class="memname">
250 <tr>
251 <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>
252 </tr>
253 </table>
254 </div><div class="memdoc">
255 <p >Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd>
256 <table class="params">
257 <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
258 <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
259 <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles</td></tr>
260 </table>
261 </dd>
262 </dl>
263 <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>
264 <p >A metasprite frame is terminated with a {metasprite_end} entry. </p>
265
266 </div>
267 </div>
268 <h2 class="groupheader">Function Documentation</h2>
269 <a id="hide_sprites_range" name="hide_sprites_range"></a>
270 <h2 class="memtitle"><span class="permalink"><a href="#hide_sprites_range">◆ </a></span>hide_sprites_range()</h2>
271
272 <div class="memitem">
273 <div class="memproto">
274 <table class="memname">
275 <tr>
276 <td class="memname">void hide_sprites_range </td>
277 <td>(</td>
278 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
279 <td class="paramname"><em>from</em>, </td>
280 </tr>
281 <tr>
282 <td class="paramkey"></td>
283 <td></td>
284 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
285 <td class="paramname"><em>to</em> </td>
286 </tr>
287 <tr>
288 <td></td>
289 <td>)</td>
290 <td></td><td></td>
291 </tr>
292 </table>
293 </div><div class="memdoc">
294 <p >Hides all hardware sprites in range from <= X < to </p><dl class="params"><dt>Parameters</dt><dd>
295 <table class="params">
296 <tr><td class="paramname">from</td><td>start OAM index </td></tr>
297 <tr><td class="paramname">to</td><td>finish OAM index </td></tr>
298 </table>
299 </dd>
300 </dl>
301
302 </div>
303 </div>
304 <a id="move_metasprite_ex" name="move_metasprite_ex"></a>
305 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_ex">◆ </a></span>move_metasprite_ex()</h2>
306
307 <div class="memitem">
308 <div class="memproto">
309 <table class="mlabels">
310 <tr>
311 <td class="mlabels-left">
312 <table class="memname">
313 <tr>
314 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite_ex </td>
315 <td>(</td>
316 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
317 <td class="paramname"><em>metasprite</em>, </td>
318 </tr>
319 <tr>
320 <td class="paramkey"></td>
321 <td></td>
322 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
323 <td class="paramname"><em>base_tile</em>, </td>
324 </tr>
325 <tr>
326 <td class="paramkey"></td>
327 <td></td>
328 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
329 <td class="paramname"><em>base_prop</em>, </td>
330 </tr>
331 <tr>
332 <td class="paramkey"></td>
333 <td></td>
334 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
335 <td class="paramname"><em>base_sprite</em>, </td>
336 </tr>
337 <tr>
338 <td class="paramkey"></td>
339 <td></td>
340 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
341 <td class="paramname"><em>x</em>, </td>
342 </tr>
343 <tr>
344 <td class="paramkey"></td>
345 <td></td>
346 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
347 <td class="paramname"><em>y</em> </td>
348 </tr>
349 <tr>
350 <td></td>
351 <td>)</td>
352 <td></td><td></td>
353 </tr>
354 </table>
355 </td>
356 <td class="mlabels-right">
357 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
358 </tr>
359 </table>
360 </div><div class="memdoc">
361 <p >Moves metasprite to the absolute position x and y</p>
362 <dl class="params"><dt>Parameters</dt><dd>
363 <table class="params">
364 <tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
365 <tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
366 <tr><td class="paramname">base_prop</td><td>Base sprite property flags (unused on this platform) </td></tr>
367 <tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
368 <tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
369 <tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
370 </table>
371 </dd>
372 </dl>
373 <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>
374 <p >Sets: </p><ul>
375 <li>__current_metasprite = metasprite; </li>
376 <li>__current_base_tile = base_tile;</li>
377 </ul>
378 <dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite </dd></dl>
379
380 </div>
381 </div>
382 <a id="move_metasprite" name="move_metasprite"></a>
383 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite">◆ </a></span>move_metasprite()</h2>
384
385 <div class="memitem">
386 <div class="memproto">
387 <table class="mlabels">
388 <tr>
389 <td class="mlabels-left">
390 <table class="memname">
391 <tr>
392 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite </td>
393 <td>(</td>
394 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
395 <td class="paramname"><em>metasprite</em>, </td>
396 </tr>
397 <tr>
398 <td class="paramkey"></td>
399 <td></td>
400 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
401 <td class="paramname"><em>base_tile</em>, </td>
402 </tr>
403 <tr>
404 <td class="paramkey"></td>
405 <td></td>
406 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
407 <td class="paramname"><em>base_sprite</em>, </td>
408 </tr>
409 <tr>
410 <td class="paramkey"></td>
411 <td></td>
412 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
413 <td class="paramname"><em>x</em>, </td>
414 </tr>
415 <tr>
416 <td class="paramkey"></td>
417 <td></td>
418 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
419 <td class="paramname"><em>y</em> </td>
420 </tr>
421 <tr>
422 <td></td>
423 <td>)</td>
424 <td></td><td></td>
425 </tr>
426 </table>
427 </td>
428 <td class="mlabels-right">
429 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
430 </tr>
431 </table>
432 </div><div class="memdoc">
433 <p >Obsolete. This function has been replaced by <a class="el" href="gb_2metasprites_8h.html#move_metasprite_ex">move_metasprite_ex()</a> </p>
434
435 </div>
436 </div>
437 <a id="move_metasprite_flipx" name="move_metasprite_flipx"></a>
438 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_flipx">◆ </a></span>move_metasprite_flipx()</h2>
439
440 <div class="memitem">
441 <div class="memproto">
442 <table class="mlabels">
443 <tr>
444 <td class="mlabels-left">
445 <table class="memname">
446 <tr>
447 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite_flipx </td>
448 <td>(</td>
449 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
450 <td class="paramname"><em>metasprite</em>, </td>
451 </tr>
452 <tr>
453 <td class="paramkey"></td>
454 <td></td>
455 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
456 <td class="paramname"><em>base_tile</em>, </td>
457 </tr>
458 <tr>
459 <td class="paramkey"></td>
460 <td></td>
461 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
462 <td class="paramname"><em>base_prop</em>, </td>
463 </tr>
464 <tr>
465 <td class="paramkey"></td>
466 <td></td>
467 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
468 <td class="paramname"><em>base_sprite</em>, </td>
469 </tr>
470 <tr>
471 <td class="paramkey"></td>
472 <td></td>
473 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
474 <td class="paramname"><em>x</em>, </td>
475 </tr>
476 <tr>
477 <td class="paramkey"></td>
478 <td></td>
479 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
480 <td class="paramname"><em>y</em> </td>
481 </tr>
482 <tr>
483 <td></td>
484 <td>)</td>
485 <td></td><td></td>
486 </tr>
487 </table>
488 </td>
489 <td class="mlabels-right">
490 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
491 </tr>
492 </table>
493 </div><div class="memdoc">
494 <p >Moves metasprite to the absolute position x and y, <b>flipped by X (horizontally)</b></p>
495 <dl class="params"><dt>Parameters</dt><dd>
496 <table class="params">
497 <tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
498 <tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
499 <tr><td class="paramname">base_prop</td><td>Base sprite property flags (unused on this platform) </td></tr>
500 <tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
501 <tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
502 <tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
503 </table>
504 </dd>
505 </dl>
506 <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>
507 <p >Sets: </p><ul>
508 <li>__current_metasprite = metasprite; </li>
509 <li>__current_base_tile = base_tile;</li>
510 </ul>
511 <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>
512 <dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite</dd></dl>
513 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a> </dd></dl>
514
515 </div>
516 </div>
517 <a id="move_metasprite_flipy" name="move_metasprite_flipy"></a>
518 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_flipy">◆ </a></span>move_metasprite_flipy()</h2>
519
520 <div class="memitem">
521 <div class="memproto">
522 <table class="mlabels">
523 <tr>
524 <td class="mlabels-left">
525 <table class="memname">
526 <tr>
527 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite_flipy </td>
528 <td>(</td>
529 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
530 <td class="paramname"><em>metasprite</em>, </td>
531 </tr>
532 <tr>
533 <td class="paramkey"></td>
534 <td></td>
535 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
536 <td class="paramname"><em>base_tile</em>, </td>
537 </tr>
538 <tr>
539 <td class="paramkey"></td>
540 <td></td>
541 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
542 <td class="paramname"><em>base_prop</em>, </td>
543 </tr>
544 <tr>
545 <td class="paramkey"></td>
546 <td></td>
547 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
548 <td class="paramname"><em>base_sprite</em>, </td>
549 </tr>
550 <tr>
551 <td class="paramkey"></td>
552 <td></td>
553 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
554 <td class="paramname"><em>x</em>, </td>
555 </tr>
556 <tr>
557 <td class="paramkey"></td>
558 <td></td>
559 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
560 <td class="paramname"><em>y</em> </td>
561 </tr>
562 <tr>
563 <td></td>
564 <td>)</td>
565 <td></td><td></td>
566 </tr>
567 </table>
568 </td>
569 <td class="mlabels-right">
570 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
571 </tr>
572 </table>
573 </div><div class="memdoc">
574 <p >Moves metasprite to the absolute position x and y, <b>flipped by Y (vertically)</b></p>
575 <dl class="params"><dt>Parameters</dt><dd>
576 <table class="params">
577 <tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
578 <tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
579 <tr><td class="paramname">base_prop</td><td>Base sprite property flags (unused on this platform) </td></tr>
580 <tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
581 <tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
582 <tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
583 </table>
584 </dd>
585 </dl>
586 <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>
587 <p >Sets: </p><ul>
588 <li>__current_metasprite = metasprite; </li>
589 <li>__current_base_tile = base_tile;</li>
590 </ul>
591 <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>
592 <dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite</dd></dl>
593 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a> </dd></dl>
594
595 </div>
596 </div>
597 <a id="move_metasprite_flipxy" name="move_metasprite_flipxy"></a>
598 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_flipxy">◆ </a></span>move_metasprite_flipxy()</h2>
599
600 <div class="memitem">
601 <div class="memproto">
602 <table class="mlabels">
603 <tr>
604 <td class="mlabels-left">
605 <table class="memname">
606 <tr>
607 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite_flipxy </td>
608 <td>(</td>
609 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
610 <td class="paramname"><em>metasprite</em>, </td>
611 </tr>
612 <tr>
613 <td class="paramkey"></td>
614 <td></td>
615 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
616 <td class="paramname"><em>base_tile</em>, </td>
617 </tr>
618 <tr>
619 <td class="paramkey"></td>
620 <td></td>
621 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
622 <td class="paramname"><em>base_prop</em>, </td>
623 </tr>
624 <tr>
625 <td class="paramkey"></td>
626 <td></td>
627 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
628 <td class="paramname"><em>base_sprite</em>, </td>
629 </tr>
630 <tr>
631 <td class="paramkey"></td>
632 <td></td>
633 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
634 <td class="paramname"><em>x</em>, </td>
635 </tr>
636 <tr>
637 <td class="paramkey"></td>
638 <td></td>
639 <td class="paramtype"><a class="el" href="stdint_8h.html#int16_t">int16_t</a> </td>
640 <td class="paramname"><em>y</em> </td>
641 </tr>
642 <tr>
643 <td></td>
644 <td>)</td>
645 <td></td><td></td>
646 </tr>
647 </table>
648 </td>
649 <td class="mlabels-right">
650 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
651 </tr>
652 </table>
653 </div><div class="memdoc">
654 <p >Moves metasprite to the absolute position x and y, <b>flipped by X and Y (horizontally and vertically)</b></p>
655 <dl class="params"><dt>Parameters</dt><dd>
656 <table class="params">
657 <tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
658 <tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
659 <tr><td class="paramname">base_prop</td><td>Base sprite property flags (unused on this platform) </td></tr>
660 <tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
661 <tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
662 <tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
663 </table>
664 </dd>
665 </dl>
666 <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>
667 <p >Sets: </p><ul>
668 <li>__current_metasprite = metasprite; </li>
669 <li>__current_base_tile = base_tile;</li>
670 </ul>
671 <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>
672 <dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite</dd></dl>
673 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2metasprites_8h.html#move_metasprite">move_metasprite()</a> </dd></dl>
674
675 </div>
676 </div>
677 <a id="hide_metasprite" name="hide_metasprite"></a>
678 <h2 class="memtitle"><span class="permalink"><a href="#hide_metasprite">◆ </a></span>hide_metasprite()</h2>
679
680 <div class="memitem">
681 <div class="memproto">
682 <table class="mlabels">
683 <tr>
684 <td class="mlabels-left">
685 <table class="memname">
686 <tr>
687 <td class="memname">void hide_metasprite </td>
688 <td>(</td>
689 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
690 <td class="paramname"><em>metasprite</em>, </td>
691 </tr>
692 <tr>
693 <td class="paramkey"></td>
694 <td></td>
695 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
696 <td class="paramname"><em>base_sprite</em> </td>
697 </tr>
698 <tr>
699 <td></td>
700 <td>)</td>
701 <td></td><td></td>
702 </tr>
703 </table>
704 </td>
705 <td class="mlabels-right">
706 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
707 </tr>
708 </table>
709 </div><div class="memdoc">
710 <p >Hides a metasprite from the screen</p>
711 <dl class="params"><dt>Parameters</dt><dd>
712 <table class="params">
713 <tr><td class="paramname">metasprite</td><td>Pointer to first struct of the desired metasprite frame </td></tr>
714 <tr><td class="paramname">base_sprite</td><td>Number of hardware sprite to start with</td></tr>
715 </table>
716 </dd>
717 </dl>
718 <p>Sets: </p><ul>
719 <li>__current_metasprite = metasprite; </li>
720 </ul>
721
722 </div>
723 </div>
724 <h2 class="groupheader">Variable Documentation</h2>
725 <a id="__current_metasprite" name="__current_metasprite"></a>
726 <h2 class="memtitle"><span class="permalink"><a href="#__current_metasprite">◆ </a></span>__current_metasprite</h2>
727
728 <div class="memitem">
729 <div class="memproto">
730 <table class="mlabels">
731 <tr>
732 <td class="mlabels-left">
733 <table class="memname">
734 <tr>
735 <td class="memname">const void* __current_metasprite</td>
736 </tr>
737 </table>
738 </td>
739 <td class="mlabels-right">
740 <span class="mlabels"><span class="mlabel">extern</span></span> </td>
741 </tr>
742 </table>
743 </div><div class="memdoc">
744
745 </div>
746 </div>
747 <a id="__current_base_tile" name="__current_base_tile"></a>
748 <h2 class="memtitle"><span class="permalink"><a href="#__current_base_tile">◆ </a></span>__current_base_tile</h2>
749
750 <div class="memitem">
751 <div class="memproto">
752 <table class="mlabels">
753 <tr>
754 <td class="mlabels-left">
755 <table class="memname">
756 <tr>
757 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> __current_base_tile</td>
758 </tr>
759 </table>
760 </td>
761 <td class="mlabels-right">
762 <span class="mlabels"><span class="mlabel">extern</span></span> </td>
763 </tr>
764 </table>
765 </div><div class="memdoc">
766
767 </div>
768 </div>
769 <a id="__render_shadow_OAM" name="__render_shadow_OAM"></a>
770 <h2 class="memtitle"><span class="permalink"><a href="#__render_shadow_OAM">◆ </a></span>__render_shadow_OAM</h2>
771
772 <div class="memitem">
773 <div class="memproto">
774 <table class="mlabels">
775 <tr>
776 <td class="mlabels-left">
777 <table class="memname">
778 <tr>
779 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> __render_shadow_OAM</td>
780 </tr>
781 </table>
782 </td>
783 <td class="mlabels-right">
784 <span class="mlabels"><span class="mlabel">extern</span></span> </td>
785 </tr>
786 </table>
787 </div><div class="memdoc">
788
789 </div>
790 </div>
791 <a id="iyl" name="iyl"></a>
792 <h2 class="memtitle"><span class="permalink"><a href="#iyl">◆ </a></span>iyl</h2>
793
794 <div class="memitem">
795 <div class="memproto">
796 <table class="memname">
797 <tr>
798 <td class="memname">void iyl</td>
799 </tr>
800 </table>
801 </div><div class="memdoc">
802
803 </div>
804 </div>
805 </div><!-- contents -->
806 </div><!-- doc-content -->
807 <!-- start footer part -->
808 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
809 <ul>
810 <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_7a84f275fead463a4aefdc90fba00235.html">sms</a></li><li class="navelem"><a class="el" href="sms_2metasprites_8h.html">metasprites.h</a></li>
811 <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>
812 </ul>
813 </div>
814 </body>
815 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.