libctru/input_2read-controls_2source_2main_8c-example.html
2024-11-03 20:36:34 +00:00

202 lines
21 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: input/read-controls/source/main.c</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">input/read-controls/source/main.c</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><span class="comment">/*</span></div>
<div class="line"><span class="comment"> Circle Pad example made by Aurelio Mannara for libctru</span></div>
<div class="line"><span class="comment"> Please refer to https://github.com/devkitPro/libctru/blob/master/libctru/include/3ds/services/hid.h for more information</span></div>
<div class="line"><span class="comment"> This code was modified for the last time on: 12/13/2014 2:20 UTC+1</span></div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> This wouldn&#39;t be possible without the amazing work done by:</span></div>
<div class="line"><span class="comment"> -Smealum</span></div>
<div class="line"><span class="comment"> -fincs</span></div>
<div class="line"><span class="comment"> -WinterMute</span></div>
<div class="line"><span class="comment"> -yellows8</span></div>
<div class="line"><span class="comment"> -plutoo</span></div>
<div class="line"><span class="comment"> -mtheall</span></div>
<div class="line"><span class="comment"> -Many others who worked on 3DS and I&#39;m surely forgetting about</span></div>
<div class="line"><span class="comment">*/</span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="3ds_8h.html">3ds.h</a>&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">//Matrix containing the name of each key. Useful for printing when a key is pressed</span></div>
<div class="line"> <span class="keywordtype">char</span> keysNames[32][32] = {</div>
<div class="line"> <span class="stringliteral">&quot;KEY_A&quot;</span>, <span class="stringliteral">&quot;KEY_B&quot;</span>, <span class="stringliteral">&quot;KEY_SELECT&quot;</span>, <span class="stringliteral">&quot;KEY_START&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;KEY_DRIGHT&quot;</span>, <span class="stringliteral">&quot;KEY_DLEFT&quot;</span>, <span class="stringliteral">&quot;KEY_DUP&quot;</span>, <span class="stringliteral">&quot;KEY_DDOWN&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;KEY_R&quot;</span>, <span class="stringliteral">&quot;KEY_L&quot;</span>, <span class="stringliteral">&quot;KEY_X&quot;</span>, <span class="stringliteral">&quot;KEY_Y&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;KEY_ZL&quot;</span>, <span class="stringliteral">&quot;KEY_ZR&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;KEY_TOUCH&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;KEY_CSTICK_RIGHT&quot;</span>, <span class="stringliteral">&quot;KEY_CSTICK_LEFT&quot;</span>, <span class="stringliteral">&quot;KEY_CSTICK_UP&quot;</span>, <span class="stringliteral">&quot;KEY_CSTICK_DOWN&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;KEY_CPAD_RIGHT&quot;</span>, <span class="stringliteral">&quot;KEY_CPAD_LEFT&quot;</span>, <span class="stringliteral">&quot;KEY_CPAD_UP&quot;</span>, <span class="stringliteral">&quot;KEY_CPAD_DOWN&quot;</span></div>
<div class="line"> };</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize services</span></div>
<div class="line"> <a name="a0"></a><a class="code" href="gfx_8h.html#a236a005ae029247c8bfe4a4a649206fc">gfxInitDefault</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Initialize console on top screen. Using NULL as the second argument tells the console library to use the internal console structure as current one</span></div>
<div class="line"> <a name="a1"></a><a class="code" href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8">consoleInit</a>(<a name="a2"></a><a class="code" href="gfx_8h.html#a356112d87f5cf6bbba3ea3b6b010e09caf9d44178134d07cf9c5923200e14af09">GFX_TOP</a>, NULL);</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> kDownOld = 0, kHeldOld = 0, kUpOld = 0; <span class="comment">//In these variables there will be information about keys detected in the previous frame</span></div>
<div class="line"> </div>
<div class="line"> printf(<span class="stringliteral">&quot;\x1b[1;1HPress Start to exit.&quot;</span>);</div>
<div class="line"> printf(<span class="stringliteral">&quot;\x1b[2;1HCirclePad position:&quot;</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Main loop</span></div>
<div class="line"> <span class="keywordflow">while</span> (<a name="a3"></a><a class="code" href="apt_8h.html#a84808c36d9a8c389896ecf241c7f89cb">aptMainLoop</a>())</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">//Scan all the inputs. This should be done once for each frame</span></div>
<div class="line"> <a name="a4"></a><a class="code" href="hid_8h.html#abbbf0e1f3a79a75e459e19f85a66bee6">hidScanInput</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//hidKeysDown returns information about which buttons have been just pressed (and they weren&#39;t in the previous frame)</span></div>
<div class="line"> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> kDown = <a name="a5"></a><a class="code" href="hid_8h.html#aa2cababf764bf0b4297dc2e2fffe2a76">hidKeysDown</a>();</div>
<div class="line"> <span class="comment">//hidKeysHeld returns information about which buttons have are held down in this frame</span></div>
<div class="line"> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> kHeld = <a name="a6"></a><a class="code" href="hid_8h.html#a68e8fd75a99650db835f045676a47949">hidKeysHeld</a>();</div>
<div class="line"> <span class="comment">//hidKeysUp returns information about which buttons have been just released</span></div>
<div class="line"> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> kUp = <a name="a7"></a><a class="code" href="hid_8h.html#acefc6e65ac14a7e02c1c1fd72279eed4">hidKeysUp</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (kDown &amp; <a name="a8"></a><a class="code" href="hid_8h.html#a531c35e38ede3ea4e5ba5afb24b29493a616a1f5c4ed36080ca954453084aea3b">KEY_START</a>) <span class="keywordflow">break</span>; <span class="comment">// break in order to return to hbmenu</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Do the keys printing only if keys have changed</span></div>
<div class="line"> <span class="keywordflow">if</span> (kDown != kDownOld || kHeld != kHeldOld || kUp != kUpOld)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">//Clear console</span></div>
<div class="line"> <a name="a9"></a><a class="code" href="console_8h.html#ac62c34a3fa2a6403c690dd80022b3e34">consoleClear</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//These two lines must be rewritten because we cleared the whole console</span></div>
<div class="line"> printf(<span class="stringliteral">&quot;\x1b[1;1HPress Start to exit.&quot;</span>);</div>
<div class="line"> printf(<span class="stringliteral">&quot;\x1b[2;1HCirclePad position:&quot;</span>);</div>
<div class="line"> </div>
<div class="line"> printf(<span class="stringliteral">&quot;\x1b[4;1H&quot;</span>); <span class="comment">//Move the cursor to the fourth row because on the third one we&#39;ll write the circle pad position</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Check if some of the keys are down, held or up</span></div>
<div class="line"> <span class="keywordtype">int</span> i;</div>
<div class="line"> <span class="keywordflow">for</span> (i = 0; i &lt; 32; i++)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">if</span> (kDown &amp; <a name="a10"></a><a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(i)) printf(<span class="stringliteral">&quot;%s down\n&quot;</span>, keysNames[i]);</div>
<div class="line"> <span class="keywordflow">if</span> (kHeld &amp; <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(i)) printf(<span class="stringliteral">&quot;%s held\n&quot;</span>, keysNames[i]);</div>
<div class="line"> <span class="keywordflow">if</span> (kUp &amp; <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(i)) printf(<span class="stringliteral">&quot;%s up\n&quot;</span>, keysNames[i]);</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Set keys old values for the next frame</span></div>
<div class="line"> kDownOld = kDown;</div>
<div class="line"> kHeldOld = kHeld;</div>
<div class="line"> kUpOld = kUp;</div>
<div class="line"> </div>
<div class="line"> <a name="_a11"></a><a class="code" href="structcirclePosition.html">circlePosition</a> pos;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Read the CirclePad position</span></div>
<div class="line"> <a name="a12"></a><a class="code" href="hid_8h.html#a54c0f28a80c0bac4d16afbb7fd06c49b">hidCircleRead</a>(&amp;pos);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Print the CirclePad position</span></div>
<div class="line"> printf(<span class="stringliteral">&quot;\x1b[3;1H%04d; %04d&quot;</span>, pos.<a name="a13"></a><a class="code" href="structcirclePosition.html#a2a234ca65b74a2634e067261050021bb">dx</a>, pos.<a name="a14"></a><a class="code" href="structcirclePosition.html#ac617313212e138e7249a1deec7ed8f88">dy</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Flush and swap framebuffers</span></div>
<div class="line"> <a name="a15"></a><a class="code" href="gfx_8h.html#aea1808bd74fe0c00f9794e455fc8499b">gfxFlushBuffers</a>();</div>
<div class="line"> <a name="a16"></a><a class="code" href="gfx_8h.html#a0f338920111994110975dc0d1360bb1f">gfxSwapBuffers</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//Wait for VBlank</span></div>
<div class="line"> <a name="a17"></a><a class="code" href="gspgpu_8h.html#abf0a992835649b5fe90e95d8a58b8c45">gspWaitForVBlank</a>();</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Exit services</span></div>
<div class="line"> <a name="a18"></a><a class="code" href="gfx_8h.html#aa446ccfdfdd4c575e648956ae96f2a3b">gfxExit</a>();</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="a3ds_8h_html"><div class="ttname"><a href="3ds_8h.html">3ds.h</a></div><div class="ttdoc">Central 3DS header.</div></div>
<div class="ttc" id="aapt_8h_html_a84808c36d9a8c389896ecf241c7f89cb"><div class="ttname"><a href="apt_8h.html#a84808c36d9a8c389896ecf241c7f89cb">aptMainLoop</a></div><div class="ttdeci">bool aptMainLoop(void)</div><div class="ttdoc">Main function which handles sleep mode and HOME/power buttons - call this at the beginning of every f...</div></div>
<div class="ttc" id="aconsole_8h_html_a8e014e84f81ff901ca62d7669a8c8de8"><div class="ttname"><a href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8">consoleInit</a></div><div class="ttdeci">PrintConsole * consoleInit(gfxScreen_t screen, PrintConsole *console)</div><div class="ttdoc">Initialise the console.</div></div>
<div class="ttc" id="aconsole_8h_html_ac62c34a3fa2a6403c690dd80022b3e34"><div class="ttname"><a href="console_8h.html#ac62c34a3fa2a6403c690dd80022b3e34">consoleClear</a></div><div class="ttdeci">void consoleClear(void)</div><div class="ttdoc">Clears the screen by using iprintf(&quot;\x1b[2J&quot;);.</div></div>
<div class="ttc" id="agfx_8h_html_a0f338920111994110975dc0d1360bb1f"><div class="ttname"><a href="gfx_8h.html#a0f338920111994110975dc0d1360bb1f">gfxSwapBuffers</a></div><div class="ttdeci">void gfxSwapBuffers(void)</div><div class="ttdoc">Updates the configuration of both screens.</div></div>
<div class="ttc" id="agfx_8h_html_a236a005ae029247c8bfe4a4a649206fc"><div class="ttname"><a href="gfx_8h.html#a236a005ae029247c8bfe4a4a649206fc">gfxInitDefault</a></div><div class="ttdeci">void gfxInitDefault(void)</div><div class="ttdoc">Initializes the LCD framebuffers with default parameters This is equivalent to calling:</div></div>
<div class="ttc" id="agfx_8h_html_a356112d87f5cf6bbba3ea3b6b010e09caf9d44178134d07cf9c5923200e14af09"><div class="ttname"><a href="gfx_8h.html#a356112d87f5cf6bbba3ea3b6b010e09caf9d44178134d07cf9c5923200e14af09">GFX_TOP</a></div><div class="ttdeci">@ GFX_TOP</div><div class="ttdoc">Top screen.</div><div class="ttdef"><b>Definition:</b> gfx.h:26</div></div>
<div class="ttc" id="agfx_8h_html_aa446ccfdfdd4c575e648956ae96f2a3b"><div class="ttname"><a href="gfx_8h.html#aa446ccfdfdd4c575e648956ae96f2a3b">gfxExit</a></div><div class="ttdeci">void gfxExit(void)</div><div class="ttdoc">Deinitializes and frees the LCD framebuffers.</div></div>
<div class="ttc" id="agfx_8h_html_aea1808bd74fe0c00f9794e455fc8499b"><div class="ttname"><a href="gfx_8h.html#aea1808bd74fe0c00f9794e455fc8499b">gfxFlushBuffers</a></div><div class="ttdeci">void gfxFlushBuffers(void)</div><div class="ttdoc">Flushes the data cache for the current framebuffers.</div></div>
<div class="ttc" id="agspgpu_8h_html_abf0a992835649b5fe90e95d8a58b8c45"><div class="ttname"><a href="gspgpu_8h.html#abf0a992835649b5fe90e95d8a58b8c45">gspWaitForVBlank</a></div><div class="ttdeci">#define gspWaitForVBlank()</div><div class="ttdoc">Waits for VBlank.</div><div class="ttdef"><b>Definition:</b> gspgpu.h:151</div></div>
<div class="ttc" id="ahid_8h_html_a531c35e38ede3ea4e5ba5afb24b29493a616a1f5c4ed36080ca954453084aea3b"><div class="ttname"><a href="hid_8h.html#a531c35e38ede3ea4e5ba5afb24b29493a616a1f5c4ed36080ca954453084aea3b">KEY_START</a></div><div class="ttdeci">@ KEY_START</div><div class="ttdoc">Start.</div><div class="ttdef"><b>Definition:</b> hid.h:15</div></div>
<div class="ttc" id="ahid_8h_html_a54c0f28a80c0bac4d16afbb7fd06c49b"><div class="ttname"><a href="hid_8h.html#a54c0f28a80c0bac4d16afbb7fd06c49b">hidCircleRead</a></div><div class="ttdeci">void hidCircleRead(circlePosition *pos)</div><div class="ttdoc">Reads the current circle pad position.</div></div>
<div class="ttc" id="ahid_8h_html_a68e8fd75a99650db835f045676a47949"><div class="ttname"><a href="hid_8h.html#a68e8fd75a99650db835f045676a47949">hidKeysHeld</a></div><div class="ttdeci">u32 hidKeysHeld(void)</div><div class="ttdoc">Returns a bitmask of held buttons.</div></div>
<div class="ttc" id="ahid_8h_html_aa2cababf764bf0b4297dc2e2fffe2a76"><div class="ttname"><a href="hid_8h.html#aa2cababf764bf0b4297dc2e2fffe2a76">hidKeysDown</a></div><div class="ttdeci">u32 hidKeysDown(void)</div><div class="ttdoc">Returns a bitmask of newly pressed buttons, this frame.</div></div>
<div class="ttc" id="ahid_8h_html_abbbf0e1f3a79a75e459e19f85a66bee6"><div class="ttname"><a href="hid_8h.html#abbbf0e1f3a79a75e459e19f85a66bee6">hidScanInput</a></div><div class="ttdeci">void hidScanInput(void)</div><div class="ttdoc">Scans HID for input data.</div></div>
<div class="ttc" id="ahid_8h_html_acefc6e65ac14a7e02c1c1fd72279eed4"><div class="ttname"><a href="hid_8h.html#acefc6e65ac14a7e02c1c1fd72279eed4">hidKeysUp</a></div><div class="ttdeci">u32 hidKeysUp(void)</div><div class="ttdoc">Returns a bitmask of newly released buttons, this frame.</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="astructcirclePosition_html_a2a234ca65b74a2634e067261050021bb"><div class="ttname"><a href="structcirclePosition.html#a2a234ca65b74a2634e067261050021bb">circlePosition::dx</a></div><div class="ttdeci">s16 dx</div><div class="ttdoc">Pad X.</div><div class="ttdef"><b>Definition:</b> hid.h:53</div></div>
<div class="ttc" id="astructcirclePosition_html_ac617313212e138e7249a1deec7ed8f88"><div class="ttname"><a href="structcirclePosition.html#ac617313212e138e7249a1deec7ed8f88">circlePosition::dy</a></div><div class="ttdeci">s16 dy</div><div class="ttdoc">Pad Y.</div><div class="ttdef"><b>Definition:</b> hid.h:54</div></div>
<div class="ttc" id="atypes_8h_html_a3a8ea58898cb58fc96013383d39f482c"><div class="ttname"><a href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a></div><div class="ttdeci">#define BIT(n)</div><div class="ttdoc">Creates a bitmask from a bit number.</div><div class="ttdef"><b>Definition:</b> types.h:47</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>