libctru/irrst_8h_source.html

164 lines
20 KiB
HTML
Raw Normal View 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libctru: include/3ds/services/irrst.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>
<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">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">irrst.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="irrst_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * @file irrst.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @brief IRRST service.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//See also: http://3dbrew.org/wiki/IR_Services http://3dbrew.org/wiki/IRRST_Shared_Memory</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hid_8h.html">3ds/services/hid.h</a>&quot;</span> <span class="comment">// for circlePosition definition</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">/// IRRST&#39;s shared memory handle.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span><span class="keyword">extern</span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code" href="irrst_8h.html#a4de48cede60d01dde7da165b6d3dc9f1">irrstMemHandle</a>;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">/// IRRST&#39;s shared memory.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span><span class="keyword">extern</span> <a class="code" href="types_8h.html#abcdd5d61f51cb4c472ac6637916cf72a">vu32</a>* <a class="code" href="irrst_8h.html#a6ec11113e52350b578816d784829ad42">irrstSharedMem</a>;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">/// IRRST&#39;s state update event</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"></span><span class="keyword">extern</span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code" href="irrst_8h.html#a0dc8751e66c41c8fb3185955418e506f">irrstEvent</a>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">/// Initializes IRRST.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="irrst_8h.html#a698caec5300ae01893e5ba5098de834b"> 21</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="irrst_8h.html#a698caec5300ae01893e5ba5098de834b">irrstInit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">/// Exits IRRST.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="irrst_8h.html#ae208aace95de96c4a609626feade344b"> 24</a></span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="irrst_8h.html#ae208aace95de96c4a609626feade344b">irrstExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">/// Scans IRRST for input.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="irrst_8h.html#a35f403f8df0133df67dda4d52cbc04e8"> 27</a></span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="irrst_8h.html#a35f403f8df0133df67dda4d52cbc04e8">irrstScanInput</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * @brief Gets IRRST&#39;s held keys.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> * @return IRRST&#39;s held keys.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="irrst_8h.html#a48182185c763fcdca0c0f32daafe0213"> 33</a></span>&#160;<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="irrst_8h.html#a48182185c763fcdca0c0f32daafe0213">irrstKeysHeld</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"> * @brief Reads the current c-stick position.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> * @param pos Pointer to output the current c-stick position to.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="irrst_8h.html#a4120b5fd220f1c0dc973d8154b975b48"> 39</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="irrst_8h.html#a4120b5fd220f1c0dc973d8154b975b48">irrstCstickRead</a>(<a class="code" href="structcirclePosition.html">circlePosition</a>* pos);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> * @brief Waits for the IRRST input event to trigger.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> * @param nextEvent Whether to discard the current event and wait until the next event.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="irrst_8h.html#a064e532f7919489e9b1ca82b37340126"> 45</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="irrst_8h.html#a064e532f7919489e9b1ca82b37340126">irrstWaitForEvent</a>(<span class="keywordtype">bool</span> nextEvent);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">/// Macro for irrstCstickRead.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="irrst_8h.html#ae7c1e131af85608a182ace6cda524095"> 48</a></span>&#160;<span class="comment"></span><span class="preprocessor">#define hidCstickRead irrstCstickRead</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> * @brief Gets the shared memory and event handles for IRRST.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> * @param outMemHandle Pointer to write the shared memory handle to.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> * @param outEventHandle Pointer to write the event handle to.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="irrst_8h.html#ae13dd3f91f553c59c929714ff61a0d7f"> 55</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="irrst_8h.html#ae13dd3f91f553c59c929714ff61a0d7f">IRRST_GetHandles</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* outMemHandle, <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* outEventHandle);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> * @brief Initializes IRRST.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> * @param unk1 Unknown.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> * @param unk2 Unknown.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="irrst_8h.html#a91189b34ca23140216288798510ccf37"> 62</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="irrst_8h.html#a91189b34ca23140216288798510ccf37">IRRST_Initialize</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk1, <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> unk2);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment">/// Shuts down IRRST.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="irrst_8h.html#a73d3e631a1c1e21e7390436c2329985d"> 65</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="irrst_8h.html#a73d3e631a1c1e21e7390436c2329985d">IRRST_Shutdown</a>(<span class="keywordtype">void</span>);</div>
<div class="ttc" id="ahid_8h_html"><div class="ttname"><a href="hid_8h.html">hid.h</a></div><div class="ttdoc">HID service.</div></div>
<div class="ttc" id="airrst_8h_html_a064e532f7919489e9b1ca82b37340126"><div class="ttname"><a href="irrst_8h.html#a064e532f7919489e9b1ca82b37340126">irrstWaitForEvent</a></div><div class="ttdeci">void irrstWaitForEvent(bool nextEvent)</div><div class="ttdoc">Waits for the IRRST input event to trigger.</div></div>
<div class="ttc" id="airrst_8h_html_a0dc8751e66c41c8fb3185955418e506f"><div class="ttname"><a href="irrst_8h.html#a0dc8751e66c41c8fb3185955418e506f">irrstEvent</a></div><div class="ttdeci">Handle irrstEvent</div><div class="ttdoc">IRRST's state update event.</div></div>
<div class="ttc" id="airrst_8h_html_a35f403f8df0133df67dda4d52cbc04e8"><div class="ttname"><a href="irrst_8h.html#a35f403f8df0133df67dda4d52cbc04e8">irrstScanInput</a></div><div class="ttdeci">void irrstScanInput(void)</div><div class="ttdoc">Scans IRRST for input.</div></div>
<div class="ttc" id="airrst_8h_html_a4120b5fd220f1c0dc973d8154b975b48"><div class="ttname"><a href="irrst_8h.html#a4120b5fd220f1c0dc973d8154b975b48">irrstCstickRead</a></div><div class="ttdeci">void irrstCstickRead(circlePosition *pos)</div><div class="ttdoc">Reads the current c-stick position.</div></div>
<div class="ttc" id="airrst_8h_html_a48182185c763fcdca0c0f32daafe0213"><div class="ttname"><a href="irrst_8h.html#a48182185c763fcdca0c0f32daafe0213">irrstKeysHeld</a></div><div class="ttdeci">u32 irrstKeysHeld(void)</div><div class="ttdoc">Gets IRRST's held keys.</div></div>
<div class="ttc" id="airrst_8h_html_a4de48cede60d01dde7da165b6d3dc9f1"><div class="ttname"><a href="irrst_8h.html#a4de48cede60d01dde7da165b6d3dc9f1">irrstMemHandle</a></div><div class="ttdeci">Handle irrstMemHandle</div><div class="ttdoc">IRRST's shared memory handle.</div></div>
<div class="ttc" id="airrst_8h_html_a698caec5300ae01893e5ba5098de834b"><div class="ttname"><a href="irrst_8h.html#a698caec5300ae01893e5ba5098de834b">irrstInit</a></div><div class="ttdeci">Result irrstInit(void)</div><div class="ttdoc">Initializes IRRST.</div></div>
<div class="ttc" id="airrst_8h_html_a6ec11113e52350b578816d784829ad42"><div class="ttname"><a href="irrst_8h.html#a6ec11113e52350b578816d784829ad42">irrstSharedMem</a></div><div class="ttdeci">vu32 * irrstSharedMem</div><div class="ttdoc">IRRST's shared memory.</div></div>
<div class="ttc" id="airrst_8h_html_a73d3e631a1c1e21e7390436c2329985d"><div class="ttname"><a href="irrst_8h.html#a73d3e631a1c1e21e7390436c2329985d">IRRST_Shutdown</a></div><div class="ttdeci">Result IRRST_Shutdown(void)</div><div class="ttdoc">Shuts down IRRST.</div></div>
<div class="ttc" id="airrst_8h_html_a91189b34ca23140216288798510ccf37"><div class="ttname"><a href="irrst_8h.html#a91189b34ca23140216288798510ccf37">IRRST_Initialize</a></div><div class="ttdeci">Result IRRST_Initialize(u32 unk1, u8 unk2)</div><div class="ttdoc">Initializes IRRST.</div></div>
<div class="ttc" id="airrst_8h_html_ae13dd3f91f553c59c929714ff61a0d7f"><div class="ttname"><a href="irrst_8h.html#ae13dd3f91f553c59c929714ff61a0d7f">IRRST_GetHandles</a></div><div class="ttdeci">Result IRRST_GetHandles(Handle *outMemHandle, Handle *outEventHandle)</div><div class="ttdoc">Gets the shared memory and event handles for IRRST.</div></div>
<div class="ttc" id="airrst_8h_html_ae208aace95de96c4a609626feade344b"><div class="ttname"><a href="irrst_8h.html#ae208aace95de96c4a609626feade344b">irrstExit</a></div><div class="ttdeci">void irrstExit(void)</div><div class="ttdoc">Exits IRRST.</div></div>
<div class="ttc" id="astructcirclePosition_html"><div class="ttname"><a href="structcirclePosition.html">circlePosition</a></div><div class="ttdoc">Circle Pad position.</div><div class="ttdef"><b>Definition:</b> hid.h:52</div></div>
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
<div class="ttc" id="atypes_8h_html_abcdd5d61f51cb4c472ac6637916cf72a"><div class="ttname"><a href="types_8h.html#abcdd5d61f51cb4c472ac6637916cf72a">vu32</a></div><div class="ttdeci">volatile u32 vu32</div><div class="ttdoc">32-bit volatile unsigned integer.</div><div class="ttdef"><b>Definition:</b> types.h:33</div></div>
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>