mirror of https://github.com/zeldaret/tmc
256 lines
13 KiB
HTML
256 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>include/global.h file | The Minish Cap Docs</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
|
<link rel="stylesheet" href="style.css" />
|
|
<link rel="icon" href="https://zelda64.dev/favicon.ico" type="image/vnd.microsoft.icon" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#22272e" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
|
|
<a href="https://github.com/zeldaret/tmc">The Minish Cap</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
|
|
</span>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li><a href="modules.html">Modules</a></li>
|
|
<li><a href="pages.html">Pages</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="3">
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path" />
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<span class="m-breadcrumb"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a>/</span>global.h <span class="m-thin">file</span>
|
|
</h1>
|
|
<p><span></span></p>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#nested-classes">Classes</a></li>
|
|
<li><a href="#typedef-members">Typedefs</a></li>
|
|
<li><a href="#var-members">Variables</a></li>
|
|
<li><a href="#define-members">Defines</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<section id="nested-classes">
|
|
<h2><a href="#nested-classes">Classes</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
union <a href="unionCoords.html" class="m-doc">Coords</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt>
|
|
struct <a href="structPACKED.html" class="m-doc">PACKED</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt>
|
|
union <a href="unionSplitDWord.html" class="m-doc">SplitDWord</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt>
|
|
union <a href="unionSplitWord.html" class="m-doc">SplitWord</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt>
|
|
union <a href="unionSplitHWord.html" class="m-doc">SplitHWord</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="typedef-members">
|
|
<h2><a href="#typedef-members">Typedefs</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="ae7b9aaa4fcfa1c3245809c44deb8f36a">
|
|
using <a href="#ae7b9aaa4fcfa1c3245809c44deb8f36a" class="m-doc-self">MultiReturnTypeSingleEntityArg</a> = <a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234" class="m-doc">u64</a>(*)(struct Entity_*)
|
|
</dt>
|
|
<dd>Multi return function data type casts.</dd>
|
|
<dt id="a123a39355ac4ab1a1525842d8011f539">
|
|
using <a href="#a123a39355ac4ab1a1525842d8011f539" class="m-doc-self">MultiReturnTypeTwoS32Arg</a> = <a href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269" class="m-doc">s64</a>(*)(s32, s32)
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="var-members">
|
|
<h2><a href="#var-members">Variables</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a82b710073fb5232c4933a7e71451f425">
|
|
union <a href="unionSplitHWord.html" class="m-doc">SplitHWord</a> <a href="#a82b710073fb5232c4933a7e71451f425" class="m-doc-self">PACKED</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="define-members">
|
|
<h2><a href="#define-members">Defines</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a5b0a66df0cdb678369e41ca8cd231b0d">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a5b0a66df0cdb678369e41ca8cd231b0d" class="m-doc-self">BLOCK_CROSS_JUMP</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a7c3453c4698ae152ee23e04549ce7960">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a7c3453c4698ae152ee23e04549ce7960" class="m-doc-self">asm_comment</a>(</span><span class="m-doc-wrap">x)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="acb6b3148c677cfff5c6dc2df18a24336">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#acb6b3148c677cfff5c6dc2df18a24336" class="m-doc-self">asm_unified</a>(</span><span class="m-doc-wrap">x)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a6476a142e89bd6749f9a56d030cb11df">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a6476a142e89bd6749f9a56d030cb11df" class="m-doc-self">ARRAY_COUNT</a>(</span><span class="m-doc-wrap">array)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a417c170109e7863ebe298b6d3a88e355">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a417c170109e7863ebe298b6d3a88e355" class="m-doc-self">SWAP</a>(</span><span class="m-doc-wrap">a,
|
|
b,
|
|
temp)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a02cd719965dc868ce3821ead9e939f6f">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a02cd719965dc868ce3821ead9e939f6f" class="m-doc-self">Q_8_8</a>(</span><span class="m-doc-wrap">n)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="af02bb63f2dd8604e753c23ba747c2ced">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#af02bb63f2dd8604e753c23ba747c2ced" class="m-doc-self">Q_16_16</a>(</span><span class="m-doc-wrap">n)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ac6afabdc09a49a433ee19d8a9486056d">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#ac6afabdc09a49a433ee19d8a9486056d" class="m-doc-self">min</a>(</span><span class="m-doc-wrap">a,
|
|
b)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="affe776513b24d84b39af8ab0930fef7f">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#affe776513b24d84b39af8ab0930fef7f" class="m-doc-self">max</a>(</span><span class="m-doc-wrap">a,
|
|
b)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ad072c9a7fa6508417f73e3e24943d89f">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#ad072c9a7fa6508417f73e3e24943d89f" class="m-doc-self">static_assert</a>(</span><span class="m-doc-wrap">cond)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ac69e0ceecb8b8ea0e694f79e5406bb24">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#ac69e0ceecb8b8ea0e694f79e5406bb24" class="m-doc-self">super</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ade5a01479b6de75bec7bf1c0a4e5f8f2">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#ade5a01479b6de75bec7bf1c0a4e5f8f2" class="m-doc-self">ASM_FUNC</a>(</span><span class="m-doc-wrap">path,
|
|
decl)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a56086581d86144f9924f929bef322b37">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a56086581d86144f9924f929bef322b37" class="m-doc-self">NONMATCH</a>(</span><span class="m-doc-wrap">path,
|
|
decl)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a1a4d5c7d8c896a4d086ed9fe21cf235d">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a1a4d5c7d8c896a4d086ed9fe21cf235d" class="m-doc-self">END_NONMATCH</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a76b323727991f1fe7746f315c7b1593c">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a76b323727991f1fe7746f315c7b1593c" class="m-doc-self">FORCE_REGISTER</a>(</span><span class="m-doc-wrap">var,
|
|
reg)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a80492499834e30e0109e1e4a69efee29">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a80492499834e30e0109e1e4a69efee29" class="m-doc-self">MEMORY_BARRIER</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="aecd6b5c7d42ab292b4e9c181924bff55">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#aecd6b5c7d42ab292b4e9c181924bff55" class="m-doc-self">FORCE_WORD_ALIGNED</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a46713ab97672a328b3b79353b4a468bf">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a46713ab97672a328b3b79353b4a468bf" class="m-doc-self">BIT</a>(</span><span class="m-doc-wrap">bit)</span>
|
|
</dt>
|
|
<dd>bitset macros</dd>
|
|
<dt id="a93abc3834bcb58b15c819e68d694ed20">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a93abc3834bcb58b15c819e68d694ed20" class="m-doc-self">IS_BIT_SET</a>(</span><span class="m-doc-wrap">value,
|
|
bit)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script>
|
|
Search.download(window.location.pathname.substr(0, window.location.pathname.lastIndexOf('/') + 1) + 'searchdata-v2.bin');
|
|
</script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<p>The Minish Cap Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|