archeus/doc/doxygen/html/de/ded/input_8h.html

265 lines
14 KiB
HTML

<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/input/input.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="../../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"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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(1); });
/* @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('de/ded/input_8h.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="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">input.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../d6/da0/keyboard_8h_source.html">arc/input/keyboard.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../dc/ded/mouse_8h_source.html">arc/input/mouse.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d8/d77/bool_8h_source.html">arc/std/bool.h</a>&quot;</code><br />
</div>
<p><a href="../../de/ded/input_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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ab10a17a34031b17d7ed09ca515a91b45" id="r_ab10a17a34031b17d7ed09ca515a91b45"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a></td></tr>
<tr class="memdesc:ab10a17a34031b17d7ed09ca515a91b45"><td class="mdescLeft">&#160;</td><td class="mdescRight">predefien ARC_Input so as not to get circular reference <br /></td></tr>
<tr class="separator:ab10a17a34031b17d7ed09ca515a91b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab067b02367e78494a930fcccdd930c0c" id="r_ab067b02367e78494a930fcccdd930c0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab067b02367e78494a930fcccdd930c0c">ARC_Input_CreateWithEngineData</a> (<a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> **input, <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *data)</td></tr>
<tr class="separator:ab067b02367e78494a930fcccdd930c0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f88d045f196b8460a62f4c32ee23f54" id="r_a3f88d045f196b8460a62f4c32ee23f54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f88d045f196b8460a62f4c32ee23f54">ARC_Input_Destroy</a> (<a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:a3f88d045f196b8460a62f4c32ee23f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb3fa56528406720283b62b2b713e118" id="r_afb3fa56528406720283b62b2b713e118"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb3fa56528406720283b62b2b713e118">ARC_Input_Update</a> (<a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:afb3fa56528406720283b62b2b713e118"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33b395c2b23fb459904fef05df97ae5d" id="r_a33b395c2b23fb459904fef05df97ae5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33b395c2b23fb459904fef05df97ae5d">ARC_Input_GetKeyboard</a> (<a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:a33b395c2b23fb459904fef05df97ae5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5de153e8f7dd3212cb998ea2ad29c4f6" id="r_a5de153e8f7dd3212cb998ea2ad29c4f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dc/ded/mouse_8h.html#a902312c6398b8df6994f040d103b507b">ARC_Mouse</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5de153e8f7dd3212cb998ea2ad29c4f6">ARC_Input_GetMouse</a> (<a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:a5de153e8f7dd3212cb998ea2ad29c4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ab10a17a34031b17d7ed09ca515a91b45" name="ab10a17a34031b17d7ed09ca515a91b45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab10a17a34031b17d7ed09ca515a91b45">&#9670;&#160;</a></span>ARC_Input</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> <a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>predefien ARC_Input so as not to get circular reference </p>
<p class="definition">Definition at line <a class="el" href="../../de/ded/input_8h_source.html#l00017">17</a> of file <a class="el" href="../../de/ded/input_8h_source.html">input.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab067b02367e78494a930fcccdd930c0c" name="ab067b02367e78494a930fcccdd930c0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab067b02367e78494a930fcccdd930c0c">&#9670;&#160;</a></span>ARC_Input_CreateWithEngineData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Input_CreateWithEngineData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> **</td> <td class="paramname"><span class="paramname"><em>input</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3f88d045f196b8460a62f4c32ee23f54" name="a3f88d045f196b8460a62f4c32ee23f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f88d045f196b8460a62f4c32ee23f54">&#9670;&#160;</a></span>ARC_Input_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Input_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a33b395c2b23fb459904fef05df97ae5d" name="a33b395c2b23fb459904fef05df97ae5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33b395c2b23fb459904fef05df97ae5d">&#9670;&#160;</a></span>ARC_Input_GetKeyboard()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> * ARC_Input_GetKeyboard </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5de153e8f7dd3212cb998ea2ad29c4f6" name="a5de153e8f7dd3212cb998ea2ad29c4f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5de153e8f7dd3212cb998ea2ad29c4f6">&#9670;&#160;</a></span>ARC_Input_GetMouse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../dc/ded/mouse_8h.html#a902312c6398b8df6994f040d103b507b">ARC_Mouse</a> * ARC_Input_GetMouse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afb3fa56528406720283b62b2b713e118" name="afb3fa56528406720283b62b2b713e118"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb3fa56528406720283b62b2b713e118">&#9670;&#160;</a></span>ARC_Input_Update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a> ARC_Input_Update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_46d97a8ae0c0aa8b914a0b5ca3ee1355.html">input</a></li><li class="navelem"><a class="el" href="../../de/ded/input_8h.html">input.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>