-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation update for Keyboard class and PS2Device enum.
- Loading branch information
Showing
78 changed files
with
2,176 additions
and
455 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| <!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=11"/> | ||
| <meta name="generator" content="Doxygen 1.9.4"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>Rishka: sdk/librishka/keyboard.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="../../navtree.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="../../resize.js"></script> | ||
| <script type="text/javascript" src="../../navtreedata.js"></script> | ||
| <script type="text/javascript" src="../../navtree.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"/> | ||
| </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="projectlogo"><img alt="Logo" src="../../rishka-logo.png"/></td> | ||
| <td id="projectalign"> | ||
| <div id="projectname">Rishka | ||
| </div> | ||
| <div id="projectbrief">RISC-V virtual runtime in C/C++ made for ESP32-WROVER</div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.4 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "../../search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(function() { | ||
| initMenu('../../',true,false,'search.php','Search'); | ||
| $(document).ready(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&dn=expat.txt MIT */ | ||
| $(document).ready(function(){initNavTree('d6/da0/keyboard_8h.html','../../'); initResizable(); }); | ||
| /* @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"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| <div class="header"> | ||
| <div class="summary"> | ||
| <a href="#nested-classes">Classes</a> </div> | ||
| <div class="headertitle"><div class="title">keyboard.h File Reference</div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
|
|
||
| <p>This header file defines the <a class="el" href="../../dc/dd2/classKeyboard.html" title="Provides access to keyboard-related functionalities in the Rishka VM SDK.">Keyboard</a> class, providing access to keyboard-related functionalities in the Rishka VM SDK. | ||
| <a href="#details">More...</a></p> | ||
| <div class="textblock"><code>#include <<a class="el" href="../../d7/dde/devices_8h_source.html">librishka/devices.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="../../d9/d49/types_8h_source.html">librishka/types.h</a>></code><br /> | ||
| </div> | ||
| <p><a href="../../d6/da0/keyboard_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 id="nested-classes" name="nested-classes"></a> | ||
| Classes</h2></td></tr> | ||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dd2/classKeyboard.html">Keyboard</a></td></tr> | ||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to keyboard-related functionalities in the Rishka VM SDK. <a href="../../dc/dd2/classKeyboard.html#details">More...</a><br /></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table> | ||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | ||
| <div class="textblock"><p >This header file defines the <a class="el" href="../../dc/dd2/classKeyboard.html" title="Provides access to keyboard-related functionalities in the Rishka VM SDK.">Keyboard</a> class, providing access to keyboard-related functionalities in the Rishka VM SDK. </p> | ||
| <dl class="section author"><dt>Author</dt><dd><a href="https://github.com/nthnn">Nathanne Isip</a></dd></dl> | ||
| <p>The <a class="el" href="../../dc/dd2/classKeyboard.html" title="Provides access to keyboard-related functionalities in the Rishka VM SDK.">Keyboard</a> class allows interaction with various keyboard-related functionalities in the Rishka VM SDK. It includes methods for retrieving information about the keyboard layout, checking the status of lock keys (Num Lock, Caps Lock, Scroll Lock), controlling the state of these lock keys, obtaining keyboard scan codes, and performing operations such as locking, unlocking, and resetting the keyboard. </p> | ||
| </div></div><!-- contents --> | ||
| </div><!-- doc-content --> | ||
| <div id="nav-path" class="navpath"> | ||
| <ul> | ||
| <li class="footer">Copyright 2024 - <a href="https://github.com/nthnn" target="_blank">Nathanne Isip</a></li> | ||
| </ul> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| var keyboard_8h = | ||
| [ | ||
| [ "Keyboard", "dc/dd2/classKeyboard.html", null ] | ||
| ]; |
Oops, something went wrong.