structmetasprite__t.html (10271B)
1<!-- HTML header for doxygen 1.8.14--> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4<head> 5<meta http-equiv="cache-control" content="max-age=86400"/> 6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 7<meta http-equiv="X-UA-Compatible" content="IE=9"/> 8<meta name="generator" content="Doxygen 1.8.20"/> 9<meta name="viewport" content="width=device-width, initial-scale=1"/> 10<title>GBDK 2020 Docs: 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_extra.css" rel="stylesheet" type="text/css"/> 23</head> 24<body> 25<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 26<div id="titlearea"> 27<table cellspacing="0" cellpadding="0"> 28 <tbody> 29 <tr style="height: 56px;"> 30 <td id="projectalign" style="padding-left: 0.5em;"> 31 <div id="projectname">GBDK 2020 Docs 32  <span id="projectnumber">4.0.6</span> 33 </div> 34 <div id="projectbrief">API Documentation for GBDK 2020</div> 35 </td> 36 </tr> 37 </tbody> 38</table> 39</div> 40<!-- end header part --> 41<!-- Generated by Doxygen 1.8.20 --> 42<script type="text/javascript"> 43/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 44var searchBox = new SearchBox("searchBox", "search",false,'Search'); 45/* @license-end */ 46</script> 47<script type="text/javascript" src="menudata.js"></script> 48<script type="text/javascript" src="menu.js"></script> 49<script type="text/javascript"> 50/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 51$(function() { 52 initMenu('',true,false,'search.php','Search'); 53 $(document).ready(function() { init_search(); }); 54}); 55/* @license-end */</script> 56<div id="main-nav"></div> 57</div><!-- top --> 58<div id="side-nav" class="ui-resizable side-nav-resizable"> 59 <div id="nav-tree"> 60 <div id="nav-tree-contents"> 61 <div id="nav-sync" class="sync"></div> 62 </div> 63 </div> 64 <div id="splitbar" style="-moz-user-select:none;" 65 class="ui-resizable-handle"> 66 </div> 67</div> 68<script type="text/javascript"> 69/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 70$(document).ready(function(){initNavTree('structmetasprite__t.html',''); initResizable(); }); 71/* @license-end */ 72</script> 73<div id="doc-content"> 74<!-- window showing the filter options --> 75<div id="MSearchSelectWindow" 76 onmouseover="return searchBox.OnSearchSelectShow()" 77 onmouseout="return searchBox.OnSearchSelectHide()" 78 onkeydown="return searchBox.OnSearchSelectKey(event)"> 79</div> 80 81<!-- iframe showing the search results (closed by default) --> 82<div id="MSearchResultsWindow"> 83<iframe src="javascript:void(0)" frameborder="0" 84 name="MSearchResults" id="MSearchResults"> 85</iframe> 86</div> 87 88<div class="header"> 89 <div class="summary"> 90<a href="#pub-attribs">Data Fields</a> </div> 91 <div class="headertitle"> 92<div class="title">metasprite_t Struct Reference</div> </div> 93</div><!--header--> 94<div class="contents"> 95 96<p><code>#include <<a class="el" href="gb_2metasprites_8h_source.html">metasprites.h</a>></code></p> 97<table class="memberdecls"> 98<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> 99Data Fields</h2></td></tr> 100<tr class="memitem:a2c3fea1f6b3354352823320c69a3e4bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html#a2c3fea1f6b3354352823320c69a3e4bb">dy</a></td></tr> 101<tr class="separator:a2c3fea1f6b3354352823320c69a3e4bb"><td class="memSeparator" colspan="2"> </td></tr> 102<tr class="memitem:a67d2a6fb62059da39b54e975c4fbb324"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html#a67d2a6fb62059da39b54e975c4fbb324">dx</a></td></tr> 103<tr class="separator:a67d2a6fb62059da39b54e975c4fbb324"><td class="memSeparator" colspan="2"> </td></tr> 104<tr class="memitem:ad68b2f80c08f2f7fc603c56af2e75a6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html#ad68b2f80c08f2f7fc603c56af2e75a6f">dtile</a></td></tr> 105<tr class="separator:ad68b2f80c08f2f7fc603c56af2e75a6f"><td class="memSeparator" colspan="2"> </td></tr> 106<tr class="memitem:ab61e73a65c5e8cb30d0d81bb7845d615"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmetasprite__t.html#ab61e73a65c5e8cb30d0d81bb7845d615">props</a></td></tr> 107<tr class="separator:ab61e73a65c5e8cb30d0d81bb7845d615"><td class="memSeparator" colspan="2"> </td></tr> 108</table> 109<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 110<div class="textblock"><p>Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd> 111 <table class="params"> 112 <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr> 113 <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr> 114 <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles </td></tr> 115 <tr><td class="paramname">props</td><td>(uint8_t) Property Flags</td></tr> 116 </table> 117 </dd> 118</dl> 119<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> 120<p>A metasprite frame is terminated with a {metasprite_end} entry.</p> 121<p>Metasprite sub-item structure </p><dl class="params"><dt>Parameters</dt><dd> 122 <table class="params"> 123 <tr><td class="paramname">dy</td><td>(int8_t) Y coordinate of the sprite relative to the metasprite origin (pivot) </td></tr> 124 <tr><td class="paramname">dx</td><td>(int8_t) X coordinate of the sprite relative to the metasprite origin (pivot) </td></tr> 125 <tr><td class="paramname">dtile</td><td>(uint8_t) Start tile relative to the metasprites own set of tiles</td></tr> 126 </table> 127 </dd> 128</dl> 129<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> 130<p>A metasprite frame is terminated with a {metasprite_end} entry. </p> 131</div><h2 class="groupheader">Field Documentation</h2> 132<a id="a2c3fea1f6b3354352823320c69a3e4bb"></a> 133<h2 class="memtitle"><span class="permalink"><a href="#a2c3fea1f6b3354352823320c69a3e4bb">◆ </a></span>dy</h2> 134 135<div class="memitem"> 136<div class="memproto"> 137 <table class="memname"> 138 <tr> 139 <td class="memname"><a class="el" href="stdint_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> metasprite_t::dy</td> 140 </tr> 141 </table> 142</div><div class="memdoc"> 143 144</div> 145</div> 146<a id="a67d2a6fb62059da39b54e975c4fbb324"></a> 147<h2 class="memtitle"><span class="permalink"><a href="#a67d2a6fb62059da39b54e975c4fbb324">◆ </a></span>dx</h2> 148 149<div class="memitem"> 150<div class="memproto"> 151 <table class="memname"> 152 <tr> 153 <td class="memname"><a class="el" href="stdint_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> metasprite_t::dx</td> 154 </tr> 155 </table> 156</div><div class="memdoc"> 157 158</div> 159</div> 160<a id="ad68b2f80c08f2f7fc603c56af2e75a6f"></a> 161<h2 class="memtitle"><span class="permalink"><a href="#ad68b2f80c08f2f7fc603c56af2e75a6f">◆ </a></span>dtile</h2> 162 163<div class="memitem"> 164<div class="memproto"> 165 <table class="memname"> 166 <tr> 167 <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> metasprite_t::dtile</td> 168 </tr> 169 </table> 170</div><div class="memdoc"> 171 172</div> 173</div> 174<a id="ab61e73a65c5e8cb30d0d81bb7845d615"></a> 175<h2 class="memtitle"><span class="permalink"><a href="#ab61e73a65c5e8cb30d0d81bb7845d615">◆ </a></span>props</h2> 176 177<div class="memitem"> 178<div class="memproto"> 179 <table class="memname"> 180 <tr> 181 <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> metasprite_t::props</td> 182 </tr> 183 </table> 184</div><div class="memdoc"> 185 186</div> 187</div> 188<hr/>The documentation for this struct was generated from the following file:<ul> 189<li>gb/<a class="el" href="gb_2metasprites_8h_source.html">metasprites.h</a></li> 190</ul> 191</div><!-- contents --> 192</div><!-- doc-content --> 193<!-- HTML footer for doxygen 1.8.14--> 194<!-- start footer part --> 195<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 196</div> 197</body> 198</html>