SpaghettiKart/GameExtractor_8h_source.html

150 lines
11 KiB
HTML

<!-- HTML header for doxygen 1.10.0-->
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Mario Kart 64: src/port/GameExtractor.h Source File</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="docs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">Mario Kart 64
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('GameExtractor_8h_source.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">GameExtractor.h</div></div>
</div><!--header-->
<div class="contents">
<a href="GameExtractor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;Companion.h&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;filesystem&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="};">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="classGameExtractor.html"> 8</a></span><span class="keyword">class </span><a class="code hl_class" href="classGameExtractor.html">GameExtractor</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classGameExtractor.html#a068ee2ee209e80be83ce70c134eec895"> 10</a></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classGameExtractor.html#a068ee2ee209e80be83ce70c134eec895">GenAssetFile</a>();</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> std::optional&lt;std::string&gt; <a class="code hl_function" href="classGameExtractor.html#a62a6158e90fd2366e4780164d3571f8c">ValidateChecksum</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classGameExtractor.html#a10cbcd1aac0aa869fdde0d3f1d502b45">SelectGameFromUI</a>();</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classGameExtractor.html#a787a62ed41a6f9e69d355810b3c8fe78">GetRoms</a>(std::vector&lt;std::string&gt;&amp; roms);</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classGameExtractor.html#a3eee313b86c230c3fee5f7a5ce120df3">GenerateOTR</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classGameExtractor.html#a7e90279a7db81dee58a4dfd4a0cb2745"> 16</a></span> fs::path <a class="code hl_variable" href="classGameExtractor.html#a7e90279a7db81dee58a4dfd4a0cb2745">mGamePath</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classGameExtractor.html#ada063d80b026e2d48266dddb3aaaf027"> 17</a></span> std::vector&lt;uint8_t&gt; <a class="code hl_variable" href="classGameExtractor.html#ada063d80b026e2d48266dddb3aaaf027">mGameData</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>};</div>
</div>
<div class="ttc" id="aclassGameExtractor_html"><div class="ttname"><a href="classGameExtractor.html">GameExtractor</a></div><div class="ttdef"><b>Definition</b> GameExtractor.h:8</div></div>
<div class="ttc" id="aclassGameExtractor_html_a068ee2ee209e80be83ce70c134eec895"><div class="ttname"><a href="classGameExtractor.html#a068ee2ee209e80be83ce70c134eec895">GameExtractor::GenAssetFile</a></div><div class="ttdeci">static bool GenAssetFile()</div></div>
<div class="ttc" id="aclassGameExtractor_html_a10cbcd1aac0aa869fdde0d3f1d502b45"><div class="ttname"><a href="classGameExtractor.html#a10cbcd1aac0aa869fdde0d3f1d502b45">GameExtractor::SelectGameFromUI</a></div><div class="ttdeci">bool SelectGameFromUI()</div><div class="ttdef"><b>Definition</b> GameExtractor.cpp:33</div></div>
<div class="ttc" id="aclassGameExtractor_html_a3eee313b86c230c3fee5f7a5ce120df3"><div class="ttname"><a href="classGameExtractor.html#a3eee313b86c230c3fee5f7a5ce120df3">GameExtractor::GenerateOTR</a></div><div class="ttdeci">bool GenerateOTR() const</div><div class="ttdef"><b>Definition</b> GameExtractor.cpp:188</div></div>
<div class="ttc" id="aclassGameExtractor_html_a62a6158e90fd2366e4780164d3571f8c"><div class="ttname"><a href="classGameExtractor.html#a62a6158e90fd2366e4780164d3571f8c">GameExtractor::ValidateChecksum</a></div><div class="ttdeci">std::optional&lt; std::string &gt; ValidateChecksum() const</div><div class="ttdef"><b>Definition</b> GameExtractor.cpp:176</div></div>
<div class="ttc" id="aclassGameExtractor_html_a787a62ed41a6f9e69d355810b3c8fe78"><div class="ttname"><a href="classGameExtractor.html#a787a62ed41a6f9e69d355810b3c8fe78">GameExtractor::GetRoms</a></div><div class="ttdeci">void GetRoms(std::vector&lt; std::string &gt; &amp;roms)</div><div class="ttdef"><b>Definition</b> GameExtractor.cpp:121</div></div>
<div class="ttc" id="aclassGameExtractor_html_a7e90279a7db81dee58a4dfd4a0cb2745"><div class="ttname"><a href="classGameExtractor.html#a7e90279a7db81dee58a4dfd4a0cb2745">GameExtractor::mGamePath</a></div><div class="ttdeci">fs::path mGamePath</div><div class="ttdef"><b>Definition</b> GameExtractor.h:16</div></div>
<div class="ttc" id="aclassGameExtractor_html_ada063d80b026e2d48266dddb3aaaf027"><div class="ttname"><a href="classGameExtractor.html#ada063d80b026e2d48266dddb3aaaf027">GameExtractor::mGameData</a></div><div class="ttdeci">std::vector&lt; uint8_t &gt; mGameData</div><div class="ttdef"><b>Definition</b> GameExtractor.h:17</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fd8b95245ffcce776715f180c056b450.html">port</a></li><li class="navelem"><a class="el" href="GameExtractor_8h.html">GameExtractor.h</a></li>
<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.13.2 </li>
</ul>
</div>
</body>
</html>