Files
tmc/defines_8h.html
2026-02-08 17:33:27 +00:00

368 lines
21 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>include/gba/defines.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><span class="m-breadcrumb"><a href="dir_5bf7dd0a8a52a280c5880004a0f430cd.html">gba</a>/</span>defines.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="#define-members">Defines</a></li>
</ul>
</li>
</ul>
</nav>
<section id="define-members">
<h2><a href="#define-members">Defines</a></h2>
<dl class="m-doc">
<dt id="aa8cecfc5c5c054d2875c03e77b7be15d">
<span class="m-doc-wrap-bumper">#define <a href="#aa8cecfc5c5c054d2875c03e77b7be15d" class="m-doc-self">TRUE</a></span>
</dt>
<dd><span></span></dd>
<dt id="aa93f0eb578d23995850d61f7d61c55c1">
<span class="m-doc-wrap-bumper">#define <a href="#aa93f0eb578d23995850d61f7d61c55c1" class="m-doc-self">FALSE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a1ccb2d4775bba0f3e7fe6f53a7c74e23">
<span class="m-doc-wrap-bumper">#define <a href="#a1ccb2d4775bba0f3e7fe6f53a7c74e23" class="m-doc-self">IWRAM_DATA</a></span>
</dt>
<dd><span></span></dd>
<dt id="a99c9f8272dfdc80bf6b9422557fe6c53">
<span class="m-doc-wrap-bumper">#define <a href="#a99c9f8272dfdc80bf6b9422557fe6c53" class="m-doc-self">EWRAM_DATA</a></span>
</dt>
<dd><span></span></dd>
<dt id="a7a18c4884994b9b520ae535b6d9579d3">
<span class="m-doc-wrap-bumper">#define <a href="#a7a18c4884994b9b520ae535b6d9579d3" class="m-doc-self">NAKED</a></span>
</dt>
<dd><span></span></dd>
<dt id="addf5ec070e9499d36b7f2009ce736076">
<span class="m-doc-wrap-bumper">#define <a href="#addf5ec070e9499d36b7f2009ce736076" class="m-doc-self">UNUSED</a></span>
</dt>
<dd><span></span></dd>
<dt id="a36d525cf4d116b2fe4ecc00222b256f1">
<span class="m-doc-wrap-bumper">#define <a href="#a36d525cf4d116b2fe4ecc00222b256f1" class="m-doc-self">PACKED</a></span>
</dt>
<dd><span></span></dd>
<dt id="a5c3720156dd81cfb1f2b2223302cb43c">
<span class="m-doc-wrap-bumper">#define <a href="#a5c3720156dd81cfb1f2b2223302cb43c" class="m-doc-self">ALIGNED</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a7d9da4963ad4b6e916489c7baea68796">
<span class="m-doc-wrap-bumper">#define <a href="#a7d9da4963ad4b6e916489c7baea68796" class="m-doc-self">SOUND_INFO_PTR</a></span>
</dt>
<dd><span></span></dd>
<dt id="aaca105232402df0f9f79f0430c851d60">
<span class="m-doc-wrap-bumper">#define <a href="#aaca105232402df0f9f79f0430c851d60" class="m-doc-self">INTR_CHECK</a></span>
</dt>
<dd><span></span></dd>
<dt id="a5b6599fe23d59fa3f99fb7db3bd4683c">
<span class="m-doc-wrap-bumper">#define <a href="#a5b6599fe23d59fa3f99fb7db3bd4683c" class="m-doc-self">INTR_VECTOR</a></span>
</dt>
<dd><span></span></dd>
<dt id="a2457f0f378048a48e23a9be978c1c811">
<span class="m-doc-wrap-bumper">#define <a href="#a2457f0f378048a48e23a9be978c1c811" class="m-doc-self">EWRAM_START</a></span>
</dt>
<dd><span></span></dd>
<dt id="a4d661a30c85e3b54ea7f08288d76528d">
<span class="m-doc-wrap-bumper">#define <a href="#a4d661a30c85e3b54ea7f08288d76528d" class="m-doc-self">EWRAM_END</a></span>
</dt>
<dd><span></span></dd>
<dt id="a4148f12f661275dbfc33bbe760e720e1">
<span class="m-doc-wrap-bumper">#define <a href="#a4148f12f661275dbfc33bbe760e720e1" class="m-doc-self">IWRAM_START</a></span>
</dt>
<dd><span></span></dd>
<dt id="a1aeb77b7af2ec19fa4580b0ed0d0b242">
<span class="m-doc-wrap-bumper">#define <a href="#a1aeb77b7af2ec19fa4580b0ed0d0b242" class="m-doc-self">IWRAM_END</a></span>
</dt>
<dd><span></span></dd>
<dt id="aa3ea8cd5a7c2061ef558a50f77e3a8b6">
<span class="m-doc-wrap-bumper">#define <a href="#aa3ea8cd5a7c2061ef558a50f77e3a8b6" class="m-doc-self">PLTT</a></span>
</dt>
<dd><span></span></dd>
<dt id="a5fe9706792acae1b19216b65500be1cc">
<span class="m-doc-wrap-bumper">#define <a href="#a5fe9706792acae1b19216b65500be1cc" class="m-doc-self">PLTT_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="af1cac6f7d62a2985867e9634fd17e80e">
<span class="m-doc-wrap-bumper">#define <a href="#af1cac6f7d62a2985867e9634fd17e80e" class="m-doc-self">PAL_RAM</a></span>
</dt>
<dd><span></span></dd>
<dt id="ad86f561a63fdf509888350f0d5fe8835">
<span class="m-doc-wrap-bumper">#define <a href="#ad86f561a63fdf509888350f0d5fe8835" class="m-doc-self">BG_PLTT</a></span>
</dt>
<dd><span></span></dd>
<dt id="a4180547d14373976689d6390e8ec66bc">
<span class="m-doc-wrap-bumper">#define <a href="#a4180547d14373976689d6390e8ec66bc" class="m-doc-self">BG_PLTT_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a26e3ba2ad915df9b9dd6c4c9ae9a3cfb">
<span class="m-doc-wrap-bumper">#define <a href="#a26e3ba2ad915df9b9dd6c4c9ae9a3cfb" class="m-doc-self">OBJ_PLTT</a></span>
</dt>
<dd><span></span></dd>
<dt id="ac48f21934aee7a9377375628490cd140">
<span class="m-doc-wrap-bumper">#define <a href="#ac48f21934aee7a9377375628490cd140" class="m-doc-self">OBJ_PLTT_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a92bb35ebceaee82bf1f68a9e6ef259ac">
<span class="m-doc-wrap-bumper">#define <a href="#a92bb35ebceaee82bf1f68a9e6ef259ac" class="m-doc-self">VRAM</a></span>
</dt>
<dd><span></span></dd>
<dt id="a44f73c2af1132081a39b3686a88cbc8c">
<span class="m-doc-wrap-bumper">#define <a href="#a44f73c2af1132081a39b3686a88cbc8c" class="m-doc-self">VRAM_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a08b4f0a78b8b477ebd1ea57f7adfa140">
<span class="m-doc-wrap-bumper">#define <a href="#a08b4f0a78b8b477ebd1ea57f7adfa140" class="m-doc-self">BG_VRAM</a></span>
</dt>
<dd><span></span></dd>
<dt id="ad93f5de6b6a34d4ae5da286180be55c1">
<span class="m-doc-wrap-bumper">#define <a href="#ad93f5de6b6a34d4ae5da286180be55c1" class="m-doc-self">BG_VRAM_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a7feda66c11aad14e0fdfae06c7c8d18d">
<span class="m-doc-wrap-bumper">#define <a href="#a7feda66c11aad14e0fdfae06c7c8d18d" class="m-doc-self">BG_CHAR_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="aca021161b4cc55608f0d200462194d8c">
<span class="m-doc-wrap-bumper">#define <a href="#aca021161b4cc55608f0d200462194d8c" class="m-doc-self">BG_SCREEN_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a848ec42f2b0471b520f903e4308fdc3e">
<span class="m-doc-wrap-bumper">#define <a href="#a848ec42f2b0471b520f903e4308fdc3e" class="m-doc-self">BG_CHAR_ADDR</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a56ff7455a1d96051b04caae7ea1e4026">
<span class="m-doc-wrap-bumper">#define <a href="#a56ff7455a1d96051b04caae7ea1e4026" class="m-doc-self">BG_SCREEN_ADDR</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a7a12b6dee96165ddc0e5a3fcad98c7a8">
<span class="m-doc-wrap-bumper">#define <a href="#a7a12b6dee96165ddc0e5a3fcad98c7a8" class="m-doc-self">BG_TILE_ADDR</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a641dc52f44c595114e29763c73b5a1c1">
<span class="m-doc-wrap-bumper">#define <a href="#a641dc52f44c595114e29763c73b5a1c1" class="m-doc-self">BG_TILE_H_FLIP</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="abfd59ded5c1c78f85621cc7b85d95b7c">
<span class="m-doc-wrap-bumper">#define <a href="#abfd59ded5c1c78f85621cc7b85d95b7c" class="m-doc-self">BG_TILE_V_FLIP</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a6e05f911884048dcff76f909f6e168ae">
<span class="m-doc-wrap-bumper">#define <a href="#a6e05f911884048dcff76f909f6e168ae" class="m-doc-self">OBJ_VRAM0</a></span>
</dt>
<dd><span></span></dd>
<dt id="a7abc068616001bfa454ee11ce7a36033">
<span class="m-doc-wrap-bumper">#define <a href="#a7abc068616001bfa454ee11ce7a36033" class="m-doc-self">OBJ_VRAM0_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a88e63d455e41807cb7af71e1687fcbd5">
<span class="m-doc-wrap-bumper">#define <a href="#a88e63d455e41807cb7af71e1687fcbd5" class="m-doc-self">OBJ_VRAM1</a></span>
</dt>
<dd><span></span></dd>
<dt id="a82d40d3559c38e2dfec17d29d61c30c5">
<span class="m-doc-wrap-bumper">#define <a href="#a82d40d3559c38e2dfec17d29d61c30c5" class="m-doc-self">OBJ_VRAM1_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a5797c8a19b428c6a97cd9b4f4324dafe">
<span class="m-doc-wrap-bumper">#define <a href="#a5797c8a19b428c6a97cd9b4f4324dafe" class="m-doc-self">OAM</a></span>
</dt>
<dd><span></span></dd>
<dt id="a66fdb2b0624111b109e271ee9f829df8">
<span class="m-doc-wrap-bumper">#define <a href="#a66fdb2b0624111b109e271ee9f829df8" class="m-doc-self">OAM_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="aca7e15b03b21b752addf3ce4ce42de81">
<span class="m-doc-wrap-bumper">#define <a href="#aca7e15b03b21b752addf3ce4ce42de81" class="m-doc-self">ROM_HEADER_SIZE</a></span>
</dt>
<dd><span></span></dd>
<dt id="a46d67d48a7faab308f2e058dc35da83a">
<span class="m-doc-wrap-bumper">#define <a href="#a46d67d48a7faab308f2e058dc35da83a" class="m-doc-self">DISPLAY_WIDTH</a></span>
</dt>
<dd><span></span></dd>
<dt id="a43b7b2061f733ea1dc0a5a6028e131ff">
<span class="m-doc-wrap-bumper">#define <a href="#a43b7b2061f733ea1dc0a5a6028e131ff" class="m-doc-self">DISPLAY_HEIGHT</a></span>
</dt>
<dd><span></span></dd>
<dt id="a6a73662cc354d156570fdff67f922726">
<span class="m-doc-wrap-bumper">#define <a href="#a6a73662cc354d156570fdff67f922726" class="m-doc-self">TILE_SIZE_4BPP</a></span>
</dt>
<dd><span></span></dd>
<dt id="a93efa256c064d294ecdc712292a160ba">
<span class="m-doc-wrap-bumper">#define <a href="#a93efa256c064d294ecdc712292a160ba" class="m-doc-self">TILE_SIZE_8BPP</a></span>
</dt>
<dd><span></span></dd>
<dt id="a7c59e8f02e3b7af06701fb467498ee67">
<span class="m-doc-wrap-bumper">#define <a href="#a7c59e8f02e3b7af06701fb467498ee67" class="m-doc-self">TILE_OFFSET_4BPP</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a010d6f12d0af397eb2718b5b8245a62e">
<span class="m-doc-wrap-bumper">#define <a href="#a010d6f12d0af397eb2718b5b8245a62e" class="m-doc-self">TILE_OFFSET_8BPP</a>(</span><span class="m-doc-wrap">n)</span>
</dt>
<dd><span></span></dd>
<dt id="a04436b6e9f961955a7725d10cd4a976d">
<span class="m-doc-wrap-bumper">#define <a href="#a04436b6e9f961955a7725d10cd4a976d" class="m-doc-self">TOTAL_OBJ_TILE_COUNT</a></span>
</dt>
<dd><span></span></dd>
<dt id="a4a118ad3ee36468a3fa616977a64864e">
<span class="m-doc-wrap-bumper">#define <a href="#a4a118ad3ee36468a3fa616977a64864e" class="m-doc-self">RGB</a>(</span><span class="m-doc-wrap">r,
g,
b)</span>
</dt>
<dd><span></span></dd>
<dt id="af862647d1298aac1131fd0676a2c3aa0">
<span class="m-doc-wrap-bumper">#define <a href="#af862647d1298aac1131fd0676a2c3aa0" class="m-doc-self">RGB2</a>(</span><span class="m-doc-wrap">r,
g,
b)</span>
</dt>
<dd><span></span></dd>
<dt id="aad69b0b0d54a168735dad8b9149b5cf9">
<span class="m-doc-wrap-bumper">#define <a href="#aad69b0b0d54a168735dad8b9149b5cf9" class="m-doc-self">_RGB</a>(</span><span class="m-doc-wrap">r,
g,
b)</span>
</dt>
<dd><span></span></dd>
<dt id="ae168f0f9864d4ed4be7807b9783f17f1">
<span class="m-doc-wrap-bumper">#define <a href="#ae168f0f9864d4ed4be7807b9783f17f1" class="m-doc-self">RGB_BLACK</a></span>
</dt>
<dd><span></span></dd>
<dt id="ac1771f95d9887118764bd8a074e537e1">
<span class="m-doc-wrap-bumper">#define <a href="#ac1771f95d9887118764bd8a074e537e1" class="m-doc-self">RGB_WHITE</a></span>
</dt>
<dd><span></span></dd>
<dt id="aa039288455af8a3812a35aa1e7b903e4">
<span class="m-doc-wrap-bumper">#define <a href="#aa039288455af8a3812a35aa1e7b903e4" class="m-doc-self">RGB_RED</a></span>
</dt>
<dd><span></span></dd>
<dt id="ab6c97468034c02fe204fd37036d9be15">
<span class="m-doc-wrap-bumper">#define <a href="#ab6c97468034c02fe204fd37036d9be15" class="m-doc-self">RGB_GREEN</a></span>
</dt>
<dd><span></span></dd>
<dt id="a0eff802f1ca228046476209dc01c76ad">
<span class="m-doc-wrap-bumper">#define <a href="#a0eff802f1ca228046476209dc01c76ad" class="m-doc-self">RGB_BLUE</a></span>
</dt>
<dd><span></span></dd>
<dt id="ad74a18fca945f257dc9d1b99f9edbd40">
<span class="m-doc-wrap-bumper">#define <a href="#ad74a18fca945f257dc9d1b99f9edbd40" class="m-doc-self">RGB_YELLOW</a></span>
</dt>
<dd><span></span></dd>
<dt id="a39f8048d8013cbc121e0dfa3f8819c44">
<span class="m-doc-wrap-bumper">#define <a href="#a39f8048d8013cbc121e0dfa3f8819c44" class="m-doc-self">RGB_MAGENTA</a></span>
</dt>
<dd><span></span></dd>
<dt id="a2ce30ac984869b55594447722b9d0579">
<span class="m-doc-wrap-bumper">#define <a href="#a2ce30ac984869b55594447722b9d0579" class="m-doc-self">RGB_CYAN</a></span>
</dt>
<dd><span></span></dd>
<dt id="ab3300bafee9cac351198f2a1593aa3ec">
<span class="m-doc-wrap-bumper">#define <a href="#ab3300bafee9cac351198f2a1593aa3ec" class="m-doc-self">RGB_WHITEALPHA</a></span>
</dt>
<dd><span></span></dd>
<dt id="a95982eccb57c2ae35f8ba3d8f0b05653">
<span class="m-doc-wrap-bumper">#define <a href="#a95982eccb57c2ae35f8ba3d8f0b05653" class="m-doc-self">SYSTEM_CLOCK</a></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">&hellip;</div>
</div>
<div class="m-doc-search-content">
<form>
<input type="search" name="q" id="search-input" placeholder="Loading &hellip;" 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">&darr;</span>
/ <span class="m-label m-dim">&uarr;</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>