gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/msx_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/msx/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('msx_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="msx_2hardware_8h_source.html">msx/hardware.h</a>></code><br />
112 <code>#include <types.h></code><br />
113 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
114 </div>
115 <p><a href="msx_2metasprites_8h_source.html">Go to the source code of this file.</a></p>
116 <table class="memberdecls">
117 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
118 Data Structures</h2></td></tr>
119 <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>
120 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
121 </table><table class="memberdecls">
122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
123 Macros</h2></td></tr>
124 <tr class="memitem:metasprite_end"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_2metasprites_8h.html#metasprite_end">metasprite_end</a>   -128</td></tr>
125 <tr class="separator:metasprite_end"><td class="memSeparator" colspan="2"> </td></tr>
126 <tr class="memitem:METASPR_ITEM"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_2metasprites_8h.html#METASPR_ITEM">METASPR_ITEM</a>(dy, dx, dt, a)   {(dy),(dx),(dt),(a)}</td></tr>
127 <tr class="separator:METASPR_ITEM"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:METASPR_TERM"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_2metasprites_8h.html#METASPR_TERM">METASPR_TERM</a>   {<a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>}</td></tr>
129 <tr class="separator:METASPR_TERM"><td class="memSeparator" colspan="2"> </td></tr>
130 </table><table class="memberdecls">
131 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
132 Typedefs</h2></td></tr>
133 <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="msx_2metasprites_8h.html#metasprite_t">metasprite_t</a></td></tr>
134 <tr class="separator:metasprite_t"><td class="memSeparator" colspan="2"> </td></tr>
135 </table><table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
137 Functions</h2></td></tr>
138 <tr class="memitem:hide_sprites_range"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_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_2z80_2types_8h.html#Z88DK_CALLEE">Z88DK_CALLEE</a> <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>
139 <tr class="separator:hide_sprites_range"><td class="memSeparator" colspan="2"> </td></tr>
140 <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="msx_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#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y)</td></tr>
141 <tr class="separator:move_metasprite_ex"><td class="memSeparator" colspan="2"> </td></tr>
142 <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="msx_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#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y)</td></tr>
143 <tr class="separator:move_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:hide_metasprite"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_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>
145 <tr class="separator:hide_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
146 </table><table class="memberdecls">
147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
148 Variables</h2></td></tr>
149 <tr class="memitem:__current_metasprite"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_2metasprites_8h.html#__current_metasprite">__current_metasprite</a></td></tr>
150 <tr class="separator:__current_metasprite"><td class="memSeparator" colspan="2"> </td></tr>
151 <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="msx_2metasprites_8h.html#__current_base_tile">__current_base_tile</a></td></tr>
152 <tr class="separator:__current_base_tile"><td class="memSeparator" colspan="2"> </td></tr>
153 <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="msx_2metasprites_8h.html#__render_shadow_OAM">__render_shadow_OAM</a></td></tr>
154 <tr class="separator:__render_shadow_OAM"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:iyl"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="msx_2metasprites_8h.html#iyl">iyl</a></td></tr>
156 <tr class="separator:iyl"><td class="memSeparator" colspan="2"> </td></tr>
157 </table>
158 <h2 class="groupheader">Macro Definition Documentation</h2>
159 <a id="metasprite_end" name="metasprite_end"></a>
160 <h2 class="memtitle"><span class="permalink"><a href="#metasprite_end">◆ </a></span>metasprite_end</h2>
161
162 <div class="memitem">
163 <div class="memproto">
164 <table class="memname">
165 <tr>
166 <td class="memname">#define metasprite_end   -128</td>
167 </tr>
168 </table>
169 </div><div class="memdoc">
170
171 </div>
172 </div>
173 <a id="METASPR_ITEM" name="METASPR_ITEM"></a>
174 <h2 class="memtitle"><span class="permalink"><a href="#METASPR_ITEM">◆ </a></span>METASPR_ITEM</h2>
175
176 <div class="memitem">
177 <div class="memproto">
178 <table class="memname">
179 <tr>
180 <td class="memname">#define METASPR_ITEM</td>
181 <td>(</td>
182 <td class="paramtype"> </td>
183 <td class="paramname">dy, </td>
184 </tr>
185 <tr>
186 <td class="paramkey"></td>
187 <td></td>
188 <td class="paramtype"> </td>
189 <td class="paramname">dx, </td>
190 </tr>
191 <tr>
192 <td class="paramkey"></td>
193 <td></td>
194 <td class="paramtype"> </td>
195 <td class="paramname">dt, </td>
196 </tr>
197 <tr>
198 <td class="paramkey"></td>
199 <td></td>
200 <td class="paramtype"> </td>
201 <td class="paramname">a </td>
202 </tr>
203 <tr>
204 <td></td>
205 <td>)</td>
206 <td></td><td>   {(dy),(dx),(dt),(a)}</td>
207 </tr>
208 </table>
209 </div><div class="memdoc">
210
211 </div>
212 </div>
213 <a id="METASPR_TERM" name="METASPR_TERM"></a>
214 <h2 class="memtitle"><span class="permalink"><a href="#METASPR_TERM">◆ </a></span>METASPR_TERM</h2>
215
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">#define METASPR_TERM   {<a class="el" href="sms_2metasprites_8h.html#metasprite_end">metasprite_end</a>}</td>
221 </tr>
222 </table>
223 </div><div class="memdoc">
224
225 </div>
226 </div>
227 <h2 class="groupheader">Typedef Documentation</h2>
228 <a id="metasprite_t" name="metasprite_t"></a>
229 <h2 class="memtitle"><span class="permalink"><a href="#metasprite_t">◆ </a></span>metasprite_t</h2>
230
231 <div class="memitem">
232 <div class="memproto">
233 <table class="memname">
234 <tr>
235 <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>
236 </tr>
237 </table>
238 </div><div class="memdoc">
239 <p >Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd>
240 <table class="params">
241 <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
242 <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
243 <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles </td></tr>
244 <tr><td class="paramname">props</td><td>(uint8_t) Property Flags</td></tr>
245 </table>
246 </dd>
247 </dl>
248 <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>
249 <p >A metasprite frame is terminated with a {metasprite_end} entry. </p>
250
251 </div>
252 </div>
253 <h2 class="groupheader">Function Documentation</h2>
254 <a id="hide_sprites_range" name="hide_sprites_range"></a>
255 <h2 class="memtitle"><span class="permalink"><a href="#hide_sprites_range">◆ </a></span>hide_sprites_range()</h2>
256
257 <div class="memitem">
258 <div class="memproto">
259 <table class="memname">
260 <tr>
261 <td class="memname">void hide_sprites_range </td>
262 <td>(</td>
263 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
264 <td class="paramname"><em>from</em>, </td>
265 </tr>
266 <tr>
267 <td class="paramkey"></td>
268 <td></td>
269 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
270 <td class="paramname"><em>to</em> </td>
271 </tr>
272 <tr>
273 <td></td>
274 <td>)</td>
275 <td></td><td></td>
276 </tr>
277 </table>
278 </div><div class="memdoc">
279 <p >Hides all hardware sprites in range from <= X < to </p><dl class="params"><dt>Parameters</dt><dd>
280 <table class="params">
281 <tr><td class="paramname">from</td><td>start OAM index </td></tr>
282 <tr><td class="paramname">to</td><td>finish OAM index </td></tr>
283 </table>
284 </dd>
285 </dl>
286
287 </div>
288 </div>
289 <a id="move_metasprite_ex" name="move_metasprite_ex"></a>
290 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite_ex">◆ </a></span>move_metasprite_ex()</h2>
291
292 <div class="memitem">
293 <div class="memproto">
294 <table class="mlabels">
295 <tr>
296 <td class="mlabels-left">
297 <table class="memname">
298 <tr>
299 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite_ex </td>
300 <td>(</td>
301 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
302 <td class="paramname"><em>metasprite</em>, </td>
303 </tr>
304 <tr>
305 <td class="paramkey"></td>
306 <td></td>
307 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
308 <td class="paramname"><em>base_tile</em>, </td>
309 </tr>
310 <tr>
311 <td class="paramkey"></td>
312 <td></td>
313 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
314 <td class="paramname"><em>base_prop</em>, </td>
315 </tr>
316 <tr>
317 <td class="paramkey"></td>
318 <td></td>
319 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
320 <td class="paramname"><em>base_sprite</em>, </td>
321 </tr>
322 <tr>
323 <td class="paramkey"></td>
324 <td></td>
325 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
326 <td class="paramname"><em>x</em>, </td>
327 </tr>
328 <tr>
329 <td class="paramkey"></td>
330 <td></td>
331 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
332 <td class="paramname"><em>y</em> </td>
333 </tr>
334 <tr>
335 <td></td>
336 <td>)</td>
337 <td></td><td></td>
338 </tr>
339 </table>
340 </td>
341 <td class="mlabels-right">
342 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
343 </tr>
344 </table>
345 </div><div class="memdoc">
346 <p >Moves metasprite to the absolute position x and y</p>
347 <dl class="params"><dt>Parameters</dt><dd>
348 <table class="params">
349 <tr><td class="paramname">metasprite</td><td>Pointer to the first struct of the metasprite (for the desired frame) </td></tr>
350 <tr><td class="paramname">base_tile</td><td>Number of the first tile where the metasprite's tiles start </td></tr>
351 <tr><td class="paramname">base_prop</td><td>Base sprite property flags (unused on this platform) </td></tr>
352 <tr><td class="paramname">base_sprite</td><td>Number of the first hardware sprite to be used by the metasprite </td></tr>
353 <tr><td class="paramname">x</td><td>Absolute x coordinate of the sprite </td></tr>
354 <tr><td class="paramname">y</td><td>Absolute y coordinate of the sprite</td></tr>
355 </table>
356 </dd>
357 </dl>
358 <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>
359 <p >Sets: </p><ul>
360 <li>__current_metasprite = metasprite; </li>
361 <li>__current_base_tile = base_tile;</li>
362 </ul>
363 <dl class="section return"><dt>Returns</dt><dd>Number of hardware sprites used to draw this metasprite </dd></dl>
364
365 </div>
366 </div>
367 <a id="move_metasprite" name="move_metasprite"></a>
368 <h2 class="memtitle"><span class="permalink"><a href="#move_metasprite">◆ </a></span>move_metasprite()</h2>
369
370 <div class="memitem">
371 <div class="memproto">
372 <table class="mlabels">
373 <tr>
374 <td class="mlabels-left">
375 <table class="memname">
376 <tr>
377 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> move_metasprite </td>
378 <td>(</td>
379 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
380 <td class="paramname"><em>metasprite</em>, </td>
381 </tr>
382 <tr>
383 <td class="paramkey"></td>
384 <td></td>
385 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
386 <td class="paramname"><em>base_tile</em>, </td>
387 </tr>
388 <tr>
389 <td class="paramkey"></td>
390 <td></td>
391 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
392 <td class="paramname"><em>base_sprite</em>, </td>
393 </tr>
394 <tr>
395 <td class="paramkey"></td>
396 <td></td>
397 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
398 <td class="paramname"><em>x</em>, </td>
399 </tr>
400 <tr>
401 <td class="paramkey"></td>
402 <td></td>
403 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
404 <td class="paramname"><em>y</em> </td>
405 </tr>
406 <tr>
407 <td></td>
408 <td>)</td>
409 <td></td><td></td>
410 </tr>
411 </table>
412 </td>
413 <td class="mlabels-right">
414 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
415 </tr>
416 </table>
417 </div><div class="memdoc">
418 <p >Obsolete </p>
419
420 </div>
421 </div>
422 <a id="hide_metasprite" name="hide_metasprite"></a>
423 <h2 class="memtitle"><span class="permalink"><a href="#hide_metasprite">◆ </a></span>hide_metasprite()</h2>
424
425 <div class="memitem">
426 <div class="memproto">
427 <table class="mlabels">
428 <tr>
429 <td class="mlabels-left">
430 <table class="memname">
431 <tr>
432 <td class="memname">void hide_metasprite </td>
433 <td>(</td>
434 <td class="paramtype">const <a class="el" href="structmetasprite__t.html">metasprite_t</a> * </td>
435 <td class="paramname"><em>metasprite</em>, </td>
436 </tr>
437 <tr>
438 <td class="paramkey"></td>
439 <td></td>
440 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
441 <td class="paramname"><em>base_sprite</em> </td>
442 </tr>
443 <tr>
444 <td></td>
445 <td>)</td>
446 <td></td><td></td>
447 </tr>
448 </table>
449 </td>
450 <td class="mlabels-right">
451 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
452 </tr>
453 </table>
454 </div><div class="memdoc">
455 <p >Hides a metasprite from the screen</p>
456 <dl class="params"><dt>Parameters</dt><dd>
457 <table class="params">
458 <tr><td class="paramname">metasprite</td><td>Pointer to first struct of the desired metasprite frame </td></tr>
459 <tr><td class="paramname">base_sprite</td><td>Number of hardware sprite to start with</td></tr>
460 </table>
461 </dd>
462 </dl>
463 <p>Sets: </p><ul>
464 <li>__current_metasprite = metasprite; </li>
465 </ul>
466
467 </div>
468 </div>
469 <h2 class="groupheader">Variable Documentation</h2>
470 <a id="__current_metasprite" name="__current_metasprite"></a>
471 <h2 class="memtitle"><span class="permalink"><a href="#__current_metasprite">◆ </a></span>__current_metasprite</h2>
472
473 <div class="memitem">
474 <div class="memproto">
475 <table class="mlabels">
476 <tr>
477 <td class="mlabels-left">
478 <table class="memname">
479 <tr>
480 <td class="memname">const void* __current_metasprite</td>
481 </tr>
482 </table>
483 </td>
484 <td class="mlabels-right">
485 <span class="mlabels"><span class="mlabel">extern</span></span> </td>
486 </tr>
487 </table>
488 </div><div class="memdoc">
489
490 </div>
491 </div>
492 <a id="__current_base_tile" name="__current_base_tile"></a>
493 <h2 class="memtitle"><span class="permalink"><a href="#__current_base_tile">◆ </a></span>__current_base_tile</h2>
494
495 <div class="memitem">
496 <div class="memproto">
497 <table class="mlabels">
498 <tr>
499 <td class="mlabels-left">
500 <table class="memname">
501 <tr>
502 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> __current_base_tile</td>
503 </tr>
504 </table>
505 </td>
506 <td class="mlabels-right">
507 <span class="mlabels"><span class="mlabel">extern</span></span> </td>
508 </tr>
509 </table>
510 </div><div class="memdoc">
511
512 </div>
513 </div>
514 <a id="__render_shadow_OAM" name="__render_shadow_OAM"></a>
515 <h2 class="memtitle"><span class="permalink"><a href="#__render_shadow_OAM">◆ </a></span>__render_shadow_OAM</h2>
516
517 <div class="memitem">
518 <div class="memproto">
519 <table class="mlabels">
520 <tr>
521 <td class="mlabels-left">
522 <table class="memname">
523 <tr>
524 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> __render_shadow_OAM</td>
525 </tr>
526 </table>
527 </td>
528 <td class="mlabels-right">
529 <span class="mlabels"><span class="mlabel">extern</span></span> </td>
530 </tr>
531 </table>
532 </div><div class="memdoc">
533
534 </div>
535 </div>
536 <a id="iyl" name="iyl"></a>
537 <h2 class="memtitle"><span class="permalink"><a href="#iyl">◆ </a></span>iyl</h2>
538
539 <div class="memitem">
540 <div class="memproto">
541 <table class="memname">
542 <tr>
543 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> iyl</td>
544 </tr>
545 </table>
546 </div><div class="memdoc">
547 <b>Initial value:</b><div class="fragment"><div class="line">{</div>
548 <div class="line"> __asm__(<span class="stringliteral">"ei"</span>)</div>
549 </div><!-- fragment -->
550 </div>
551 </div>
552 </div><!-- contents -->
553 </div><!-- doc-content -->
554 <!-- start footer part -->
555 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
556 <ul>
557 <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_71c6fbf9500dd05f2fc30c566388269f.html">msx</a></li><li class="navelem"><a class="el" href="msx_2metasprites_8h.html">metasprites.h</a></li>
558 <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>
559 </ul>
560 </div>
561 </body>
562 </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.