diff options
Diffstat (limited to 'gbdk/docs/api/structmetasprite__t.html')
| -rw-r--r-- | gbdk/docs/api/structmetasprite__t.html | 198 |
1 files changed, 198 insertions, 0 deletions
diff --git a/gbdk/docs/api/structmetasprite__t.html b/gbdk/docs/api/structmetasprite__t.html new file mode 100644 index 00000000..45e691e6 --- /dev/null +++ b/gbdk/docs/api/structmetasprite__t.html @@ -0,0 +1,198 @@ +<!-- 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.8.20"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>GBDK 2020 Docs: metasprite_t Struct 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_extra.css" rel="stylesheet" type="text/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.0.6</span> + </div> + <div id="projectbrief">API Documentation for GBDK 2020</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.20 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('structmetasprite__t.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="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">metasprite_t Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="gb_2metasprites_8h_source.html">metasprites.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<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> +<tr class="separator:a2c3fea1f6b3354352823320c69a3e4bb"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a67d2a6fb62059da39b54e975c4fbb324"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:ad68b2f80c08f2f7fc603c56af2e75a6f"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:ab61e73a65c5e8cb30d0d81bb7845d615"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><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> +<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> + </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><h2 class="groupheader">Field Documentation</h2> +<a id="a2c3fea1f6b3354352823320c69a3e4bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2c3fea1f6b3354352823320c69a3e4bb">◆ </a></span>dy</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="stdint_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> metasprite_t::dy</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a67d2a6fb62059da39b54e975c4fbb324"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a67d2a6fb62059da39b54e975c4fbb324">◆ </a></span>dx</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="stdint_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> metasprite_t::dx</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ad68b2f80c08f2f7fc603c56af2e75a6f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad68b2f80c08f2f7fc603c56af2e75a6f">◆ </a></span>dtile</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> metasprite_t::dtile</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ab61e73a65c5e8cb30d0d81bb7845d615"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab61e73a65c5e8cb30d0d81bb7845d615">◆ </a></span>props</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> metasprite_t::props</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>gb/<a class="el" href="gb_2metasprites_8h_source.html">metasprites.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> +</div> +</body> +</html> |