gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/incbin_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/gbdk/incbin.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('incbin_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="#define-members">Macros</a> </div>
104 <div class="headertitle"><div class="title">incbin.h File Reference</div></div>
105 </div><!--header-->
106 <div class="contents">
107 <div class="textblock"><code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
108 </div>
109 <p><a href="incbin_8h_source.html">Go to the source code of this file.</a></p>
110 <table class="memberdecls">
111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
112 Macros</h2></td></tr>
113 <tr class="memitem:INCBIN_EXTERN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN</a>(VARNAME)</td></tr>
114 <tr class="separator:INCBIN_EXTERN"><td class="memSeparator" colspan="2"> </td></tr>
115 <tr class="memitem:INCBIN_SIZE"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="incbin_8h.html#INCBIN_SIZE">INCBIN_SIZE</a>(VARNAME)   ( (<a class="el" href="stdint_8h.html#uint16_t">uint16_t</a>) & __size_ ## VARNAME )</td></tr>
116 <tr class="separator:INCBIN_SIZE"><td class="memSeparator" colspan="2"> </td></tr>
117 <tr class="memitem:BANK"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="incbin_8h.html#BANK">BANK</a>(VARNAME)   ( (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>) & __bank_ ## VARNAME )</td></tr>
118 <tr class="separator:BANK"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:INCBIN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="incbin_8h.html#INCBIN">INCBIN</a>(VARNAME, FILEPATH)</td></tr>
120 <tr class="separator:INCBIN"><td class="memSeparator" colspan="2"> </td></tr>
121 </table>
122 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
123 <div class="textblock"><p >Allows binary data from other files to be included into a C source file.</p>
124 <p >It is implemented using asm .incbin and macros.</p>
125 <p >See the <code>incbin</code> example project for a demo of how to use it. </p>
126 </div><h2 class="groupheader">Macro Definition Documentation</h2>
127 <a id="INCBIN_EXTERN" name="INCBIN_EXTERN"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#INCBIN_EXTERN">◆ </a></span>INCBIN_EXTERN</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
133 <tr>
134 <td class="memname">#define INCBIN_EXTERN</td>
135 <td>(</td>
136 <td class="paramtype"> </td>
137 <td class="paramname">VARNAME</td><td>)</td>
138 <td></td>
139 </tr>
140 </table>
141 </div><div class="memdoc">
142 <b>Value:</b><div class="fragment"><div class="line"><span class="keyword">extern</span> <span class="keyword">const</span> <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> VARNAME[]; \</div>
143 <div class="line">extern <span class="keyword">const</span> <span class="keywordtype">void</span> __size_ ## VARNAME; \</div>
144 <div class="line">extern <span class="keyword">const</span> <span class="keywordtype">void</span> __bank_ ## VARNAME;</div>
145 <div class="ttc" id="astdint_8h_html_uint8_t"><div class="ttname"><a href="stdint_8h.html#uint8_t">uint8_t</a></div><div class="ttdeci">unsigned char uint8_t</div><div class="ttdef"><b>Definition:</b> stdint.h:51</div></div>
146 </div><!-- fragment --><p >Creates extern entries for accessing a <a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a> generated variable and it's size in another source file.</p>
147 <dl class="params"><dt>Parameters</dt><dd>
148 <table class="params">
149 <tr><td class="paramname">VARNAME</td><td>Name of the variable used with INCBIN</td></tr>
150 </table>
151 </dd>
152 </dl>
153 <p>An entry is created for the variable and it's size variable.</p>
154 <p ><a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a>, <a class="el" href="incbin_8h.html#INCBIN_SIZE">INCBIN_SIZE()</a> </p>
155
156 </div>
157 </div>
158 <a id="INCBIN_SIZE" name="INCBIN_SIZE"></a>
159 <h2 class="memtitle"><span class="permalink"><a href="#INCBIN_SIZE">◆ </a></span>INCBIN_SIZE</h2>
160
161 <div class="memitem">
162 <div class="memproto">
163 <table class="memname">
164 <tr>
165 <td class="memname">#define INCBIN_SIZE</td>
166 <td>(</td>
167 <td class="paramtype"> </td>
168 <td class="paramname">VARNAME</td><td>)</td>
169 <td>   ( (<a class="el" href="stdint_8h.html#uint16_t">uint16_t</a>) & __size_ ## VARNAME )</td>
170 </tr>
171 </table>
172 </div><div class="memdoc">
173 <p >Obtains the <b>size in bytes</b> of the <a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a> generated data</p>
174 <dl class="params"><dt>Parameters</dt><dd>
175 <table class="params">
176 <tr><td class="paramname">VARNAME</td><td>Name of the variable used with INCBIN</td></tr>
177 </table>
178 </dd>
179 </dl>
180 <p>Requires <a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN()</a> to have been called earlier in the source file</p>
181 <p ><a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a>, <a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN()</a> </p>
182
183 </div>
184 </div>
185 <a id="BANK" name="BANK"></a>
186 <h2 class="memtitle"><span class="permalink"><a href="#BANK">◆ </a></span>BANK</h2>
187
188 <div class="memitem">
189 <div class="memproto">
190 <table class="memname">
191 <tr>
192 <td class="memname">#define BANK</td>
193 <td>(</td>
194 <td class="paramtype"> </td>
195 <td class="paramname">VARNAME</td><td>)</td>
196 <td>   ( (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>) & __bank_ ## VARNAME )</td>
197 </tr>
198 </table>
199 </div><div class="memdoc">
200 <p >Obtains the <b>bank number</b> of the <a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a> generated data</p>
201 <dl class="params"><dt>Parameters</dt><dd>
202 <table class="params">
203 <tr><td class="paramname">VARNAME</td><td>Name of the variable used with INCBIN</td></tr>
204 </table>
205 </dd>
206 </dl>
207 <p>Requires <a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN()</a> to have been called earlier in the source file</p>
208 <p ><a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a>, <a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN()</a> </p>
209
210 </div>
211 </div>
212 <a id="INCBIN" name="INCBIN"></a>
213 <h2 class="memtitle"><span class="permalink"><a href="#INCBIN">◆ </a></span>INCBIN</h2>
214
215 <div class="memitem">
216 <div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">#define INCBIN</td>
220 <td>(</td>
221 <td class="paramtype"> </td>
222 <td class="paramname">VARNAME, </td>
223 </tr>
224 <tr>
225 <td class="paramkey"></td>
226 <td></td>
227 <td class="paramtype"> </td>
228 <td class="paramname">FILEPATH </td>
229 </tr>
230 <tr>
231 <td></td>
232 <td>)</td>
233 <td></td><td></td>
234 </tr>
235 </table>
236 </div><div class="memdoc">
237 <b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">void</span> __func_ ## VARNAME(<span class="keywordtype">void</span>) __banked __naked { \</div>
238 <div class="line">__asm \</div>
239 <div class="line">_ ## VARNAME:: \</div>
240 <div class="line">1$: \</div>
241 <div class="line"> .incbin FILEPATH \</div>
242 <div class="line">2$: \</div>
243 <div class="line"> ___size_ ## VARNAME = (2$-1$) \</div>
244 <div class="line"> .globl ___size_ ## VARNAME \</div>
245 <div class="line"> .local b___func_ ## VARNAME \</div>
246 <div class="line"> ___bank_ ## VARNAME = b___func_ ## VARNAME \</div>
247 <div class="line"> .globl ___bank_ ## VARNAME \</div>
248 <div class="line">__endasm; \</div>
249 <div class="line">}</div>
250 </div><!-- fragment --><p >Includes binary data into a C source file</p>
251 <dl class="params"><dt>Parameters</dt><dd>
252 <table class="params">
253 <tr><td class="paramname">VARNAME</td><td>Variable name to use </td></tr>
254 <tr><td class="paramname">FILEPATH</td><td>Path to the file which will be binary included into the C source file</td></tr>
255 </table>
256 </dd>
257 </dl>
258 <p><b>filepath</b> is relative to the working directory of the tool that is calling it (often a makefile's working directory), <b>NOT</b> to the file it's being included into.</p>
259 <p >The variable name is not modified and can be used as-is.</p>
260 <p >The <a class="el" href="incbin_8h.html#INCBIN">INCBIN()</a> macro will declare the <a class="el" href="gb_8h.html#BANK">BANK()</a> and <a class="el" href="incbin_8h.html#INCBIN_SIZE">INCBIN_SIZE()</a> helper symbols. Then if <a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN()</a> is used in the header then those helper macros can be used in the application code.</p><ul>
261 <li><a class="el" href="incbin_8h.html#INCBIN_SIZE">INCBIN_SIZE()</a> for obtaining the size of the included data.</li>
262 <li><a class="el" href="gb_8h.html#BANK">BANK()</a> for obtaining the bank number of the included data.</li>
263 </ul>
264 <p >Use <a class="el" href="incbin_8h.html#INCBIN_EXTERN">INCBIN_EXTERN()</a> within another source file to make the variable and it's data accessible there.</p>
265 <hr />
266
267 </div>
268 </div>
269 </div><!-- contents -->
270 </div><!-- doc-content -->
271 <!-- start footer part -->
272 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
273 <ul>
274 <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_aedcfcf321a7f13aa34b51e3093299b2.html">gbdk</a></li><li class="navelem"><a class="el" href="incbin_8h.html">incbin.h</a></li>
275 <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>
276 </ul>
277 </div>
278 </body>
279 </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.