gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/structmetasprite__t.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: metasprite_t Struct 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('structmetasprite__t.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="#pub-attribs">Data Fields</a> </div>
104 <div class="headertitle"><div class="title">metasprite_t Struct Reference</div></div>
105 </div><!--header-->
106 <div class="contents">
107
108 <p><code>#include <<a class="el" href="gb_2metasprites_8h_source.html">gbdk-lib/include/gb/metasprites.h</a>></code></p>
109 <table class="memberdecls">
110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
111 Data Fields</h2></td></tr>
112 <tr class="memitem:dy"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#int8_t">int8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html#dy">dy</a></td></tr>
113 <tr class="separator:dy"><td class="memSeparator" colspan="2"> </td></tr>
114 <tr class="memitem:dx"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#int8_t">int8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html#dx">dx</a></td></tr>
115 <tr class="separator:dx"><td class="memSeparator" colspan="2"> </td></tr>
116 <tr class="memitem:dtile"><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="structmetasprite__t.html#dtile">dtile</a></td></tr>
117 <tr class="separator:dtile"><td class="memSeparator" colspan="2"> </td></tr>
118 <tr class="memitem:props"><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="structmetasprite__t.html#props">props</a></td></tr>
119 <tr class="separator:props"><td class="memSeparator" colspan="2"> </td></tr>
120 </table>
121 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
122 <div class="textblock"><p >Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd>
123 <table class="params">
124 <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
125 <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
126 <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles </td></tr>
127 <tr><td class="paramname">props</td><td>(uint8_t) Property Flags</td></tr>
128 </table>
129 </dd>
130 </dl>
131 <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>
132 <p >A metasprite frame is terminated with a {metasprite_end} entry.</p>
133 <p >Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd>
134 <table class="params">
135 <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
136 <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr>
137 <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles</td></tr>
138 </table>
139 </dd>
140 </dl>
141 <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>
142 <p >A metasprite frame is terminated with a {metasprite_end} entry. </p>
143 </div><h2 class="groupheader">Field Documentation</h2>
144 <a id="dy" name="dy"></a>
145 <h2 class="memtitle"><span class="permalink"><a href="#dy">◆ </a></span>dy</h2>
146
147 <div class="memitem">
148 <div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname"><a class="el" href="stdint_8h.html#int8_t">int8_t</a> metasprite_t::dy</td>
152 </tr>
153 </table>
154 </div><div class="memdoc">
155
156 </div>
157 </div>
158 <a id="dx" name="dx"></a>
159 <h2 class="memtitle"><span class="permalink"><a href="#dx">◆ </a></span>dx</h2>
160
161 <div class="memitem">
162 <div class="memproto">
163 <table class="memname">
164 <tr>
165 <td class="memname"><a class="el" href="stdint_8h.html#int8_t">int8_t</a> metasprite_t::dx</td>
166 </tr>
167 </table>
168 </div><div class="memdoc">
169
170 </div>
171 </div>
172 <a id="dtile" name="dtile"></a>
173 <h2 class="memtitle"><span class="permalink"><a href="#dtile">◆ </a></span>dtile</h2>
174
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
178 <tr>
179 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> metasprite_t::dtile</td>
180 </tr>
181 </table>
182 </div><div class="memdoc">
183
184 </div>
185 </div>
186 <a id="props" name="props"></a>
187 <h2 class="memtitle"><span class="permalink"><a href="#props">◆ </a></span>props</h2>
188
189 <div class="memitem">
190 <div class="memproto">
191 <table class="memname">
192 <tr>
193 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> metasprite_t::props</td>
194 </tr>
195 </table>
196 </div><div class="memdoc">
197
198 </div>
199 </div>
200 <hr/>The documentation for this struct was generated from the following files:<ul>
201 <li>gbdk-lib/include/gb/<a class="el" href="gb_2metasprites_8h_source.html">metasprites.h</a></li>
202 <li>gbdk-lib/include/msx/<a class="el" href="msx_2metasprites_8h_source.html">metasprites.h</a></li>
203 <li>gbdk-lib/include/nes/<a class="el" href="nes_2metasprites_8h_source.html">metasprites.h</a></li>
204 <li>gbdk-lib/include/sms/<a class="el" href="sms_2metasprites_8h_source.html">metasprites.h</a></li>
205 </ul>
206 </div><!-- contents -->
207 </div><!-- doc-content -->
208 <!-- start footer part -->
209 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
210 <ul>
211 <li class="navelem"><a class="el" href="structmetasprite__t.html">metasprite_t</a></li>
212 <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>
213 </ul>
214 </div>
215 </body>
216 </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.