forked from mmistakes/minimal-mistakes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
struct_input_manager.html
175 lines (165 loc) · 7.89 KB
/
struct_input_manager.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!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" lang="en-US">
<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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CS4850 Final Project: InputManager Struct 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>
<script type="text/javascript" src="clipboard.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" />
</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="projectalign">
<div id="projectname">CS4850 Final Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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');
$(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">
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="struct_input_manager-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">InputManager Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Singleton class that handles input.
<a href="#details">More...</a></p>
<p><code>#include <<a class="el" href="_input_manager_8hpp_source.html">InputManager.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af5638e587b34848dbdb982d8109666be" id="r_af5638e587b34848dbdb982d8109666be"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#af5638e587b34848dbdb982d8109666be">IsKeyPressed</a> (std::string key)</td></tr>
<tr class="memdesc:af5638e587b34848dbdb982d8109666be"><td class="mdescLeft"> </td><td class="mdescRight">Check if a key is pressed. Use SDL_Scancode for key. <br /></td></tr>
<tr class="separator:af5638e587b34848dbdb982d8109666be"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac42ba07e30b85a20b8ca1219960b944f" id="r_ac42ba07e30b85a20b8ca1219960b944f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="struct_input_manager.html">InputManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac42ba07e30b85a20b8ca1219960b944f">Instance</a> ()</td></tr>
<tr class="memdesc:ac42ba07e30b85a20b8ca1219960b944f"><td class="mdescLeft"> </td><td class="mdescRight">Get the instance of the <a class="el" href="struct_input_manager.html" title="Singleton class that handles input.">InputManager</a>. <br /></td></tr>
<tr class="separator:ac42ba07e30b85a20b8ca1219960b944f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Singleton class that handles input. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac42ba07e30b85a20b8ca1219960b944f" name="ac42ba07e30b85a20b8ca1219960b944f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac42ba07e30b85a20b8ca1219960b944f">◆ </a></span>Instance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="struct_input_manager.html">InputManager</a> & InputManager::Instance </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the instance of the <a class="el" href="struct_input_manager.html" title="Singleton class that handles input.">InputManager</a>. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_input_manager.html" title="Singleton class that handles input.">InputManager</a>& <a class="el" href="struct_input_manager.html" title="Singleton class that handles input.">InputManager</a> instance </dd></dl>
</div>
</div>
<a id="af5638e587b34848dbdb982d8109666be" name="af5638e587b34848dbdb982d8109666be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5638e587b34848dbdb982d8109666be">◆ </a></span>IsKeyPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool InputManager::IsKeyPressed </td>
<td>(</td>
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>key</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a key is pressed. Use SDL_Scancode for key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>Key to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the key is pressed </dd>
<dd>
false if the key is not pressed </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_input_manager_8hpp_source.html">InputManager.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>