libctru/irrst_8h.html
2024-11-03 20:36:34 +00:00

297 lines
18 KiB
HTML

<!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 File Reference</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="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">irrst.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>IRRST service.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="hid_8h_source.html">3ds/services/hid.h</a>&quot;</code><br />
</div>
<p><a href="irrst_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae7c1e131af85608a182ace6cda524095"><td class="memItemLeft" align="right" valign="top"><a id="ae7c1e131af85608a182ace6cda524095"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#ae7c1e131af85608a182ace6cda524095">hidCstickRead</a>&#160;&#160;&#160;<a class="el" href="irrst_8h.html#a4120b5fd220f1c0dc973d8154b975b48">irrstCstickRead</a></td></tr>
<tr class="memdesc:ae7c1e131af85608a182ace6cda524095"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro for irrstCstickRead. <br /></td></tr>
<tr class="separator:ae7c1e131af85608a182ace6cda524095"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a698caec5300ae01893e5ba5098de834b"><td class="memItemLeft" align="right" valign="top"><a id="a698caec5300ae01893e5ba5098de834b"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a698caec5300ae01893e5ba5098de834b">irrstInit</a> (void)</td></tr>
<tr class="memdesc:a698caec5300ae01893e5ba5098de834b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes IRRST. <br /></td></tr>
<tr class="separator:a698caec5300ae01893e5ba5098de834b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae208aace95de96c4a609626feade344b"><td class="memItemLeft" align="right" valign="top"><a id="ae208aace95de96c4a609626feade344b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#ae208aace95de96c4a609626feade344b">irrstExit</a> (void)</td></tr>
<tr class="memdesc:ae208aace95de96c4a609626feade344b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits IRRST. <br /></td></tr>
<tr class="separator:ae208aace95de96c4a609626feade344b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35f403f8df0133df67dda4d52cbc04e8"><td class="memItemLeft" align="right" valign="top"><a id="a35f403f8df0133df67dda4d52cbc04e8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a35f403f8df0133df67dda4d52cbc04e8">irrstScanInput</a> (void)</td></tr>
<tr class="memdesc:a35f403f8df0133df67dda4d52cbc04e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans IRRST for input. <br /></td></tr>
<tr class="separator:a35f403f8df0133df67dda4d52cbc04e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48182185c763fcdca0c0f32daafe0213"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a48182185c763fcdca0c0f32daafe0213">irrstKeysHeld</a> (void)</td></tr>
<tr class="memdesc:a48182185c763fcdca0c0f32daafe0213"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets IRRST's held keys. <a href="irrst_8h.html#a48182185c763fcdca0c0f32daafe0213">More...</a><br /></td></tr>
<tr class="separator:a48182185c763fcdca0c0f32daafe0213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4120b5fd220f1c0dc973d8154b975b48"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a4120b5fd220f1c0dc973d8154b975b48">irrstCstickRead</a> (<a class="el" href="structcirclePosition.html">circlePosition</a> *pos)</td></tr>
<tr class="memdesc:a4120b5fd220f1c0dc973d8154b975b48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current c-stick position. <a href="irrst_8h.html#a4120b5fd220f1c0dc973d8154b975b48">More...</a><br /></td></tr>
<tr class="separator:a4120b5fd220f1c0dc973d8154b975b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a064e532f7919489e9b1ca82b37340126"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a064e532f7919489e9b1ca82b37340126">irrstWaitForEvent</a> (bool nextEvent)</td></tr>
<tr class="memdesc:a064e532f7919489e9b1ca82b37340126"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the IRRST input event to trigger. <a href="irrst_8h.html#a064e532f7919489e9b1ca82b37340126">More...</a><br /></td></tr>
<tr class="separator:a064e532f7919489e9b1ca82b37340126"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae13dd3f91f553c59c929714ff61a0d7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#ae13dd3f91f553c59c929714ff61a0d7f">IRRST_GetHandles</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *outMemHandle, <a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *outEventHandle)</td></tr>
<tr class="memdesc:ae13dd3f91f553c59c929714ff61a0d7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the shared memory and event handles for IRRST. <a href="irrst_8h.html#ae13dd3f91f553c59c929714ff61a0d7f">More...</a><br /></td></tr>
<tr class="separator:ae13dd3f91f553c59c929714ff61a0d7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91189b34ca23140216288798510ccf37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a91189b34ca23140216288798510ccf37">IRRST_Initialize</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk1, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> unk2)</td></tr>
<tr class="memdesc:a91189b34ca23140216288798510ccf37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes IRRST. <a href="irrst_8h.html#a91189b34ca23140216288798510ccf37">More...</a><br /></td></tr>
<tr class="separator:a91189b34ca23140216288798510ccf37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73d3e631a1c1e21e7390436c2329985d"><td class="memItemLeft" align="right" valign="top"><a id="a73d3e631a1c1e21e7390436c2329985d"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a73d3e631a1c1e21e7390436c2329985d">IRRST_Shutdown</a> (void)</td></tr>
<tr class="memdesc:a73d3e631a1c1e21e7390436c2329985d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shuts down IRRST. <br /></td></tr>
<tr class="separator:a73d3e631a1c1e21e7390436c2329985d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a4de48cede60d01dde7da165b6d3dc9f1"><td class="memItemLeft" align="right" valign="top"><a id="a4de48cede60d01dde7da165b6d3dc9f1"></a>
<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a4de48cede60d01dde7da165b6d3dc9f1">irrstMemHandle</a></td></tr>
<tr class="memdesc:a4de48cede60d01dde7da165b6d3dc9f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">IRRST's shared memory handle. <br /></td></tr>
<tr class="separator:a4de48cede60d01dde7da165b6d3dc9f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec11113e52350b578816d784829ad42"><td class="memItemLeft" align="right" valign="top"><a id="a6ec11113e52350b578816d784829ad42"></a>
<a class="el" href="types_8h.html#abcdd5d61f51cb4c472ac6637916cf72a">vu32</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a6ec11113e52350b578816d784829ad42">irrstSharedMem</a></td></tr>
<tr class="memdesc:a6ec11113e52350b578816d784829ad42"><td class="mdescLeft">&#160;</td><td class="mdescRight">IRRST's shared memory. <br /></td></tr>
<tr class="separator:a6ec11113e52350b578816d784829ad42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dc8751e66c41c8fb3185955418e506f"><td class="memItemLeft" align="right" valign="top"><a id="a0dc8751e66c41c8fb3185955418e506f"></a>
<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="irrst_8h.html#a0dc8751e66c41c8fb3185955418e506f">irrstEvent</a></td></tr>
<tr class="memdesc:a0dc8751e66c41c8fb3185955418e506f"><td class="mdescLeft">&#160;</td><td class="mdescRight">IRRST's state update event. <br /></td></tr>
<tr class="separator:a0dc8751e66c41c8fb3185955418e506f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>IRRST service. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae13dd3f91f553c59c929714ff61a0d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae13dd3f91f553c59c929714ff61a0d7f">&#9670;&nbsp;</a></span>IRRST_GetHandles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> IRRST_GetHandles </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>outMemHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>outEventHandle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the shared memory and event handles for IRRST. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outMemHandle</td><td>Pointer to write the shared memory handle to. </td></tr>
<tr><td class="paramname">outEventHandle</td><td>Pointer to write the event handle to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a91189b34ca23140216288798510ccf37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91189b34ca23140216288798510ccf37">&#9670;&nbsp;</a></span>IRRST_Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> IRRST_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>unk1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>unk2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes IRRST. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">unk1</td><td>Unknown. </td></tr>
<tr><td class="paramname">unk2</td><td>Unknown. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4120b5fd220f1c0dc973d8154b975b48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4120b5fd220f1c0dc973d8154b975b48">&#9670;&nbsp;</a></span>irrstCstickRead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void irrstCstickRead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcirclePosition.html">circlePosition</a> *&#160;</td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the current c-stick position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>Pointer to output the current c-stick position to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a48182185c763fcdca0c0f32daafe0213"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48182185c763fcdca0c0f32daafe0213">&#9670;&nbsp;</a></span>irrstKeysHeld()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> irrstKeysHeld </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets IRRST's held keys. </p>
<dl class="section return"><dt>Returns</dt><dd>IRRST's held keys. </dd></dl>
</div>
</div>
<a id="a064e532f7919489e9b1ca82b37340126"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a064e532f7919489e9b1ca82b37340126">&#9670;&nbsp;</a></span>irrstWaitForEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void irrstWaitForEvent </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>nextEvent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits for the IRRST input event to trigger. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nextEvent</td><td>Whether to discard the current event and wait until the next event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>