nytpu
/
game
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
game/docs/html/load_8c.html

233 lines
11 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>game: src/load.c File 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="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" />
</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">game
</div>
<div id="projectbrief">untitled gba game</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">load.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>load things into memory
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;tonc.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &quot;gbfs.h&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;stdarg.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &quot;<a class="el" href="globals_8h_source.html">globals.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="load_8h_source.html">load.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:afef9f3c3b24f0650b6fbf1189ddfebb3"><td class="memItemLeft" align="right" valign="top"><a id="afef9f3c3b24f0650b6fbf1189ddfebb3"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FILENAME_EXT_REG</b>&#160;&#160;&#160;8</td></tr>
<tr class="separator:afef9f3c3b24f0650b6fbf1189ddfebb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64feb4c249171701c5cbdfb0014bd0b0"><td class="memItemLeft" align="right" valign="top"><a id="a64feb4c249171701c5cbdfb0014bd0b0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FILENAME_EXT_FRAMES</b>&#160;&#160;&#160;12</td></tr>
<tr class="separator:a64feb4c249171701c5cbdfb0014bd0b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a20b20b0aac91db2116781f8d273686d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="load_8c.html#a20b20b0aac91db2116781f8d273686d4">load_region</a> (const char filename[], int filename_len, COLOR *palbank, TILE *charblock, SCR_ENTRY *screenblock)</td></tr>
<tr class="memdesc:a20b20b0aac91db2116781f8d273686d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">load region from gbfs file into memory <a href="load_8c.html#a20b20b0aac91db2116781f8d273686d4">More...</a><br /></td></tr>
<tr class="separator:a20b20b0aac91db2116781f8d273686d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9b9147a025a5344283d154e485d99de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="load_8c.html#ac9b9147a025a5344283d154e485d99de">load_sprite</a> (const char filename[], int filename_len, int num_frames,...)</td></tr>
<tr class="memdesc:ac9b9147a025a5344283d154e485d99de"><td class="mdescLeft">&#160;</td><td class="mdescRight">load sprite into object memory <a href="load_8c.html#ac9b9147a025a5344283d154e485d99de">More...</a><br /></td></tr>
<tr class="separator:ac9b9147a025a5344283d154e485d99de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7100ffd1cc02f80f17969bbf0cd27f96"><td class="memItemLeft" align="right" valign="top"><a id="a7100ffd1cc02f80f17969bbf0cd27f96"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>load_hub</b> (COLOR *palbank, TILE *charblock, SCR_ENTRY *screenblock)</td></tr>
<tr class="separator:a7100ffd1cc02f80f17969bbf0cd27f96"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>load things into memory </p>
<p>used to quickly load levels and sprites from gbfs into video memory and for running other memory loads as necessary </p><dl class="section author"><dt>Author</dt><dd>nytpu </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>For license details see COPYING. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a20b20b0aac91db2116781f8d273686d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20b20b0aac91db2116781f8d273686d4">&#9670;&nbsp;</a></span>load_region()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void load_region </td>
<td>(</td>
<td class="paramtype">const char&#160;</td>
<td class="paramname"><em>filename</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>filename_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">COLOR *&#160;</td>
<td class="paramname"><em>palbank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TILE *&#160;</td>
<td class="paramname"><em>charblock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SCR_ENTRY *&#160;</td>
<td class="paramname"><em>screenblock</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>load region from gbfs file into memory </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename[]</td><td>base filename of region without extension </td></tr>
<tr><td class="paramname">filename_len</td><td>length of base filename including null terminator </td></tr>
<tr><td class="paramname">palbank</td><td></td></tr>
<tr><td class="paramname">charblock</td><td></td></tr>
<tr><td class="paramname">screenblock</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac9b9147a025a5344283d154e485d99de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9b9147a025a5344283d154e485d99de">&#9670;&nbsp;</a></span>load_sprite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void load_sprite </td>
<td>(</td>
<td class="paramtype">const char&#160;</td>
<td class="paramname"><em>filename</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>filename_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>load sprite into object memory </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename[]</td><td>base filename without extension </td></tr>
<tr><td class="paramname">filename_len</td><td>length of filename including null terminaor </td></tr>
<tr><td class="paramname">num_frames</td><td>number of frames in sprite animation </td></tr>
<tr><td class="paramname">...</td><td>num_frames of TILE* pointing to a location in tile_mem to load frame into</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>assumes shared palette for all frames. assumes filename convention of "&lt;filename&gt;_f&lt;frame_number&gt;.img.bin" </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink